WorldFirst DocsWorldFirst DocsDOCS

inquiryTradeOrder

POST: /aps/api/business/trade/inquiryTradeOrder

Signature required

Note: This step only concerns transfers inbound to China. It is not necessary for non-CNY scenario transfers.

For inbound transfers to China, use the inquiryTradeOrder API to query the review result of the trade order information.

Once the Partner submits a trade order for review, the Partner can inquire about the result by calling the inquiryTradeOrder API. WorldFirst(Alipay) responds to the Partner with the result of the trade order review.

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

Field

Data type

Required

Description

orderId

String

Yes

The unique ID that is assigned by the Partner to identify a transaction.

Note:

  • This field is an API idempotency field. For details about API idempotency, see the Idempotency chapter.

More information:

  • Maximum length: 64 characters

Response parameters

Field

Data type

Required

Description

tradeOrderResult

TradeOrderResult object

Yes

The result of the trade order review.

Result processing logic

In the request message:

  • tradeOrderResult.resultMessage field indicates the result of the trade order review.

The Partner can make another API call when the returned status is UNKNOWN.

Use the following query strategy:

  • Times: 7.
  • Intervals: 5m, 10m, 20m, 40m, 80m, 160m, and 320m.

If none of the queries is successful, contact WorldFirst(Alipay) Technical Support.

Result codes

result.resultCode

resultCode

resultStatus

resultMessage

Further action

SUCCESS

S

Success

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.

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.

REQUEST_TRAFFIC_EXCEED_LIMIT

U

The request traffic exceeds the limit.

Call the interface again to resolve the issue. If the issue persists, contact WorldFirst Technical Support.

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. For more details, refer to the following chapter:

METHOD_NOT_SUPPORTED

F

The server does not implement the requested HTTP method.

Ensure the HTTP method is POST.

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 WorldFirst Technical Support.

ORDER_NOT_EXIST

F

The order does not exist.

Retry with another transfer order.

Samples

Request

copy
{
	"orderId": "123456******"
}

Response

copy
{
  "tradeOrderResult": {
    "orderId": "123456******",
    "orderStatus": "AVAILABLE",
    "resultMessage": "Can be use for declaration."
  }
}

 

@2024 WorldFirst