WorldFirst DocsWorldFirst DocsDOCS

Inquire about invoice payment resultSignature required

POST /amsin/api/v1/business/fund/queryInvoice

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 object REQUIRED

The payment amount. 

Show child parameters

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.
  • RETURNED indicates that the invoice is returned by the bank. 

result Result object REQUIRED

The result of the API calling. 

Show child parameters
API Explorer

Request

URL
Request Body

Response

Response Body

Result/Error codes

CodeValueMessageFurther action
SUCCESSSSuccess
UNKNOWN_EXCEPTIONUAPI failed due to unknown reason.

The service might be down, retry later. If the issue persists, contact our Technical Support Team. 

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. 

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.  

UN_SUPPORT_BUSINESSFUnsupported business.

Ensure that all the request parameters are correct and try to call the API again. 

@2024 WorldFirst