Inquire about invoice payment resultSignature required
The Partner calls this API to inquire about the invoice payment result from WorldFirst.
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
Response 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 REQUIRED
The payment amount.
invoiceStatus String
The invoice payment status. Valid values are:
INIT: indicates that the invoice payment request is not initiated yet.PROCESSING: indicates that the user initiate a payment request on the cashier page and the payment request is accepted.FAILED: indicates that the invoice payment failed.SUCCESSFUL: indicates that the invoice payment succeeds.RETURNEDindicates that the invoice is returned by the bank.
result Result 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 | 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. |
| 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. |
| UN_SUPPORT_BUSINESS | F | Unsupported business. | Ensure that all the request parameters are correct and try to call the API again. |