Withdrawal broadcast notification
Currently, we support 20+ cryptocurrencies as a payout option. Once you initiate a withdrawal we need to take care of a couple of things before we successfully broadcast it to the network. Withdrawals take on average 10 minutes to be broadcast on the designated blockchain network. Upon completion, you'll receive a callback notification.
This callback notification is sent on your
withdrawalCallbackUrl
endpoint.
Schema
Parameter | Type | Description |
status | string [required] | One of |
clientWithdrawalId | string [required] | Unique withdrawal identifier provided by the merchant in the request body of POST |
businessId | string [required] | Unique Finrax business identifier |
withdrawalId | string [required] | Unique Finrax withdrawal identifier |
displayCurrency | string [required] | The fiat currency chosen for display (denomination) purposes |
withdrawCurrency | string [required] | Cryptocurrency to be withdrawn |
settlementCurrency | string [required] | The currency in which the merchant's account was debited because of the withdrawal (can be either fiat or cryptocurrency) |
expectedDisplayAmount | number [required] | Amount in |
actualDisplayAmount | number [optional] | Actual amount withdrawn in |
estimatedWithdrawAmount | number [required] | Estimated amount for this withdrawal. Can be different than |
actualWithdrawAmount | number [optional] | Actual amount withdrawn in |
deducedSettlementAmount | number [optional] | Amount debited from the merchant's balance in |
withdrawFee | number [optional] | Blockchain cost for this withdrawal in |
displayFee | number [optional] | Blockchain cost for this withdrawal in |
toTxAddress | string [required] | The address to which the |
transactionId | string [optional] | Unique blockchain transaction ID of the withdrawal |
txAddressOwner | object [required] | Address AML screening results |
name | string [required] | Address owning entity name |
category | string [required] | Address owning entity category |
Last updated