Get Deposit Addresses

Retrieve a list of deposit addresses associated with the account, both fiat and crypto.

Auth:Bearer <api_key>

Tags:Addresses

This endpoint is deprecated and may be removed in a future version. Avoid using it in new integrations.

Request

cURL

curl -G https://publicapi.sandbox.hercle.financial/api/v1/addresses/deposit \
  -H "Authorization: Bearer eyJhb..." \

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication

Response

Success Response Schema

A list of deposit addresses.

Field	Type	Description
`id`	string	Unique identifier for the address
`name`	string	Name the platform assigns to the address (not set by the client); for crypto addresses the provider asset ID, e.g. USDT_ERC20
`userId`	string	ID of the user who owns the address
`endUserId`	string	End user ID associated with the address; empty string when there is none (never null)
`asset`	string	Asset code (e.g., BTC, ETH, USD)
`address`	string	The deposit address
`addressParams`	object	Extra address parameters as string key/value pairs; empty object when there are none. Fiat virtual-account addresses can also carry their bank routing codes here
`addressParams.tag`	string	Destination tag / memo, for assets that use one (e.g. XRP, XLM, ATOM)
`network`	string	Network name (e.g., Bitcoin, Ethereum)
`deleted`	boolean	Indicates if the address has been deleted
`creationDate`	string	ISO 8601 formatted creation date of the address
`refAccountId`	string	ID of the linked account (for VIRTUAL_ACCOUNT, the virtual account ID); empty string when there is none
`refAccountType`	string	Type of the linked account: VIRTUAL_ACCOUNT (fiat) or CRYPTO_ACCOUNT; empty string when there is none
`refAccountDetails`	string	Details of the linked account as a JSON-encoded string; empty string when there is none. Parse it to get the Bank Details object (VIRTUAL_ACCOUNT) or the Crypto Deposit Account Details object (CRYPTO_ACCOUNT)

Bank Details Object (Fiat Only)

Decoded refAccountDetails when refAccountType is VIRTUAL_ACCOUNT. Addresses registered when the virtual account was activated use these camelCase keys; addresses whose bank details came back when the address was created use PascalCase keys instead (BankName, Iban, RoutingCodes[].Type, ...)

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 addresses

Field	Type	Description
`Id`	string	Identifier of the crypto deposit account (same value as refAccountId)
`Address`	string	Blockchain address for deposits
`LegacyAddress`	string \| null	Legacy address format
`EnterpriseAddress`	string \| null	Enterprise address
`Tag`	string	Tag or memo for certain cryptocurrencies; empty string when not used
`EosAccountName`	string	EOS account name
`Status`	string \| null	Status of the crypto deposit account
`ActivationTxId`	string \| null	Transaction ID of the activation transaction

Responses

A list of deposit addresses.

200 application/json

[
  {
    "id": "xxxx",
    "name": "EUR",
    "userId": "yyyy",
    "endUserId": "zzzz",
    "asset": "EUR",
    "address": "zzzz",
    "addressParams": {},
    "network": "Sepa",
    "deleted": false,
    "creationDate": "2025-01-15T10:30:00.000Z",
    "refAccountId": "vac_123456789",
    "refAccountType": "VIRTUAL_ACCOUNT",
    "refAccountDetails": "{\"bankName\":\"Deutsche Bank\",\"accountHolderName\":\"John Doe\",\"country\":\"DE\",\"accountNumber\":\"532013000\",\"routingCodes\":[{\"type\":\"sortcode\",\"value\":\"123456\"}],\"iban\":\"DE89370400440532013000\",\"bic\":\"COBADEFFXXX\"}"
  },
  {
    "id": "aaaa",
    "name": "BTC",
    "userId": "bbbb",
    "endUserId": "cccc",
    "asset": "BTC",
    "address": "cccc",
    "addressParams": {},
    "network": "Bitcoin",
    "deleted": false,
    "creationDate": "2025-01-15T10:30:00.000Z",
    "refAccountId": "",
    "refAccountType": "",
    "refAccountDetails": ""
  }
]

API Tester

Test this endpoint directly against the sandbox environment

API Key

Get your API key from Hercle Sandbox

Request URL

https://publicapi.sandbox.hercle.financial/api/v1/addresses/deposit