Query the available credit quotaSignature required
Call this API to query the financing quota information.
It's recommended to call this API and query the current quota before submitting invoice documents (by calling the submitAttachment API) and apply for a credit grant (by calling the applyCreditGrant API).
Structure
A message consists 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 is:
AMAZON_VC_FACTORING_LOAN
Response parameters
result Result REQUIRED
The result of the API call.
productCode String REQUIRED
The product code. Valid value is:
-
AMAZON_VC_FACTORING_LOAN
productStatus String REQUIRED
The product status. Valid values are:
NORMAL: All loans are in good standing.OVD: One or more loans have overdue payment(s).
capLimitTotalAmount Amount REQUIRED
The cap limit amount, meaning the maximum credit amount that can be granted from WorldFirst.
grantTotalAmount Amount REQUIRED
The total granted credit amount, including the available and the used amount.
Formula: grantTotalAmount = availableTotalAmount + unpaidTotalAmount.
unpaidTotalAmount Amount REQUIRED
The used credit amount, meaning the credit has been granted and used.
availableTotalAmount Amount REQUIRED
The available credit amount, meaning the credit that has been granted but not yet used.
subCapList Array<SubCap>
The sub-cap quota information.
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 |
Business-related result codes
| Code | Value | Message | Further action |
|---|---|---|---|
| USER_LOAN_STATUS_QUERY_FAILED | F | The user's loan status query has failed. | Retry with the correct user information. |
| QUOTA_QUERY_FAILED | F | The quota query has failed. | Retry with the correct user information. |