WorldFirst DocsWorldFirst Docs

Query the credit grantSignature required

POST /amsin/alipay/business/credit/inquiryCreditGrant

Call this API to query the grant application result.

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

referenceNo String  REQUIRED

The external ID that identifies a credit request.

Response parameters

result Result  REQUIRED

The result of the API call.

Show child parameters

creditGrantNo String  

The WorldFirst credit grant number.

creditGrantAmount String  

The credit grant amount. Unit: cent.

creditGrantCurrency String  

The credit grant currency. Fixed value: ​USD​.

annualPercentageRate String  

The annual percentage rate. Format: decimal. For example, 0.05 stands for 5%.

dueDate String  

The date when credit grant is due. Format: YYYYMMDD. For example, 20241231.

creditGrantStatus String  REQUIRED

The credit grant status. Valid values are:

  • ACCEPTED: The grant application has been accepted.
  • ​SUCCESS​: The grant application is approved.
  • FAILED: The grant application has failed.
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.