Receive an FX deal notificationSignature required
WorldFirst uses this interface to notify the Partner about the forward deal results. 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
deal Deal REQUIRED
Transaction details of the forward deal.
dealResult Result REQUIRED
Indicates the result of the forward deal.
Response parameters
result Result REQUIRED
Indicates whether this API is called successfully.
Request
Response
Result processing logic
WorldFirst sends you the result of the forex deal with the dealResult.result parameter in the request. For details, see the following dealResult.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.
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
Code | Value | Message | 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 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. |