Create an invoiceSignature required

2024-11-21 06:55

POST /amsin/api/v1/business/fund/createInvoice

The Partner calls this API to request WorldFirst to create an invoice, which can be either a bill or an order.

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:

Maximum length: 32 characters

productCode String REQUIRED

The type of the payment product that is used to pay the invoice. Valid values are:

CASHIER_PAYMENT: indicates Cashier Payment.
AUTO_DEBIT: indicates Auto Debit.

invoice Invoice REQUIRED

Information about the invoice, such as the invoice type.

Show child parameters

payToDetail PayToDetail REQUIRED

Information about the payment, such as the payment amount and the fee amount.

Show child parameters

Response parameters

requestId String REQUIRED

The unique ID that is assigned by the Partner to identify an invoice.

More information:

Maximum length: 32 characters

result Result REQUIRED

The result of the API calling, including the result status, result code and result message.

Show child parameters

bizOrderId String

The unique ID that is assigned by WorldFirst to identify an invoice.

More information:

Maximum length: 32 characters

actionForm ActionForm

The further action that the Partner needs to take.

Show child parameters

extendInfo String

Any other information that WorldFirst wants to pass to the Partner.

More information:

Maximum length: 512 characters

API Explorer

Request

URL

Request Body

Response

Response Body

Result processing logic

After the Partner calls the API, WorldFirst responds to the Partner by specifying the value of the result.resultStatus parameter in the response body. The following table lists valid values for the result.resultStatus parameter and their descriptions.

Result/Error codes

Code	Value	Message	Further action
SUCCESS	S	Success
REQUEST_TRAFFIC_EXCEED_LIMIT	U	The request traffic exceeds the limit.	Call the API again to resolve the issue. If the issue persists, contact the WorldFirst Technical Support Team.
UNKNOWN_EXCEPTION	U	The API call is failed, which is caused by unknown reasons.	The service might be down, retry later. If the issue persists, contact the WorldFirst Technical Support Team.
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 `POST` and retry.
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.
UN_SUPPORT_BUSINESS	F	Unsupported business.	Ensure that all the request parameters are correct and try to call the API again.

result.resultStatus	Description
`S`	The API call succeeds.
`F`	The API call failed. For more information about why the call failed and how to handle the result, see the value of the result.resultCode parameter.
`U`	The API call result is unknown. The Partner can try to call the API again by following the rules below: At most 7 queries are allowed. Intervals between queries: 5m, 10m, 20m, 40m, 80m, 160m, and 320m. If none of the queries is successful, contact the WorldFirst Technical Support Team.