# VALR Business API

> Regulated digital asset infrastructure

Collect, disburse and manage treasury from your own systems.

## Table of Contents

### Guides

- [Authentication](/guides/authentication.md): Institution API keys and how to sign requests
- [Permissions & bundles](/guides/permissions.md): The permission bundles an institution API key can hold, and the endpoints each permission opens
- [Rate limits](/guides/rate-limiting.md): Request limits per API key and per IP address, and the routes with their own per-second limits
- [Errors](/guides/errors.md): Error responses for each endpoint, plus an index of every documented error code
- [Performance](/guides/performance.md): Avoiding polling, caching, and keeping your clock and connections in good shape
- [AI support](/guides/ai-support.md): Ask questions about the API with AI-powered support, and machine-readable docs for coding assistants

### Products

- [Account](/api/account.md): Balances, sub-accounts and transfers between them, and transaction history.
- [Wallets](/api/wallets.md): Receive and send crypto and fiat, manage saved crypto addresses and linked bank accounts, and track every deposit and withdrawal.
- [Collections](/api/collections.md): Collect bank deposits from your payers with unique deposit references, then follow each payment to settlement.
- [Payouts](/api/payouts.md): Pay many bank beneficiaries in one batch from your payout account, and track every payout to completion.
- [Webhooks](/api/webhooks.md): Get an HTTPS notification when something happens on your business's accounts, instead of polling the API.
- [Public data](/api/public-data.md): Exchange status, server time, currencies and pairs, and market prices, with no API key needed.













### Deposit references

- [Get a deposit reference](/api-docs/getV2WalletFiatByCurrencyPaymentReferencesByReferenceCode.md): GET /v2/wallet/fiat/{currency}/payment/references/{referenceCode}
- [Delete a deposit reference](/api-docs/deleteV2WalletFiatByCurrencyPaymentReferencesByReferenceCode.md): DELETE /v2/wallet/fiat/{currency}/payment/references/{referenceCode}
- [Update a deposit reference](/api-docs/putV2WalletFiatByCurrencyPaymentReferencesByReferenceCode.md): PUT /v2/wallet/fiat/{currency}/payment/references/{referenceCode}
- [Create a deposit reference](/api-docs/postV2WalletFiatByCurrencyPaymentReferences.md): POST /v2/wallet/fiat/{currency}/payment/references
- [List deposit references](/api-docs/getV2WalletFiatByCurrencyPaymentReferences.md): GET /v2/wallet/fiat/{currency}/payment/references
- [Create deposit references in bulk](/api-docs/postV2WalletFiatByCurrencyPaymentBulkReferences.md): POST /v2/wallet/fiat/{currency}/payment/bulk-references
- [Get a bulk reference job](/api-docs/getV2WalletFiatByCurrencyPaymentBulkReferencesByJobId.md): GET /v2/wallet/fiat/{currency}/payment/bulk-references/{jobId}
- [List bulk reference job items](/api-docs/getV2WalletFiatByCurrencyPaymentBulkReferencesByJobIdItems.md): GET /v2/wallet/fiat/{currency}/payment/bulk-references/{jobId}/items
- [List credited deposits](/api-docs/getV2WalletFiatByCurrencyPaymentDeposits.md): GET /v2/wallet/fiat/{currency}/payment/deposits
- [Unlink a deposit from its reference](/api-docs/deleteV2WalletFiatByCurrencyPaymentDepositsByPublicIdReference.md): DELETE /v2/wallet/fiat/{currency}/payment/deposits/{publicId}/reference
- [Link a deposit to a reference](/api-docs/putV2WalletFiatByCurrencyPaymentDepositsByPublicIdReference.md): PUT /v2/wallet/fiat/{currency}/payment/deposits/{publicId}/reference

### Balances

- [Get balances](/api-docs/getV1AccountBalances.md): GET /v1/account/balances
- [Get balances for all accounts](/api-docs/getV1AccountBalancesAll.md): GET /v1/account/balances/all

### Disbursements

