Create address
Generates a new deposit address for the vault and deposit method. The response carries the new address along with deposit fee, minimum and maximum amounts, expiration timestamp, and the asset and asset class the method belongs to. The request fails with TooManyAddresses when the maximum number of addresses for the method has been reached.
Rate limit: 200 requests per 30 seconds per IP.
Authorizations
Path Parameters
Deposit method identifier returned by the list deposit methods endpoint.
"11111111-1111-1111-1111-111111111111"
Vault identifier, a V-prefixed 14-char base32 string with a final check character.
"VABCDEF234567A"
Body
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 code the address belongs to (e.g. BTC, USD).
"BTC"
Asset class of the deposit method. Currently always currency.
"currency"
Deposit address string for the underlying chain.
"bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"
Destination tag for assets that require it, such as XRP or XLM.
"123456"
Memo for chains that route by memo instead of tag, such as EOS.
"deposit-memo-001"
Human-readable label assigned to the address.
"Primary deposit"
Address expiration time as a Unix timestamp in seconds. Empty when the address does not expire.
"1735689600"
Whether this address was generated for the current request.
true
Deposit fee, fixed-precision decimal as string.
"0.00000000"
Minimum deposit amount, fixed-precision decimal as string.
"0.00100000"
Maximum deposit amount, fixed-precision decimal as string. Empty when there is no upper bound.
"100.00000000"
Whether another deposit address can be generated for this method.
true
Maximum number of deposit addresses that may exist for this method.
10