Create Deposit Address

Creates a deposit address for the given asset.

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 -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

The deposit address for the asset and network. If one already exists for this asset and network, that same address is returned.

Field	Type	Description
`id`	string	Unique identifier for the deposit address
`name`	string	Set by the server to the custody asset ID for this asset and network (e.g. BTC, USDC_POLYGON_NXTB); not chosen by the client
`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; empty string when none
`refAccountType`	string	Type of reference account: CRYPTO_ACCOUNT, or an empty string for older addresses
`refAccountId`	string	Custody reference of the wallet (same value as refAccountDetails.id); empty string for older addresses
`refAccountDetails`	object \| null	Wallet details of the deposit address (see Crypto Deposit Account Details Object); null for older addresses that have none

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	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

The deposit address for the asset and network. If one already exists for this asset and network, that same address is returned.

200 application/json

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "BTC",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "asset": "BTC",
  "network": "Bitcoin",
  "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
  "addressParams": {},
  "endUserId": "",
  "refAccountId": "35",
  "refAccountType": "CRYPTO_ACCOUNT",
  "refAccountDetails": {
    "id": "35",
    "address": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
    "legacyAddress": "",
    "enterpriseAddress": null,
    "tag": "",
    "eosAccountName": "Address BTC",
    "status": null,
    "activationTxId": null
  }
}

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