1. Prepare a crypto payout
/payout/withdraw/local/crypto/directCreate a stablecoin payout request.
Note : This provides a quote that expires 60 seconds after creation. You can ask for a new quote before the previous one expires for a seamless front-end experience.
Body application/json
Unique key that identifies a merchant
Email address of the payout recipient
The currency to be withdrawn. This should be a 3-character ISO 4217 currency code
Amount of the local currency to be withdrawn and converted into cryptocurrency.
Is required unless the crypto_amount is specified instead.
Default value is onchain-wallet. binance represents sending cryptocurrency through Binance Pay.
As of June 2026, this Binance payout feature is only enabled upon request. Please contact our support team.
Cryptocurrency that will be paid out.
If the payout_destination_type is binance, the supported values are BTC and USDC only.
You can use this to request a payout for a precise crypto amount (for example, ask a payout for a value of 0.0324 ETH rather than 72 USD).
Remarks for the payout
The crypto wallet address of your customer.
If the payout_destination_type is binance, this value should be a valid Binance ID of the recipient.
The merchant’s name
The merchant’s business registration number or national id if an individual
The merchant’s domiciled country. It must be a 2-character ISO 3166 country code.
IP address of the merchant
The merchant’s system unique order id. It has to be unique and has never been used for a payout previously.
The URL to send the webhook notification. The webhook URL given in your account setup will be used if this is not provided. For testing you can use webhook.site
The shared secret that will be used to sign the notification. This secret can be at most 64 characters long. If this is not provided in the payment request, the system will create a random secret just for that payment.
Response
Success
The merchant’s system unique order id.
Unique payout reference number
The type of payout:
-
refund- A partial or complete refund of a prior successful payment. -
withdraw- A withdrawal (or payout) of the merchant’s accumulated local currency balance in cryptocurrency.
Account type the funds are drawn from: local - Funds are drawn
from a local currency account
Type of conversion the funds underwent:
-
local-local- Funds are drawn from a local currency account and paid out as local currency. -
local-crypto- Funds are drawn from a local currency account and paid out as cryptocurrency.
This indicates the type of wallet the payout goes to, either a Binance wallet or other onchain-wallet.
The local currency equivalent of the payout. This should be a 3-character ISO 4217 currency code. Please ignore if the payout is in cryptocurrency.
The local currency amount to be paid out. Please ignore if the payout is in cryptocurrency.
Cryptocurrency that will be paid out. Please ignore if the payout is in local currency.
Amount of cryptocurrency to be paid out if the payout is in cryptocurrency.
Amount of cryptocurrency representing the network fee. This is denominated in crypto_currency.
Amount of cryptocurrency after deduction of the network_fee_crypto_amount.
Address that recipient will receive the payout at.
This could either be a unique wallet address hash or Binance ID, depending on the field - payout_destination_type.
The exchange rate that will be used to exchange local currency to cryptocurrency or vice-versa.
The current status of the payout:
-
new- The payout has just been created or refreshed, but has not been confirmed or cancelled yet. This status will appear if you call the Create Crypto Payout via API. -
confirm- The payout has been confirmed. This status will appear if you call the Confirm Crypto Payout via API. -
done- The payout has been broadcasted to the blockchain and successfully paid out to the recipient. -
cancel- The payout has been cancelled. This status will appear if you call the Cancel Crypto Payout via API and successfully cancel the payout.
Date and time the status was updated
Name of the merchant
Remarks for the payout
The URL to send the webhook notification. The webhook URL given in your account setup will be used if this is not provided. For testing you can use webhook.site
The shared secret that will be used to sign the notification. This secret can be at most 64 characters long. If this is not provided in the payment request, the system will create a random secret just for that payment.
Unauthorized
unauthorized- refers to no access token is used for authentication.Invalid token: access token is invalid- refers to the invalid or incorrect access token used.
No permission to create payout
no_permission - refers to when trying to confirm, cancel or refresh the payout that has been confirmed or cancelled. Or access token has expired.
Exchange Rate has expired
rate_expire - refers to confirming the payout after the exchange rate expired.
Validation Error - There are 1 or more errors in the request body
Main error message