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. Or you can query the status by quert balance report API
A merchant can generate up to a maximum of 50 balance reports per month.
EndPoint
POST /binancepay/openapi/balance-report
Request Parameters
Attributes | Type | Required | Limitation | Description |
---|---|---|---|---|
reportType | string | Y | Valid value is "Balance" | - |
walletType | string | N | Valid 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 |
startDate | string | Y | YYYY-MM-DD | From startDate to endDate can only support querying data within 3 months |
endDate | string | Y | YYYY-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
Attributes | Type | Required | Limitation | Description |
---|---|---|---|---|
status | string | Y | "SUCCESS" or "FAIL" | status of the API request |
code | string | Y | - | request result code, refer to |
data | string | N | - | 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
Name | Code | Reason | Solution |
---|---|---|---|
UNKNOWN_ERROR | 400000 | An unknown error occurred while processing the request. | Try again later |
INVALID_REQUEST | 400001 | Parameter format is wrong or parameter transferring doesn't follow the rules. | Please check whether the parameters are correct. |
INVALID_SIGNATURE | 400002 | Incorrect signature result | Check whether the signature parameter and method comply with signature algorithm requirements. |
INVALID_TIMESTAMP | 400003 | Timestamp for this request is outside of the time window. | Sync server clock |
INVALID_API_KEY_OR_IP | 400004 | API identity key not found or invalid. | Check API identity key |
BAD_API_KEY_FMT | 400005 | API identity key format invalid. | Check API identity key. |
MANDATORY_PARAM_EMPTY_OR_MALFORMED | 400100 | A parameter was missing/empty/null, or malformed. | |
INVALID_PARAM_WRONG_LENGTH | 400101 | A parameter was not valid, was empty/null, or too long/short, or wrong format. | |
INVALID_PARAM_WRONG_VALUE | 400102 | A parameter was not valid, the value is out of range. | |
INVALID_PARAM_ILLEGAL_CHAR | 400103 | A parameter was not valid, contains illegal characters | |
INVALID_REQUEST_TOO_LARGE | 400104 | Invalid request, content length too large | |
INVALID_MERCHANT_TRADE_NO | 400201 | merchantTradeNo is invalid or duplicated | |
ORDER_NOT_FOUND | 400202 | Order not found. | |
INVALID_ACCOUNT_STATUS | 400203 | Not support for this account, please check account status. |