Get Deposit Accounts Paginated

Returns a paginated list of deposit accounts including both fiat (bank account details) and crypto (blockchain addresses) deposit methods.

Auth:Bearer <api_key>

Tags:Banking

Request

cURL

curl -G https://publicapi.sandbox.hercle.financial/api/v1/deposit-accounts?pageSize={pageSize} \
  -H "Authorization: Bearer eyJhb..." \

Query Parameters

Name	Type	Required	Description
pageSize	number	Yes	Number of deposit accounts to return (must be between 5 and 50) Example: `10`
paginationToken	string	No	Token for pagination (e.g., next page token)

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer API_KEY Example: `Bearer your_api_key_here`
Content-Type	string	Yes	application/json Example: `application/json`

Response

Success Response Schema

Deposit accounts retrieved successfully

Field	Type	Description
`payload`	array	Array of deposit account objects
`paginationToken`	string	Token for retrieving the next page of results

Deposit Account Object

Individual deposit account details for fiat or crypto deposits

Field	Type	Description
`id`	string	Unique identifier of the deposit account
`userId`	string	User ID associated with the deposit account
`endUserId`	string	End user ID associated with the deposit account
`name`	string	Name of the deposit account
`asset`	string	Asset type (e.g., EUR, BTC)
`address`	string	Deposit address (IBAN or blockchain address). Only on crypto and fiat accounts
`addressParams`	object	Additional address parameters, as key-value strings; {} when there are none. Only on crypto and fiat accounts
`addressParams.tag`	string	Destination tag or memo (e.g. XLM, ATOM)
`network`	string	Network type (e.g., Sepa, Bitcoin)
`refAccountId`	string	Reference account ID (virtual account ID for fiat, blockchain address for crypto)
`refAccountType`	string	Type of reference account
`refAccountDetails`	object \| null	Detailed account information
`deleted`	boolean	Whether the deposit account is deleted

Bank Details Object (Fiat Only)

Detailed bank account information for fiat deposit accounts

Field	Type	Description
`bankName`	string	Name of the bank
`accountHolderName`	string	Name of the account holder
`country`	string	Country code (ISO 3166-1 alpha-2, e.g., DE, GB)
`accountNumber`	string	Bank account number
`routingCodes`	array	Array of routing code objects
`iban`	string	International Bank Account Number
`bic`	string	Bank Identifier Code (SWIFT code)

Routing Code Object

Routing code information for bank transfers

Field	Type	Description
`type`	string	Type of routing code (e.g., sortcode, aba)
`value`	string	Value of the routing code

Crypto Deposit Account Details Object

Blockchain address and details for crypto deposit accounts

Field	Type	Description
`id`	string	Unique identifier of the crypto deposit account
`address`	string	Blockchain address for deposits
`legacyAddress`	string \| null	Legacy address format
`enterpriseAddress`	string \| null	Enterprise address
`tag`	string \| null	Tag or memo for certain cryptocurrencies
`eosAccountName`	string \| null	EOS account name
`status`	string \| null	Status of the crypto deposit account
`activationTxId`	string \| null	Transaction ID of the activation transaction

Responses

Deposit accounts retrieved successfully

200 application/json

{
  "payload": [
    {
      "id": "xxxx",
      "userId": "yyyy",
      "endUserId": "zzzz",
      "name": "Deposit EUR",
      "asset": "EUR",
      "address": "DE1234567899",
      "addressParams": {},
      "network": "Sepa",
      "refAccountId": "vac_12345",
      "refAccountType": "VIRTUAL_ACCOUNT",
      "refAccountDetails": {
        "bankName": "Banking Name",
        "accountHolderName": "Account Holder Name",
        "country": "DE",
        "accountNumber": "",
        "routingCodes": [],
        "iban": "DE1234567899",
        "bic": "AAAABBCC"
      },
      "deleted": false
    },
    {
      "id": "xxxx",
      "userId": "yyyy",
      "endUserId": "zzzz",
      "name": "BTC",
      "asset": "BTC",
      "address": "35bSzXvRKLpHsHMrzb82f617cV4Srnt7hS",
      "addressParams": {},
      "network": "Bitcoin",
      "refAccountId": "38",
      "refAccountType": "CRYPTO_ACCOUNT",
      "refAccountDetails": {
        "id": "38",
        "address": "35bSzXvRKLpHsHMrzb82f617cV4Srnt7hS",
        "legacyAddress": "afsZ1JMhhjgSYFYG1bJ9pLKko",
        "enterpriseAddress": null,
        "tag": "",
        "eosAccountName": "Address BTC",
        "status": null,
        "activationTxId": null
      },
      "deleted": false
    }
  ],
  "paginationToken": ""
}

API Tester

Test this endpoint directly against the sandbox environment

API Key

Get your API key from Hercle Sandbox

Query Parameters

pageSize

Required

Number of deposit accounts to return (must be between 5 and 50)

paginationToken

Token for pagination (e.g., next page token)

Request URL

https://publicapi.sandbox.hercle.financial/api/v1/deposit-accounts