Skip to main content

Payout Query

Payout query API used for Merchant/Partner to query transfer status.

EndPoint#

POST /binancepay/openapi/payout/query

Request Parameters#

AttributesTypeRequiredLimitationDescription
requestIdstringYMaximum length 32The unique ID assigned by the merchant to identify a payout request.
detailStatusstringNEnum string listALL: return all transfer details, default value.
PROCESSING: only return transfers in processing.
SUCCESS: only return successful transfers.
FAIL: only return failed transfers.

Sample Request Body#

{    "requestId":"payouttransfer19998"}

Response Parameters#

AttributesTypeRequiredLimitationDescription
statusstringY"SUCCESS" or "FAIL"status of the API request
codestringY-request result code, refer to
dataTransferQueryResultY-response body, refer to
errorMessagestringN-

Child Attribute#

TransferQueryResult#

AttributesTypeRequiredLimitationDescription
requestIdstringYMaximum length 32The passed-in request ID
batchStatusstringYEnum stringACCEPTED: accepted the request, will process it soon.
PROCESSING: batch under processing
SUCCESS: all transfers are successful
PART_SUCCESS: transfers partially succeeded
FAILED: all transfers failed
CANCELED: there remains transfers with unknown results after retry limit, will not retry further
merchantIdlongY
currencystringYValid crypto currencyThe request currency.
totalAmountdecimalYTotal transfer amount in this batch.
totalNumberintYMaximum length 1000Total number of transfers in the batch.
transferDetailListTransferDetailResultYMax size 1000Detail transfer result.

Child Attribute#

TransferDetailResult#

AttributesTypeRequiredLimitationDescription
orderIdlongYMaximum length 32The passed-in request ID.
merchantSendIdstringYMaximum length 32The passed-in merchantSendId.
payerIdLongYPayer's payment account ID.
amountstringYAmount transferred.
receiveTypedecimalYEnum stringPAY_ID
BINANCE_ID
receiverintYReceiver ID from the request.
payeeIdlongYReceiver's payment account ID.
transferMethodstringYEnum stringSPOT_WALLET
FUNDING_WALLET
statusstringYEnum stringSUCCESS
FAIL
PROCESSING
remarkstringNMaximum length 128

Sample Response#

{    "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": "PAY_ID",                "receiver": "354205155",                "payeeId": 354205155,                "transferMethod": "SPOT_WALLET",                "status": "PROCESSING",                "remark": "test1"            },            {                "orderId": 118073402258677762,                "merchantSendId": "21231313132",                "payerId": 354195960,                "amount": "0.00000001",                "receiveType": "PAY_ID",                "receiver": "354205155",                "payeeId": 354205155,                "transferMethod": "SPOT_WALLET",                "status": "PROCESSING",                "remark": "test2"            }        ]    }}
{    "status": "FAIL",    "code": "403015",    "errorMessage": "pay order not found"}

Result Code#

NameCodeReasonSolution
UNKNOW_ERROR400000An unknown error occurred while processing the request.Try again later
INVALID_REQUEST400001Parameter format is wrong or parameter transferring doesn't follow the rules.Please check whether the parameters are correct.
INVALID_SIGNATURE400002Incorrect signature resultCheck whether the signature parameter and method comply with signature algorithm requirements.
INVALID_TIMESTAMP400003Timestamp for this request is outside of the time window.Sync server clock
INVALID_API_KEY_OR_IP400004API identity key not found or invalid.Check API identity key
BAD_API_KEY_FMT400005API identity key format invalid.Check API identity key.
MANDATORY_PARAM_EMPTY_OR_MALFORMED400100A parameter was missing/empty/null, or malformed.
INVALID_PARAM_WRONG_LENGTH400101A parameter was not valid, was empty/null, or too long/short, or wrong format.
INVALID_PARAM_WRONG_VALUE400102A parameter was not valid, the value is out of range.
INVALID_PARAM_ILLEGAL_CHAR400103A parameter was not valid, contains illegal characters
INVALID_REQUEST_TOO_LARGE400104Invalid request, content length too large
PAYMENT_PAY_ORDER_NOT_FOUND403015Pay order not found