Download Report
API used to download transaction and settlement report.
- This API is only available for whitelisted merchants. If you need any help, you can contact us: merchant@binance.com
#
EndPoint#
Request ParametersAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
reportType | enum string | Y | Only Transaction or Settlement | Report Type |
transactionType | enum string | N | When the reportType is Transaction, then the transactionType is required and only can be Payment or Payout | Transaction type |
startDate | string | Y | dd/MM/yyyy | Start date |
endDate | string | Y | dd/MM/yyyy | End date. from startDate to endDate can only support querying data within 3 months |
#
Sample Request Parameter#
Response ParametersAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
status | string | Y | "SUCCESS" or "FAIL" | status of the API request |
code | string | Y | - | request result code, refer to |
data | list[MerchantDailyReportData] | N | - | response body, refer to |
errorMessage | string | N | maximum length 256 |
#
Child Attribute#
MerchantDailyReportDataAttributes | Type | Required | Limitation | Description |
---|---|---|---|---|
reportType | string | Y | Report type | |
transactionType | string | Y | Transaction or Settlement | |
transactionDate | string | Y | When reportType is Transaction, then the transactionType is Payment or Payout(the list contains one type File depends on the request param, when reportType is Settlement, then the transactionType is Payment or Refund (the list contains two type File) | |
fileName | string | Y | T_Payment_yyyyMMdd.xls / T_Payout_yyyyMMdd.xls / S_Payment_yyyyMMdd.xls / S_Refund_yyyyMMdd.xls | Report file name |
downloadUrl | string | Y | Download URL |
#
Sample Response#
Result CodeName | 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. |
BAD_HTTP_METHOD | 400006 | Request method not supported. | Check Request method. |
MEDIA_TYPE_NOT_SUPPORTED | 400007 | Media type not supported. | Check Request Media type. |
INVALID_REQUEST_BODY | 400008 | Request body is not a valid json object. | Check Request body |
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 |