API Reference
  1. HERALD EXCHANGE
  2. Beneficiary Accounts

Get Beneficiary Accounts

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

Retrieves a paginated list of beneficiary bank accounts associated with the authenticated user, with optional filters for search keywords and receiving currency. The API returns the total number of beneficiary accounts along with detailed account information

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

The page number used for paginated retrieval of beneficiary records.

string

A keyword used to filter beneficiaries based on name, account, or other matching details.

string

The currency used to filter beneficiaries who receive funds in a specific currency (e.g., USD, EUR).

Headers
string
required

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

string
required

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

string
required

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

string
required

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

Response

Updated about 2 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?