WorldFirst DocsWorldFirst Docs

Query the available loanSignature required

POST /amsin/alipay/business/credit/queryCreditQuota

Call this API to query the available loan quota.

Note:

  • To obtain and accumulate loan quota, you need to call the submitAttachment API to upload valid invoices.
  • Your loan quota will be subtracted once a credit grant expires or a loan is used.
  • You are recommended to call this API and query the current available quota before submitting additional invoices to apply for a credit grant.
  • To apply for additional credit grant, make sure it's no more than capLimitTotalAmount subtracted by grantTotalAmount and unpaidTotalAmount.

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: AMAZON_VC_FACTORING_LOAN

Response parameters

result Result  REQUIRED

The result of the API call.

Show child parameters

productCode String  REQUIRED

The product code. Valid value: AMAZON_VC_FACTORING_LOAN

capLimitTotalAmount Amount  REQUIRED

The maximum credit amount that can be granted.

Show child parameters

grantTotalAmount Amount  REQUIRED

The total granted and available credit amount.

Show child parameters

unpaidTotalAmount Amount  REQUIRED

The used and unrepaid loan amount.

Show child parameters

availableTotalAmount Amount  REQUIRED

The available loan amount.

Show child parameters

productStatus String  REQUIRED

The product status. Valid values:

  • NORMAL: All loans are in good standing.
  • OVD​: One or more loans have overdue payment(s).
API Explorer

Request

URL
Request Body

Response

Response Body

Result processing logic

After calling the API, a response is returned. Possible values for result.resultStatus are:

Result status

Description

S

Indicates that the API call succeeded.

F

Indicates that the API call failed. For additional information on the failure, refer to result.resultCode.

U

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:

  • Maximum 7 queries are allowed. 
  • Intervals between queries: 5 min, 10 min, 20 min, 40 min, 80 min, 160 min, and 320 min.

If no query succeed, contact our Technical Support Team.

System-related result codes

CodeValueMessageFurther action
SUCCESSSSuccess
PARAM_ILLEGALFIllegal 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_FAILFA 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_EXCEPTIONUAPI failed due to unknown reason.

The service might be down, retry later. If the issue persists, contact our Technical Support Team.

REQUEST_TRAFFIC_EXCEED_LIMITUThe request traffic exceeds the limit.

Call the interface again to resolve the issue. If the issue persists, contact our Technical Support Team.

OAUTH_FAILFOAuth process failed.

Contact our Technical Support Team for detailed reasons.

INVALID_APIFThe called API is invalid or not active.

Check whether the correct API is being called.

INVALID_CLIENTFThe client is invalid.

The Client ID does not exist or is invalid.

INVALID_SIGNATUREFThe signature is invalid.

Make sure the request is properly signed with a valid signature.

METHOD_NOT_SUPPORTEDFThe server does not implement the requested HTTP method.

Ensure the HTTP method is POST.

Business-related result codes

CodeValueMessageFurther action
USER_LOAN_STATUS_QUERY_FAILEDFThe user's loan status query has failed.

Retry with the correct user information.

QUOTA_QUERY_FAILEDFThe quota query has failed.

Retry with the correct user information.