Skip to main content

Download Report

API used to download transaction and settlement report.

  • This API is only available for whitelisted merchants. If you need help, please contact us at along with your Merchant ID and background


POST /binancepay/openapi/report/get-file

Request Parameters#

reportTypeenum stringY"Transaction" "Settlement"Report type can be either "Settlement" or "Transaction". Please note the parameter is cap sensitive.
transactionTypeenum stringN"Payment" "Payout"transactionType refers to the transaction information you wish to generate.Please note the parameter is cap sensitive.If the reportType is "Settlement", this can be null If the reportType is "Transaction" field is required, either "Payment" or Payout"
startDatestringYdd/MM/yyyyStart date
endDatestringYdd/MM/yyyyEnd date. from startDate to endDate can only support querying data within 3 months

Sample Request Parameter#

{    "reportType": "Settlement",    "transactionType": "",    "startDate": "01/10/2022",    "endDate": "29/10/2022"}

Response Parameters#

statusstringY"SUCCESS" or "FAIL"status of the API request
codestringY-request result code, refer to
datalist[MerchantDailyReportData]N-response body, refer to
errorMessagestringNmaximum length 256

Child Attribute#


reportTypestringYReport type
transactionTypestringYTransaction or Settlement
transactionDatestringYWhen 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)
fileNamestringYT_Payment_yyyyMMdd.xls / T_Payout_yyyyMMdd.xls / S_Payment_yyyyMMdd.xls / S_Refund_yyyyMMdd.xlsReport file name
downloadUrlstringYDownload URL

Sample Response#

{  "status": "SUCCESS",  "code": "000000",  "data": [    {      "reportType": "Settlement",      "transactionType": "Refund",      "transactionDate": "29/10/2022",      "fileName": "S_Refund_29102022.xlsx",      "downloadUrl": ""    },    {      "reportType": "Settlement",      "transactionType": "Payment",      "transactionDate": "29/10/2022",      "fileName": "S_Payment_29102022.xlsx",      "downloadUrl": ""    }  ]}
{    "status": "FAIL",    "code": "400003",    "errorMessage": "Timestamp for this request is outside of the recvWindow."}

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