Skip to main content
POST
Create address

Authorizations

api-key
string
header
required
api-sign
string
header
required
api-nonce
string
header
required

Path Parameters

method_id
string
required

Deposit method identifier returned by the list deposit methods endpoint.

Example:

"11111111-1111-1111-1111-111111111111"

vault_id
string
required

Vault identifier, a V-prefixed 14-char base32 string with a final check character.

Example:

"VABCDEF234567A"

Body

application/json

Empty request body. The vault and deposit method are supplied as path parameters.

Empty request body. Pass {} or an empty object.

Response

The newly generated deposit address for the vault and deposit method.

A single deposit address entry.

asset
string
required

Asset code the address belongs to (e.g. BTC, USD).

Example:

"BTC"

asset_class
string
required

Asset class of the deposit method. Currently always currency.

Example:

"currency"

address
string

Deposit address string for the underlying chain.

Example:

"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"

tag
string

Destination tag for assets that require it, such as XRP or XLM.

Example:

"123456"

memo
string

Memo for chains that route by memo instead of tag, such as EOS.

Example:

"deposit-memo-001"

name
string

Human-readable label assigned to the address.

Example:

"Primary deposit"

expire_time
string<date-time>

Address expiration time as an RFC 3339 UTC timestamp. Empty when the address does not expire.

Example:

"2025-01-01T00:00:00Z"

is_new
boolean

Whether this address was generated for the current request.

Example:

true

fee_amount
string

Deposit fee amount, fixed-precision decimal as string.

Example:

"0.00000000"

minimum
string

Minimum deposit amount, fixed-precision decimal as string.

Example:

"0.00100000"

maximum
string

Maximum deposit amount, fixed-precision decimal as string. Empty when there is no upper bound.

Example:

"100.00000000"

allow_new_funding_id
boolean

Whether another deposit address can be generated for this method.

Example:

true

max_funding_ids
integer<int32>

Maximum number of deposit addresses that may exist for this method.

Example:

10