Apply for a loanSignature required
Call this API to apply for a loan.
Note: Make sure you have sufficient information before you call this API.
- Call the applyCreditGrant API to get the value of the creditGrantNo parameter.
- Call the queryCreditGrant API to get the value of the creditGrantAmount parameter.
- Call the consultLoan API to get the value of the numOfPeriod and interestRate parameters.
Structure
Messages consist of a header and body. The following sections are focused on the body structure. For the header structure, see:
Request parameters
requestId String REQUIRED
The unique ID assigned by WorldFirst to identify a loan request.
More information:
- This field is an API idempotency field.
creditGrantNo String REQUIRED
The unique number assigned by WorldFirst to identify each credit grant.
productCode String REQUIRED
The product code. Valid value: AMAZON_VC_FACTORING_LOAN
loanAmount Amount REQUIRED
The loan amount.
repayMode String REQUIRED
The repayment method.
Valid value: REPAY_OUTRIGHT: Repay all at once, including both the principal and the interests.
interestRate Rate REQUIRED
The loan interest rate.
numOfPeriod Integer REQUIRED
The total number of loan periods.
Response parameters
result Result REQUIRED
The result of the API call.
loanOrderNo String REQUIRED
The unique number assigned by WorldFirst to identify a loan order.
Request
Response
Result processing logic
After calling the API, a response is returned. Possible values for result.resultStatus are:
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 |
|---|---|---|---|
| UNRELATED_US_SUB_ACCOUNT_ERROR | F | The US sub account is not associated. | Associate the US sub-account and try again. |
| LOAN_USER_NOT_MATCH | F | The credit grant number is not matched with the current user. | Make sure the credit order and user match and try again. |
| ACCESS_CODE_LOSE_EXCEPTION | F | The access code does not exist. | Contact WorldFirst technical support. |
| REAL_TIME_COLLECTION_NOT_ENABLED_ERROR | F | Real time collection is not enabled. | Contact WorldFirst technical support. |
| CREDIT_ORDER_ALREADY_LOAN | F | The credit grant order has been used. | Change the creditGrantNo and try again. If the issue persists, contact WorldFirst Technical Support. |
| REPAY_MODE_NOT_SUPPORTED | F | The repay mode is not supported. | Retry with the correct repay mode. |
| LOAN_TERM_NOT_SUPPORTED | F | The loan periods is not supported. | Retry with the correct loan periods. |
| LOAN_AMOUNT_ILLEGAL | F | The loan amount is not supported. | Retry with the correct loan amount. |
| LOAN_AMOUNT_NOT_MATCH | F | The loan amount does not match. | Make sure the loan amount is consistent with the credit grant amount and try again. |