Manage Crypto Addresses
Add, delete, and view crypto addresses
Headers
All requests will require the following headers
x-api-key*
String
{{x-api-key}}
API Auth Key
x-signature*
String
Signature created using your API secret
x-nonce*
String
Timestamp in millisecond
Add Crypto Address
Add a crypto address to your address book for withdrawals and deposits.
POST https://api.aquanow.io/users/v2/addressBook
Payload
currencyType
string
required
Must be “crypto”; specifies that this is a crypto address entry.
currency
string
optional
Crypto currency (e.g. “BTC”). If omitted, the address applies to all currencies supported on the specified network;
networkSymbol
string
required
Network identifier for the address
address
string
required
Destination/source address string.
addressTagMemo
string
optional
Tag/memo if supported by the network (e.g., destination tag for XRP, memo for XLM).
externalReferenceId
string
optional
Client-defined reference/alias for the saved address.
acceptTerms
boolean
required
Must be true; confirms legal and beneficial ownership/control.
addressType
array
required
Array of values: "sourceAddress", "withdrawalAddress". Indicates usage for incoming funds, withdrawals, or both.
walletType
string
required
One of: “SELF_HOSTED”, “VASP”, “OTHER_VASP”. Where the wallet is hosted.
vaspId
string
conditional
Required if walletType = “VASP”.
A valid vaspId can be retrieved from
https://docs.aquanow.io/pay/api-endpoints/wallet-types-api
vaspName
string
conditional
Required if walletType = “OTHER_VASP”.
vaspWebsite
string
optional
Optional when walletType = “OTHER_VASP”.
Example
Response
When acceptTerms: false
Delete Crypto Address
Delete a crypto address using the addressBookId
DELETE https://api.aquanow.io/users/v2/addressBook/{id}
Path Parameters
id*
String
Unique identifier of the crypto address to delete
Response
Get Crypto Addresses
Fetch a list of all addresses matching the query parameters. If currencyType is not specified, it will fetch Bank Instructions and Crypto Addresses.
Query Parameters
currencyType
string
optional
currency
string
optional
network
string
optional
address
string
optional
addressTagMemo
string
optional
addressType
string
optional
externalReferenceId
string
optional
addressBookId
string
optional
Examples
Filter by the unique identifier addressBookId
GET https://api.aquanow.io/users/v2/addressBook??addressBookId={addressBookId}
Response
Filter by addressType
GET https://api.aquanow.io/users/v2/addressBook?addressType=sourceAddress
Filter by multiple query search parameters
GET https://api.aquanow.io/users/v2/addressBook?addressType=sourceAddress¤cy=ALL&networkSymbol=SOL
Note: When querying by currency , it will also return addresses that support all currencies in that network. Some addresses returned will have currency: ALL
For example:
GET https://api.aquanow.io/users/v2/addressBook?addressType=sourceAddress¤cy=ETH
Last updated