Skip to content

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 ​

BundleAllows
TREASURY_READRead deposit details, withdrawals and balances
WITHDRAWALS_WRITESend crypto and fiat, and read withdrawals and balances
BANK_ACCOUNTS_WRITELink and remove bank accounts

Endpoints ​

Crypto deposits ​

Deposit addresses for receiving crypto, and the history of crypto deposits to your accounts.

EndpointRequestNeeds
Get a crypto deposit addressGET /v1/wallet/crypto/{currency}/deposit/addressDEPOSITS_READ
List crypto deposits for a currencyGET /v1/wallet/crypto/{currency}/deposit/historyDEPOSITS_READ
List crypto depositsGET /v1/wallet/crypto/deposit/historyDEPOSITS_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.

EndpointRequestNeeds
Get crypto withdrawal settingsGET /v1/wallet/crypto/{currency}/withdrawWITHDRAWALS_READ
Withdraw cryptoPOST /v1/wallet/crypto/{currency}/withdrawWITHDRAWALS_CREATE
Get a crypto withdrawalGET /v1/wallet/crypto/{currency}/withdraw/{id}WITHDRAWALS_READ
List crypto withdrawals for a currencyGET /v1/wallet/crypto/{currency}/withdraw/historyWITHDRAWALS_READ
Get crypto withdrawal limitsGET /v1/wallet/crypto/{currency}/withdraw/limitsWITHDRAWALS_READ
List service providersGET /v1/wallet/crypto/service-providersWITHDRAWALS_READ
List crypto withdrawalsGET /v1/wallet/crypto/withdraw/historyWITHDRAWALS_READ
Pay a crypto beneficiaryPOST /v2/crypto/paymentsWITHDRAWALS_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.

EndpointRequestNeeds
List address-book entriesGET /v1/wallet/crypto/address-bookWITHDRAWALS_READ
List address-book entries for a currencyGET /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.

EndpointRequestNeeds
List bank accountsGET /v1/wallet/fiat/{currency}/accountsWITHDRAWALS_READ
Link a bank accountPOST /v1/wallet/fiat/{currency}/accountsBANK_ACCOUNTS_MANAGE
Delete a bank accountDELETE /v1/wallet/fiat/{currency}/accounts/{id}BANK_ACCOUNTS_MANAGE
Get a bank accountGET /v1/wallet/fiat/{currency}/accounts/{id}WITHDRAWALS_READ
List banks for a currencyGET /v1/wallet/fiat/{currency}/banksWITHDRAWALS_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.

EndpointRequestNeeds
Get the account deposit referenceGET /v1/wallet/fiat/{currency}/deposit/referenceDEPOSITS_READ
Get an auto-buy deposit referenceGET /v1/wallet/fiat/{currency}/deposit/reference/{buyCurrencySymbol}DEPOSITS_READ
List auto-buy currenciesGET /v1/wallet/fiat/{currency}/auto-buyDEPOSITS_READ

Fiat withdrawals ​

Withdraw fiat to a linked bank account or pay a bank beneficiary in one call, estimate fees, and track withdrawals.

EndpointRequestNeeds
Estimate a fiat withdrawal feeGET /v1/wallet/fiat/{currency}/withdraw/estimate-feeWITHDRAWALS_READ
Withdraw fiat to a bank accountPOST /v1/wallet/fiat/{currency}/withdrawWITHDRAWALS_CREATE
List fiat withdrawalsGET /v1/wallet/fiat/{currency}/withdrawalsWITHDRAWALS_READ
Get a fiat withdrawalGET /v1/wallet/fiat/{currency}/withdrawals/{id}WITHDRAWALS_READ
Pay a bank beneficiaryPOST /v2/fiat/paymentsWITHDRAWALS_CREATE