Remove a beneficiarySignature required

2024-11-21 06:55

POST /amsin/api/v1/business/account/removeBeneficiary

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 access token that is used for OAuth authorization.

More information:

The unique ID assigned by the Partner to identify a beneficiary removal request.

This field (removeBeneficiaryRequestId) is not the same as bindBeneficiaryRequestId.

More information:

This field is an API idempotency field.For details about API idempotency, see the Idempotency chapter.
Maximum length: 64 characters

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:

Indicates whether this API is called successfully.

Show child parameters

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.

API Explorer

URL

Request Body

Response Body

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 result.resultCode table.
`U`	This indicates the API call result is unknown. Partner can make a query when the returned status is `UNKNOWN`. Use the following query strategy: A Partner can make 7 queries at maximum. Intervals between queries: 5m, 10m, 20m, 40m, 80m, 160m, and 320m. If none of the queries is successful, contact our Technical Support Team.

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 `POST`.

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.

Field	Required	Sample	Description
Client-Id	Yes	`Client-Id: *****`	For more information about these request header fields, see Request header.
Signature	Yes	`Signature: algorithm=RSA256, keyVersion=2, signature=*****`
Content-Type	Yes	`Content-Type: application/json; charset=UTF-8`
Request-Time	Yes	`Request-Time: 2019-04-04T12:08:56+08:00`
Connected-CustomerId	Optional	`Connected-CustomerId: *****`	Attention The unique id assigned by WorldFirst to identify an account. Note: This parameter replaces customerId in the request body. Both parameters serve the same function, and this change does not impact functionality. If you have already integrated this API, you may continue using customerId in the request body or re-integrate this API using Connected-CustomerId in the request header.