Get Deposit Addresses

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

Auth:Bearer <api_key>

Tags:Addresses

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	User-defined name for the address
`userId`	string	ID of the user who owns the address
`endUserId`	string \| null	End user ID associated with the address
`asset`	string	Asset code (e.g., BTC, ETH, USD)
`address`	string	The deposit address
`addressParams`	object	Additional address parameters
`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 \| null	Reference account ID if applicable
`refAccountType`	string \| null	Reference account type if applicable
`refAccountDetails`	object \| null	Additional details for the reference account

Bank Details Object (Fiat Only)

Detailed bank account information for fiat deposit addresses

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., sort_code, 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	Unique identifier of the crypto deposit account
`address`	string	Blockchain address for deposits
`legacyAddress`	string	Legacy address format
`enterpriseAddress`	string \| null	Enterprise address
`tag`	string	Tag or memo for certain cryptocurrencies
`eosAccountName`	string	EOS account name
`status`	string \| null	Status of the crypto deposit account
`activationTxId`	string \| null	Transaction ID of the activation transaction
`message`	string	Status message regarding the crypto deposit account

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": "0001-01-01T00:00:00",
    "refAccountId": "vac_123456789",
    "refAccountType": "VIRTUAL_ACCOUNT",
    "refAccountDetails": {
      "bankName": "Deutsche Bank",
      "accountHolderName": "John Doe",
      "country": "DE",
      "accountNumber": "532013000",
      "routingCodes": [
        {
          "type": "sort_code",
          "value": "123456"
        }
      ],
      "iban": "DE89370400440532013000",
      "bic": "COBADEFFXXX"
    }
  },
  {
    "id": "aaaa",
    "name": "BTC",
    "userId": "bbbb",
    "endUserId": "cccc",
    "asset": "BTC",
    "address": "cccc",
    "addressParams": {},
    "network": "Bitcoin",
    "deleted": false,
    "creationDate": "0001-01-01T00:00:00",
    "refAccountId": null,
    "refAccountType": null,
    "refAccountDetails": null
  }
]

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