Receive FX settlement result notificationSignature required
After the settlement is completed, WorldFirst notifies the Partner with this API of the result. The Partner needs to process the result and response to WorldFirst indicating the reception of the given notification.
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
exchangeResult Result object REQUIRED
Indicates the result of the settlement request.
For more details, refer to the Result processing logic section on this page.
exchangeId String REQUIRED
The unique ID that is assigned by WorldFirst to identify a settlement request.
More information about this field
- Maximum length: 64 characters
exchangeRequestId String REQUIRED
The unique ID that is assigned by the Partner to identify a settlement request.
More information about this field
- This field is an API idempotency field.For details about API idempotency, see the Idempotency chapter.
- Maximum length: 128 characters
sell QuoteAmount object REQUIRED
The amount and the currency to be sold.
buy QuoteAmount object REQUIRED
The amount and the currency to be bought.
exchangeCreateTime DateTime REQUIRED
The time that the settlement request is created.
More information about this field
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
exchangeFinishTime DateTime REQUIRED
The time that the settlement request is completed.
More information about this field
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
quote Quote object REQUIRED
Transfer quote information.
exchangeMode String REQUIRED
The mode of the settlement.
Valid values are:
REALTIME: Real-time settlement.APPOINTED: Appointed settlement.
exchangeTradeType String REQUIRED
Defines the type of settlement.
Valid values are:
SPOT: Using spot rate.FORWARD: Using forward rate.UNFUNDED_SPOT: Using forward rate.
exchangeUnfundedInfo ExchangeForwardInfo object CONDITIONAL
Information about the forward exchange.
This field is returned only when the value of result.resultStatus is
Sand the value of exchangeTradeType isUNFUNDED_SPOT.
exchangeForwardInfo ExchangeForwardInfo object CONDITIONAL
Information about the forward exchange.
This field is returned only when the value of result.resultStatus is
Sand the value of exchangeTradeType isFORWARD.
Response parameters
result Result object REQUIRED
Indicates whether this API is called successfully.
Request
Response
Result processing logic
WorldFirst sends you the result of the forex settlement with the exchangeResult.result parameter in the request. For details, see the following exchangeResult.resultCode section. After receiving the result notification, you need to send a response to acknowledge the reception of the notification.
Note: You must sign the message before making the response. Take the following header codes as an example. For details, see the "Sign a request and validate the signature " chapter and the Response header chapter.
If you do not send the acknowledgment back toWorldFirst, WorldFirst retries to send the result by complying with the following attempt rules:
- WorldFirst retries notifications 7 times at most.
- Intervals between notifications: 2m, 10m, 10m, 1h, 2h, 6h, and 15h.
exchangeResult.resultCode
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | The settlement is successfully completed. | |
| 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. |