Payout
Binance Payout provides your business with an instant and secure way to send mass crypto payouts to your customers and suppliers all over the world. You can use the Payout API to make payments to multiple recipients in a single API request, either to their Binance ID or email. This includes non-Binance users as well.
How it works#
You can choose to perform Payout from the following options:
- API Integration: Initiate payout request using Batch Payout API;
- Manual: Upload csv file to perform payout in the MMP.
- Enable Payout features for your API Keys
- Before performing the payout, you can use Query Wallet Balance API to ensure that your wallet has sufficient funds.
- Each batch payout can be performed to multiple recipients (max. 500) in the desired cryptocurrency.
- Recipients with verified Binance accounts will receive the payout in their Funding Wallet. For non-Binance user, they will receive an email invitation to create a Binance account and perform KYC to receive the fund. If user did not complete KYC within 72 hours, we will refund amount back to your account.
Getting Started#
Enabling Payout Function in MMP#
Go to [Developers] Tab, select [API].
Check on the boxes to enable Payout. For added security, you can also input the trusted IPs to access the Payout function for the specific API Keys only.
Batch Payout via API#
You can use the “Batch Payout” API to initiate transfers to multiple Binance users in a single request.
End Point#
POST / binancepay / openapi / payout / transferRequest Example#
For full API specification, please go to API Request Reference.
You need to assign a requestId for batch payout request. (Max. length 32)
The transferDetailList array defines the payout items, and you will need to assign a merchantSendId (Max. length 32) for each item.
"requestId":"samplerequest1234", "batchName" :"sample batch", "currency" : "USDT", "totalAmount": 200.4, "totalNumber": 2, "bizScene": "SETTLEMENT", "transferDetailList":[ { "merchantSendId" : "21231313131", "transferAmount": 110.3, "receiveType":"BINANCE_ID", "transferMethod":"SPOT_WALLET", "receiver":"354205155", "remark":"test1" }, { "merchantSendId" : "21231313132", "transferAmount": 90.1, "receiveType":"BINANCE_ID", "transferMethod":"SPOT_WALLET", "receiver":"354205153", "remark":"test2" } ]}You can describe the type of payout under bizScene, the default value is direct_transfer.
| Status | Description |
|---|---|
| DIRECT_TRANSFER | The default value |
| CRYPTO_REWARDS | Gift or rewards payout |
| SETTLEMENT | Marketplace settlement or commission fee |
| REIMBURSEMENT | Reimburse of expenses to employees |
| MERCHANT_PAYMENT | Payment to your partners, users or suppliers |
| OTHERS | Any other payment |
Response Example#
For full API specification, please go to API Request Reference.
{ "status": "SUCCESS", "code": "000000", "data": { "requestId": "samplerequest1234", "status": "ACCEPTED" }}You can monitor the status using the parameter “Status”
| Status | Description |
|---|---|
| SUCCESS | Payout request ID accepted, and being processed. |
| FAIL | Payout request failed |
For success payout, a requestID will be returned in the data, along with an “ACCEPTED” status. This shows that the batch payout request has been accepted, it will be processed soon.
If the batch payout request is unsuccessful, you will receive a fail status along with the error message.
| Status | Description |
|---|---|
| ACCEPTED | Transfer accepted and will be processed soon. |
| PROCESSING | Transfers are currently being processed. |
| SUCCESS | All transfers are successful |
| PART_SUCCESS | Transfers partially succeeded |
| FAILED | All transfers failed |
| CANCELED | Retry limit met, transfers will not retry further. All transfer are cancelled |
Payout Query API#
You can use the “Payout Query” API to retrieve payout status and details.
End Point#
POST / binancepay / openapi / payout / queryRequest Example#
For full API specification, please go to API Request Reference.
Please use the requestId to search for specific Batch Payout.
{ "requestId": "payouttransfer19998"}Response Example#
For full API specification, please go to API Request Reference.
{ "status": "SUCCESS", "code": "000000", "data": { "requestId": "payoutqueryrequest1232455", "batchStatus": "ACCEPTED", "merchantId": 354195960, "currency": "USDT", "totalAmount": "0.00000002", "totalNumber": 2, "transferDetailList": [ { "orderId": 118073402258677761, "merchantSendId": "21231313131", "payerId": 354195960, "amount": "0.00000001", "receiveType": "BINANCE_ID", "receiver": "354205155", "payeeId": 354205155, "transferMethod": "SPOT_WALLET", "status": "PROCESSING", "remark": "test1" }, { "orderId": 118073402258677762, "merchantSendId": "21231313132", "payerId": 354195960, "amount": "0.00000001", "receiveType": "BINANCE_ID", "receiver": "354205155", "payeeId": 354205155, "transferMethod": "SPOT_WALLET", "status": "PROCESSING", "remark": "test2" } ] }}If the query request is unsuccessful, it could be due to an incorrect requestID. You will receive a “FAIL” status along with the error message.
Payout via MMP#
Apart from the batch payout API, you can easily manage and payout to multiple recipients in the Merchant Management Platform.
Under the Account Tab, select to [Send Funds] to perform Payout.
You can either perform a single payout by entering the recipient’s Binance ID, followed by the amount and transaction details, or send to multiple recipients (max. 500) by selecting [Send to multiple recipients].
A pop up will appear, you can download the Recipient Form shown, fill in the information accordingly and upload the csv. file to proceed with the Batch Payout.
After successful import, line items of the payout will be shown. You can view the total number of transfers within the batch, each item details as well as delete invalid transactions.
Once you have finished reviewing, click confirm to continue with the Payout and the recipients will receive the payment in their funding wallet instantly.
Supported Currencies#
View the list of support currencies here.