Remove a beneficiarySignature required
The Partner can use this API to remove a beneficiary. The Partner is able to remove one beneficiary per API call.
Structure
A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:
Request parameters
removeBeneficiaryRequestId String REQUIRED
The unique ID assigned by the Partner to identify a beneficiary removal request.
This field (removeBeneficiaryRequestId) is not the same as bindBeneficiaryRequestId.
More information about this field
- This field is an API idempotency field.For details about API idempotency, see the Idempotency chapter.
- Maximum length: 64 characters
beneficiaryToken String REQUIRED
A ciphered text that contains information about the details of the beneficiary's bank account.
The cipher is encoded in the Base64 algorithm. For more details about encoding, refer to the message encoding chapter.
More information about this field
- Maximum length: 128 characters
customerId String CONDITIONAL
The unique id assigned by WorldFirst to identify an account.
customerId and accessToken cannot be both empty.
More information about this field
- Maximum length: 64 characters
accessToken String CONDITIONAL
The access token used for OAuth authorization.
customerId and accessToken cannot be both empty.
More information about this field
- Maximum length: 64 characters
Response parameters
result Result object REQUIRED
Indicates whether this API is called successfully.
beneficiaryToken String REQUIRED
A ciphered text that contains information about the details of the beneficiary's bank account.
This cipher is encoded in the Base64 algorithm. For more details about encoding, refer to the message encoding chapter.
Request
Response
Result processing logic
After calling the API, a response is returned. 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. Partner can make a query when the returned status is
If none of the queries is successful, contact our Technical Support Team. |
System-realted result codes
| Code | Value | Message | Further action |
|---|---|---|---|
| SUCCESS | S | Success | |
| 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. |
| 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. |
| 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. |
| OAUTH_FAIL | F | OAuth process failed. | Contact our Technical Support Team for detailed reasons. |
| 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 e.g. currency is incorrect. Retry with the correct information. |
| USER_NOT_EXIST | F | The user does not exist. | Retry with the correct user information. |
| BENEFICIARY_NOT_EXIST | F | The beneficiary does not exist. | Check the beneficiary information and try again. |
| REPEAT_REQ_INCONSISTENT | F | Repeated requests are inconsistent. | Ensure all the fields in the requests are the same. |