Get deposit addresses

POST 
/0/private/DepositAddresses

Retrieve (or generate a new) deposit addresses for a particular asset and funding method. Use the Get Deposit Methods API to identify the appropriate deposit method.

Request

Header Parameters

x-vault-id stringrequired
Possible values: >= 12 characters and <= 19 characters, Value must match regular expression (^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$|AA[A-Z0-9]{2} ?[A-Z0-9]{4} ?[A-Z0-9]{4} ?[A-Z0-9]{4})
Vault ID or Vault IIBAN
Example: VOBJAQBMOKYR3K or AA73 N84G ZI3B MCFQ

application/json

Body

nonce int64required

Nonce used in construction of API-Sign header

aclass string

Possible values: [currency, forex, equity, equitypair, nft, volume]

Default value: currency

asset stringrequired

Possible values: non-empty and <= 16 characters

method stringrequired

Name of the deposit method

new boolean

Whether or not to generate a new address

Responses

default

Response

application/json

Schema

Schema

error object[]required
Array [
severity stringrequired
Possible values: [E, W]
API error severity.
errorClass stringrequired
type stringrequired
errorMessage stringnullable
]
result object[]nullable
Array [
address stringrequired
expiretm string
Default value: 0
memo stringnullable
new booleannullable
tag stringnullable
]

Example (from schema)

{
  "error": [
    {
      "severity": "E",
      "errorClass": "string",
      "type": "string",
      "errorMessage": "string"
    }
  ],
  "result": [
    {
      "address": "string",
      "expiretm": "string",
      "memo": "string",
      "new": true,
      "tag": "string"
    }
  ]
}

Loading...