Withdrawal broadcast notification
Currently, we support 9 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.
{
"status": "COMPLETED",
"clientWithdrawalId": "Example-Withdrawal",
"businessId": "19dee3c4-4dc9-4bcc-b8ed-92e3d4f256bd",
"withdrawalId": "9b479a98-99ed-4bf9-87e0-4a05dbb012b6",
"displayCurrency": "TRY",
"withdrawCurrency": "XRP",
"settlementCurrency": "USDC",
"expectedDisplayAmount": "200.00000000",
"actualDisplayAmount": "200.00000000",
"estimatedWithdrawAmount": "119.63196400",
"actualWithdrawAmount": "119.66467800",
"deductedSettlementAmount": "35.28559158",
"withdrawFee": "0.25000000",
"displayFee": "0.42000000",
"displayRateDepegLossAmount":"0.49",
"settlementRateDepegLossAmount": "0.48",
"toTxAddress": "rLsVuk4hgmGUtjQKj1ybpg1etnFodZ4CJ?dt=140",
"transactionId": "1AABB14A963442246EC6252B6FDCC72223544B9BBB9E28C431DF2F1C B3545DB5",
"txAddressOwner": {
"name": "Coinbase",
"category": "Exchange"
}
}
Schema
Parameter
Type
Description
status
string [required]
One ofCOMPLETED,
FAILED
or BLOCKED
clientWithdrawalId
string [required]
Unique withdrawal identifier provided by the merchant in the request body of POST /withdrawals
businessId
string [required]
Unique Finrax business identifier UUID
withdrawalId
string [required]
Unique Finrax withdrawal identifier UUID
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 displayCurrency
requested for this payment
actualDisplayAmount
number [optional]
Actual amount withdrawn in displayCurrency
currency (e.g.EUR, USD, GBP, TRY etc..)
Can be different than expectedDisplayAmount
estimatedWithdrawAmount
number [required]
Estimated amount for this withdrawal. Can be different than actualWithdrawAmount
actualWithdrawAmount
number [optional]
Actual amount withdrawn in withdrawCurrency
Can be different than estimatedWithdrawAmount
deducedSettlementAmount
number [optional]
Amount debited from the merchant's balance in settlementCurrency
withdrawFee
number [optional]
Blockchain cost for this withdrawal in withdrawCurrency
displayFee
number [optional]
Blockchain cost for this withdrawal in displayCurrency
displayRateDepegLossAmount
number [optional]
Loss incurred from the pegging of withdrawal and display currencies market rate in displayCurrency
.
settlementRateDepegLossAmount
number [optional]
Loss incurred from the pegging of withdrawal and display currencies market rate in settlementCurrency
.
toTxAddress
string [required]
The address to which the actualWithdrawAmount
was sent
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
Was this helpful?