# BVNK API Documentation > Complete API documentation for BVNK payment infrastructure—crypto payments, wallets, and financial services This file contains links to documentation sections following the llmstxt.org standard. ## Table of Contents - [API Schema Embed Demo](https://docs.bvnk.com/bvnk/get-started/api-schema-embed-demo.md): Demonstrates ApiSchema and ApiExample components for embedding endpoint data in guides. - [Charge customer fees](https://docs.bvnk.com/bvnk/get-started/charge-customer-fees.md): As a partner, you can add a markup fee to your customers' transactions, enabling you to collect additional revenue from your customers. - [Configure webhooks](https://docs.bvnk.com/bvnk/get-started/create-webhook-listener.md): Webhooks are a form of event-driven communication that execute immediately after a specific event occurs. When something happens in your BVNK accou... - [Create a wallet (v.1)](https://docs.bvnk.com/bvnk/get-started/creating-your-first-wallet.md): :::warning DEPRECATED - [Select your delivery model](https://docs.bvnk.com/bvnk/get-started/delivery-models.md): This article outlines the available BVNK delivery models. - [Find your use case](https://docs.bvnk.com/bvnk/get-started/find-your-usecase.md): Use this table to quickly identify which BVNK use case matches your business needs. Compare use cases to understand the target industries, currency... - [Create API keys](https://docs.bvnk.com/bvnk/get-started/generate-api-keys.md): BVNK uses **Hawk authentication** to secure API access. Hawk is a cryptographic scheme that ensures request integrity and authentication without tr... - [Get started with BVNK](https://docs.bvnk.com/bvnk/get-started/get-started-w-bvnk.md): Begin seamless and efficient stablecoin payments with BVNK. This page outlines the five steps from initial setup to going live: - [Mastercard Global Money Platform](https://docs.bvnk.com/bvnk/get-started/global-money-platform.md): The Mastercard Global Money Platform provides unified infrastructure to hold, convert, send, receive, and spend both fiat currencies and stablecoin... - [Manage wallets](https://docs.bvnk.com/bvnk/get-started/manage-wallet.md): To get notified each time a wallet's status changes, listen to the [wallet notification](../../api-explorer/bvnk-webhooks/ledger-wallet-status-chan... - [Migrate from Wallets v.1 to v.2](https://docs.bvnk.com/bvnk/get-started/migrate-wallets-v1-to-v2.md): The Wallets API v.2 replaces v.1 endpoints, offering a simpler request model, more detailed responses, advanced Lucene-based filtering, and enhance... - [Try fiat payments in simulator](https://docs.bvnk.com/bvnk/get-started/payment-sim.md): The sandbox environment provides a consistent simulation experience for pay-ins and payouts across all customer accounts. This ensures predictable ... - [Add Ethereum wallet for ETH and USDT/USDC](https://docs.bvnk.com/bvnk/get-started/set-up-metamask-ethereum-wallet-for-eth-and-usdt-erc20-tokens.md):
- [Add TronLink wallet for TRX and USDT](https://docs.bvnk.com/bvnk/get-started/set-up-tronlink-wallet-for-trx-and-usdt-trc20-tokens.md):
- [Set up wallets](https://docs.bvnk.com/bvnk/get-started/set-up-wallets.md): :::info Wallets API v.2 - [Create an internal transfer (v.3)](https://docs.bvnk.com/bvnk/use-cases/create-internal-transfer-v3.md): :::warning - [Create an internal transfer (Legacy)](https://docs.bvnk.com/bvnk/use-cases/create-internal-transfer.md): This endpoint is used to facilitate internal transfers. You can transfer both fiat and crypto funds. - [Migrate from the Quote API to Transfers v.3](https://docs.bvnk.com/bvnk/use-cases/migrate-quote-to-transfers-v3.md): The Transfers v.3 API replaces the legacy Quote API for wallet-to-wallet currency conversion. Instead of creating a standalone quote and accepting ... - [Currencies](https://docs.bvnk.com/bvnk/references/currencies.md): Comprehensive list of supported fiat and crypto currencies on the BVNK platform - [Date and time](https://docs.bvnk.com/bvnk/references/date-time.md): Date and times are encoded into UNIX epoch timestamps, including milliseconds, for example, `1566203005000` is `Monday, August 19, 2019 8:23:25 AM`. - [Glossary](https://docs.bvnk.com/bvnk/references/glossary.md):
[A](#a) • [B](#b) • [C](#c) • [D](#d) • [E](#e) • [F](#f) • [H](#h) • [I](#i) • [K](#k) • [M]... - [Industry references](https://docs.bvnk.com/bvnk/references/industy-references.md): This is a definitive list of industries and sub-industries which can be included in the payload when creating a customer. - [Monthly expected volumes](https://docs.bvnk.com/bvnk/references/monthly-expected-volumes.md): This is a definitive list of Expected Monthly Volume values which can be included in the payload when creating a customer. - [Payment schemes](https://docs.bvnk.com/bvnk/references/payment-methods.md): Comprehensive guide to supported payment schemes and integration options on the BVNK platform - [Third-party providers](https://docs.bvnk.com/bvnk/references/third-party-providers.md): The revised Payment Services Directive (PSD2) was enacted on 13 January 2018 across Europe and the UK. PSD2 introduced new rights for certain third... - [Uptime and incident handling](https://docs.bvnk.com/bvnk/references/uptime-and-incident-handling.md): At BVNK, we understand the critical importance of maintaining consistent and reliable service. We are dedicated to providing an **uptime of 99.90% ... - [Webhook signature validator](https://docs.bvnk.com/bvnk/references/webhook-validator.md): Validate BVNK webhook signatures client-side without sending sensitive data to external servers - [BVNK Main API](https://docs.bvnk.com/api/bvnk-main-api.md): Welcome to the BVNK Main API documentation. This API enables seamless and secure transactions, including payments, channels, and digital wallet ope... - [Authentication](https://docs.bvnk.com/bvnk/api-explorer/api-overview/authentication.md): Most interactions with the BVNK Crypto Payments API require the use of the API keys. - [Errors](https://docs.bvnk.com/bvnk/api-explorer/api-overview/errors.md):
- [Idempotency](https://docs.bvnk.com/bvnk/api-explorer/api-overview/idempotency.md): Some API endpoints support idempotency, allowing you to safely retry requests without duplicating actions. - [Metadata](https://docs.bvnk.com/bvnk/api-explorer/api-overview/metadata.md): You can include custom metadata in some requests. For example, in the payout requests the metadata will be associated with the payout and included ... - [Overview](https://docs.bvnk.com/bvnk/api-explorer/api-overview/overview.md): The BVNK RESTful API is designed to enable seamless and secure transactions, including payments, channels, and digital wallet operations. The API o... - [Pagination](https://docs.bvnk.com/bvnk/api-explorer/api-overview/pagination.md): By default, most of the "List" endpoints return paginated results. Use the query parameters `page` and `size` to control the number of results disp... - [Postman Collection](https://docs.bvnk.com/bvnk/api-explorer/api-overview/testing-the-api-endpoints-using-a-postman-collection.md): You can easily test our API before you start developing your app using our Postman Collection.\ - [Agreement status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/agreement-status-change.md): :::info A newer version of this webhook is available - [Associate documents status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/associate-documents-status-change.md): :::info A newer version of this webhook is available - [Associate status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/associate-status-change.md): :::info A newer version of this webhook is available - [BVNK Webhooks API](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/bvnk-webhooks-api.md): BVNK Webhooks API provides real-time notifications for various events across the BVNK platform. - [Card updated notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/card-card-updated.md): Triggered when a card's status or configuration changes. - [Card transaction status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/card-transaction-status-change.md): Triggered when a card transaction changes status (for example, from `AUTHORIZED` to `SETTLED`, or from `PENDING` to `DECLINED`). - [Channel created](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/channel-created.md): The `bvnk:payment:channel:created` webhook is triggered when a new crypto payment **channel** is successfully created for a wallet. - [Channel transaction confirmed](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/channel-transaction-confirmed.md): The `bvnk:payment:channel:transaction-confirmed` webhook is triggered when a new channel transaction is confirmed on chain, and the transaction has... - [Channel transaction detected](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/channel-transaction-detected.md): The `bvnk:payment:channel:transaction-detected` webhook is triggered when a new channel transaction is detected, and the transaction has not yet be... - [Channel transaction placed on hold](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/channel-transaction-on-hold.md): The `bvnk:payment:channel:transaction-on-hold` webhook is triggered when a transaction sent to a channel is placed on hold under BVNKs compliance p... - [Company documents status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/company-documents-status-change.md): :::info A newer version of this webhook is available - [Compliance information request](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/compliance-information-request.md): Triggered when additional information is required to comply with the Travel Rule for a related crypto payment. - [Cryptocurrency refund initiated](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/crypto-refund-initiated.md): Triggered when a cryptocurrency payment refund is initiated. - [Cryptocurrency payment status change](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/crypto-status-change.md): Triggered when the status of a cryptocurrency payment changes. - [Cryptocurrency transaction late](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/crypto-transaction-late.md): Triggered when a cryptocurrency transaction is received after the payment has expired or been completed. - [Cryptocurrency transaction on hold](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/crypto-transaction-on-hold.md): Triggered when a cryptocurrency transaction is placed on hold under BVNK's compliance program. - [Customer document status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/customer-document-status-change.md): Triggered when a customer document verification status changes. - [Customer status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/customer-status-change.md): Triggered when a customer's status changes to `INFO_REQUIRED`, `PENDING`, `VERIFIED`, or `REJECTED`. - [Customer update notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/customer-update.md): Triggered when customer information is updated. This is usually done by a verification provider's link when customer data is populated from the ver... - [Customer status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/customers-status-change.md): :::info A newer version of this webhook is available - [Ledger report ready notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/ledger-report-ready.md): Triggered when a ledger report is ready for download. - [Ledger wallet creation notification (v1)](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/ledger-wallet-create.md): A wallet creation webhook provides real-time notifications to your system when a new wallet is successfully created. - [Ledger wallet status change notification (v2)](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/ledger-wallet-status-change-v-2.md): Triggered when a wallet status changes. - [Fiat pay-in status change notification (v2)](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/payment-payin-status-change-v-2.md): Triggered when the status of an incoming fiat payment changes (version 2). - [Fiat payment status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/payment-payin-status-change.md): Triggered when the status of an incoming fiat payment changes. - [Fiat payout status change notification (v2)](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/payment-payout-status-change-v-2.md): Triggered when the status of an outgoing fiat payment changes (version 2). - [Fiat payout status change notification (v1)](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/payment-payout-status-change.md): Triggered when the status of an outgoing fiat payment changes (version 1). - [Internal transfer status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/payment-transfer-status-change-v-2.md): Triggered when the status of an internal payment transfer changes (version 2). - [Internal transfer status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/payment-transfer-status-change-v-3.md): Triggered when the status of an internal payment transfer changes (version 3). - [Internal transfer status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/payment-transfer-status-change.md): Triggered when the status of an internal payment transfer changes (version 1). - [Agreement status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/platform-customer-agreement-status-change.md): **Event URN:** `platform:accounts:customer:agreement-status-change` - [Associate deleted notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/platform-customer-associate-deleted.md): **Event URN:** `platform:accounts:customer:associate-deleted` - [Associate document status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/platform-customer-associate-document-status-change.md): **Event URN:** `platform:accounts:customer:associate-document-status-change` - [Associate status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/platform-customer-associate-status-change.md): **Event URN:** `platform:accounts:customer:associate-status-change` - [Customer created notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/platform-customer-created.md): **Event URN:** `platform:accounts:customer:created` - [Customer data updated notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/platform-customer-data-updated.md): **Event URN:** `platform:accounts:customer:data-updated` - [Customer document status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/platform-customer-document-status-change.md): **Event URN:** `platform:accounts:customer:document-status-change` - [Customer initialized notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/platform-customer-initialized.md): **Event URN:** `platform:accounts:customer:initialized` - [Customer status change notification](https://docs.bvnk.com/bvnk/api-explorer/bvnk-webhooks/platform-customer-status-change.md): **Event URN:** `platform:accounts:customer:status-change` - [Cards API](https://docs.bvnk.com/bvnk/api-explorer/cards/cards-api.md): The BVNK Cards API enables you to issue and manage virtual cards for your customers. You can create cards linked to BVNK wallets, manage card lifec... - [Create card](https://docs.bvnk.com/bvnk/api-explorer/cards/create-card.md): Creates a new virtual card linked to a specified BVNK wallet. The card is issued in a `CREATED` state. Shortly after, the asynchronous issuing proc... - [Cancel card](https://docs.bvnk.com/bvnk/api-explorer/cards/delete-card.md): Permanently cancels a card by setting its status to `CANCELLED`. This action is irreversible: once cancelled, the card cannot be reactivated. Any p... - [Get card transaction](https://docs.bvnk.com/bvnk/api-explorer/cards/get-card-transaction.md): Retrieves the full details of a single card transaction by its unique identifier. The response includes transaction amounts, merchant metadata, pro... - [List card transactions](https://docs.bvnk.com/bvnk/api-explorer/cards/get-card-transactions.md): Retrieves a paginated list of card transactions for the authenticated tenant. A date range is required in the query. - [Get card](https://docs.bvnk.com/bvnk/api-explorer/cards/get-card.md): Retrieves the details of a single card by its unique identifier. The response includes the card's current status, spend limit configuration, availa... - [List cards](https://docs.bvnk.com/bvnk/api-explorer/cards/get-cards.md): Retrieves a paginated list of cards for the authenticated tenant. Use the query parameter to filter cards by customer ID, status, or card ID. - [Check eligibility status](https://docs.bvnk.com/bvnk/api-explorer/cards/get-eligibility-status.md): Checks whether a customer meets all eligibility requirements for card issuance. Returns a list of any outstanding requirements that must be fulfill... - [Get sensitive card details token](https://docs.bvnk.com/bvnk/api-explorer/cards/get-sensitive-card-details-token.md): Obtains a one-time, short-lived token that can be used to retrieve encrypted sensitive card details. This is the first step in the two-step sensiti... - [Renew card](https://docs.bvnk.com/bvnk/api-explorer/cards/renew-card.md): Creates a new replacement card from a cancelled or expired card's configuration. The new card is issued in `CREATED` state with the same wallet, as... - [Simulate authorization](https://docs.bvnk.com/bvnk/api-explorer/cards/simulate-authorization.md): Create a simulated card authorization transaction for testing purposes. Only available in the sandbox environment. - [Simulate transaction update](https://docs.bvnk.com/bvnk/api-explorer/cards/simulate-transaction-update.md): Simulate a transaction state change on a previously simulated authorization. Use this to test settlement, reversal, and refund flows. Only availabl... - [Update card limit](https://docs.bvnk.com/bvnk/api-explorer/cards/update-card-limit.md): Updates the spend limit of an existing card. You can change the limit type (daily, monthly, yearly, or per-transaction) and the maximum amount. - [Update card status](https://docs.bvnk.com/bvnk/api-explorer/cards/update-card-status.md): Updates the status of an existing card. Use this endpoint to freeze or unfreeze a card. - [Check dispute eligibility](https://docs.bvnk.com/bvnk/api-explorer/cards/validate-dispute-eligibility.md): Checks whether a specific card transaction is eligible for dispute submission. A transaction may be ineligible if it has already been disputed, is ... - [Accept assigned agreement](https://docs.bvnk.com/bvnk/api-explorer/endpoints/accept-onboarding-assigned-agreement.md): Accepts an assigned agreement. Agreement status transitions from `PENDING` to `ACCEPTED`. - [Bulk respond to customer agreements](https://docs.bvnk.com/bvnk/api-explorer/endpoints/bulk-respond-pre-customer-agreements-v-2.md): Accept or reject up to 50 agreements within a single working set in one call. The request is scoped by the partner-supplied `reference`; each `acti... - [BVNK API Endpoints](https://docs.bvnk.com/bvnk/api-explorer/endpoints/bvnk-api-endpoints.md): The BVNK API is designed to facilitate seamless and secure transactions including payments, channels, and digital wallet transactions. - [Create channel](https://docs.bvnk.com/bvnk/api-explorer/endpoints/channel-create.md): Creates a channel through which your customers can send crypto payments. - [List channels](https://docs.bvnk.com/bvnk/api-explorer/endpoints/channel-list.md): Retrieves all channels related to a Wallet ID. - [List channel payments](https://docs.bvnk.com/bvnk/api-explorer/endpoints/channel-payment-list.md): Retrieves a list of payments to a channel on a specific Wallet ID. - [Get channel payment](https://docs.bvnk.com/bvnk/api-explorer/endpoints/channel-payment-read.md): Retrieves a specific payment made into a channel. - [Get channel](https://docs.bvnk.com/bvnk/api-explorer/endpoints/channel-read.md): Retrieves a specific channel by its UUID. - [Get channel spot rate](https://docs.bvnk.com/bvnk/api-explorer/endpoints/channel-spot-rate.md): Poll the current spot rate for a channel. Use this endpoint if you are building your own UI and need to display the live conversion rate to customers. - [Submit originator data for Travel rule information request](https://docs.bvnk.com/bvnk/api-explorer/endpoints/compliance-information-request-action.md): Submits originator information for a crypto payment that BVNK is holding under the Travel Rule after the customer has sent the payment. - [Create agreement signing session](https://docs.bvnk.com/bvnk/api-explorer/endpoints/create-agreement-session.md): Creates a session for customers to agree to the conditions and requirements. - [Create business customer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/create-business-customer-onboarding-application.md): Creates a business customer onboarding application in a single request. Submit company details, associates, and business profile together. BVNK enr... - [Create contact](https://docs.bvnk.com/bvnk/api-explorer/endpoints/create-contact-v-3.md): :::warning Beta - [Create customer associate](https://docs.bvnk.com/bvnk/api-explorer/endpoints/create-customer-associate-v-2.md): Creates an associate under a customer onboarding application. The `entity` payload is discriminated by `type`: use `PERSON` for a natural person (U... - [Create customer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/create-customer-v-2.md): Starts a new customer onboarding application. Submit either a `company` or `individual` payload together with the `useCase`. - [Create fiat wallet](https://docs.bvnk.com/bvnk/api-explorer/endpoints/create-customer-wallet.md): Creates a fiat wallet for a specific Customer, generating a unique virtual account tied to the wallet. - [Create customer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/create-customer.md): :::warning - [Create deposit](https://docs.bvnk.com/bvnk/api-explorer/endpoints/create-deposit.md): Allocates funds from a same-currency wallet into a portfolio so they start earning rewards. The source wallet must hold sufficient balance to cover... - [Create express session](https://docs.bvnk.com/bvnk/api-explorer/endpoints/create-express-session.md): Creates a wallet session URL for Embedded Express customers, allowing them to access their branded stablecoin wallet. The URL is returned in `walle... - [Create payment limit](https://docs.bvnk.com/bvnk/api-explorer/endpoints/create-payment-limit.md): Creates a payment limit for a specific currency and payment method. Limits can be set at account level to control the maximum amount allowed per tr... - [Create customer agreements](https://docs.bvnk.com/bvnk/api-explorer/endpoints/create-pre-customer-agreements-v-2.md): Create an agreement working set for a prospective customer (before a customer record exists). Identified by a partner-supplied `reference` that mus... - [Create report schedule](https://docs.bvnk.com/bvnk/api-explorer/endpoints/create-report-schedule.md): Creates a new scheduled report that will be automatically generated and delivered according to the specified frequency and delivery preferences. Ea... - [Create withdrawal](https://docs.bvnk.com/bvnk/api-explorer/endpoints/create-withdrawal.md): Withdraws funds from a portfolio back into a same-currency wallet you own. The portfolio must hold sufficient balance to cover the withdrawal amount. - [Delete contact](https://docs.bvnk.com/bvnk/api-explorer/endpoints/delete-contact-v-3.md): :::warning Beta - [Delete customer associate](https://docs.bvnk.com/bvnk/api-explorer/endpoints/delete-customer-associate-v-2.md): Deletes an associate from a customer onboarding application. Safe to call before the application transitions to a terminal state. - [Remove a document](https://docs.bvnk.com/bvnk/api-explorer/endpoints/delete-document.md): :::info Customers API v2 - [Delete payment limit](https://docs.bvnk.com/bvnk/api-explorer/endpoints/delete-payment-limit.md): Deletes an existing payment limit. The limit is removed immediately and no longer applies to future transactions. - [Delete report schedule](https://docs.bvnk.com/bvnk/api-explorer/endpoints/delete-report-schedule.md): Deletes an existing report schedule. Only the user who created the schedule can delete it. Once deleted, no further reports will be generated accor... - [Download customer document](https://docs.bvnk.com/bvnk/api-explorer/endpoints/download-customer-document-v-2.md): Downloads a customer document as a binary file attachment. - [List Earn Products](https://docs.bvnk.com/bvnk/api-explorer/endpoints/earn-product-list.md): Returns a paginated list of available earning products. Use the `currency` query parameter to filter products by a specific currency, for example `... - [Estimate refund fee](https://docs.bvnk.com/bvnk/api-explorer/endpoints/estimate-refund-fee.md): Returns the estimated processing fee and the maximum remaining refundable balance for the pay-in. The fee will be deducted from your wallet when is... - [Retrieve agreement session status](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-agreement-session-status.md): :::info Customers API v2 - [Fetch agreements](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-agreements.md): Fetch all required agreement documents needed to onboard a Customer. - [Get contact](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-contact-v-3.md): :::warning Beta - [Get customer associate](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-customer-associate-v-2.md): Returns a single associate by id. - [Get customer document](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-customer-document-v-2.md): Returns a single customer document by their `id`'s. - [Get customer documents](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-customer-documents.md): :::info Customers API v2 - [Get customer fee wallets](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-customer-fee-wallets.md): Retrieves the list of available wallets that can receive customer fees. - [List required information](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-customer-info-required.md): :::info Customers API v2 - [Get customer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-customer-v-2.md): Retrieves a customer by id, including the submitted onboarding body (`company` or `individual`). Person associates are inlined under `company.assoc... - [Get customer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-customer-with-external-status.md): :::info Customers API v2 - [Get document download URL](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-document-url.md): :::info Customers API v2 - [List industries](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-industries.md): Retrieves a definitive list of industries and sub-industries, which can be included in the payload when creating a customer. - [List monthly expected volumes](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-monthly-expected-volumes.md): Retrieves a definitive list of Expected Monthly Volume values, which can be included in the payload when creating a customer. - [Retrieve application status](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-onboarding-application-status.md): Retrieves the current onboarding application state, including associates' validation status, outstanding required documents, questionnaire definiti... - [Retrieve assigned agreements](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-onboarding-assigned-agreements.md): Returns agreements assigned to an onboarding application. All assigned agreements must reach `ACCEPTED` status for onboarding to proceed. - [Get payment limit](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-payment-limit.md): Retrieves a specific payment limit by its unique identifier. - [Get customer agreement content URL](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-pre-customer-agreement-content-v-2.md): Get a presigned URL for downloading the agreement document. Use this when you need a fresh URL outside of the list/get responses. - [Get customer agreement](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-pre-customer-agreement-v-2.md): Fetch a single customer agreement entry by its UUID. The response includes the agreement's current `status` (PENDING / ACCEPTED / REJECTED). - [Get questionnaire definition](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-questionnaire-definitions.md): :::info Customers API v2 - [Search questionnaire submissions](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-questionnaires.md): :::info Customers API v1 - [Get supported timezones](https://docs.bvnk.com/bvnk/api-explorer/endpoints/get-supported-timezones.md): Retrieves a list of all supported timezones that can be used when creating or updating report schedules. Each timezone includes both the IANA timez... - [Create wallet](https://docs.bvnk.com/bvnk/api-explorer/endpoints/ledger-wallet-create-v-2.md): Creates a crypto or fiat wallet associated with a wallet profile. You can create wallets for yourself or for your customers. - [Execute wallet action](https://docs.bvnk.com/bvnk/api-explorer/endpoints/ledger-wallet-execute-action.md): Executes a lifecycle action on a wallet: TERMINATE, BLOCK, or UNBLOCK. A non-empty comment explaining the reason is required. - [Get wallets](https://docs.bvnk.com/bvnk/api-explorer/endpoints/ledger-wallet-list-v-2.md): Shows all *Direct* and *Customer* wallet types. Results are summaries only (**payment instruments are not included**); use `GET /ledger/v2/wallets/... - [List customer's fiat wallets](https://docs.bvnk.com/bvnk/api-explorer/endpoints/ledger-wallet-list.md): Retrieves a list of wallets for your customers. - [Get wallet](https://docs.bvnk.com/bvnk/api-explorer/endpoints/ledger-wallet-read-v-2.md): Retrieves a single wallet by its ID. You can retrieve your own or your customer's wallet. - [Get fiat wallet](https://docs.bvnk.com/bvnk/api-explorer/endpoints/ledger-wallet-read.md): Retrieves a specific wallet by its ID. - [List customers](https://docs.bvnk.com/bvnk/api-explorer/endpoints/list-account-customers.md): :::info Customers API v2 - [List contacts](https://docs.bvnk.com/bvnk/api-explorer/endpoints/list-contacts-v-3.md): :::warning Beta - [Fetch country codes](https://docs.bvnk.com/bvnk/api-explorer/endpoints/list-countries.md): Fetch list of all countries and associated ISO codes. - [List crypto currencies](https://docs.bvnk.com/bvnk/api-explorer/endpoints/list-currencies-crypto.md): Retrieves a list of all cryptocurrencies available on the BVNK platform. This list represents cryptocurrencies that end users can select whilst mak... - [List wallet currencies](https://docs.bvnk.com/bvnk/api-explorer/endpoints/list-currencies-deposit.md): These are the currencies that can be used to create a new wallet. - [List fiat currencies](https://docs.bvnk.com/bvnk/api-explorer/endpoints/list-currencies-fiat.md): Retrieves a list of all display fiat currencies available on BVNK's Crypto Payments API. - [Get assigned agreements](https://docs.bvnk.com/bvnk/api-explorer/endpoints/list-customer-assigned-agreements-v-2.md): Returns the set of agreements assigned to an existing customer. Each item carries its current `status` (PENDING / ACCEPTED / REJECTED) and, once re... - [List customer associates](https://docs.bvnk.com/bvnk/api-explorer/endpoints/list-customer-associates-v-2.md): Returns a paginated list of associates for a customer. - [List customer documents](https://docs.bvnk.com/bvnk/api-explorer/endpoints/list-customer-documents-v-2.md): Returns a paginated list of documents associated with a customer. - [List exchange rates](https://docs.bvnk.com/bvnk/api-explorer/endpoints/list-exchange-rates.md): Lists available exchange rates for a given currency. - [List payment limits](https://docs.bvnk.com/bvnk/api-explorer/endpoints/list-payment-limits.md): Retrieves all payment limits configured for the authenticated account. Supports filtering by customer, limit type, payment method, and currency. - [List customer agreements by reference](https://docs.bvnk.com/bvnk/api-explorer/endpoints/list-pre-customer-agreements-v-2.md): List the agreement working set previously created for the given partner-supplied `reference`. - [List report schedules](https://docs.bvnk.com/bvnk/api-explorer/endpoints/list-report-schedules.md): Retrieves a paginated list of report schedules for the authenticated user's account. Returns all schedules created by the user with their current c... - [Create merchant ID](https://docs.bvnk.com/bvnk/api-explorer/endpoints/merchant-id-create.md): Generate a Merchant ID for your account to process pay-ins and pay-outs through our API. - [List merchant IDs](https://docs.bvnk.com/bvnk/api-explorer/endpoints/merchant-id-list.md): Retrieves merchant IDs setup on your account. - [Accept an estimated payout](https://docs.bvnk.com/bvnk/api-explorer/endpoints/pay-estimate-accept.md): Accepts the current estimate and converts it into a pending crypto payment. - [Update an existing estimate payout](https://docs.bvnk.com/bvnk/api-explorer/endpoints/pay-estimate-update.md): Refreshes the quote using the latest exchange rates and fees. Call periodically (e.g., every 30 seconds) with either `walletRequiredAmount` or `pai... - [Create an estimate payout](https://docs.bvnk.com/bvnk/api-explorer/endpoints/pay-estimate.md): Retrieves latest exchange rates, fees and network costs for a crypto payout without creating an actual payout. Provide either `walletRequiredAmount... - [Accept payment](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-accept.md): Accepts a pending payment with currency or payout information. - [Confirm payment](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-confirm.md): Confirms a two-step payout. - [Create payment](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-create.md): Creates an incoming (type IN) or outcoming (type OUT) crypto payment. - [Preview payment](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-dry-run.md): Previews a payment without creating it. BVNK calculates and returns the full payment summary, including the exchange rate, fees, and converted amou... - [List payments](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-list.md): Retrieves a list of payments on a specific Wallet ID. - [Validate address](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-out-validate.md): Validates that a crypto address is correct. - [Get payment](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-read.md): Retrieves details of a specific payment using the UUID of the payment. - [Activate or deactivate payment rule](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-rule-action.md): Activates or deactivates a payment rule. If you linked a rule to an incorrect wallet, you can deactivate it. Deactivated rules will not trigger aut... - [Create on-ramp payment rule](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-rule-create.md): Creates a rule that links a crypto wallet to a fiat virtual account to automatically handle on-ramp (fiat → crypto) flow. The `trigger` field defin... - [List payment rules by wallet](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-rule-list-by-wallet.md): Retrieves a list of payment rules applied to a specific wallet by its ID. - [List payment rules](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-rule-list.md): Retrieves a list of all payment rules configured for your account. - [Update payment rule](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-rule-update.md): Partially updates a previously created payment rule. Only properties included in the request are updated; omitted fields remain unchanged. Setting ... - [Update payment](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payment-update.md): Updates a pending payment with currency or payout information. - [Confirm beneficiary's name](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payout-confirm-beneficiary-v-2.md): Confirms a payout when the beneficiary name check returns a mismatch warning. If not confirmed within five minutes, the action expires. In this cas... - [Initiate payout](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payout-create-v-2.md): Creates a payout to business or individual customers. - [Initiate Payout](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payout-create.md): Creates a fiat payout with an existing beneficiary or by adding a new one. - [Get proof of payment in PDF](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payout-get-proof-of-payment-v-2.md): Retrieves a Proof of Payment PDF report for a fiat wallet payout. The proof of payment is available only for completed fiat payouts. - [Get payout](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payout-get-v-2.md): Retrieves a specific payout. You can also use this endpoint to check the status of the crypto or fiat payout. - [Get payout](https://docs.bvnk.com/bvnk/api-explorer/endpoints/payout-read.md): Retrieves a specific payout. - [Accept quote](https://docs.bvnk.com/bvnk/api-explorer/endpoints/quote-accept.md): Executes a quote. - [Create quote](https://docs.bvnk.com/bvnk/api-explorer/endpoints/quote-create.md): Creates a quote to convert currency between wallets. - [List quotes](https://docs.bvnk.com/bvnk/api-explorer/endpoints/quote-list.md): Retrieves all quotes on a specific Merchant ID. - [Get quote](https://docs.bvnk.com/bvnk/api-explorer/endpoints/quote-read.md): Retrieves a specific quote. - [Get exchange rate](https://docs.bvnk.com/bvnk/api-explorer/endpoints/read-exchange-rate.md): Provides a last traded price from connected liquidity providers between two assets. - [Refund pay-in](https://docs.bvnk.com/bvnk/api-explorer/endpoints/refund-payin.md): Initiates seamless one-click refund processing for any previous pay-in. Once accepted, a refund transaction appears in your portal and can be acqu... - [Search customers](https://docs.bvnk.com/bvnk/api-explorer/endpoints/search-customers-v-2.md): Searches customers associated with the caller's account, with optional filters and pagination. - [Set wallet for customer fees](https://docs.bvnk.com/bvnk/api-explorer/endpoints/set-customer-fee-wallet.md): Sets up the customer fee wallet for a specific currency. The customer fee wallet is where the collected customer fees will be credited when process... - [Simulate pay-in](https://docs.bvnk.com/bvnk/api-explorer/endpoints/simulate-payin-v-2.md): Simulates pay-ins with different currencies and payment methods in the sandbox environment. - [Simulate pay-in](https://docs.bvnk.com/bvnk/api-explorer/endpoints/simulate-payin.md): Simulates pay-ins with different currencies and payment methods in the sandbox environment. - [Submit associate questionnaires](https://docs.bvnk.com/bvnk/api-explorer/endpoints/submit-onboarding-associate-questionnaires.md): Submits questionnaire responses for an associate. Always source questionnaire IDs, section IDs, item IDs, and accepted values from `questionnaireDe... - [Submit questionnaire](https://docs.bvnk.com/bvnk/api-explorer/endpoints/submit-questionnaire-responses.md): :::info Customers API v2 - [Perform transfer action](https://docs.bvnk.com/bvnk/api-explorer/endpoints/transfer-action-v-3.md): Performs an action on a V3 transfer. - [Create internal transfer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/transfer-create-v-2.md): Creates an internal stablecoin and fiat transfer between customer's and partner's wallets. - [Create internal transfer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/transfer-create-v-3.md): Creates an internal transfer between wallets with optional currency conversion. - [Create internal transfer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/transfer-create.md): Create an internal Fiat transfer to an existing beneficiary wallet. - [Preview internal transfer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/transfer-dry-run-v-3.md): Previews an internal transfer without creating it. BVNK calculates and returns conversion details, including exchange rate, spread, fees, and conve... - [Get transfer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/transfer-read-v-2.md): Retrieves a specific transfer details. - [Get transfer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/transfer-read-v-3.md): Retrieves a specific V3 transfer by its ID, including conversion details if applicable. - [Get transfer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/transfer-read.md): Retrieves a specific transfer details. - [List transfer beneficiaries](https://docs.bvnk.com/bvnk/api-explorer/endpoints/transfers-beneficiary-read.md): Retrieves a list of beneficiaries eligible for transfers for a specified wallet. - [Update agreement session status](https://docs.bvnk.com/bvnk/api-explorer/endpoints/update-agreement-session.md): :::info Customers API v2 - [Update contact](https://docs.bvnk.com/bvnk/api-explorer/endpoints/update-contact-v-3.md): :::warning Beta - [Update customer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/update-customer.md): :::warning - [Update payment limit](https://docs.bvnk.com/bvnk/api-explorer/endpoints/update-payment-limit.md): Updates an existing payment limit. You can modify the payment method, limit type, and amount. - [Update existing report schedule](https://docs.bvnk.com/bvnk/api-explorer/endpoints/update-report-schedule.md): Updates an existing scheduled report with new frequency and delivery preferences. Only the user who created the schedule can update it. - [Upload associate identification documents](https://docs.bvnk.com/bvnk/api-explorer/endpoints/upload-associate-identification-documents-v-2.md): Uploads 1-3 identification and address verification documents for a specific associate as `multipart/form-data`. - [Upload company documents](https://docs.bvnk.com/bvnk/api-explorer/endpoints/upload-customer-company-documents-v-2.md): Uploads 1-3 company-level KYB documents for a customer as `multipart/form-data`. - [Upload documents to customer](https://docs.bvnk.com/bvnk/api-explorer/endpoints/upload-customer-documents.md): :::info Customers API v2 - [Upload associate identity documents](https://docs.bvnk.com/bvnk/api-explorer/endpoints/upload-onboarding-associate-identification-documents.md): Uploads identity and address verification documents for a specific associate as `multipart/form-data`. - [Upload company documents](https://docs.bvnk.com/bvnk/api-explorer/endpoints/upload-onboarding-company-documents.md): Uploads company-level KYB documents for an onboarding application as `multipart/form-data`. - [Verify beneficiary's name](https://docs.bvnk.com/bvnk/api-explorer/endpoints/verify-beneficiary.md): Verifies the beneficiary's name. You can call this endpoint before creating a payout via [`POST /payment/v2/payouts`](https://docs.bvnk.com/referen... - [List crypto wallet balances](https://docs.bvnk.com/bvnk/api-explorer/endpoints/wallet-balance-list.md): Retrieves the balances of your wallets on platform. - [Create crypto wallet](https://docs.bvnk.com/bvnk/api-explorer/endpoints/wallet-create.md): Creates a crypto wallet on the BVNK platform. - [Get transactions](https://docs.bvnk.com/bvnk/api-explorer/endpoints/wallet-list-transactions.md): Retrieves a paginated list of transactions for a specific wallet. Supports filtering by `walletId` and optional date range. - [List crypto wallets](https://docs.bvnk.com/bvnk/api-explorer/endpoints/wallet-list.md): Retrieves a list of wallets on your account. Displays the first 10 wallets without max set to higher. - [Get wallet profiles](https://docs.bvnk.com/bvnk/api-explorer/endpoints/wallet-profiles-2.md): Returns available wallet profiles based on optional filters for currency codes and payment methods. For more information on how to apply it in the ... - [Get wallet profiles](https://docs.bvnk.com/bvnk/api-explorer/endpoints/wallet-profiles.md): Returns available wallet profiles based on optional filters for currency codes and payment methods. - [Get crypto wallet](https://docs.bvnk.com/bvnk/api-explorer/endpoints/wallet-read.md): Retrieves detailed information about a specific wallet. - [Transactions report](https://docs.bvnk.com/bvnk/api-explorer/endpoints/wallet-transaction-report-v-2.md): Report all transactions from wallet in specified format. Report will be generated and sent to main account email in the specified format. - [Generate report](https://docs.bvnk.com/bvnk/api-explorer/endpoints/wallet-transaction-report.md): Creates a report from a wallet in the specified format and sends it via the preferred delivery method: WEBHOOK or EMAIL. - [BVNK Ledger — Self-Custody Key Management](https://docs.bvnk.com/bvnk/api-explorer/self-custody/bvnk-ledger-self-custody-key-management.md): Key management endpoints for **self-custody wallets**. - [Get data transit key](https://docs.bvnk.com/bvnk/api-explorer/self-custody/get-data-transit-key.md): Returns the RSA public key used to wrap your AES key for key - [List key pairs](https://docs.bvnk.com/bvnk/api-explorer/self-custody/list-key-pairs.md): Returns the key pairs for a given customer. - [For individual customers](https://docs.bvnk.com/bvnk/get-started/compliance-requirements/compliance-requirements-for-individuals2.md):
- [For business customers](https://docs.bvnk.com/bvnk/get-started/compliance-requirements/embedded-compliance-requirements-businesses-2.md):
- [For business customers](https://docs.bvnk.com/bvnk/get-started/compliance-requirements/embedded-compliance-requirements-businesses.md): This article provides a comprehensive summary of the required fields, document types, identity verification requirements, and applicable conditions... - [Add documents to customers](https://docs.bvnk.com/bvnk/get-started/create-embedded-partner-customer/add-documents-to-customers.md): :::info Customers API v2 - [Create business customers](https://docs.bvnk.com/bvnk/get-started/create-embedded-partner-customer/create-customers-com.md): This guide describes how to create and onboard your customers. - [Create a customer](https://docs.bvnk.com/bvnk/get-started/create-embedded-partner-customer/creating-an-embedded-customer-company-api.md): :::info Customers API v2 - [Create a customer](https://docs.bvnk.com/bvnk/get-started/create-embedded-partner-customer.md): Embedded Wallets provide partners with seamless payment and fund management capabilities directly within their platform while maintaining their bra... - [Manage customers](https://docs.bvnk.com/bvnk/get-started/create-embedded-partner-customer/manage-customers.md): Use the following guide to view and track the customers you have created, including their current onboarding and verification status, and to manage... - [Gather compliance data for onboarding](https://docs.bvnk.com/bvnk/get-started/create-embedded-partner-customer/onboard-epc.md): :::info Customers API v2 - [Onboard customers via your own KYC flow](https://docs.bvnk.com/bvnk/get-started/create-embedded-partner-customer/reliance-onboarding.md): :::info Customers API v2 - [Retrieve customer details](https://docs.bvnk.com/bvnk/get-started/create-embedded-partner-customer/retrieve-embedded-partner-customer.md): :::info Customers API v2 - [Prepare customer agreements](https://docs.bvnk.com/bvnk/get-started/create-embedded-partner-customer/signing-customer-agreements.md): :::info Customers API v2 - [Update customer details](https://docs.bvnk.com/bvnk/get-started/create-embedded-partner-customer/update-embedded-partner-customer.md): With these endpoints, you can update information about a specific customer within the system: key customer data, including their profile, associate... - [Overview](https://docs.bvnk.com/bvnk/get-started/self-custody/sc-overview.md): Self-custody wallets are non-custodial crypto wallets where customers control their own keys. Unlike standard BVNK wallets (where BVNK holds the ke... - [Security architecture](https://docs.bvnk.com/bvnk/get-started/self-custody/sc-security.md): This page explains key storage locations, key material transfer processes, safeguards for each key operation, and key pair management procedures. - [Set up self-custody wallets](https://docs.bvnk.com/bvnk/get-started/self-custody/sc-wallets.md): Self-custody wallets let you provide customers with wallets to receive, hold, and send digital assets. Each customer has one master key, from which... - [Receive transactions report via webhook](https://docs.bvnk.com/bvnk/reconciliation/receive-transactions-report-via-webhook.md): Create a webhook as described in [Create webhook listener](../../get-started/create-webhook-listener). In the **Events** field, specify `bvnk:ledge... - [Reconcile transactions](https://docs.bvnk.com/bvnk/reconciliation/reconcile-transactions.md): Reconciliation allows you to verify that your internal transaction records match BVNK's transaction data. By comparing your system's records with B... - [Issue cards to customers](https://docs.bvnk.com/bvnk/use-cases/cards.md): :::warning Beta - [Display sensitive card details using SDK](https://docs.bvnk.com/bvnk/use-cases/cards/display-card-details.md): :::warning Beta - [Create cards](https://docs.bvnk.com/bvnk/use-cases/cards/implement-cards.md): :::warning Beta - [Manage cards](https://docs.bvnk.com/bvnk/use-cases/cards/manage-cards.md): :::warning Beta - [Prepare for integration](https://docs.bvnk.com/bvnk/use-cases/cards/prepare-for-cards-integration.md): :::warning Beta - [Manage contacts](https://docs.bvnk.com/bvnk/use-cases/contacts/manage-contacts.md): :::warning Beta - [Manage payment limits](https://docs.bvnk.com/bvnk/use-cases/fiat/manage-payment-limits.md): Payment limits allow you to set the maximum amount you can send per transaction or per day for each currency and payment method. Limits apply only ... - [Overview](https://docs.bvnk.com/bvnk/use-cases/fiat/payout-overview.md): This process allows for the ability for the `CUSTOMER ENABLED` wallet to complete payouts to other bank accounts using their virtual account. - [Automate fiat-to-crypto transfers](https://docs.bvnk.com/bvnk/use-cases/on-off-ramp/automate-fiat-to-crypto-transfers.md): To create a rule that links a fiat virtual account to a crypto blockchain address, send the [`POST /payment/v1/rules`](../../../api-explorer/endpoi... - [Convert funds (on-ramp)](https://docs.bvnk.com/bvnk/use-cases/on-off-ramp/on-ramp-overview.md): An _on-ramp_ is the process of automatically converting value from fiat currency into crypto, offering customers greater financial flexibility by p... - [Prepare for integration](https://docs.bvnk.com/bvnk/use-cases/on-off-ramp/prepare-for-onramp-integration.md): This guide outlines the phases required to integrate BVNK's stablecoin payment capabilities into your platform. The scope of each phase depends on ... - [Earn stablecoin rewards](https://docs.bvnk.com/bvnk/use-cases/rewards/rewards-overview.md): BVNK **Earn** allows you to generate additional funds from your BVNK balances. **Rewards** is the first product in Earn, enabling stablecoin issuer... - [Approve and reject payouts](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/approve-reject-payouts.md): In case you want to integrate an additional layer of security to your payments, you can approve or reject payouts before they go out. For example, ... - [Refund Payments](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/auto-refund-payments.md): When a payment exception occurs, BVNK offers automatic cryptocurrency refunds for partners who do not wish to hold these assets due to compliance c... - [Auto-refund to source address](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/auto-refund-to-source-address.md): When a payment exception (overpayment, underpayment, or late payment) occurs, BVNK can automatically refund the cryptocurrency directly to the wall... - [Collect via Channels](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/create-channel.md): Channels are static crypto addresses that remain open at all times for your customers, as part of the Crypto Payments offering. Each channel is uni... - [Enable payouts for customers](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/epc-stablecoin-overview.md): The customer stablecoin payment flow enables Payment Service Providers (PSPs) to offer stablecoin payouts to their customers without requiring dire... - [Exception scenarios](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/exception-scenarios.md): The final step is to implement exception handling within the payment flow. While the Receive Payment Notifications page outlines webhook types, the... - [Receive stablecoin payments](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/get-payment-overview.md): Using BVNKs Receive products, you can collect crypto payments from your customers, allowing them to top up accounts or purchase goods and services ... - [Receive stablecoins via Payment Links](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/get-payment.md): Use this method to add crypto payments to your checkout flow and collect payments from your customers. You can build your own UI using the API resp... - [Late Payments](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/late-payments.md): :::important - [Overpayments](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/overpayments.md): Overpayments occur when end-users send more cryptocurrency than intended. For example, they intend to send 0.01 ETH but send 0.1 ETH instead. In th... - [Create payouts](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/pay-out-to-your-users.md): There are two ways to create a payout: - [Send stablecoin payments](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/payout-overview.md): The following guide describes how you can integrate stablecoin payments into your platform via BVNK. - [Prepare for integration](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/prepare-for-epc-integration.md): This guide outlines the phases required to integrate BVNK's stablecoin payment capabilities into your platform. The scope of each phase depends on ... - [Prepare for integration](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/prepare-for-integration.md): This guide outlines the phases required to integrate BVNK's stablecoin payment capabilities into your platform. The scope of each phase depends on ... - [Provide additional party information travel rule.](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/provide-user-information-for-payments.md): In traditional payment systems such as credit cards and bank transfers, collecting and sharing party information is standard practice. The **Travel... - [Send stablecoin payments via customer's wallet](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/send-stabelcoin-via-customers-wallet.md): When creating a payout, there are two possible flows: - [Track transactions](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/track-transactions.md): To configure Payout webhooks, go to the BVNK Portal and navigate to **Integrations** > **Webhooks**. For the full guide, see [Create a Webhook Lis... - [Underpayments](https://docs.bvnk.com/bvnk/use-cases/stablecoin-payments-for-platforms/underpayments.md): Underpayments occur when end-users do not transfer enough cryptocurrency to fulfill their payment obligation. - [Charge Customer Fees](https://docs.bvnk.com/bvnk/use-cases/unprocessed/charge-customer-fees.md): As a partner, you can add a markup fee to your customers' transactions, enabling you to collect additional revenue from your Customers. - [Accept Stablecoin Pay-in with 1:1 Peg](https://docs.bvnk.com/bvnk/use-cases/unprocessed/payments-with-11-stablecoin-peg.md): This feature is a part of Payment Links product and offers customers a 1:1 exchange rate for Stablecoin to USD incoming payments. The stablecoin am... - [Provide party information for crypto payments](https://docs.bvnk.com/bvnk/use-cases/unprocessed/provide-user-information-for-payments.md): In established payment systems like credit card and bank transfers, collecting and sharing information about the parties involved in a transaction ... - [Third Party Providers (TPPs)](https://docs.bvnk.com/bvnk/use-cases/unprocessed/third-party-providers.md): The revised Payment Services Directive (PSD2) was enacted on 13 January 2018 across Europe and the UK. PSD2 introduced new rights for certain third... - [Send payments](https://docs.bvnk.com/bvnk/use-cases/virtual-accounts/initiate-payment-2.md): To create a fiat payout for **local payment** rails, you must have the following: - [Prepare for integration](https://docs.bvnk.com/bvnk/use-cases/virtual-accounts/prepare-for-va-integration.md): The sandbox environment mirrors production but operates with test data, allowing you to build and validate your integration without financial risk. - [Provide virtual account to your customers](https://docs.bvnk.com/bvnk/use-cases/virtual-accounts/provide-customer-virtual-accounts.md): As a licensed financial institution, you can create virtual accounts for your own customers so that each customer receives a vIBAN issued in their ... - [Receive fiat pay-ins](https://docs.bvnk.com/bvnk/use-cases/virtual-accounts/receive-fiat-pay-ins.md): BVNK virtual accounts accept fiat pay-ins in EUR, GBP, and USD across a range of payment rails, including SWIFT, SEPA, ACH, Faster Payments, and ot... - [Refund payments](https://docs.bvnk.com/bvnk/use-cases/virtual-accounts/refund-payments-via-va.md): The Refund feature enables you to instantly return any previous fiat pay-in. The payout is generated automatically, and you don't need to re-enter ... - [Send payments](https://docs.bvnk.com/bvnk/use-cases/virtual-accounts/send-payment-via-va.md): To initiate a fiat payout using local payment rails, ensure you have the following information: - [Overview](https://docs.bvnk.com/bvnk/use-cases/virtual-accounts/va-overview.md): This guide outlines how to use virtual accounts (VAs) to manage fiat and crypto payments through BVNK. - [Enable Express wallets for customers](https://docs.bvnk.com/bvnk/use-cases/xpress-store-funds/express-overview.md): Express Embedded offers a customizable user interface and backend APIs that add stablecoin wallet functionality to your platform. This allows you t... - [Fund Express wallets](https://docs.bvnk.com/bvnk/use-cases/xpress-store-funds/store-funds.md): This guide explains how to debit funds from your fiat account and credit them to your customer's stablecoin account. To complete the conversion, yo... - [Tutorial Intro](https://docs.bvnk.com/intro.md): Let's discover **Docusaurus in less than 5 minutes**. - [Authentication](https://docs.bvnk.com/l1-api/api-overview/authentication.md): This guide explains how to generate and use RSA-based HTTP Message Signatures to securely authenticate API requests to Layer1. - [Errors](https://docs.bvnk.com/l1-api/api-overview/errors.md): The following reference contains a list of error codes, their messages, and descriptions for errors that may be encountered when using the Layer1 API. - [Webhooks](https://docs.bvnk.com/l1-api/api-overview/webhooks.md): Webhooks are critical for real-time notifications within our Layer1 platform, enabling automated updates related to payments, conversions, or new a... - [Approvals](https://docs.bvnk.com/l1-api/approvals/approvals.md): Layer1 API for approvals management - [Bulk vote](https://docs.bvnk.com/l1-api/approvals/bulk-vote.md): Submits the same vote decision (approve or reject) for multiple approval requests. Processes each request independently and returns detailed result... - [Count approval requests](https://docs.bvnk.com/l1-api/approvals/count-approval-requests.md): Returns the total count of approval requests matching the specified criteria. - [Get approval request status](https://docs.bvnk.com/l1-api/approvals/get-approval-request-status.md): Retrieves the current status and last update time for a specific approval request. - [Get approval request details](https://docs.bvnk.com/l1-api/approvals/get-approval-request.md): Retrieves complete details of an approval request including votes, requirements, and context. - [Get approval settings](https://docs.bvnk.com/l1-api/approvals/get-approval-settings.md): Retrieves current approval policy settings for a specific namespace. - [List approval requests](https://docs.bvnk.com/l1-api/approvals/list-approval-requests.md): Retrieves a paginated and filterable list of approval requests with support for query-based search. - [Vote on the request a policy and context name](https://docs.bvnk.com/l1-api/approvals/standing-vote.md): Holds a vote for the approval request whose context carries the values given, and applies it as soon as such a request is pending - a voter can dec... - [Vote](https://docs.bvnk.com/l1-api/approvals/submit-vote.md): Submits an approval or rejection vote for a pending approval request. Returns updated status after evaluation. - [Create or update approval settings](https://docs.bvnk.com/l1-api/approvals/upsert-approval-settings.md): Creates or updates approval policy settings for a specific namespace. Settings are validated before saving. - [Asset Service](https://docs.bvnk.com/l1-api/assets/asset-service.md): Layer1 API for managing asset groups and custom assets - [Get single asset group by code](https://docs.bvnk.com/l1-api/assets/get-asset-group.md): Retrieves a single asset group together with its enabled assets. - [List all asset groups with enabled assets](https://docs.bvnk.com/l1-api/assets/get-asset-groups.md): Retrieves all asset groups together with their enabled assets for the authenticated tenant. - [Get single asset](https://docs.bvnk.com/l1-api/assets/get-asset.md): Retrieves a single asset belonging to an asset group. - [Update asset capabilities](https://docs.bvnk.com/l1-api/assets/patch-asset-capabilities.md): Updates specific capabilities (`depositEnabled`, `withdrawalEnabled`, `tradeEnabled`) of a custom asset. - [Enable or disable all assets in an asset group](https://docs.bvnk.com/l1-api/assets/toggle-asset-group-state.md): Toggles the enabled state for all assets in a given asset group. - [Enable or disable a single asset](https://docs.bvnk.com/l1-api/assets/toggle-asset-state.md): Toggles the enabled state for a single asset in a given asset group. - [Create or update a custom asset](https://docs.bvnk.com/l1-api/assets/upsert-asset.md): Creates or updates a custom asset within an asset group. - [Assign Contact to Merchant Channel](https://docs.bvnk.com/l1-api/channels/assign-contact.md): Assigns a contact to a merchant channel by updating the compliance data on its address. Accepts either an existing contactId, or inline complianceD... - [backfillHistoricalConversions](https://docs.bvnk.com/l1-api/channels/backfill-historical-conversions.md): backfillHistoricalConversions - [Channel](https://docs.bvnk.com/l1-api/channels/channel.md): Layer1 API making management of crypto assets simple and easy - [Close Merchant Channel](https://docs.bvnk.com/l1-api/channels/close-channel.md): Closes a merchant channel by its UUID. - [Create Merchant Channel](https://docs.bvnk.com/l1-api/channels/create-channel.md): Creates a new merchant channel with the provided details. - [createHistoricalConversion](https://docs.bvnk.com/l1-api/channels/create-historical-conversion.md): createHistoricalConversion - [depositWebhookEvents](https://docs.bvnk.com/l1-api/channels/deposit-webhook-events.md): depositWebhookEvents - [getById](https://docs.bvnk.com/l1-api/channels/get-by-id.md): getById - [getFailedMessagesByStatus](https://docs.bvnk.com/l1-api/channels/get-failed-messages-by-status.md): getFailedMessagesByStatus - [Get Merchant Channel Payment by ID](https://docs.bvnk.com/l1-api/channels/get-merchant-channel-payment-by-id.md): Retrieves a specific merchant channel payment by its UUID. - [Get Merchant Channel by UUID](https://docs.bvnk.com/l1-api/channels/get-merchant-channel.md): Retrieves a specific merchant channel by its UUID. - [getRequiredRates](https://docs.bvnk.com/l1-api/channels/get-required-rates.md): getRequiredRates - [Get Merchant Channel Spot Rates by UUID](https://docs.bvnk.com/l1-api/channels/get-spot-rates.md): Retrieves spot rates for a specific merchant channel by its UUID. - [ignore](https://docs.bvnk.com/l1-api/channels/ignore.md): ignore - [List Merchant Channel Payments](https://docs.bvnk.com/l1-api/channels/list-merchant-channel-payments.md): Retrieves a list of merchant channel payments based on the provided filters. - [List Merchant Channels](https://docs.bvnk.com/l1-api/channels/list-merchant-channels.md): Retrieves a list of merchant channels based on the provided filters. - [markAsFailed](https://docs.bvnk.com/l1-api/channels/mark-as-failed.md): markAsFailed - [resendWebhook](https://docs.bvnk.com/l1-api/channels/resend-webhook.md): resendWebhook - [retry](https://docs.bvnk.com/l1-api/channels/retry.md): retry - [start](https://docs.bvnk.com/l1-api/channels/start.md): start - [stop](https://docs.bvnk.com/l1-api/channels/stop.md): stop - [tradeWebhookEvents](https://docs.bvnk.com/l1-api/channels/trade-webhook-events.md): tradeWebhookEvents - [Update Merchant Channel](https://docs.bvnk.com/l1-api/channels/update-channel.md): Updates the reference of a merchant channel by its UUID. - [Add payment instrument](https://docs.bvnk.com/l1-api/contacts/add-instrument.md): Adds a new payment instrument (such as a crypto address) to an existing contact. This operation may require approval depending on the trusted addre... - [Contacts](https://docs.bvnk.com/l1-api/contacts/contacts.md): Layer1 API for managing contacts and their payment instruments - [Create contact](https://docs.bvnk.com/l1-api/contacts/create.md): Creates a new contact. The contact can have multiple payment instruments such as crypto addresses. - [Get contacts by IDs](https://docs.bvnk.com/l1-api/contacts/get-contacts-by-ids.md): Retrieves multiple contacts by their IDs in a single request. Specify contact IDs as a comma-separated list in the 'ids' query parameter. - [Get contact](https://docs.bvnk.com/l1-api/contacts/get.md): Retrieves a single contact by ID. - [List payment instruments](https://docs.bvnk.com/l1-api/contacts/list-instruments.md): Retrieves a paginated list of payment instruments for a specific contact. - [List payment instruments](https://docs.bvnk.com/l1-api/contacts/list.md): Retrieves a paginated list of payment instruments across all contacts. Supports advanced search using Lucene-like query syntax for filtering by ins... - [Remove payment instrument](https://docs.bvnk.com/l1-api/contacts/remove-instrument.md): Removes a payment instrument from a contact. This operation may require approval depending on the trusted address approval settings. - [Update payment instrument](https://docs.bvnk.com/l1-api/contacts/update-instrument.md): Updates an existing payment instrument for a contact. This operation may require approval depending on the trusted address approval settings. - [Update contact](https://docs.bvnk.com/l1-api/contacts/update.md): Updates an existing contact's information. - [Create Merchant Channel](https://docs.bvnk.com/l1-api/crypto-payments/create-channel.md): Creates a new merchant channel with the provided details. - [Crypto Payment API Endpoints](https://docs.bvnk.com/l1-api/crypto-payments/crypto-payment-api-endpoints.md): Crypto Payments API making management of crypto assets simple and easy - [Get Merchant Channel Payment by ID](https://docs.bvnk.com/l1-api/crypto-payments/get-merchant-channel-payment-by-id.md): Retrieves a specific merchant channel payment by its UUID. - [Get Merchant Channel by UUID](https://docs.bvnk.com/l1-api/crypto-payments/get-merchant-channel.md): Retrieves a specific merchant channel by its UUID. - [Get Merchant Channel Spot Rates by UUID](https://docs.bvnk.com/l1-api/crypto-payments/get-spot-rates.md): Retrieves spot rates for a specific merchant channel by its UUID. - [List Merchant Channel Payments](https://docs.bvnk.com/l1-api/crypto-payments/list-merchant-channel-payments.md): Retrieves a list of merchant channel payments based on the provided filters. - [List Merchant Channels](https://docs.bvnk.com/l1-api/crypto-payments/list-merchant-channels.md): Retrieves a list of merchant channels based on the provided filters. - [Accept Payment](https://docs.bvnk.com/l1-api/crypto-payments/payment-accept.md): Accepts a pending payment with currency or payout information. - [Create Payment](https://docs.bvnk.com/l1-api/crypto-payments/payment-create.md): Creates a payment, either type IN or type OUT. - [List Payments](https://docs.bvnk.com/l1-api/crypto-payments/payment-list.md): Retrieves a list of payments on a specific Merchant ID. - [Validate Address](https://docs.bvnk.com/l1-api/crypto-payments/payment-out-validate.md): Validates that a crypto address is correct. - [Get Payment](https://docs.bvnk.com/l1-api/crypto-payments/payment-read.md): Retrieves details of a specific payment using the UUID of the payment. - [Update Payment](https://docs.bvnk.com/l1-api/crypto-payments/payment-update.md): Updates a pending payment with currency or payout information. - [Read smart contract state](https://docs.bvnk.com/l1-api/digital-assets/call-contract.md): Calls a view or pure method and returns its decoded return values. No transaction is created, no fee is incurred and no funds move. - [Claim blockchain transaction](https://docs.bvnk.com/l1-api/digital-assets/claim-transaction.md): Claims an existing blockchain transaction. - [Create a new address](https://docs.bvnk.com/l1-api/digital-assets/create-address.md): Creates a crypto address. - [Create addresses synchronously across all supporting networks](https://docs.bvnk.com/l1-api/digital-assets/create-addresses.md): Creates a keypair, then concurrently creates addresses on all networks supporting the given asset or assets. Pass `asset` for one asset, `assets` f... - [Create asset pool](https://docs.bvnk.com/l1-api/digital-assets/create-asset-pool.md): Creates a new asset pool, which serves as a collection of assets. - [Query point-in-time balances](https://docs.bvnk.com/l1-api/digital-assets/create-balance-query.md): Retrieves point-in-time balance state for a bounded list of resource IDs. ADDRESS and POOL queries are supported. ADDRESS IDs that are not found or... - [Create consolidation request](https://docs.bvnk.com/l1-api/digital-assets/create-consolidation-request.md): Create a new address-level consolidation request to sweep funds from a specified address to the master address. - [Deploy a smart contract](https://docs.bvnk.com/l1-api/digital-assets/create-contract-deployment.md): Deploys a registered smart contract artifact from an address in the given asset pool. The deployment is processed asynchronously; poll the returned... - [Invoke a smart contract method](https://docs.bvnk.com/l1-api/digital-assets/create-contract-invocation.md): Invokes a state-changing method on a smart contract from an address in the given asset pool. Read-only methods must be queried through contract cal... - [Create an export job](https://docs.bvnk.com/l1-api/digital-assets/create-export.md): Starts a CSV export. Use the required query parameter 'type' to select either a transaction or balance export. - [Create key pair](https://docs.bvnk.com/l1-api/digital-assets/create-key-pair.md): Creates a new key pair from which different addresses can be created - [Create return transaction request](https://docs.bvnk.com/l1-api/digital-assets/create-return-transaction-request.md): Create a new blockchain transaction meant to return previously deposited funds - [Create staking request](https://docs.bvnk.com/l1-api/digital-assets/create-staking-transaction.md): Create a new blockchain staking transaction - [Create transaction request](https://docs.bvnk.com/l1-api/digital-assets/create-transaction.md): Creates a blockchain transaction. - [Delete asset pool](https://docs.bvnk.com/l1-api/digital-assets/delete-asset-pool.md): Deletes an asset pool with given ID if it doesn't have created addresses or transactions. - [Digital Asset](https://docs.bvnk.com/l1-api/digital-assets/digital-asset.md): Layer1 API making management of crypto assets simple and easy - [Estimate transaction fee](https://docs.bvnk.com/l1-api/digital-assets/estimate-transaction-fee.md): Estimate fee to send blockchain transaction. - [Execute an action on an address](https://docs.bvnk.com/l1-api/digital-assets/execute-address-action.md): Executes an action on a crypto address. Supported actions: CREATE_TAG — creates a new destination tag on a tag-based network address (e.g. Ripple/X... - [Execute an action on a transaction request](https://docs.bvnk.com/l1-api/digital-assets/execute-transaction-request-action.md): Executes an action on a transaction request. Supported actions: REJECT — rejects a transaction request that is awaiting funds, before it reaches th... - [Get point-in-time address balance](https://docs.bvnk.com/l1-api/digital-assets/get-address-balances-at-point-in-time.md): Retrieves balance state of an address at a specific timestamp - [Get address](https://docs.bvnk.com/l1-api/digital-assets/get-address.md): Retrieves details of the specific address. - [Get asset pool balances at point in time](https://docs.bvnk.com/l1-api/digital-assets/get-asset-pool-balances-at-point-in-time.md): Retrieves the aggregated balance state of an asset pool at a specific historical point in time. - [Get max asset pool withdrawable balance](https://docs.bvnk.com/l1-api/digital-assets/get-asset-pool-max-withdrawable-amount.md): Retrieves the maximum approximate withdrawable amount for a specified network and asset. **Note**: Fees are not included in this calculation. - [Get asset pool summary](https://docs.bvnk.com/l1-api/digital-assets/get-asset-pool-summary.md): Retrieve authenticated summary across all asset pools. - [Get asset pool](https://docs.bvnk.com/l1-api/digital-assets/get-asset-pool.md): Retrieves a specific asset pool by its unique ID. - [Get a contract deployment](https://docs.bvnk.com/l1-api/digital-assets/get-contract-deployment.md): Retrieves a deployment, including its status and — once confirmed — the address the contract was created at. - [Get a contract invocation](https://docs.bvnk.com/l1-api/digital-assets/get-contract-invocation.md): Retrieves an invocation, including its status and, once broadcast, its transaction hash. - [Get smart contract artifact](https://docs.bvnk.com/l1-api/digital-assets/get-contract.md): Retrieves a smart contract artifact by id, if it is visible to the caller's tenant (owned by that tenant or available to every tenant). Bytecode is... - [Get export with a download link](https://docs.bvnk.com/l1-api/digital-assets/get-export.md): Retrieves export details, including a short-lived download link, using the export ID. - [List all exports](https://docs.bvnk.com/l1-api/digital-assets/get-exports.md): Retrieves a paginated list of exports based on type and pagination settings. - [Get key pair](https://docs.bvnk.com/l1-api/digital-assets/get-key-pair.md): Retrieve a key pair given id - [Get all networks](https://docs.bvnk.com/l1-api/digital-assets/get-networks.md): Get all supported networks and their assets. By default, only enabled networks are returned. - [Get transaction](https://docs.bvnk.com/l1-api/digital-assets/get-transaction-by-id.md): Retrieves a transaction by its ID. - [Get transaction request](https://docs.bvnk.com/l1-api/digital-assets/get-transaction-request-by-id.md): Retrieves a transaction request by its ID. - [List addresses](https://docs.bvnk.com/l1-api/digital-assets/list-addresses-v-2.md): Retrieves a cursor-paginated list of crypto addresses. Follow `nextCursor` from each response to page forward; the last page omits it and reports `... - [List asset pools](https://docs.bvnk.com/l1-api/digital-assets/list-asset-pools.md): Retrieves a paginated list of asset pools. - [List smart contract artifacts](https://docs.bvnk.com/l1-api/digital-assets/list-contracts.md): Retrieves a paginated list of smart contract artifacts visible to the caller's tenant (its own artifacts plus artifacts available to every tenant).... - [List deposits requiring remediation](https://docs.bvnk.com/l1-api/digital-assets/list-deposits-requiring-remediation.md): Retrieves a paginated list of deposit transactions for the authenticated tenant that require remediation (e.g. missing compliance details). - [List key pairs](https://docs.bvnk.com/l1-api/digital-assets/list-key-pairs.md): Retrieve paginated list of key-pairs belonging to a asset pool - [List screening results](https://docs.bvnk.com/l1-api/digital-assets/list-screenings.md): Retrieves a paginated list of the most recent transfers along with their screening results. - [List address tags](https://docs.bvnk.com/l1-api/digital-assets/list-tags.md): Retrieves a paginated list of address tags. - [List transaction requests](https://docs.bvnk.com/l1-api/digital-assets/list-transaction-requests.md): Retrieves a paginated list of transaction requests. - [List transactions](https://docs.bvnk.com/l1-api/digital-assets/list-transactions.md): Retrieves a paginated list of transactions. - [Approve, reject, bypass, or remediate screening of a transfer](https://docs.bvnk.com/l1-api/digital-assets/manually-action-transfer.md): Approves or rejects a held transfer, bypasses screening for a pending one, or remediates a transfer. The required scope depends on the requested ac... - [Patch address](https://docs.bvnk.com/l1-api/digital-assets/patch-address.md): Partially updates an address using JSON Merge Patch (RFC 7396). Supports patching `metadata`. Within metadata, keys with non-null values are set, k... - [Patch key pair](https://docs.bvnk.com/l1-api/digital-assets/patch-key-pair.md): Partially updates a key pair using JSON Merge Patch (RFC 7396). Only the `metadata` field can be patched. Within metadata, keys with non-null value... - [Update asset pool](https://docs.bvnk.com/l1-api/digital-assets/update-asset-pool.md): Updates a specific asset pool property by its ID. - [Validate address](https://docs.bvnk.com/l1-api/digital-assets/validate-address.md): Validate a blockchain address. - [Cancel conversion](https://docs.bvnk.com/l1-api/trade/cancel-conversion.md): Attempt to cancel an in-progress conversion. Only conversions with status PENDING or PROCESSING can be cancelled. - [Create conversion export](https://docs.bvnk.com/l1-api/trade/create-conversion-export.md): Initiates an asynchronous job to export conversion data for the specified date range. The export will be generated in the requested format and uplo... - [Create conversion](https://docs.bvnk.com/l1-api/trade/create-conversion.md): Creates a new conversion request to exchange one asset for another. The conversion will be processed asynchronously. - [Create a venue deposit address directly](https://docs.bvnk.com/l1-api/trade/create-venue-deposit-address.md): Creates a new deposit address by directly providing all required details. This is a synchronous operation that stores the address immediately witho... - [Delete a venue deposit address](https://docs.bvnk.com/l1-api/trade/delete-venue-deposit-address.md): Deletes an existing deposit address for a specific venue, asset, network, and address combination. This operation is idempotent - deleting a non-ex... - [Estimate conversion](https://docs.bvnk.com/l1-api/trade/estimate-conversion.md): Get an accurate estimate of the conversion result including expected output amount, fees, and execution time - [List possible destination assets](https://docs.bvnk.com/l1-api/trade/find-possible-destination-assets.md): Retrieve a list of assets that can be converted to from the specified source asset, considering available trading symbols - [Get all indicative exchange rates](https://docs.bvnk.com/l1-api/trade/get-all-indicative-rates.md): Retrieve all available indicative exchange rates for a given base currency. This endpoint returns exchange rates from the specified base asset to a... - [Get venue balance summary aggregated by asset across available venues](https://docs.bvnk.com/l1-api/trade/get-balance-summary.md): Get venue balance summary - [Get conversion](https://docs.bvnk.com/l1-api/trade/get-conversion.md): Retrieve detailed information about a specific conversion using its unique identifier - [Get export with a download link](https://docs.bvnk.com/l1-api/trade/get-export.md): Retrieves export details, including a short-lived download link, using the export ID. - [List all exports](https://docs.bvnk.com/l1-api/trade/get-exports.md): Retrieves a paginated list of exports based on type and pagination settings. - [Get indicative exchange rate](https://docs.bvnk.com/l1-api/trade/get-indicative-rate.md): Retrieve an indicative exchange rate between two assets using mid-market/ticker rates. The rate is calculated based on current market data and prov... - [Get aggregated order book](https://docs.bvnk.com/l1-api/trade/get-market-data-aggregated-order-book.md): Retrieve an aggregated order book that combines data from multiple venues for a given trading symbol. The aggregation includes venue information an... - [Get market data order books](https://docs.bvnk.com/l1-api/trade/get-market-data-order-books.md): Retrieve a list of order books for a given trading symbol. Order books contain bid and ask orders with price levels and quantities. If a venue is s... - [Get market data tickers](https://docs.bvnk.com/l1-api/trade/get-market-data-tickers.md): Retrieve a list of tickers for a given trading symbol. Tickers contain current market data including last price, bid/ask prices, volume, and high/l... - [Get live venue quotes](https://docs.bvnk.com/l1-api/trade/get-market-data-venue-quotes.md): Fetch live quotes from a quote-executing venue. Unrecognized query parameters are relayed to the venue as venue-specific options. - [Get venue deposit](https://docs.bvnk.com/l1-api/trade/get-venue-deposit.md): Retrieve a single venue deposit - [Get venue withdrawal](https://docs.bvnk.com/l1-api/trade/get-venue-withdrawal.md): Retrieve detailed information about a specific withdrawal using its unique identifier - [List venue balances](https://docs.bvnk.com/l1-api/trade/list-balances.md): List venue balances - [List conversions](https://docs.bvnk.com/l1-api/trade/list-conversions.md): Retrieve a paginated list of conversions with optional filtering using Lucene query syntax - [List venue deposit addresses](https://docs.bvnk.com/l1-api/trade/list-venue-deposit-addresses.md): Retrieve a paginated list of deposit addresses across all venues with optional filtering by venue, asset, status, and other criteria - [List venue deposits](https://docs.bvnk.com/l1-api/trade/list-venue-deposits.md): Retrieve paginated list of venue deposits - [List venue withdrawals](https://docs.bvnk.com/l1-api/trade/list-venue-withdrawals.md): Retrieve a paginated list of venue withdrawals with optional filtering by asset and venue - [List venues](https://docs.bvnk.com/l1-api/trade/list-venues.md): Retrieve a list of trading venues - [Request a new venue deposit address](https://docs.bvnk.com/l1-api/trade/request-venue-deposit-address.md): Creates a request for a new deposit address at a specific venue for the given asset. The address generation is processed asynchronously and the add... - [Request venue withdrawal](https://docs.bvnk.com/l1-api/trade/request-venue-withdrawal.md): Creates a new withdrawal request to transfer funds from a venue to a blockchain address or fiat destination. The withdrawal will be processed async... - [Trading](https://docs.bvnk.com/l1-api/trade/trading.md): Layer1 API making management of crypto assets simple and easy - [Update venue settings](https://docs.bvnk.com/l1-api/trade/update-venue.md): Update venue properties like trading enabled status - [Create managed balance with optional eligible sources](https://docs.bvnk.com/l1-api/treasury/create-managed-balance.md): Create a new managed balance with the ability to provide eligible sources upfront - [Remove managed balance](https://docs.bvnk.com/l1-api/treasury/delete-managed-balance.md): Delete a managed balance by ID. Allowed only if balanced is not referenced anywhere as a source. - [Delete cached processing profile](https://docs.bvnk.com/l1-api/treasury/delete-processing-profile.md): Remove the cached processing profile mapping for a specific managed balance - [Trigger a manual top-up](https://docs.bvnk.com/l1-api/treasury/execute-balance-adjustment-1.md): Execute a balance adjustment for a managed balance - [Trigger a manual top-up](https://docs.bvnk.com/l1-api/treasury/execute-balance-adjustment.md): Execute a balance adjustment for a managed balance - [Get activity logs for a managed balance](https://docs.bvnk.com/l1-api/treasury/get-activity-logs.md): Retrieve a paginated list of activity logs for a specific managed balance within a date range. The date range cannot exceed 3 months. Activity logs... - [List managed balances](https://docs.bvnk.com/l1-api/treasury/get-all-managed-balances.md): Retrieve a paginated list of all managed balances - [Get current balance](https://docs.bvnk.com/l1-api/treasury/get-current-balance.md): Retrieve the current balance for a specific managed balance - [Get eligible sources for a managed balance](https://docs.bvnk.com/l1-api/treasury/get-eligible-sources.md): Retrieve all eligible sources with their details and priorities for a managed balance - [Get linked managed balances](https://docs.bvnk.com/l1-api/treasury/get-linked-managed-balances.md): Retrieve a list of managed balances that are linked to the specified managed balance - [Get revisions for a managed balance](https://docs.bvnk.com/l1-api/treasury/get-managed-balance-revisions.md): Retrieve a paginated list of revisions for a specific managed balance by ID - [Get managed balance](https://docs.bvnk.com/l1-api/treasury/get-managed-balance.md): Retrieve a specific managed balance by ID - [Get processing profile](https://docs.bvnk.com/l1-api/treasury/get-processing-profile.md): Retrieve the processing profile mapped to a specific managed balance - [Get treasury operations](https://docs.bvnk.com/l1-api/treasury/get-treasury-operations.md): Retrieve a paginated list of treasury operations for the authenticated tenant - [Update managed balance property](https://docs.bvnk.com/l1-api/treasury/patch-managed-balance-property.md): Update a specific property (monitoring-enabled or forecast-enabled) for a managed balance - [Update threshold for a managed balance](https://docs.bvnk.com/l1-api/treasury/patch-thresholds.md): Update thresholds for a managed balance - [Remove funding source for a managed balance](https://docs.bvnk.com/l1-api/treasury/remove-eligible-source.md): Remove an eligible source from a managed balance - [Get templates to create a managed balance](https://docs.bvnk.com/l1-api/treasury/retrieve-managed-balance-templates.md): Retrieve templates for managed balance creation for the authenticated tenant - [Treasury](https://docs.bvnk.com/l1-api/treasury/treasury.md): Layer1 API for treasury management - [Add funding source for a managed balance](https://docs.bvnk.com/l1-api/treasury/upsert-eligible-source.md): Add or update an eligible source for a managed balance - [Update managed balance](https://docs.bvnk.com/l1-api/treasury/upsert-managed-balance.md): Create a new managed balance or update an existing one - [validate](https://docs.bvnk.com/l1-api/treasury/validate.md): validate - [Approval request status changed](https://docs.bvnk.com/l1-api/webhook-events/approval-request-status-changed.md): Triggered when the status of an approval request changes to a final state. - [Approval request vote required](https://docs.bvnk.com/l1-api/webhook-events/approval-request-vote-required.md): Triggered when an approval request requires a user's vote. - [API audit event](https://docs.bvnk.com/l1-api/webhook-events/audit-api.md): This webhook is sent for necessary, predefined API calls configured on the API gateway. - [Authentication login audit event](https://docs.bvnk.com/l1-api/webhook-events/audit-auth-login.md): This webhook captures user and client login events recorded by Keycloak. - [Cryptocurrency address created](https://docs.bvnk.com/l1-api/webhook-events/crypto-address-created.md): Triggered when a new cryptocurrency address is created. - [Consolidation status change](https://docs.bvnk.com/l1-api/webhook-events/crypto-consolidation-status-change.md): Triggered when the status of a cryptocurrency consolidation changes. - [Deposit status change](https://docs.bvnk.com/l1-api/webhook-events/crypto-deposit-status-change.md): Triggered when the status of a cryptocurrency deposit changes. - [Withdrawal status change](https://docs.bvnk.com/l1-api/webhook-events/crypto-withdrawal-status-change.md): Triggered when the status of a cryptocurrency withdrawal changes. - [Digital balance updated](https://docs.bvnk.com/l1-api/webhook-events/digital-balance-updated.md): Triggered when a digital asset balance is updated. - [Layer1 Webhooks API](https://docs.bvnk.com/l1-api/webhook-events/layer-1-webhooks-api.md): Layer1 Webhooks API provides real-time notifications for various events across the Layer1 platform. - [Trade conversion created](https://docs.bvnk.com/l1-api/webhook-events/trade-conversion-created.md): Triggered when a new trade conversion is created. - [Trade conversion state change](https://docs.bvnk.com/l1-api/webhook-events/trade-conversion-state-changed.md): Triggered when the state of a trade conversion changes. - [Create a new destination](https://docs.bvnk.com/l1-api/webhooks/create-destination-1.md): Allows admin to create a new destination for a provided account - [Create a new destination](https://docs.bvnk.com/l1-api/webhooks/create-destination.md): Creates a new destination - [Hook](https://docs.bvnk.com/l1-api/webhooks/hook.md): Layer1 API making management of crypto assets simple and easy - [List destinations for a specific account](https://docs.bvnk.com/l1-api/webhooks/list-destinations-1.md): Allows admin to retrieve paginated list of destinations for a specific account - [List destinations](https://docs.bvnk.com/l1-api/webhooks/list-destinations.md): Retrieve paginated list of destinations - [List events](https://docs.bvnk.com/l1-api/webhooks/list-events.md): Retrieve paginated list of events - [Remove an existing destination](https://docs.bvnk.com/l1-api/webhooks/remove-destination-1.md): Removes an existing destination - [Remove a destination](https://docs.bvnk.com/l1-api/webhooks/remove-destination.md): Allows admin to permanently remove a destination for a provided account - [Replay events](https://docs.bvnk.com/l1-api/webhooks/replay-events.md): Replay completed events by re-publishing them. - [Update a new destination](https://docs.bvnk.com/l1-api/webhooks/update-destination-1.md): Allows admin to update certain details of a destination for a provided account - [Update the existing destination](https://docs.bvnk.com/l1-api/webhooks/update-destination.md): Updates the existing destination - [Create a blockchain address](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/create-addresses.md): Unique blockchain wallet addresses - [Create a merchant account](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/creating-accounts.md): Adding your Merchants as part of the whitelabel Payment Services solution. - [Create an asset pool](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/creating-an-asset-pool.md): Your collection of funds across networks - [Deposit and withdraw funds](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/deposits-and-withdrawals.md): Seeing your assets move - [Manage Smart Treasury](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/manage-smart-treasury.md): Automate liquidity top-ups in your Layer1 Wallet based on configurable thresholds and AI-powered forecasts. - [Create tenant account and add users](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/tenant-and-user-creation.md): Getting access - [Organise wallets, channels, and payment links](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal/wallets-channels-payment-links.md): Account portal payments feature set - [Get started with sandbox portal](https://docs.bvnk.com/layer1/getting-started/getting-started-in-sandbox-portal.md): Explore the Layer1 back office portal in Sandbox - [Overview](https://docs.bvnk.com/layer1/getting-started.md): The wallet service and blockchain node provider service, all bundled into one. - [Layer 1 documentation](https://docs.bvnk.com/layer1.md): Redirect to Layer 1 overview - [Dust classification](https://docs.bvnk.com/layer1/references/dust-classification.md):
- [Reporting and reconciliation](https://docs.bvnk.com/layer1/references/reporting-reconciliation.md): Layer1 reporting tools help you track wallet activity, monitor balances, and export data to match against your internal financial records. Use this... - [Roles and permissions](https://docs.bvnk.com/layer1/references/roles.md): User and API key role descriptions - [Supported assets and networks](https://docs.bvnk.com/layer1/references/supported-assets-and-protocols.md): The supported digital assets on our platform, including details such as their code, protocols, and the required block confirmations for transactions. - [Auto-consolidate assets in master wallet](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses/automatic-fund-conslidation.md): Auto-consolidation is a native feature of the Layer1 platform that automatically aggregates dispersed liquidity from multiple blockchain deposit wa... - [Create a crypto address](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses/create-a-new-crypto-address.md): Once you have an Asset Pool and `id` from the earlier request, you can generate crypto addresses within that Asset Pool. See the list of available ... - [Create an asset pool](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses/create-an-asset-pool.md): An Asset Pool is a collection of funds from various currencies and networks, all grouped together. That means all actions can be focused at the poo... - [Receive deposit and ingest the webhooks](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses/receive-deposit-and-ingest-the-webhooks.md): Once you share the address with a depositor, wait for the deposit to arrive. When Layer1 detects such a transaction, the following webhook types ar... - [Recover funds sent on incorrect network](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses/recover-funds-from-incorrect-network.md): The guide explains how to recover funds that were sent over the incorrect network. - [Set up a webhook destination](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses/set-up-a-webhook-destination.md): Webhooks allow you to subscribe to specific events or multiple events within a single destination. - [Receive deposits](https://docs.bvnk.com/layer1/use-cases/digital-assets/accepting-deposits-to-new-addresses.md): This guide outlines the process for accepting deposits into a unique address created for the transaction. - [Add a contact](https://docs.bvnk.com/layer1/use-cases/digital-assets/add-a-contact.md): Manage trusted withdrawal addresses for first- and third-party accounts to enable seamless transfers and reduce the risk of sending funds to incorr... - [Approve withdrawals](https://docs.bvnk.com/layer1/use-cases/digital-assets/creating-a-withdrawal-transaction-request/approve-withdrawals.md): To set up approvals for your Layer1 account, first follow the steps outlined in the [Configure Approval for Withdrawals ](/layer1/use-cases/digital... - [Configure approvals for withdrawals](https://docs.bvnk.com/layer1/use-cases/digital-assets/creating-a-withdrawal-transaction-request/configure-approval-settings.md): Approval settings allow you to configure rules to govern outgoing transactions from your asset pools. By setting volume-based thresholds, you can r... - [Create withdrawal transaction](https://docs.bvnk.com/layer1/use-cases/digital-assets/creating-a-withdrawal-transaction-request/creating-the-withdrawal.md): To create a withdrawal transaction, send [`POST /digital/v1/transaction-requests`](/l1-api/digital-assets/create-transaction) request with the foll... - [Receive withdrawal notifications](https://docs.bvnk.com/layer1/use-cases/digital-assets/creating-a-withdrawal-transaction-request/understanding-the-withdrawal-webhooks.md): Once the transaction has been submitted, the following webhooks are sent out for each stage of the withdrawal process. - [Send withdrawals](https://docs.bvnk.com/layer1/use-cases/digital-assets/creating-a-withdrawal-transaction-request.md): Create a transaction to withdraw crypto from your asset pool and send it to an external wallet. - [Screen transactions](https://docs.bvnk.com/layer1/use-cases/digital-assets/screening-providers.md): Layer1 integrates with leading blockchain intelligence platforms to help identify and mitigate exposure to high-risk counterparties. Today, the pla... - [Stake TRX to reduce gas fees](https://docs.bvnk.com/layer1/use-cases/digital-assets/staking.md): This step-by-step guide explains how staking works on the TRON network and how that saves you gas fees. - [Digital assets](https://docs.bvnk.com/layer1/use-cases/digital-assets.md): Receive deposits, send withdrawals, manage asset pools, and screen transactions using the Layer1 Digital Assets API. - [Create pay-in](https://docs.bvnk.com/layer1/use-cases/merchant-payments/building-a-checkout-for-crypto-payments-1/creating-a-payment-1.md): To initiate a payment process, send the [`POST /api/v1/pay/summary`](/l1-api/crypto-payments/payment-create) request with the following body parame... - [Receive pay-in notifications](https://docs.bvnk.com/layer1/use-cases/merchant-payments/building-a-checkout-for-crypto-payments-1/listening-for-payment-in-webhooks-1.md): Layer1 sends out a series of webhooks to keep you informed on any lifecycle event for the payment you have created. - [Accept digital asset payments](https://docs.bvnk.com/layer1/use-cases/merchant-payments/building-a-checkout-for-crypto-payments-1.md): This guide outlines the process for incorporating crypto payments into your workflow with Layer1 via API, allowing you to customise your own paymen... - [Charge merchant fees](https://docs.bvnk.com/layer1/use-cases/merchant-payments/charge-merchant-fees.md): With Layer1’s Fee Service, you have all the tools to charge your merchants for the payment processing services you provide. Setting this up correct... - [Payment in](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/creating-a-payment-in.md): Initiating the payment in flow - [Directing the end-user to pay](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/directing-the-user-to-pay.md): Redirect the end-user to the Hosted Payments Page to complete the payment - [Directing the end-user to payout](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/directing-the-user-to-payout.md): Redirect the user to the Hosted Payments Page so that they can complete the payment - [Listening for payment in webhooks](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/listening-for-payment-in-webhooks.md): Get notified of all state changes in the payment journey - [Listening for payout webhooks](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/listening-for-payout-webhooks.md): Get notified of all state changes in the payment journey - [(Optional) Pre-selecting the digital asset to pay](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/optional-preselecting-digital-asset-to-pay.md): Skip a step in the journey by having the digital asset already selected - [(Optional) Pre-selecting the digital asset to receive](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/optional-preselecting-digital-asset-to-receive.md): Skip a step in the journey by having the digital asset already selected - [Handle payment in exceptions](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/payment-in-exception-scenarios-1.md): The final step is to build in handling for exceptions that may occur in the payment flow. We have discussed the types of webhooks in a previous pag... - [Payout](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments/payment-out.md): Initiating the payout flow - [Hosted checkout for digital asset payments](https://docs.bvnk.com/layer1/use-cases/merchant-payments/hosted-checkout-digital-asset-payments.md): Use our hosted checkout experience or build your own - [Create a payout](https://docs.bvnk.com/layer1/use-cases/merchant-payments/sending-crypto-payouts/create-a-pay-out-with-payment-out-details.md): To initiate a payment out, send the [`POST /api/v1/pay/summary`](/l1-api/crypto-payments/payment-create) request with `type` set to `OUT`. Remember... - [Receive payout notifications](https://docs.bvnk.com/layer1/use-cases/merchant-payments/sending-crypto-payouts/listening-for-payout-webhooks.md): Layer1 sends out a series of webhooks to keep you informed on any lifecycle event for the payment you have created. - [Send digital asset payouts](https://docs.bvnk.com/layer1/use-cases/merchant-payments/sending-crypto-payouts.md): This quick start guide aims to assist you in adding crypto payout capabilities to your product. - [Set up payment processing](https://docs.bvnk.com/layer1/use-cases/merchant-payments/set-up-payment-processing.md): The following guide outlines the initial setup required to begin processing payments with the Merchant Payments Engine. These are one-time configur... - [Merchant payments](https://docs.bvnk.com/layer1/use-cases/merchant-payments.md): The **Merchant Payment Engine** is a complete, off-the-shelf crypto checkout solution explicitly built for Layer1 tenants. It lets you instantly gi... - [Add Ethereum wallet for USDT and USDC](https://docs.bvnk.com/layer1/use-cases/testing-your-integration/setting-up-a-metamask-ethereum-wallet-for-eth-and-usdt-erc20-tokens.md): Set Up a MetaMask Ethereum Wallet for ETH and USDT ERC20 tokens. - [Add TronLink wallet for TRX and USDT](https://docs.bvnk.com/layer1/use-cases/testing-your-integration/setting-up-a-tronlink-wallet-for-trx-and-usdt-trc20-tokens.md): Set Up a TronLink Wallet for TRX and USDT TRC20 tokens. - [Test blockchain integration](https://docs.bvnk.com/layer1/use-cases/testing-your-integration.md): Use a test network to check your integration with real blockchains. - [Understanding the conversion flow](https://docs.bvnk.com/layer1/use-cases/trading/converting-or-trading-your-balances/understanding-the-conversion-flow.md): This section describes the lifecycle of a conversion and order on the Layer1 platform, outlining the different statuses a conversion goes through f... - [Convert balances](https://docs.bvnk.com/layer1/use-cases/trading/converting-or-trading-your-balances.md): Using Layer1 you can convert balances held at your connected trading venues. With Layer1's API connections to the venues you are able to optimise c... - [Add trading venues](https://docs.bvnk.com/layer1/use-cases/trading/trading-venues.md): Layer1 integrates with trading venues via the [XChange Java library](https://github.com/knowm/XChange). This provides consistent access to major ex... - [Trading](https://docs.bvnk.com/layer1/use-cases/trading.md) - [Manage balances](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups/manage-balances.md): This guide provide a detailed description of all operations involving managed balances. - [Manage funding sources](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups/manage-funding-sources.md): To **add a funding source to a managed balance**, send a [`PUT /treasury/v1/managed-balances/{managedBalanceId}/eligible-sources/{sourceManagedBala... - [Predict top-ups](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups/predict-top-ups.md): Forecasting helps automate your treasury operations with data-backed intelligence. It ensures you always have the right funds, in the right place, ... - [Quick start](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups/quick-start.md): Use the Smart Treasury API to automate wallet funding and ensure constant liquidity without manual intervention. This guide walks you through three... - [Receive notifications](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups/receive-notification.md): When Layer1 detects a managed balance transaction , the following webhooks types are sent out: - [View and adjust balance](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups/view-and-adjust-balance.md): To **create a manual balance adjustment**, send a [`POST /treasury/v1/balance-adjustments`](/l1-api/treasury/execute-balance-adjustment-1) request ... - [Automate treasury top-ups](https://docs.bvnk.com/layer1/use-cases/treasury/automate-treasury-top-ups.md): This guide explains how to integrate with the Smart Treasury APIs to automate top-ups, configure thresholds, and monitor liquidity. - [Smart treasury](https://docs.bvnk.com/layer1/use-cases/treasury.md) - [Beneficiary](https://docs.bvnk.com/terms/beneficiary.md): The entity that receives the transaction. - [Originator](https://docs.bvnk.com/terms/originator.md): The entity that initiates the transaction. For example, a customer that wants to buy crypto with fiat currency.