Skip to main content

Download Balance Report

Download Balance Report API used to download balance activities within a date range. The report cannot query current day's data.

When report is ready, a callback notification will be sent to merchant's default callback URL.

A merchant can generate up to a maximum of 10 balance reports per month.

  • This API is in beta, thus functionalities are limited.

EndPoint#

POST /binancepay/openapi/balance-report

Request Parameters#

AttributesTypeRequiredLimitationDescription
reportTypestringYValid value is "Balance"-
walletTypestringNValid values are:"SPOT_WALLET", "FUNDING_WALLET"If merchants don't specify one wallet, then Binance Pay will query all records of spot wallet and funding wallet
startDatestringYYYYY/MM/DDFrom startDate to endDate can only support querying data within 3 months
endDatestringYYYYY/MM/DD. End date must be before yesterday.From startDate to endDate can only support querying data within 3 months

Sample Request Body#

Submit request for both FUNDING and SPOT wallet activities:

{  "reportType": "Balance",  "startDate": "2022-08-20",  "endDate": "2022-09-05"}

Submit request for single wallet activities:

{  "reportType": "Balance",  "walletType": "SPOT_WALLET",  "startDate": "2022-08-20",  "endDate": "2022-09-05"}

Response Parameters#

AttributesTypeRequiredLimitationDescription
statusstringY"SUCCESS" or "FAIL"status of the API request
codestringY-request result code, refer to
datastringN-containing the download ID if request was submitted successfully.

Child Attribute#

Sample Response#

{  "status": "SUCCESS",  "code": "000000",  "data": "Your request has been submitted successfully. Your task ID: 197430692664688640"}

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.
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
INVALID_MERCHANT_TRADE_NO400201merchantTradeNo is invalid or duplicated
ORDER_NOT_FOUND400202Order not found.
INVALID_ACCOUNT_STATUS400203Not support for this account, please check account status.