Batch Payout
Payout API used for Merchant/Partner to make transfers in batch.
#
EndPoint#
Request ParametersAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
requestId | string | Y | Maximum length 32 | The unique ID assigned by the merchant to identify a payout request. |
bizScene | string | N | Enum value | Describe the business scene of this payout. Limited to: DIRECT_TRANSFER: the default value CRYPTO_REWARDS: gift or rewards payout SETTLEMENT: settlement or commission fee REIMBURSEMENT: reimburse employees MERCHANT_PAYMENT: payment to partners/users OTHERS |
batchName | string | Y | Maximum length 32 | The name of the batch payout. |
currency | string | Y | Crypto token only, fiat NOT supported. All characters must be in uppercase | All the transfers under this batch must use the same currency. |
totalAmount | decimal | Y | limitation refer to Create Order API order amount | It must be equal to the sum of all the detail transfers. |
totalNumber | int | Y | Maximum value 500 | The total number of transfers. It must be equal to the detail transfer count. |
transferDetailList | list[TransferDetailReq] | Y | Maximum size 500 | Detail transfer list |
#
Child Attribute#
TransferDetailReqAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
merchantSendId | string | Y | Maximum length 32 | The unique ID assigned by the merchant to identify a detail transfer. |
receiveType | string | Y | Enum value | Receiver's ID type PAY_ID: Binance pay ID. BINANCE_ID: Binance user ID. EMAIL: Binance user email address, support payout to non-binance users |
receiver | string | Y | Receiver's PAY_ID/ BINANCE_ID/ EMAIL depends on the receiver type. Note: - If it is a non-binance user email address, he or she needs to register a binance account to receive the payout. - The amount will be automatically refunded to your wallet if receivers haven't completed the registration with 72 hours. | |
transferAmount | decimal | Y | Transfer amount maximum is at 80K USD equivalent | |
transferMethod | string | Y | Enum string | Wallet to be used. Currently support: FUNDING_WALLET SPOT_WALLET |
remark | String | N | Maximum length 128 | Remark |
registrationEmail | String | N | Receiver's registration email address | |
registrationMobileNumber | String | N | Receiver's mobile number | |
registrationMobileCode | String | N | Receiver's mobile code eg:971 for UAE |
#
Sample Request Body#
Response ParametersAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
status | string | Y | "SUCCESS" or "FAIL" | status of the API request |
code | string | Y | - | request result code, refer to |
data | PayoutTransferResponse | N | - | response body, refer to |
errorMessage | string | N | maximum length 256 |
#
Child Attribute#
PayoutTransferResponseAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
requestId | string | Y | Maximum length 32 | The passed-in request ID |
status | string | Y | Enum string | ACCEPTED: accepted the request, will process it soon |
#
Sample Response#
Result CodeName | Code | Reason | Solution |
---|---|---|---|
UNKNOWN_ERROR | 400000 | An unknown error occurred while processing the request. | Try again later |
INVALID_REQUEST | 400001 | Parameter format is wrong or parameter transferring doesn't follow the rules. | Please check whether the parameters are correct. |
INVALID_SIGNATURE | 400002 | Incorrect signature result | Check whether the signature parameter and method comply with signature algorithm requirements. |
INVALID_TIMESTAMP | 400003 | Timestamp for this request is outside of the time window. | Sync server clock |
INVALID_API_KEY_OR_IP | 400004 | API identity key not found or invalid. | Check API identity key |
BAD_API_KEY_FMT | 400005 | API identity key format invalid. | Check API identity key. |
BAD_HTTP_METHOD | 400006 | Request method not supported. | Check Request method. |
MEDIA_TYPE_NOT_SUPPORTED | 400007 | Media type not supported. | Check Request Media type. |
INVALID_REQUEST_BODY | 400008 | Request body is not a valid json object. | Check Request body |
MANDATORY_PARAM_EMPTY_OR_MALFORMED | 400100 | A parameter was missing/empty/null, or malformed. | |
INVALID_PARAM_WRONG_LENGTH | 400101 | A parameter was not valid, was empty/null, or too long/short, or wrong format. | |
INVALID_PARAM_WRONG_VALUE | 400102 | A parameter was not valid, the value is out of range. | |
INVALID_PARAM_ILLEGAL_CHAR | 400103 | A parameter was not valid, contains illegal characters. | |
INVALID_REQUEST_TOO_LARGE | 400104 | Invalid request, content length too large. | |
INVALID_REQUEST_CURRENCY_NOT_SUPPORTED | 400105 | Invalid request, the transfer currency is not supported or not in upper case. | |
PAYMENT_ACTION_TOO_FREQUENT | 400501 | action Too Frequent, get the lock fail | Try again later |
PAYMENT_ILLEGAL_AMOUNT | 400701 | The amount is illegal, too small or too large | |
PAYMENT_INVALID_PARAM | 400702 | Invalid request parameter | |
PAYMENT_C2C_RECEIVER_ACCOUNT_NOT_FOUND | 400703 | Payee not found | |
PAYEE_ACCOUNT_LOCKED | 400704 | Payee account is locked | |
PAYEE_ACCOUNT_FROZEN | 400705 | payee account is frozen | |
PAYMENT_C2C_RECEIVER_ACCOUNT_INVALID | 400706 | Payee status invalid | |
PAYMENT_EXCEED_MERCHANT_DAILY_LIMIT | 400707 | Exceeds merchant's payment daily limit in USD. | |
PAYMENT_EXCEED_MERCHANT_ANNUAL_LIMIT | 400708 | Exceeds merchant's payment annual limit in USD. | |
USER_IN_BLOCK_KYC | 400709 | Payee is unable to access Binance due to his/her residential region, you will not be able to proceed with the payment. | |
PAYEE_KYC_NOT_PASSED | 400710 | We are unable to initiate the transfer as payee has not completed identity verification. | |
RISK_HIT_REJECTED | 400711 | The deal is rejected and there may be risks in the current transaction | |
PAYMENT_RECEIVER_EXCEED_RECEIVE_LIMIT | 400712 | Recipient has exceeded fund receiving limit. | |
PAYMENT_C2C_HIT_RISK_RULE | 400713 | The deal is rejected and there may be risks in the current transaction | |
USER_IN_BLACK_KYC | 400714 | user in black kyc | |
USER_IN_BLACK_IP_AND_NO_KYC | 400715 | user in black ip and no kyc | |
USER_IN_BLACK_IP_AND_KYC | 400716 | user in black ip | |
USER_IN_BLACK_DEVICE_RELATION | 400717 | user in black device relation | |
COMPLIANCE_USER_IN_BLACK_KYC | 400718 | user in black kyc | |
COMPLIANCE_USER_IN_BLACK_IP_AND_NO_KYC | 400719 | user in black ip and no kyc | |
COMPLIANCE_USER_IN_BLACK_IP_AND_KYC | 400720 | user in black ip | |
KYC_NOT_PASSED | 400721 | kyc not passed | |
KYC_NOT_COMPLETED | 400722 | kyc not completed | |
KYC_AUDITING | 400723 | kyc auditing | |
KYC_SERVER_PUBLISHING | 400724 | kyc server publishing | |
MERCHANT_TRANSFER_SAME_ACCOUNT | 406101 | Receiver account cannot be same with payer | |
MERCHANT_TRANSFER_INVALID_AMOUNT | 406102 | Payout transfer amount must be greater than min usd | |
MERCHANT_TRANSFER_PAYEE_NOT_FOUND | 406103 | payee account cannot be found in the system | |
MERCHANT_TRANSFER_CURRENCY_NOT_SUPPORT | 406104 | Invalid request, currency is not supported | |
MERCHANT_TRANSFER_PAYEE_CANNOT_SUB_USER | 406105 | Receiver account cannot be a sub user | |
MERCHANT_TRANSFER_RECEIVER_INVALID | 406106 | Receiver account info is not valid, please check again |
#
Supported Currenciesname | Effective |
---|---|
CAKE | Yes |
APE | Yes |
LOKA | Yes |
WOO | Yes |
XNO | Yes |
TRIBE | Yes |
T | Yes |
USDT | Yes |
SHIB | Yes |
GALA | Yes |
BTTC | Yes |
BEL | Yes |
ARPA | Yes |
LAZIO | Yes |
MBOX | Yes |
TRB | Yes |
ZEN | Yes |
STORJ | Yes |
CTK | Yes |
SKL | Yes |
ENJ | Yes |
YFI | Yes |
YFII | Yes |
SRM | Yes |
CRV | Yes |
BAT | Yes |
BAL | Yes |
KSM | Yes |
AAVE | Yes |
THETA | Yes |
WAVES | Yes |
OCEAN | Yes |
KAVA | Yes |
AXS | Yes |
ICX | Yes |
LRC | Yes |
REN | Yes |
TOMO | Yes |
MKR | Yes |
ONT | Yes |
BLZ | Yes |
SNX | Yes |
RLC | Yes |
FLM | Yes |
KNC | Yes |
CVC | Yes |
IOTA | Yes |
RSR | Yes |
BAND | Yes |
OMG | Yes |
ZRX | Yes |
RUNE | Yes |
COMP | Yes |
NEAR | Yes |
HNT | Yes |
RUB | Yes |
NGN | Yes |
UAH | Yes |
IOST | Yes |
AVAX | Yes |
SUSHI | Yes |
ALGO | Yes |
SOL | Yes |
FIRO | Yes |
IDRT | Yes |
AMP | Yes |
PLA | Yes |
JASMY | Yes |
GRT | Yes |
ALPHA | Yes |
XEC | Yes |
ACM | Yes |
REQ | Yes |
ADX | Yes |
RIF | Yes |
ROSE | Yes |
RVN | Yes |
AERGO | Yes |
SAND | Yes |
AGIX | Yes |
SC | Yes |
AGLD | Yes |
SCRT | Yes |
AION | Yes |
SFP | Yes |
AKRO | Yes |
ALICE | Yes |
ALPACA | Yes |
AMB | Yes |
ANKR | Yes |
ANT | Yes |
SNM | Yes |
SNT | Yes |
AR | Yes |
ARDR | Yes |
ARK | Yes |
SSV | Yes |
STEEM | Yes |
ASR | Yes |
STMX | Yes |
AST | Yes |
ATA | Yes |
STPT | Yes |
STX | Yes |
ATM | Yes |
SUN | Yes |
AUCTION | Yes |
AUDIO | Yes |
AUTO | Yes |
SYS | Yes |
BADGER | Yes |
BAKE | Yes |
TCT | Yes |
BAR | Yes |
TFUEL | Yes |
TLM | Yes |
TORN | Yes |
BEAM | Yes |
TROY | Yes |
BETA | Yes |
TRU | Yes |
TVK | Yes |
BIFI | Yes |
TWT | Yes |
UFT | Yes |
UMA | Yes |
BNT | Yes |
UNFI | Yes |
BNX | Yes |
UTK | Yes |
BOND | Yes |
VGX | Yes |
VIB | Yes |
BRD | Yes |
VIDT | Yes |
BTCST | Yes |
VITE | Yes |
BTG | Yes |
BTS | Yes |
VTHO | Yes |
BURGER | Yes |
WABI | Yes |
WAN | Yes |
C98 | Yes |
WAXP | Yes |
WBTC | Yes |
WIN | Yes |
CELO | Yes |
WING | Yes |
CELR | Yes |
WNXM | Yes |
CFX | Yes |
CHESS | Yes |
WTC | Yes |
CITY | Yes |
CKB | Yes |
CLV | Yes |
XEM | Yes |
COCOS | Yes |
COS | Yes |
COTI | Yes |
YGG | Yes |
CREAM | Yes |
CTXC | Yes |
CVP | Yes |
DAR | Yes |
DATA | Yes |
DCR | Yes |
DEGO | Yes |
DENT | Yes |
DEXE | Yes |
DF | Yes |
DGB | Yes |
DIA | Yes |
DNT | Yes |
DOCK | Yes |
DODO | Yes |
DREP | Yes |
DUSK | Yes |
DYDX | Yes |
ELF | Yes |
ENS | Yes |
EPS | Yes |
ERN | Yes |
EZ | Yes |
FARM | Yes |
FET | Yes |
FIDA | Yes |
FIO | Yes |
FIS | Yes |
FLOW | Yes |
FOR | Yes |
FORTH | Yes |
FTT | Yes |
FUN | Yes |
FXS | Yes |
GAS | Yes |
GHST | Yes |
GLM | Yes |
GNO | Yes |
GO | Yes |
GTC | Yes |
GTO | Yes |
GXS | Yes |
HARD | Yes |
HIVE | Yes |
HOT | Yes |
ICP | Yes |
IDEX | Yes |
ILV | Yes |
INJ | Yes |
IQ | Yes |
IRIS | Yes |
JST | Yes |
JUV | Yes |
KEY | Yes |
KLAY | Yes |
KMD | Yes |
KP3R | Yes |
LINA | Yes |
LIT | Yes |
LOOM | Yes |
LPT | Yes |
LSK | Yes |
LTO | Yes |
LUNA | Yes |
MASK | Yes |
MBL | Yes |
MDA | Yes |
MDT | Yes |
MDX | Yes |
MFT | Yes |
MINA | Yes |
MIR | Yes |
MITH | Yes |
MLN | Yes |
MOVR | Yes |
MTL | Yes |
NAS | Yes |
NAV | Yes |
NBS | Yes |
NEBL | Yes |
NKN | Yes |
NMR | Yes |
NULS | Yes |
NXS | Yes |
OAX | Yes |
OG | Yes |
OGN | Yes |
ONG | Yes |
ORN | Yes |
OXT | Yes |
PAXG | Yes |
PERL | Yes |
PERP | Yes |
PHA | Yes |
PHB | Yes |
PIVX | Yes |
PNT | Yes |
POLS | Yes |
POLY | Yes |
POND | Yes |
PORTO | Yes |
POWR | Yes |
PROM | Yes |
PSG | Yes |
PUNDIX | Yes |
QI | Yes |
QKC | Yes |
QLC | Yes |
QNT | Yes |
QSP | Yes |
QUICK | Yes |
RAD | Yes |
RAMP | Yes |
RARE | Yes |
RAY | Yes |
REEF | Yes |
REP | Yes |
BIDR | Yes |
DAI | Yes |
CHR | Yes |
SUPER | Yes |
CHZ | Yes |
SLP | Yes |
TKO | Yes |
XVG | Yes |
MATIC | Yes |
IOTX | Yes |
FRONT | Yes |
XVS | Yes |
BCH | Yes |
DOT | Yes |
1INCH | Yes |
BTC | Yes |
FTM | Yes |
ONE | Yes |
ATOM | Yes |
MANA | Yes |
ETC | Yes |
BNB | Yes |
ETH | Yes |
ZEC | Yes |
NEO | Yes |
ADA | Yes |
VET | Yes |
DOGE | Yes |
SXP | Yes |
HBAR | Yes |
DASH | Yes |
XRP | Yes |
CTSI | Yes |
TRX | Yes |
AVA | Yes |
STRAX | Yes |
LTC | Yes |
EGLD | Yes |
GRS | Yes |
UNI | Yes |
XLM | Yes |
LINK | Yes |
WRX | Yes |
QTUM | Yes |
OM | Yes |
XTZ | Yes |
EOS | Yes |
FIL | Yes |
BUSD | Yes |
XMR | Yes |
ZIL | Yes |
VAI | Yes |