Query the repayment listSignature required
Call this API to query the list of repayment records based on the timeframe, the status or the repayment entities.
Structure
Messages consist of a header and body. The following sections are focused on the body structure. For the header structure, see:
Request parameters
productCode String REQUIRED
The product code. Valid value: AMAZON_VC_FACTORING_LOAN
startDate DateTime
The starting date for filtering repayment records.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
endDate DateTime
The ending date for filtering repayment records.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
statusList Array<String>
The status of the repayment order. Valid values:
ACCEPTED: The repayment order is accepted and being processed by WorldFirst.SUCCESS: The repayment order is successful.FAILED: The repayment order has failed.
If unspecified, WorldFirst returns repayment records of all statuses.
operateTypes Array<String>
The type of entity that initiates the repayment. Valid values:
BATCH: The repayment is made by the system.USER: The repayment is made by the user.
If unspecified, WorldFirst returns repayment records of all types.
pageSize Integer REQUIRED
The number of items included in one page.
More information:
- Value range: 0 - 100 (inclusive of 100)
pageNumber Integer REQUIRED
The current page number.
Format: 1, 2, 3...
Response parameters
result Result REQUIRED
The result of the API call.
repayOrderList Array<RepayOrder> REQUIRED
The list of repayment orders.
totalCount Long REQUIRED
The total number of items in the query.
currentPageNumber Integer REQUIRED
The current page index number.
pageSize Integer REQUIRED
The number of items included in one page.
More information:
- Value range: 0 - 100 (inclusive of 100)
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 query succeed, contact our Technical Support Team. |
System-related result codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| 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. |
| PROCESS_FAIL | F | A general business failure occurred. Do not retry. | Human intervention is usually needed. It is recommended that you contact our Technical Support Team to resolve the issue. |
| 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. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Call the interface again to resolve the issue. If the issue persists, contact our Technical Support Team. |
| OAUTH_FAIL | F | OAuth process failed. | Contact our Technical Support Team for detailed reasons. |
| INVALID_API | F | The called API is invalid or not active. | Check whether the correct API is being called. |
| INVALID_CLIENT | F | The client is invalid. | The Client ID does not exist or is invalid. |
| INVALID_SIGNATURE | F | The signature is invalid. | Make sure the request is properly signed with a valid signature. |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | Ensure the HTTP method is |