Appearance
Wallets ​
Wallets cover money coming into and going out of your accounts: crypto deposit addresses and withdrawals, bank deposits and withdrawals, and the saved addresses and bank accounts you send to. Each account, primary or sub-account, has its own deposit addresses, deposit reference, address book and linked bank accounts, so select the account with X-VALR-SUB-ACCOUNT-ID as described in Account.
Receiving funds ​
- Crypto: Get a crypto deposit address returns the account's address for a currency on one network, creating it the first time.
- Fiat: Get the account deposit reference returns the reference to quote on a bank transfer so it's credited to that account. An auto-buy reference also uses the deposit to buy another currency.
Sending funds ​
Withdrawals are sent straight away, with no further confirmation, and any fee is charged on top of the amount. Each has an ID to follow it by.
- Crypto to an address, or to an entry in the account's address book. If your business only allows withdrawals to address-book entries, the address must already be saved there and past its waiting period.
- Fiat to a bank account linked to the same account. To link a new bank account and pay it in one call, use Pay a bank beneficiary; Pay a crypto beneficiary does the same for an address-book entry.
Check a currency's withdrawal settings and your limits before you send, and estimate fiat withdrawal fees with the fee estimate.
Following deposits and withdrawals ​
Subscribe a webhook to CRYPTO_DEPOSIT_CREDITED, FIAT_DEPOSIT_CREDITED, SEND_STATUS_UPDATE and FIAT_WITHDRAWAL_STATUS_UPDATE to hear about changes as they happen, or read the deposit and withdrawal history.
Before you start ​
| Bundle | Allows |
|---|---|
TREASURY_READ | Read deposit details, withdrawals and balances |
WITHDRAWALS_WRITE | Send crypto and fiat, and read withdrawals and balances |
BANK_ACCOUNTS_WRITE | Link and remove bank accounts |
Endpoints ​
Crypto deposits ​
Deposit addresses for receiving crypto, and the history of crypto deposits to your accounts.
| Endpoint | Request | Needs |
|---|---|---|
| Get a crypto deposit address | GET /v1/wallet/crypto/{currency}/deposit/address | DEPOSITS_READ |
| List crypto deposits for a currency | GET /v1/wallet/crypto/{currency}/deposit/history | DEPOSITS_READ |
| List crypto deposits | GET /v1/wallet/crypto/deposit/history | DEPOSITS_READ |
Crypto withdrawals ​
Send crypto to an address or a saved address-book entry, check a currency's withdrawal settings and your limits, and follow each withdrawal's progress. Withdrawals to an address hosted by another provider need the recipient's details.
| Endpoint | Request | Needs |
|---|---|---|
| Get crypto withdrawal settings | GET /v1/wallet/crypto/{currency}/withdraw | WITHDRAWALS_READ |
| Withdraw crypto | POST /v1/wallet/crypto/{currency}/withdraw | WITHDRAWALS_CREATE |
| Get a crypto withdrawal | GET /v1/wallet/crypto/{currency}/withdraw/{id} | WITHDRAWALS_READ |
| List crypto withdrawals for a currency | GET /v1/wallet/crypto/{currency}/withdraw/history | WITHDRAWALS_READ |
| Get crypto withdrawal limits | GET /v1/wallet/crypto/{currency}/withdraw/limits | WITHDRAWALS_READ |
| List service providers | GET /v1/wallet/crypto/service-providers | WITHDRAWALS_READ |
| List crypto withdrawals | GET /v1/wallet/crypto/withdraw/history | WITHDRAWALS_READ |
| Pay a crypto beneficiary | POST /v2/crypto/payments | WITHDRAWALS_CREATE |
Address book ​
Saved withdrawal addresses, with the recipient's details where they've been added. Your business can require crypto withdrawals to go only to these addresses.
| Endpoint | Request | Needs |
|---|---|---|
| List address-book entries | GET /v1/wallet/crypto/address-book | WITHDRAWALS_READ |
| List address-book entries for a currency | GET /v1/wallet/crypto/address-book/{currency} | WITHDRAWALS_READ |
Bank accounts ​
Bank accounts you withdraw fiat to, and the banks you can link. Each bank account belongs to one account, the primary or a sub-account, and only that account can withdraw to it.
| Endpoint | Request | Needs |
|---|---|---|
| List bank accounts | GET /v1/wallet/fiat/{currency}/accounts | WITHDRAWALS_READ |
| Link a bank account | POST /v1/wallet/fiat/{currency}/accounts | BANK_ACCOUNTS_MANAGE |
| Delete a bank account | DELETE /v1/wallet/fiat/{currency}/accounts/{id} | BANK_ACCOUNTS_MANAGE |
| Get a bank account | GET /v1/wallet/fiat/{currency}/accounts/{id} | WITHDRAWALS_READ |
| List banks for a currency | GET /v1/wallet/fiat/{currency}/banks | WITHDRAWALS_READ |
Fiat deposits ​
References to quote when you deposit fiat by bank transfer, including auto-buy references that use the deposit to buy another currency.
| Endpoint | Request | Needs |
|---|---|---|
| Get the account deposit reference | GET /v1/wallet/fiat/{currency}/deposit/reference | DEPOSITS_READ |
| Get an auto-buy deposit reference | GET /v1/wallet/fiat/{currency}/deposit/reference/{buyCurrencySymbol} | DEPOSITS_READ |
| List auto-buy currencies | GET /v1/wallet/fiat/{currency}/auto-buy | DEPOSITS_READ |
Fiat withdrawals ​
Withdraw fiat to a linked bank account or pay a bank beneficiary in one call, estimate fees, and track withdrawals.
| Endpoint | Request | Needs |
|---|---|---|
| Estimate a fiat withdrawal fee | GET /v1/wallet/fiat/{currency}/withdraw/estimate-fee | WITHDRAWALS_READ |
| Withdraw fiat to a bank account | POST /v1/wallet/fiat/{currency}/withdraw | WITHDRAWALS_CREATE |
| List fiat withdrawals | GET /v1/wallet/fiat/{currency}/withdrawals | WITHDRAWALS_READ |
| Get a fiat withdrawal | GET /v1/wallet/fiat/{currency}/withdrawals/{id} | WITHDRAWALS_READ |
| Pay a bank beneficiary | POST /v2/fiat/payments | WITHDRAWALS_CREATE |