Apply for a credit grantSignature required
Call this API to request a credit grant.
Make sure you have previously called the submitAttachment API to upload all the required invoices. WorldFirst will evaluate these documents to approve your credit application.
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.
payeeCode String REQUIRED
The unique code that identifies a payee.
vcCode String REQUIRED
The unique code that identifies a vitual credit account.
invoiceDate String REQUIRED
The invoice date.
Format: YYYYMMDD. For example, 20241231.
timeZone String REQUIRED
The timezone.
attachmentFile AttachmentInfo REQUIRED
The invoice attachments used to request a credit.
Call the submitAttachment API before you specify this parameter.
invoiceInfoList Array<InvoiceInfo> REQUIRED
The detailed information of the invoices.
vendorName String
The name of the vendor.
More information:
- Maximum length: 128 characters
marketRegion String
Two-letter ISO 3166 country/region code that represents the country/region of the market.
businessMode String
The business mode of the vendor. Valid values are:
-
PO: indicates the purchase order mode. -
DF: indicates the direct fulfilment mode. -
DI: indicates the direct import mode.
Response parameters
result Result REQUIRED
The result of the API call.
referenceNo String REQUIRED
The external ID that identifies a credit request.
creditGrantNo String
The unique credit grant number assigned by WorldFirst to identify a credit grant application.
creditGrantStatus String REQUIRED
The credit grant status. Valid values are:
-
ACCEPTED: The grant application has been accepted. -
FAILED: The grant application has failed.
failCode String CONDITIONAL
The code that identifies the problem of a failing/unsuccessful grant application.
This field is only returned when the value of creditGrantStatus is
FAILED.
failMessage String CONDITIONAL
The message that further explains the unsuccessful grant application.
This field is only returned when the value of creditGrantStatus is
FAILED.
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 |