Inquiry about trade order submission resultSignature required

2024-09-24 06:52

POST /amsin/api/v1/business/account/inquiryTradeOrder

B2C partners can call this API to inquiry about the submission result of trade orders.

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 assigned by the Partner to identify a trade order submission request.

More information:

This field is an API idempotency field.The Partner can use it to do the idempotent check.
Maximum length: 64 characters

sceneCode String REQUIRED

The code that represents the business scenario. Valid value:

PAY_INTO_CHINA: the foreign exchange scenario without the association of the trade order.

quotaAccumulationMethod String REQUIRED

The method that is used for the quota accumulation. Valid values are:

USER_ID: indicates the quota is accumulated by the WorldFirst user ID.
RECEIVING_ACCOUNT: indicates the quota is accumulated by the receiving account.
VIRTUAL_ACCOUNT: indicates the quota is accumulated by the virtual account.
BENEFICIARY: indicates the quota is accumulated by the beneficiary.

quotaAccumulationId String REQUIRED

The ID that is used for the quota accumulation. Specify this parameter with the following rules:

If quotaAccumulationMethod = USER_ID, specify this parameter as the WorldFirst user ID.
If quotaAccumulationMethod = RECEIVING_ACCOUNT, specify this parameter as the receiving account.
If quotaAccumulationMethod = VIRTUAL_ACCOUNT , specify this parameter as the virtual account.
If quotaAccumulationMethod = BENEFICIARY , specify this parameter as the beneficiary ID.

tradeType String REQUIRED

The type of the trade.

Valid values:

GOODS: indicates the goods trade.
SERVICE: indicates the service trade.

Response parameters

result Result object REQUIRED

Indicates the result of the trade order submission, including the result status and result message.

Show child parameters

requestId String REQUIRED

The unique ID assigned by the Partner to identify a trade order submission request.

batchStatus String REQUIRED

Indicates the status of the submitted trade orders. Valid values are:

PROCESSING: indicates the trade order batch is in processing.
FINISHED: indicates the trade order batch is processed.

tradeOrderResults Array <TradeOrderResult> CONDITIONAL

Indicates the list of the trade order results.

This parameter is only returned when batchStatus is FINISHED.

Show child parameters

API Explorer

Request

URL

Case

Use USER_ID to inquire about submission result

Request Body

Response

Case

Use USER_ID to inquire about submission result

Response Body

Result processing logic

Once the Partner calls API, WorldFirst returns with its result. The range of result.resultStatus field is:

result.resultStatus	Description
`S`	API is called with success.
`F`	API is called with failure. For reasons, refer to result.resultCode and result.resultMessage.
`U`	When API returns with `UNKNOWN`, retry calling it. Retry strategy: Maximum times of retrying: 7 Interval of retrying: 5 minutes, 10 minutes, 20 minutes, 40 minutes, 80 minutes, 160 minutes, 320 minutes. Please contact WorldFirst technical support if the issue remains.

Result/Error codes

Code	Value	Message	Further action
SUCCESS	S	Success
UNKNOWN_EXCEPTION	U	The API call failed, which is caused by unknown reasons.	The service might be down, retry later. If the issue persists, contact WorldFirst Technical Support.
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.
CONTRACT_CHECK_FAIL	F	The contract check has failed.	Check the contract status with WorldFirst before retrying.
USER_NOT_EXIST	F	The user does not exist.	Retry with the correct user information.
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.

tradeOrderResult.errorCode

Code	Value	Message	Further action
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.
TRADE_ORDER_SUBMITTED	F	trade order has been submitted before.	Check and verify whether the trade order has been submitted. If so stop submitting it again.
RISK_REJECT	F	The trade order is rejected for risk control reasons.	Prompt the user that the request is rejected because the risk control failed.
PROCESS_FAIL	F	A general business failure occurred. Do not retry.	Human intervention is usually needed. It is recommended that you contact WorldFirst Technical Support to resolve the issue.
ACCOUNT_NOT_EXIST	F	The account does not exist.	Check if the account is valid and retry.
ORDER_NOT_EXIST	F	The order does not exist.	Check if the order is valid and retry.