Create Binance Pay Withdrawal

post

https://api.getorbital.io/crypto/withdrawal/binance

Initiates crypto payout to a Binance Pay user using their Binance ID or email.

Body Params

receiveType

string

enum

required

Specifies how the receiver is identified: either BINANCE_ID or EMAIL.

Allowed:

receiver

string

required

The Binance ID or email address of the receiver, depending on the receiveType specified.

externalId

uuid

required

Unique ID for the transaction generated by the merchant. Each request requires a new externalId; reusing one is not allowed.

notifyUrl

uri

URL to receive notifications about the withdrawal status.

sourceCurrency

string

enum

This is the currency held in the merchant's balance from which the withdrawal amount will be deducted.

Accepted values: USD, GBP, EUR, USDT, USDC.

Allowed:

sourceAmount

string

The amount of sourceCurrency that the merchant wants to deduct from their balance.

targetCurrency

string

enum

This is the cryptocurrency that the receiver will get in their Binance Pay wallet.

Accepted values: USDT or USDC.

Conversion Rules: If targetCurrency is specified, a conversion occurs. It can be:

Fiat-to-Crypto: e.g., USD (source) to USDT (target).
Crypto-to-Crypto: e.g., USDT (source) to USDC (target).

If targetCurrency is omitted, no conversion occurs, and the payout is made in the sourceCurrency.

Allowed:

targetAmount

string

The amount of targetCurrency to be credited to the receiver.

cashierCurrency

string

enum

The currency in which the receiver's balance is displayed on the merchant platform.

cashierAmount

string

The amount in cashierCurrency that is displayed in the receiver's balance on the merchant platform.

firstName

string

required

length ≤ 100

Receiver's first name.

lastName

string

required

length ≤ 100

Receiver's last name.

dateOfBirth

date

required

Receiver's date of birth in YYYY-MM-DD format.

merchantId

string

Internal merchant identifier - PMID number. By default, this field is automatically referenced by the system.

personType

string

enum

Defaults to naturalPerson

Indicates the type of receiver. Can be naturalPerson or legalPerson.

Allowed:

Responses

200Binance Pay withdrawal created successfully.

400Bad request - Indicates that the request parameters are invalid or missing.

401Unauthorized – Missing or invalid API key.

500Internal server error. This can be caused by duplicate externalId, missing account permissions or unexpected server-side issues.