inquiryTransfer
Call this API to query the fund transfer result.
- Set up a timeout mechanism to stop the polling process, in case no conclusive transfer result is reached.
- If you do not receive any notification from Antom two hours after you call the createTransfer API; and meanwhile, if you call the inquiryTransfer API and get
UNKNOWN in the transferResult.resultCode, contact Antom Technical Support for help.
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:
- Maximum length: 64 characters
Response parameters
result Result REQUIRED
Indicates whether this API is called successfully.
transferResult Result
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
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.
More information:
- The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".
transferFromDetail TransferFromDetail
Transfer details submitted by the payer.
Note: This field is returned on demand only when the value of result.resultStatus is S.
transferToDetail TransferToDetail
Transfer details for the beneficiary.
Note: This field is returned on demand only when the value of result.resultStatus is S.
businessSceneCode String
The code that represents the transfer business scenario. Valid value is:
THIRD_PARTY_TRANSFER: Account-to-account transfer (the value of payee isANTOM_BIZ_ACCOUNT).
More information:
- Maximum length: 64 characters
Request
Response
Result/Error codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | success. | This interface is called successfully. |
| 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. |
| 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 our Technical Support Team. |
| REQUEST_TRAFFIC_EXCEED_LIMIT | U | The request traffic exceeds the limit. | Call the interface again to resolve the issue. If the issue persists, contact our Technical Support Team. |
| 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 | No further action is needed. |
| PROCESSING | S | Processing | The partner can retry to query the status after receiving processing. It means Antom has received the transaction, but pending for processing. It is not a final status. |
| 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 | Unknown exception | The service might be down, retry later. If the issue persists, contact our Technical Support Team. |
| 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 our Technical Support Team 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. | Try again later. |
| 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. |
| BALANCE_NOT_ENOUGH | F | Balance is not enough. | Make sure the balance is sufficient and retry. |
| ORDER_NOT_FOUND | U | Order not found. | Retry with correct order information. |