Check an FX deal statusSignature required
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:
Request parameters
dealRequestId String REQUIRED
The unique ID that is assigned by the Partner to identify a deal request.
More information about this field
- Maximum length: 64 characters
Response parameters
result Result object REQUIRED
Indicates whether this API is called successfully.
responseId String REQUIRED
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 about this field
- Maximum length: 32 characters
deal Deal object REQUIRED
Transaction details of the forward deal.
This field is returned only when the value of result.resultStatus is
S.
dealResult Result object REQUIRED
Indicates the result of the forward deal.
This field is returned only when the value of result.resultStatus is
S.
Request
Response
Result processing logic
After calling the API, a response is returned with two result codes, result.resultStatus and dealResult.resultStatus.
result.resultStatusindicates the result of the inquiry.dealResult.resultStatusindicates 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:
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 |
U | This indicates the API call result is unknown. Partner can make a query when the returned status is
If none of the queries is successful, contact our Technical Support Team. |
dealResult.resultCode
| 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. |
result.resultCode: System-realted result codes
| 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 |
result.resultCode: Business-related result codes
| 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. |