notifyPayout
Antom sends notifications of the payout result with this interface. The merchant can set up the URL for receiving payout notifications by specifying the transferToDetail.transferNotifyUrl field when calling createPayout or setting the url in Antom's portal.
The merchant 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. The following sections are focused on the body structure. For the header structure, see：
Note: Set the data type of each field (except array) as String. This means that you must use double quotation marks (" ") to enclose the field value. Examples:
- If the data type of a field is Integer and its value is 20, set it as "20".
- If the data type of a field is Boolean and its value is
true, set it as "true".
Request parameters
transferRequestId String REQUIRED
The unique ID assigned by the merchant to identify a transfer request.
More information:
- This field is an API idempotency field.
- Maximum length: 64 characters
transferId String REQUIRED
The unique ID assigned by Antom to identify a transfer.
More information:
- Maximum length: 64 characters
transferResult Object REQUIRED
The result of the transfer request.
transferFinishTime Datetime
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 Object REQUIRED
Transfer details submitted by the buyer.
transferToDetail Object REQUIRED
Transfer details for the beneficiary.
Response parameters
result Object REQUIRED
Indicates whether this notification from Antom was received successfully.
Request
Response
Result processing logic
After calling the API, Antom responds to the merchant with the result of the API call. The possible responses for result.resultStatus are:
Result/Error codes
| 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 Antom Technical Support 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 Antom Technical Support. |
transferResult.resultCode
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | success | No further action is needed. |
| PROCESSING | S | The transfer is in process. | Try again later. |
| PROCESS_FAIL | F | A general business failure occurred. Do not retry. | Human intervention is usually needed. It is recommended that you contact Antom Technical Support to resolve the issue. |
| USER_ACCOUNT_ABNORMAL | F | The user account status is abnormal. | Retry with a different user. If the issue persists, contact Antom 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. |
| ORDER_IS_CLOSED | F | The order is closed. | Retry with another payout order. |
| ORDER_IS_REVERSED | F | The order is reversed. | Retry with another payout order. |
| ORDER_NOT_FOUND | U | Order not found. | Retry with correct order information. |
| CARD_INFO_NOT_MATCH | F | The card information does not match. | Retry with another payout order. |
| BALANCE_NOT_ENOUGH | F | Balance is not enough. | Make sure the balance is sufficient and retry. |