Receive transfer result notificationSignature required
WorldFirst sends notifications of the transfer result with this interface. The Partner can set up the URL for receiving transfer notifications by specifying the transferToDetail.transferNotifyUrl field when calling createTransfer.
The Partner needs to acknowledge the reception of the notification. For more details, refer to the Result processing logic section.
Structure
A message consists of a header and body.
Request header parameters
Request parameters
transferRequestId String REQUIRED
The unique ID assigned by the Partner to identify a transfer request.
More information:
- This field is an API idempotency field.For details about API idempotency, see the Idempotency chapter.
- Maximum length: 64 characters
transferId String REQUIRED
The unique ID assigned by WorldFirst to identify a transfer.
More information:
- Maximum length: 64 characters
businessSceneCode String REQUIRED
The code that represents the transfer business scenario.
Valid values:
MULTI_ACCOUNT_TRANSFER：transfer between your primary account and subaccounts.ATOMIC_TRANSFER：transfer between WF accounts
transferResult TransferResult REQUIRED
Indicates the result of the transfer request.
transferFinishTime DateTime REQUIRED
Indicates the finishing time of a transfer.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
transferFromDetail TransferFromDetail REQUIRED
Transfer details submitted by the payer.
transferToDetail TransferToDetail REQUIRED
Transfer details for the beneficiary.
Response parameters
result Result REQUIRED
Indicates whether this API is called successfully.
Request
Response
Result processing logic
The parameter transferResult.resultCode indicates the result of the transfer. For more details, refer to the transferResult.resultCode section.
After receiving the notification, you need to send a response message to acknowledge the receipt of the notification.
Make sure you properly sign the message before sending the response. For details, refer to the Sign a request and validate the signature chapter.
For more details on the response header, refer to the API overview chapter.
The response body has the following fixed value:
In the absense of an ackowledgement reponse from the Partner, WorldFirst will resend the result.
The following policy represents how WorldFirst makes retry attempts:
- WorldFirst retries notifications 7 times.
- Intervals between notifications: 2m, 10m, 10m, 1h, 2h, 6h, and 15h.
result.resultCode
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | The transfer is created successfully and being processed. Call the inquiryTransfer API for the transfer result. |
| 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. |
transferResult.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. |