- [Get a disbursement batch](/api-docs/getV2PaymentsBulkWithdrawalsBatchesById.md): GET /v2/payments/bulk-withdrawals/batches/{id}
- [List supported banks](/api-docs/getV2PaymentsBulkWithdrawalsBanks.md): GET /v2/payments/bulk-withdrawals/banks
- [List disbursement batches](/api-docs/getV2PaymentsBulkWithdrawalsBatches.md): GET /v2/payments/bulk-withdrawals/batches
- [Create a disbursement batch](/api-docs/postV2PaymentsBulkWithdrawalsBatches.md): POST /v2/payments/bulk-withdrawals/batches
- [Cancel a disbursement batch](/api-docs/postV2PaymentsBulkWithdrawalsBatchesByIdCancel.md): POST /v2/payments/bulk-withdrawals/batches/{id}/cancel
- [Get a batch's fee quote](/api-docs/getV2PaymentsBulkWithdrawalsBatchesByIdFeeQuote.md): GET /v2/payments/bulk-withdrawals/batches/{id}/fee-quote
- [Rename a disbursement batch](/api-docs/putV2PaymentsBulkWithdrawalsBatchesByIdLabel.md): PUT /v2/payments/bulk-withdrawals/batches/{id}/label
- [List a batch's withdrawals](/api-docs/getV2PaymentsBulkWithdrawalsBatchesByIdWithdrawals.md): GET /v2/payments/bulk-withdrawals/batches/{id}/withdrawals
- [Quote fees for withdrawals](/api-docs/postV2PaymentsBulkWithdrawalsFeeQuote.md): POST /v2/payments/bulk-withdrawals/fee-quote
- [List withdrawals](/api-docs/getV2PaymentsBulkWithdrawalsWithdrawals.md): GET /v2/payments/bulk-withdrawals/withdrawals
- [List payout account transactions](/api-docs/getV2PaymentsPayoutHistory.md): GET /v2/payments/payout/history
- [Get a payout account transaction](/api-docs/getV2PaymentsPayoutHistoryById.md): GET /v2/payments/payout/history/{id}

### Webhooks

- [List webhooks](/api-docs/getV1Webhooks.md): GET /v1/webhooks
- [Create a webhook](/api-docs/postV1Webhooks.md): POST /v1/webhooks
- [Delete a webhook](/api-docs/deleteV1WebhooksById.md): DELETE /v1/webhooks/{id}
- [Get a webhook](/api-docs/getV1WebhooksById.md): GET /v1/webhooks/{id}
- [Update a webhook](/api-docs/putV1WebhooksById.md): PUT /v1/webhooks/{id}
- [List webhook delivery attempts](/api-docs/getV1WebhooksByIdDeliveries.md): GET /v1/webhooks/{id}/deliveries
- [Get a webhook event](/api-docs/getV1WebhooksByIdEventsByEventId.md): GET /v1/webhooks/{id}/events/{eventId}
- [List webhook event types](/api-docs/getV1WebhooksEventTypes.md): GET /v1/webhooks/event-types

### Getting paid

- [List payments](/api-docs/getV2Payments.md): GET /v2/payments
- [Get a payment](/api-docs/getV2PaymentsById.md): GET /v2/payments/{id}
- [List collection activity](/api-docs/getV2PaymentsCollectionsHistory.md): GET /v2/payments/collections/history

### Collection schedules

- [List queued scheduled payments](/api-docs/getV2PaymentsCollectEvents.md): GET /v2/payments/collect/events
- [Get a scheduled payment](/api-docs/getV2PaymentsCollectEventsById.md): GET /v2/payments/collect/events/{id}
- [List processed scheduled payments](/api-docs/getV2PaymentsCollectHistory.md): GET /v2/payments/collect/history
- [Get a payout run](/api-docs/getV2PaymentsCollectRunsById.md): GET /v2/payments/collect/runs/{id}
- [List a payout run's payments](/api-docs/getV2PaymentsCollectRunsByIdPayments.md): GET /v2/payments/collect/runs/{id}/payments
- [List payout runs](/api-docs/getV2PaymentsCollectRunsHistory.md): GET /v2/payments/collect/runs/history
- [List payout schedules](/api-docs/getV2PaymentsCollectSchedules.md): GET /v2/payments/collect/schedules
- [Get upcoming scheduled payouts](/api-docs/getV2PaymentsCollectUpcoming.md): GET /v2/payments/collect/upcoming

### Settlements

- [List settlements](/api-docs/getV2PaymentsCollectSettlements.md): GET /v2/payments/collect/settlements
- [Get a settlement](/api-docs/getV2PaymentsCollectSettlementsById.md): GET /v2/payments/collect/settlements/{id}
- [List a settlement's payments](/api-docs/getV2PaymentsCollectSettlementsByIdPayments.md): GET /v2/payments/collect/settlements/{id}/payments
- [Get the settlement wallet](/api-docs/getV2PaymentsCollectSettlementsWallet.md): GET /v2/payments/collect/settlements/wallet

### Payments balances

- [Get payments account balances](/api-docs/getV2PaymentsAccountBalancesByType.md): GET /v2/payments/account/balances/{type}

### Beneficiaries

- [List beneficiaries](/api-docs/getV2PaymentsBulkWithdrawalsBeneficiaries.md): GET /v2/payments/bulk-withdrawals/beneficiaries
- [Create a beneficiary](/api-docs/postV2PaymentsBulkWithdrawalsBeneficiaries.md): POST /v2/payments/bulk-withdrawals/beneficiaries
- [Archive a beneficiary](/api-docs/deleteV2PaymentsBulkWithdrawalsBeneficiariesById.md): DELETE /v2/payments/bulk-withdrawals/beneficiaries/{id}
- [Get a beneficiary](/api-docs/getV2PaymentsBulkWithdrawalsBeneficiariesById.md): GET /v2/payments/bulk-withdrawals/beneficiaries/{id}
- [Update a beneficiary](/api-docs/putV2PaymentsBulkWithdrawalsBeneficiariesById.md): PUT /v2/payments/bulk-withdrawals/beneficiaries/{id}
- [Create beneficiaries in bulk](/api-docs/postV2PaymentsBulkWithdrawalsBeneficiariesBulk.md): POST /v2/payments/bulk-withdrawals/beneficiaries/bulk

### Crypto deposits

- [Get a crypto deposit address](/api-docs/getV1WalletCryptoByCurrencyDepositAddress.md): GET /v1/wallet/crypto/{currency}/deposit/address
- [List crypto deposits for a currency](/api-docs/getV1WalletCryptoByCurrencyDepositHistory.md): GET /v1/wallet/crypto/{currency}/deposit/history
- [List crypto deposits](/api-docs/getV1WalletCryptoDepositHistory.md): GET /v1/wallet/crypto/deposit/history

### Crypto withdrawals

- [Get crypto withdrawal settings](/api-docs/getV1WalletCryptoByCurrencyWithdraw.md): GET /v1/wallet/crypto/{currency}/withdraw
- [Withdraw crypto](/api-docs/postV1WalletCryptoByCurrencyWithdraw.md): POST /v1/wallet/crypto/{currency}/withdraw
- [Get a crypto withdrawal](/api-docs/getV1WalletCryptoByCurrencyWithdrawById.md): GET /v1/wallet/crypto/{currency}/withdraw/{id}
- [List crypto withdrawals for a currency](/api-docs/getV1WalletCryptoByCurrencyWithdrawHistory.md): GET /v1/wallet/crypto/{currency}/withdraw/history
- [Get crypto withdrawal limits](/api-docs/getV1WalletCryptoByCurrencyWithdrawLimits.md): GET /v1/wallet/crypto/{currency}/withdraw/limits
- [List service providers](/api-docs/getV1WalletCryptoServiceProviders.md): GET /v1/wallet/crypto/service-providers
- [List crypto withdrawals](/api-docs/getV1WalletCryptoWithdrawHistory.md): GET /v1/wallet/crypto/withdraw/history
- [Pay a crypto beneficiary](/api-docs/postV2CryptoPayments.md): POST /v2/crypto/payments

### Address book

- [List address-book entries](/api-docs/getV1WalletCryptoAddressBook.md): GET /v1/wallet/crypto/address-book
- [List address-book entries for a currency](/api-docs/getV1WalletCryptoAddressBookByCurrency.md): GET /v1/wallet/crypto/address-book/{currency}

### Bank accounts

- [List bank accounts](/api-docs/getV1WalletFiatByCurrencyAccounts.md): GET /v1/wallet/fiat/{currency}/accounts
- [Link a bank account](/api-docs/postV1WalletFiatByCurrencyAccounts.md): POST /v1/wallet/fiat/{currency}/accounts
- [Delete a bank account](/api-docs/deleteV1WalletFiatByCurrencyAccountsById.md): DELETE /v1/wallet/fiat/{currency}/accounts/{id}
- [Get a bank account](/api-docs/getV1WalletFiatByCurrencyAccountsById.md): GET /v1/wallet/fiat/{currency}/accounts/{id}
- [List banks for a currency](/api-docs/getV1WalletFiatByCurrencyBanks.md): GET /v1/wallet/fiat/{currency}/banks

### Fiat deposits

- [Get the account deposit reference](/api-docs/getV1WalletFiatByCurrencyDepositReference.md): GET /v1/wallet/fiat/{currency}/deposit/reference
- [Get an auto-buy deposit reference](/api-docs/getV1WalletFiatByCurrencyDepositReferenceByBuyCurrencySymbol.md): GET /v1/wallet/fiat/{currency}/deposit/reference/{buyCurrencySymbol}
- [List auto-buy currencies](/api-docs/getV1WalletFiatByCurrencyAutoBuy.md): GET /v1/wallet/fiat/{currency}/auto-buy

### Fiat withdrawals

- [Estimate a fiat withdrawal fee](/api-docs/getV1WalletFiatByCurrencyWithdrawEstimateFee.md): GET /v1/wallet/fiat/{currency}/withdraw/estimate-fee
- [Withdraw fiat to a bank account](/api-docs/postV1WalletFiatByCurrencyWithdraw.md): POST /v1/wallet/fiat/{currency}/withdraw
- [List fiat withdrawals](/api-docs/getV1WalletFiatByCurrencyWithdrawals.md): GET /v1/wallet/fiat/{currency}/withdrawals
- [Get a fiat withdrawal](/api-docs/getV1WalletFiatByCurrencyWithdrawalsById.md): GET /v1/wallet/fiat/{currency}/withdrawals/{id}
- [Pay a bank beneficiary](/api-docs/postV2FiatPayments.md): POST /v2/fiat/payments

### Transaction history

- [List transactions](/api-docs/getV1AccountTransactionhistory.md): GET /v1/account/transactionhistory
- [List transactions for all sub-accounts](/api-docs/getV1AccountTransactionhistorySubaccounts.md): GET /v1/account/transactionhistory/subaccounts

### Sub-accounts

- [List sub-accounts](/api-docs/getV1AccountSubaccounts.md): GET /v1/account/subaccounts
- [Get a sub-account](/api-docs/getV1AccountSubaccountByAccountPublicId.md): GET /v1/account/subaccount/{accountPublicId}
- [Create a sub-account](/api-docs/postV1AccountSubaccount.md): POST /v1/account/subaccount
- [Rename a sub-account](/api-docs/putV1AccountSubaccount.md): PUT /v1/account/subaccount
- [Delete a sub-account](/api-docs/deleteV1AccountSubaccount.md): DELETE /v1/account/subaccount
- [Transfer between accounts](/api-docs/postV1AccountSubaccountsTransfer.md): POST /v1/account/subaccounts/transfer

### Status and time

- [Get the server time](/api-docs/getV1PublicTime.md): GET /v1/public/time
- [Get the exchange status](/api-docs/getV1PublicStatus.md): GET /v1/public/status

### Market prices

- [List market summaries](/api-docs/getV1PublicMarketsummary.md): GET /v1/public/marketsummary
- [Get a pair's market summary](/api-docs/getV1PublicByCurrencyPairMarketsummary.md): GET /v1/public/{currencyPair}/marketsummary
- [List price buckets](/api-docs/getV1PublicByCurrencyPairBuckets.md): GET /v1/public/{currencyPair}/buckets

### Currencies and pairs

- [List currencies](/api-docs/getV1PublicCurrencies.md): GET /v1/public/currencies
- [List currency pairs](/api-docs/getV1PublicPairs.md): GET /v1/public/pairs
- [List currency pairs by type](/api-docs/getV1PublicPairsByType.md): GET /v1/public/pairs/{type}

### Other

- [API Reference](/api.md): VALR Business API reference for institution API keys