Edit the beneficiarySignature required

2024-11-29 08:10

POST /amsin/api/v1/business/account/editBeneficiary

Call this API to edit the beneficiary's nickname.

Structure

A message consists of a header and body.

The unique ID that is assigned by WorldFirst to identify a Customer.

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:

The nickname of the beneficiary. The nickname is defined by the Customer to identify the beneficiary easily.

More information:

The result of the API call.

Show child parameters

A ciphered text that contains information about the details of the beneficiary's bank account.

This field is returned as needed only when result.resultStatus =S.

The cipher is encoded in the Base64 algorithm. For more details about encoding, refer to the message encoding chapter.

More information:

API Explorer

URL

Request Body

Response Body

After calling the API, a response is returned. Possible values for result.resultStatus are:

Code	Value	Message	Further action
SUCCESS	S	Success
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.
CONTRACT_CHECK_FAIL	F	The contract check has failed.	Check the contract status with WorldFirst before retrying.
USER_NOT_EXIST	F	The user does not exist.	Retry with the correct user information.
AUTHORIZATION_NOT_EXIST	F	OAUTH does not exist.	The current token authorization does not exist. Please contact our Technical Support Team to verify token authorization.
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.
OAUTH_FAIL	F	OAuth process failed.	Contact our Technical Support Team for detailed reasons.
INVALID_CLIENT	F	The client is invalid.	The Client ID does not exist or is invalid.
INVALID_API	F	The called API is invalid or not active.	Check whether the correct API is being called.
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`.

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.

Result status	Description
`S`	Indicates that the API call succeeded.
`F`	Indicates that the API call failed. For additional information on the failure, refer to result.resultCode.
`U`	Indicates that the API call result is unknown. If this status is returned, the Partner may make a query. The querying strategy is as follows: Maximum 7 queries are allowed. Intervals between queries: 5 min, 10 min, 20 min, 40 min, 80 min, 160 min, and 320 min. If no query succeed, contact our Technical Support Team.