Update Beneficiary Account

put

https://herald-otc-api-sandbox.heraldex.com:3292/api/v1/beneficiary/update_account/{unique_id}

Updates an existing beneficiary bank account using the beneficiary ID and SWIFT banking details such as account information, currency, recipient country, and bank address. On successful validation and update, the API returns the updated beneficiary account details

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

unique_id

string

required

Required to update the particular beneficiary details

Body Params

receiving_currency

string

enum

The currency in which the beneficiary will receive the funds (e.g., USD, EUR, AED).

Allowed:

recipient_country

string

The country of the beneficiary receiving the payment.

recipient_type

integer

enum

Type of recipient: 1 for individual, 2 for business.

Allowed:

account_type

string

enum

The type of bank account (e.g., Current, Checking, Savings).

Allowed:

account_name

string

The name of the account holder receiving the funds.

beneficiary_description

string

A description or label for the beneficiary account for reference.

business_name

string

The business name associated with the beneficiary (if applicable).

account_number

integer

The bank account number of the beneficiary; required only if the service is SWIFT and receiving_currency is USD or AED.

code

string

The bank code required for the transfer (e.g., SWIFT code); required only if the service is SWIFT and receiving_currency is USD.

iban

string

The International Bank Account Number; required only if the service is SEPA and receiving_currency is EUR or AED.

bic

string

Required when the receiving_currency is AED

bank_primary_address

string

The primary address of the beneficiary’s bank.

bank_secondary_address

string

The secondary address or suite number of the beneficiary’s bank.

bank_city

string

The city where the beneficiary’s bank is located.

bank_state

string

The state or region of the beneficiary’s bank.

bank_postal_code

integer

The postal or ZIP code of the beneficiary’s bank.

bank_country

string

The country where the beneficiary’s bank is located.

payment_method

string

The selected payment method for the transfer (e.g., SWIFT, SEPA, ACH).

Headers

x-api-key

string

required

The unique API key assigned to the client for authenticating API requests.

x-api-signature

string

required

The cryptographic signature generated to verify the integrity and authenticity of the request.

x-api-timestamp

string

required

The timestamp of the API request used to prevent replay attacks.

Authorization

string

required

Bearer token used to authenticate and authorize access to the API.

Response

200Success