Skip to main content

Query Receiver

API used to query list of receivers.


POST /binancepay/openapi/profitsharing/v1/query-receiver

Request Parameters#

pageNumintYPagination number. Starts from 1.
pageSizeintYPagination size, number of receivers in a page.

Sample Request Parameter#

{    "pageNum": 1,    "pageSize": 20}

Response Parameters#

statusstringY"SUCCESS" or "FAIL"status of the API request
codestringY-request result code, refer to
dataResponseN-response body, refer to
errorMessagestringNmaximum length 256

Child Attribute#


accountListList(String)YList of accounts registered as receiver.
totalPageNumintYTotal amount of pages
totalRecordNumlongYTotal amount of records
currentPageNumintYCurrent page number
currentPageSizeintYCurrent page size

Sample Response#

{  "status": "SUCCESS",  "code": "000000",  "data": {    "accountList": [      "12345",      "67890"    ],    "totalPageNum": 1,    "totalRecordNum": 2,    "currentPageNum": 1,    "currentPageSize": 20  }}
{  "status": "FAIL",  "code": "400000",  "errorMessage": "An unknown error occurred while processing the request."}

Result Code#

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
INVALID_REQUEST_TOO_LARGE400104Invalid request, content length too large
PAYMENT_ACCOUNT_NOT_FOUND400601Account not found
RECEIVER_INVALID400214Receiver not bind