Query the available credit quotaSignature required

2025-06-06 03:08

POST /amsin/alipay/business/credit/queryCreditQuota

Call this API to query the available credit quota.

Note:

The credit quota means the approvable credit limit, and the credit grant means the approved credit amount.
You are recommended to call this API and query the current available quota before submitting additional invoices (by calling the submitAttachment API) and apply for a credit grant (by calling the applyCreditGrant API).
Approvable credit quota ≤ capLimitTotalAmount - grantTotalAmount.
Your accumulated credit grant will be subtracted once it expires or a loan is used.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

The product code. Valid value: AMAZON_VC_FACTORING_LOAN

The result of the API call.

Show child parameters

The product code. Valid value: AMAZON_VC_FACTORING_LOAN

The maximum credit amount that can be granted.

Show child parameters

The total granted credit amount, including the available and the used amount.

grantTotalAmount = availableTotalAmount + unpaidTotalAmount.

Show child parameters

The used and unrepaid loan amount.

Show child parameters

The available loan amount.

Show child parameters

The product status. Valid values:

API Explorer

URL

Request Body

Response Body

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

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 `POST`.

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.

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.