Check an FX deal statusSignature required

2024-11-21 06:55

POST /amsin/api/v1/business/fund/inquiryDeal

The Partner can use this API to inquire about a forward deal.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

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

More information:

Indicates whether this API is called successfully.

Show child parameters

The unique ID that is assigned by WorldFirst to identify a response.

This field is returned only when the value of result.resultStatus is S.

More information:

Transaction details of the forward deal.

This field is returned only when the value of result.resultStatus is S.

Show child parameters

Indicates the result of the forward deal.

This field is returned only when the value of result.resultStatus is S.

Show child parameters

API Explorer

URL

Request Body

Response Body

After calling the API, a response is returned with two result codes, result.resultStatus and dealResult.resultStatus.

result.resultStatus indicates the result of the inquiry.
dealResult.resultStatus indicates the deal result. For more details, refer to the result codes section.

After calling the API, a response is returned. The possible responses for result.resultStatus are:

Code	Value	Message
SUCCESS	S	The forward deal is successful.
PROCESSING	S	The forward deal is being processed.
CANCELLED	F	The forward deal is canceled.
FAIL	F	The forward deal has failed.

Code	Value	Message	Further action
SUCCESS	S	Success
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.
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.
REQUEST_TRAFFIC_EXCEED_LIMIT	U	The request traffic exceeds the limit.	Call the interface again to resolve the issue. If the issue persists, contact our 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`.

Code	Value	Message	Further action
UN_SUPPORT_BUSINESS	F	Unsupported business.	Invalid parameters are used e.g. currency is incorrect. Retry with the correct information.
AUTHORIZATION_NOT_EXIST	F	The authorization does not exist.	Make sure that the input is correct. If the issue persists, contact our Technical Support Team to verify the authorization status.
CONTRACT_CHECK_FAIL	F	The contract check has failed.	Check the contract status before retrying.

Result status	Description
`S`	This indicates the API call succeeded.
`F`	This indicates the API call failed. For more information on why the call failed, see result.resultCode table.
`U`	This indicates the API call result is unknown. Partner can make a query when the returned status is `UNKNOWN`. Use the following query strategy: A Partner can make 7 queries at maximum. Intervals between queries: 5m, 10m, 20m, 40m, 80m, 160m, and 320m. If none of the queries is successful, contact our Technical Support Team.