createTransfer
Use this interface to transfer funds between Antom business accounts.
The transfer process is asynchronous. After calling this API, Antom returns an immediate response indicating the transfer is being processed. The final transfer result will be sent to you via the notifyTransfer API. You can also call the inquiryTransfer API to query the transfer status.
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
transferFromDetail Object REQUIRED
Transfer details submitted by the payer.
transferToDetail Object REQUIRED
Transfer details for the beneficiary.
Response parameters
result Object REQUIRED
Indicates whether this API is called successfully.
transferRequestId String
The unique ID assigned by a 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
transferFromDetail Object
Transfer details submitted by the payer.
Note: This field is returned on demand only when the value of result.resultStatus is S.
transferToDetail Object
Transfer details for the beneficiary, including the transfer amount received.
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. | The API is called successfully, and no further action is needed. |
| PROCESSING | S | The transfer is in process. | The transfer is created successfully and being processed. Call the inquiryTransfer API for the transfer result. |
| 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. |
| UN_SUPPORT_BUSINESS | F | Unsupported business. | Invalid parameters are used. Retry with the correct information. |
| USER_NO_PERMISSION | F | User does not have permission. | Retry with another user information. |
| CURRENCY_NOT_SUPPORT | F | The currency is not supported. | Make sure the currency input is correct and try again. |
| 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. |
| REPEAT_REQ_INCONSISTENT | F | Repeated requests are inconsistent. | Ensure all the fields in the requests are the same and try again. |
| USER_STATUS_ABNORMAL | F | The status of the user is abnormal. Retry with another card. | The status of the user is abnormal. Retry with another transfer order. |
| BALANCE_NOT_ENOUGH | F | Balance is not enough. | Make sure the balance is sufficient and retry. |
| AMOUNT_EXCEED_LIMIT | F | The amount exceeds the limit. | Make sure the amount submitted is correct and retry. |
| CONTRACT_CHECK_FAIL | F | The contract check has failed. | Ensure the Partner has already signed a contract and the input is correct. |
| QUOTE_EXPIRED | F | The quote is expired. | Call the createQuote API to create a new quote. Retry creating a new request with the new quote. |