Finrax API
HomeChangelogIntegration GuideResources
HomeChangelogIntegration GuideResources
  1. Callbacks
  • Getting Started
    • Introduction
    • Environments
    • Errors
    • Authorization
      • API Key Management
      • Signature
      • Code Snippets
  • Payments and Withdrawals
    • Crypto Payments
      • Fetch payment by ID
      • 🔒Fetch payments
      • Submit crypto payment
      • Request crypto payment
    • Fetch withdrawals
      GET
    • Fetch withdrawal metadata
      GET
    • Request crypto withdrawal
      POST
    • Fetch whitelisted addresses
      GET
    • Whitelist an address
      POST
    • Fetch crypto withdrawal approval by ID
      GET
    • Fetch business by ID
      GET
    • Fetch business balance
      GET
    • Unwhitelist an address
      DELETE
  • Callbacks
    • Deposit received notification
    • Withdrawal broadcast notification
    • Withdrawal approved/rejected notification
  • Address validation
    • Validate address
      GET
    • Validate address and destination tag
      GET
  • Rates and metadata
    • Fetch market rates
      GET
    • Fetch fiat rates
      GET
    • Fetch deposit rates
      GET
    • Fetch all currencies
      GET
  1. Callbacks

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#

ParameterTypeDescription
statusstring One ofCOMPLETED, FAILED or BLOCKED
clientWithdrawalIdstring Unique withdrawal identifier provided by the merchant in the request body of POST /withdrawals
businessIdstring Unique Finrax business identifier UUID
withdrawalIdstring Unique Finrax withdrawal identifier UUID
displayCurrencystring The fiat currency chosen for display (denomination) purposes
withdrawCurrencystring Cryptocurrency to be withdrawn
settlementCurrencystring The currency in which the merchant's account was debited because of the withdrawal (can be either fiat or cryptocurrency)
expectedDisplayAmountnumber Amount in displayCurrency requested for this payment
actualDisplayAmountnumber Actual amount withdrawn in displayCurrency currency (e.g.EUR, USD, GBP, TRY etc..)Can be different than expectedDisplayAmount
estimatedWithdrawAmountnumber Estimated amount for this withdrawal. Can be different than actualWithdrawAmount
actualWithdrawAmountnumber Actual amount withdrawn in withdrawCurrencyCan be different than estimatedWithdrawAmount
deducedSettlementAmountnumber Amount debited from the merchant's balance in settlementCurrency
withdrawFeenumber Blockchain cost for this withdrawal in withdrawCurrency
displayFeenumber Blockchain cost for this withdrawal in displayCurrency
toTxAddressstring The address to which the actualWithdrawAmountwas sent
transactionIdstring Unique blockchain transaction ID of the withdrawal
txAddressOwnerobject Address AML screening results
namestring Address owning entity name
categorystring Address owning entity category
Modified at 2024-07-04 10:42:11
Previous
Deposit received notification
Next
Withdrawal approved/rejected notification
Built with