inquirePayout
Use this interface to to query the fund payout result.
- Please set up a timeout mechanism to stop the polling process, in case no conclusive payout result is reached.
- If any notification from Antom is received more than two hours after calling the createPayout API, and the transferResult.resultCode showing UNKNOWN after calling the inquirePayout API, please contact Antom Technical Support for assistance.
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
The unique ID assigned by the merchant to identify a payout request.
Note: This field is required when the transferId parameter is empty.
More information:
- Maximum length: 64 characters
transferId String
The unique ID returned by Antom to identify a payout request.
Note: This field is required when the transferRequestId parameter is empty.
More information:
- Maximum size: 64 elements
Response parameters
result Object REQUIRED
Indicates whether this API is called successfully.
transferResult Object REQUIRED
The result of the transfer request.
Note: This field is returned on demand only when the value of result.resultStatus is S.
transferRequestId String
The unique ID assigned by the merchant to identify a transfer request.
Note: This field is returned on demand only when the value of result.resultStatus is S.
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.
Note: This field is returned on demand only when the value of result.resultStatus is S.
More information:
- Maximum length: 64 characters
transferFinishTime Datetime
The finishing time of a transfer.
Note: This field is returned on demand only when the value of result.resultStatus is S and the payout has finished processing.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
transferFromDetail Object
Transfer details submitted by the buyer.
Note: This field is returned on demand only when the value of result.resultStatus is S.
transferToDetail Object
Transfer details for the beneficiary.
Note: This field is returned on demand only when the value of result.resultStatus is S.
Request
Response
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | success. | API is successfully called, not resembling order status |
| 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. |
| 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. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Call the interface again to resolve the issue. If the issue persists, contact Antom 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. |
| METHOD_NOT_SUPPORTED | F | The server does not implement the requested HTTP method. | Ensure the HTTP method is POST. |
transferResult.resultCode
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | API is successfully called, not resembling order status |
| PROCESSING | S | Processing | Try again later. |
| ORDER_NOT_FOUND | U | Order not found. | Retry with correct order information. |
| 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. |
| ORDER_IS_REVERSED | F | The order is reversed. | Retry with another payout order. |
| USER_NOT_EXIST | F | The user does not exist. | Retry with the correct user information. |
| 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. |
| USER_STATUS_ABNORMAL | F | The status of the user is abnormal. Retry with another card. | Retry with a different user. |
| 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. |
| CARD_INFO_NOT_MATCH | F | The card information does not match. | Retry with the correct card information. |
| BALANCE_NOT_ENOUGH | F | Balance is not enough. | Make sure the balance is sufficient and retry. |
| CURRENCY_NOT_SUPPORT | F | The currency is not supported. | Make sure the currency is correct and retry. |
| ORDER_NOT_EXIST | F | The order does not exist. | Retry with another order. |
| UN_SUPPORT_BUSINESS | F | Unsupported business. | Retry with correct parameters. |
| USER_NO_PERMISSION | F | User does not have permission. | Check user permission and retry. |
| ORDER_IS_CLOSED | F | The order is closed. | Retry with another payout order. |