notifyTransferResultSignature required
WorldFirst uses the notifyTransferResult interface to send transfer result notifications to the Partner. Partner needs to process the result and response to WorldFirst indicating the reception of the notification.
Note: By consuming this interface, the Partner mainly engages with the transferResult field.
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
transferRequestId String REQUIRED
The unique ID assigned by the Partner to identify a transfer request.
More information:
- This field is an API idempotency field.
transferId String REQUIRED
The unique ID assigned by WorldFirst to identify the status of the transfer.
More information:
- This field is an API idempotency field.
transferResult Result REQUIRED
Indicates the status of the transfer made by the transfer API.
transferFinishTime DateTime object 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
The transfer amount submitted by the payer.
transferToDetail transferToDetail REQUIRED
The transfer details for the beneficiary, such as the transfer amount collected by the beneficiary.
Response parameters
result Result REQUIRED
Indicates whether this API is called successfully.
Request
Response
Result processing logic
In the request message:
- The
transferResult.resultCodefield indicates the result of the prefunding process. For more information, refer to the Result codes section.
After receiving the notification from WorldFirst, the Partner needs to send WorldFirst a response message to acknowledge the receipt of the notification.
The Partner needs to properly sign the message before making the response. For details, refer to the Sign a request and validate the signature chapter.
The response header observes the following structure:
- Signature: Required. Example: Signature: algorithm=RSA256, keyVersion=2, signature=****
- Content-Type: Required. Example: Content-Type: application/json; charset=UTF-8
- Client-Id: Required. Example: Client-Id: ****
- Response-Time: Required. Example: Response-Time: 2019-04-04T12:08:56+08:00
Sample response header:
For more details about the response message, refer to the API overview chapter.
The response body has the following fixed value:
If the Partner does not respond to WorldFirst that the notification has been received successfully, 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 | |
| PROCESS_FAIL | F | A general business failure occurred. Do not retry. | Human intervention is usually needed. It is recommended that you contact WorldFirst Technical Support to resolve the issue. |
| 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. |
| UNKNOWN_EXCEPTION | U | The API call is failed, which is caused by unknown reasons. | The service might be down, retry later. If the issue persists, contact WorldFirst Technical Support. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | Call the interface again to resolve the issue. If not resolved, contact Alipay Technical Support. | Call the interface again to resolve the issue. If not resolved, contact Alipay Technical Support. |
| 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. For more details, refer to the following chapter:
|
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | Ensure the HTTP method is |
| ORDER_NOT_EXIST | F | The order does not exist. | Retry with another transfer order. |
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 WorldFirst Technical Support to resolve the issue. |
| USER_NOT_EXIST | F | The user does not exist. | Human intervention is usually needed. It is recommended that you contact WorldFirst Technical Support to resolve the issue. |
| USER_ACCOUNT_ABNORMAL | F | User account status abnormal. | Retry with a different user. If the issue persists, contact WorldFirst Technical Support for more details. |
| AMOUNT_EXCEED_LIMIT | F | The amount exceeds the limit. | Make sure the amount submitted is correct and retry. |
| RISK_REJECT | F | The transfer is rejected for risk control reasons. | Prompt the user that the request is rejected because the risk control failed. |
| TRANSFER_IN_PROCESS | U | The transfer is in process. | Query the transfer result with the inquiryTransfer API. |
| ORDER_IS_CLOSED | F | The order is closed. | Retry with another transfer order. |
| ORDER_IS_REVERSED | F | The order is reversed. | Retry with another transfer order. |
| CARD_INFO_NOT_MATCH | F | The card information does not match. | Retry with the correct card information. |
| UNKNOWN_EXCEPTION | U | Unknown exception. | The service might be down, retry later. If the issue persists, contact WorldFirst Technical Support. |
| BALANCE_NOT_ENOUGH | F | Balance is not enough. | Make sure the balance is sufficient and retry. |