Skip to main content

Payout Validate Receiver

Payout Receiver API is for Merchant/Partner to validate and match receiver's registration information (email/phone no) and openUserID. Not supported for individual merchants to invoke this API.

EndPoint

POST /binancepay/openapi/payout/receiver/check

Request Parameters

AttributesTypeRequiredLimitationDescription
receiveTypestringYEnum valueReceiver's ID type

BINANCE_ID: Binance user ID.
receiverIdstringYReceiver's BINANCE_ID depends on the receiver type.
registrationEmailStringNReceiver's registration email address
registrationMobileNumberStringNReceiver's mobile number
registrationMobileCodeStringNReceiver's mobile code eg:971 for UAE
openUserIdStringNReceiver’s openUserId received in webhook notification

Sample Request Body

{
"receiveType":"BINANCE_ID",
"receiverId":"354205155",
"registrationEmail":"[email protected]",
"registrationMobileNumber":"322342111",
"registrationMobileCode":"971",
}

Response Parameters

AttributesTypeRequiredLimitationDescription
statusstringY"SUCCESS" or "FAIL"status of the API request
codestringY-request result code, refer to
dataBooleanN-true means matched, false means not matched
errorMessagestringNmaximum length 256

Sample Response

{
"status": "SUCCESS",
"code": "000000",
"data": true
}

{
"status": "FAIL",
"code": "406108",
"errorMessage": "Fail rate is high, please try again later"
}

Result Code

NameCodeReasonSolution
UNKNOWN_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.
BAD_HTTP_METHOD400006Request method not supported.Check Request method.
MEDIA_TYPE_NOT_SUPPORTED400007Media type not supported.Check Request Media type.
INVALID_REQUEST_BODY400008Request body is not a valid json object.Check Request body
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
MERCHANT_TRANSFER_MERCHANT_TYPE_INVALID406107Merchant type not valid not support individual merchant
MERCHANT_TRANSFER_MERCHANT_TOO_FREQUENT406108Fail rate is high, please try again later