Receive invoice payment notification
WorldFirst calls this API to notify the Partner of the invoice payment 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
requestId String REQUIRED
The unique ID that is assigned by the Partner to identify an invoice.
More information about this field
- Maximum length: 32 characters
bizOrderId String
The unique ID that is assigned by WorldFirst to identify an invoice.
More information about this field
- Maximum length: 32 characters
payToAmount Amount object REQUIRED
The payment amount.
invoiceStatus String
The invoice payment status. Valid values are:
PROCESSING: indicates that the invoice payment is being processed.FAILEDindicates that the invoice payment dailed.SUCCESSFULindicates that the invoice payment succeeds.RETURNEDindicates that the invoice is returned by the bank.
errorCode String CONDITIONAL
The error code. This parameter is specified by WorldFirst if invoiceStatus = FAILED .
More information about this field
- Maximum length: 16 characters
errodMessage String CONDITIONAL
The error message. This parameter is specified by WorldFirst if invoiceStatus = FAILED .
More information about this field
- Maximum length: 64 characters
extendInfo String
Any other information about the invoice payment.
More information about this field
- Maximum length: 128 characters
Response parameters
result Result object REQUIRED
The result of the API calling.
Request
Response
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| 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. |
| PARAM_ILLEGAL | F | Ilegal 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. |
| 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 |