Create Deposit Address

Creates a deposit address for the given asset.

Auth:Bearer <api_key>

Tags:Addresses

Request

cURL

curl -X POST https://publicapi.sandbox.hercle.financial/api/v1/addresses/deposit \
  -H "Authorization: Bearer eyJhb..." \
  -H "Content-Type: application/json" \
  -d '{"key": "value"}'

Headers

Name	Type	Required	Description
Authorization	string	Yes	Bearer token for authentication
Content-Type	string	Yes	Content type of the request body

Request Body

Schema

object

asset*:string

// The asset code (e.g., EUR, USD)

network*:string

// The network of the asset (e.g., Sepa, Swift)

Example

{
  "asset": "EUR",
  "network": "Sepa"
}

Response

Success Response Schema

Address request submitted successfully

Field	Type	Description
`id`	string	Unique identifier for the deposit address
`name`	string	User-defined name for the deposit address
`userId`	string	ID of the user who owns the deposit address
`asset`	string	Asset code (e.g., BTC, ETH, USD)
`network`	string	Network name (e.g., Bitcoin, Ethereum)
`address`	string	The deposit address
`addressParams`	object	Additional parameters for the deposit address
`endUserId`	string	End user ID associated with the deposit address
`refAccountType`	string \| null	Type of reference account
`refAccountId`	string \| null	Reference account ID
`refAccountDetails`	object \| null	Detailed account information (bank details or crypto details)

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., sort_code, 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	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

Responses

Address request submitted successfully

201 application/json

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "My Deposit Address",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "asset": "EUR",
    "network": "Sepa",
    "address": "DE89370400440532013000",
    "addressParams": {},
    "endUserId": "",
    "refAccountType": null,
    "refAccountId": null,
    "refAccountDetails": null
  },
  {
    "id": "addr_def456ghi789",
    "name": "EUR Virtual Account",
    "userId": "user_789xyz",
    "asset": "EUR",
    "network": "Sepa",
    "address": "DE89370400440532013000",
    "addressParams": {},
    "endUserId": "eus_123456789",
    "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"
    }
  }
]

API Tester

Test this endpoint directly against the sandbox environment

API Key

Get your API key from Hercle Sandbox

Request Body

Request URL

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