Consult expected payout resultSignature required
Use this API to inquire about the expected payout results before calling the createPayout API to initiate a payout.
Structure
A message consists of a header and body.
Request header parameters
Field Required Sample Description Client-Id Yes For detailed field descriptions, see API Overview. Signature Yes Content-Type Yes Request-Time Yes Connected-CustomerId No (Conditional) Pay special attention to this field Required when a partner manages a customer's account. Client-Id: *****Signature: algorithm=RSA256, keyVersion=2, signature=*****Content-Type: application/json; charset=UTF-8Request-Time: 2019-04-04T12:08:56+08:00Connected-CustomerId: ******
Request parameters
transferFromDetail TransferFromDetail object REQUIRED
Transfer details submitted by the payer.
transferToDetail TransferToDetail object REQUIRED
Transfer 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 object REQUIRED
Indicates whether this API is called successfully.
transferFromDetail TransferFromDetail object REQUIRED
Transfer details submitted by the payer.
This field is returned as needed only when
result.resultStatus=S.
transferToDetail TransferToDetail object REQUIRED
Transfer details for the beneficiary.
This field is returned as needed only when
result.resultStatus=S.
availableQuota Amount object CONDITIONAL
The available quota. Specify this parameter if the value of the transferToDetail.transferToAmount.currency parameter is CNY.
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 status | Description |
S | This indicates the API call succeeded. |
F | This indicates the API call failed. For more information on why the call failed, see |
U | This indicates the API call result is unknown. The partner can call this API again. |
result.resultCode: System-related result codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| 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. |
| 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. |
| 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. |
| 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. |
| CONTRACT_CHECK_FAIL | F | The contract check has failed. | Ensure the Partner has already signed a contract and the input is correct. |