Query bill listSignature required
Call this API to query the transaction records of the WorldCard.
Structure
A message consists of a header and body. For details, see the following sections.
Request header
Request parameters
startTime DateTime REQUIRED
The starting time of the queried transaction records.
The time interval between startTime and endTime cannot be more than 100 days.
More information:
- Value range: 0 to 99 (inclusive).
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
endTime DateTime REQUIRED
The ending time of the queried transaction records.
The time interval between startTime and endTime cannot be more than 100 days.
More information:
- Value range: 0 to 99 (inclusive).
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
pageNumber Integer REQUIRED
The current page index. The first page index is 1.
pageSize Integer REQUIRED
The number of items on each page.
Value range: 1 to 100 (inclusive).
Recommended value is 10.
billStatusList List<String>
The list of transaction status.
Valid values are:
WAITING_CLEARANCESUCCESSFAILEDREFUNDEDCANCELLEDPARTIAL_CANCELPARTIAL_REFUNDWAITING_DEDUCT
cardNo String
The full card number or its last four digits.
merchantName String
The merchant name.
orderNo String
The order number.
budgetAccountIdList Array<String>
List of the budget account ID.
Response parameters
result Result REQUIRED
The result of the API call.
billList Array<BillInfo> REQUIRED
The list of transaction information.
This field is returned only when the value of result.resultStatus is S.
currentPageNumber Integer REQUIRED
The currency page index number.
This field is returned only when the value of result.resultStatus is S.
totalCount Integer REQUIRED
The total number of items in the query result.
This field is returned only when the value of result.resultStatus is S.
totalPageNumber Integer REQUIRED
The total number of pages.
This field is returned only when the value of result.resultStatus is S.
Request
Response
Result processing logic
After calling the API, a response is returned. Possible values for result.resultStatus are:
Result status | Description |
| Indicates that the API call succeeded. |
| Indicates that the API call failed. For additional information on the failure, refer to result.resultCode. |
| Indicates that the API call result is unknown. If this status is returned, the Partner may make a query. The querying strategy is as follows:
If no queries succeed, contact our Technical Support Team. |
billFailReason.errorCode
result.resultCode
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | None |
| SYSTEM_ERROR | F | System error. | Do not retry, and contact our Technical Support Team for more details. |
| PARAM_ILLEGAL | F | Illegal parameters exist. For example, a non-numeric input, or an invalid date. | Check and verify whether the request fields, including the header fields and body fields, are correct and valid. For details on the fields of each API, see the specific API Structure section. |
| UNKNOWN_EXCEPTION | U | API failed due to unknown reason. | The service might be down, retry later. If the issue persists, contact our Technical Support Team. |
| CONTRACT_NOT_EXIST | F | The contract check has failed | Ensure the Partner has already signed a contract and the input is correct. |
| ACCESS_TOKEN_EXPIRED | F | The access token expired. | Refresh the token to get a new access token or contact our Technical Support Team to address it. |
| AUTHORIZATION_NOT_EXIST | F | The authorization does not exist. | Make sure that the input is correct. If the issue persists, contact our Technical Support Team to verify the authorization status. |