Create Beneficiary Account

post

https://herald-otc-api-sandbox.heraldex.com:3292/api/v1/beneficiary/create_account

Adds a new beneficiary bank account for fiat transfers, supporting various payment methods such as SWIFT. The API records full account and bank details, assigns a unique beneficiary ID, and returns the created account information along with status. Authentication is required via API key, signature, and timestamp headers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

receiving_currency

string

enum

required

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

Allowed:

recipient_country

string

required

The country of the beneficiary receiving the payment.

recipient_type

integer

enum

required

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

Allowed:

account_type

string

enum

required

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

Allowed:

account_name

string

required

The name of the account holder receiving the funds.

beneficiary_description

string

required

A description or label for the beneficiary account for reference.

business_name

string

required

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

account_number

string

required

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

code

string

required

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

required

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

bic

string

required

Required when the receiving_currency is AED

bank_primary_address

string

required

The primary address of the beneficiary’s bank.

bank_secondary_address

string

required

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

bank_city

string

required

The city where the beneficiary’s bank is located.

bank_state

string

required

The state or region of the beneficiary’s bank.

bank_postal_code

string

required

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

bank_country

string

required

The country where the beneficiary’s bank is located.

payment_method

string

enum

required

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

Allowed:

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