Create a transfer requestSignature required
Use this API to transfer funds between WorldFirst accounts.
The transfer process is asynchronous. After you call this API, WorldFirst returns the result of the API call, indicating only that the transfer is being processed. The final transfer results will be sent to you through the notifyTransfer API. You can also call the inquiryTransfer API to query the transfer results.
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) |
| Required when a partner manages a customer's account. |
Request parameters
transferRequestId String REQUIRED
The unique ID assigned by the Partner to identify a transfer request.
More information:
- This field is an API idempotency field.For details about API idempotency, see the Idempotency chapter.
- Maximum length: 64 characters
businessSceneCode String CONDITIONAL
The code that represents the transfer business scenario.
Valid values:
MULTI_ACCOUNT_TRANSFER：transfer between your primary account and subaccounts.
This parameter is only required when you need to transfer funds between your primary account and subaccount or between your subaccounts.
transferFromDetail TransferFromDetail REQUIRED
Transfer details submitted by the payer.
transferToDetail TransferToDetail REQUIRED
Transfer details for the beneficiary.
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 transfer 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 transfer.
This field is returned as needed only when result.resultStatus = S .
More information:
- Maximum length: 64 characters
businessSceneCode String REQUIRED
The code that represents the transfer business scenario.
Valid values:
MULTI_ACCOUNT_TRANSFER：transfer between your primary account and subaccounts.ATOMIC_TRANSFER：transfer between WF accounts
transferFromDetail TransferFromDetail REQUIRED
Transfer details submitted by the payer.
This field is returned as needed only when result.resultStatus = S .
transferToDetail TransferToDetail REQUIRED
The transfer 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:
System-realted result codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| 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. 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 |
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 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. |