Use case:
The merchants can use this API to download the transaction settlement report and reconcile the accounts.
Parameter | Type | Mandatory | Length | Description | Sample |
---|---|---|---|---|---|
app_id | String | Y | 32 | An app id assigned to the developer by Alipay | 2014072300007148 |
method | String | Y | 128 | api name | Alipay.data.dataservice.bill.downloadurl.query |
charset | String | Y | 10 | The char set for request use, like utf-8, gbk, gb2312, etc. | utf-8 |
sign_type | String | Y | 10 | The type of signature algorithm used by the merchant to generate the signature string. Currently only RSA is supported. | RSA |
sign | String | Y | 256 | Signature string | |
timestamp | String | Y | 19 | The sending time of the request, formatting in “yyyy-MM-dd HH:mm:ss” | 2014-07-24 03:07:50 |
version | String | Y | 3 | The version of this API, hard coded as 1.0 for now. | 1.0 |
app_auth_token | String | N | 40 | Please refer to the section “application authorization” |
Parameter | Type | Mandatory | Length | Description | Sample |
---|---|---|---|---|---|
bill_type | String | Y | 10 | Type of report. Currently we support “trade”, “signcustomer”. The “trade“ type is for normal merchants. | trade |
bill_date | String | Y | 15 | The date of the bill. For daily report, the format is “yyyy-MM-dd”. For monthly report, the format is “yyyy-MM”. | 2016-04-05 |
Parameter | Type | Mandatory | Length | Description | Sample |
---|---|---|---|---|---|
bill_download_url | String | Y | 2048 | The URL to download the report. It expires after 30 seconds. | http://dwbillcenter.alipay.com/downloadBillFile.resource?bizType=X&userId=X&fileType=X&bizDates=X&downloadFileName=X&fileId=X |
Error code | Error description | Solution |
---|---|---|
INVAILID_ARGUMENTS | Illegal parameters | Examine the parameters and re-send the request. |
BILL_NOT_EXIST | There is no report for the day. | Confirm parameters and re-send the request. |
UNKNOW_ERROR | Unknown error | Try it again later or contact the technical support to investigate the problem. |