Create a payout requestSignature required
The Partner can use this API to withdraw money from a Wallet Account (WA) to all accounts external to the Ant International Group (e.g. bank accounts, Alipay CN accounts or Alipay Wallet).
Structure
A message consists of a header and body.
Request header parameters
Request parameters
transferRequestId String REQUIRED
The unique ID assigned by the Partner to identify a payout request.
More information:
- This field is an API idempotency field.For details about API idempotency, see the Idempotency chapter.
- Maximum length: 64 characters
transferFromDetail TransferFromDetail REQUIRED
Payout details submitted by the payer.
transferToDetail TransferToDetail REQUIRED
Payout details for the beneficiary.
businessSceneCode String CONDITIONAL
The business scene type of the payout. Specify this parameter if the value of the transferToDetail.transferToAmount.currency is CNY.
Valid values are:
THIRD_PARTY_PAYOUT: indicates a payout to a third-party bank account, which can be either a third-party company bank account or a third-party personal bank account.SAME_NAME_PAYOUT: indicates a payout to a same-name bank account.
Response parameters
result Result REQUIRED
Indicates whether this API is called successfully.
transferRequestId String REQUIRED
The unique ID assigned by the Partner to identify a payout request.
This field is returned as needed only when result.resultStatus =
S.
More information:
- This field is an API idempotency field.For details about API idempotency, see the Idempotency chapter.
- Maximum length: 64 characters
transferId String REQUIRED
The unique ID assigned by WorldFirst to identify a payout.
This field is returned as needed only when result.resultStatus =
S.
More information:
- Maximum length: 64 characters
transferFromDetail TransferFromDetail REQUIRED
Payout details submitted by the payer.
This field is returned as needed only when result.resultStatus =
S.
transferToDetail TransferToDetail REQUIRED
Payout details for the beneficiary.
This field is returned as needed only when result.resultStatus =
S.
Request
Response
Result processing logic
After making an API request, WorldFirst responds to the Partner with the result of the API call. The possible responses for result.resultStatus are:
result.resultCode: System-related result codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| PROCESSING | S | The transfer is in process. | The payout is created successfully and being processed. |
| 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 our Technical Support Team 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 |
result.resultCode: Business-related result codes
| Code | Value | Message | Further action |
|---|---|---|---|
| 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 our Technical Support Team 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 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_NOT_EXIST | F | Contract does not exist. | Ensure the Partner has already signed a contract and the input is correct. |
| CONTRACT_CHECK_FAIL | F | The contract check has failed. | Check the contract status with WorldFirst before retrying. |
| QUOTE_EXPIRED | F | The quote is expired. | Call the createQuote API to create a new quote. Retry to create a new settlement request with the new quote. |
| AVAILABLE_QUOTA_NOT_ENOUGH | F | Payout quota is not enough. | Call inquiryAvailableQuota API to check the currently available payout quota, make sure it is sufficient and then retry. |
| CARD_INFO_NOT_MATCH | F | The card information does not match. | Retry with the correct card information. |