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 object REQUIRED

Transaction details of the forward deal.

Show child parameters

dealResult Result object REQUIRED

Indicates the result of the forward deal.

Show child parameters

Response parameters

result Result object REQUIRED

Indicates whether this API is called successfully.

Show child parameters
API Explorer

Request

Request Body

Response

Response Body

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.  

Sample Code

 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

CodeValueMessage
SUCCESSSThe forward deal is successful.
PROCESSINGSThe forward deal is being processed.
CANCELLEDFThe forward deal is canceled.
FAILFThe forward deal has failed.

result.resultCode

CodeValueMessageFurther action
SUCCESSSSuccess
PROCESS_FAILFA 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_EXCEPTIONUAPI failed due to unknown reason.

The service might be down, retry later. If the issue persists, contact our Technical Support Team.

@2024 WorldFirst