# BVNK API Docs Documentation ## Guides - [MCP Server](https://docs.bvnk.com/docs/mcp-1.md) - [Receive Webhook Notifications](https://docs.bvnk.com/docs/create-webhook-listener.md) - [Create Your First Merchant](https://docs.bvnk.com/docs/creating-your-first-merchant.md) - [Create Your First Wallet](https://docs.bvnk.com/docs/creating-your-first-wallet.md) - [Get Started with BVNK](https://docs.bvnk.com/docs/getting-started.md): Welcome to the BVNK Developer Hub. Here you'll find comprehensive guides and documentation to help you start working with BVNK as quickly as possible, and get support if you get stuck. - [Add Ethereum Wallet for ETH and USDT](https://docs.bvnk.com/docs/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/docs/setting-up-a-tronlink-wallet-for-trx-and-usdt-trc20-tokens.md): Set Up a TronLink Wallet for TRX and USDT TRC20 tokens. - [Currencies](https://docs.bvnk.com/docs/currencies-1.md) - [Industry References](https://docs.bvnk.com/docs/retrieve-industry-references-1.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/docs/retrieve-monthly-expected-volumes-references-1.md): This is a definitive list of Expected Monthly Volume values which can be included in the payload when creating a customer. - [Uptime and incident handling](https://docs.bvnk.com/docs/uptime-and-incident-handling.md) - [Provide party information for crypto payments](https://docs.bvnk.com/docs/provide-user-information-for-payments.md): Learn what details you must provide within your payments to comply with the travel rule. - [Receive Transactions Report via Webhook](https://docs.bvnk.com/docs/receive-transaction-history-report-via-webhook.md) - [Create a Channel](https://docs.bvnk.com/docs/creating-a-channel.md) - [Integrate Cryptocurrency Top-up ](https://docs.bvnk.com/docs/adding-crypto-top-ups.md): This quick start guide explains how to incorporate crypto balance top-ups into your product with BVNK. - [Receive Channel Notifications](https://docs.bvnk.com/docs/listening-for-channel-webhooks.md) - [Set up Currency for Payments](https://docs.bvnk.com/docs/configuring-currency-and-protocol-preferences-on-payout.md) - [Make a Payment](https://docs.bvnk.com/docs/creating-a-payment.md) - [Build Crypto Payment Gateway](https://docs.bvnk.com/docs/building-a-checkout.md): The following guide will walk you step by step through the process of making a crypto gateway: from creating your first payment to preparing a UI ready to accept crypto payments from your customers. - [Receive Payment Notifications](https://docs.bvnk.com/docs/listening-for-payment-webhooks.md) - [Overpayments](https://docs.bvnk.com/docs/over-payments.md): How to handle receival of payment amounts greater than expected. - [Fiat-to-Crypto On-ramp](https://docs.bvnk.com/docs/fiat-to-crypto-on-ramp.md): This guide explains how to create a rule on a Fiat Virtual Account to automatically convert from fiat to crypto (on-ramp), and then send those crypto funds to a crypto address. - [Create a Customer Wallet and Virtual Account](https://docs.bvnk.com/docs/creating-a-customer-wallet.md) - [Listen for Pay-in Webhooks](https://docs.bvnk.com/docs/listening-for-payin-webhooks.md): A pay-in webhook delivers real-time notifications about key events, such as initiation, completion, or failure, ensuring automated updates in your system. - [Retrieve Customer Wallets](https://docs.bvnk.com/docs/retrieve-wallet-details.md) - [Creating a Company Customer](https://docs.bvnk.com/docs/creating-a-company-customer.md) - [Creating an Individual Customer](https://docs.bvnk.com/docs/creating-an-individual-customer.md) - [Create a Customer](https://docs.bvnk.com/docs/creating-a-customer.md) - [Retrieve Customer Details](https://docs.bvnk.com/docs/retrieve-customer-details.md) - [Create an Internal Transfer](https://docs.bvnk.com/docs/creating-a-transfer.md): This endpoint is used to facilitate internal transfers. You can transfer both fiat and crypto funds. - [Listen for Internal Transfer Webhook](https://docs.bvnk.com/docs/listening-for-transfer-webhooks.md) - [Check Payout Status](https://docs.bvnk.com/docs/check-the-status-of-a-payout.md): This endpoint is used to check the status of a payout which was initiated. - [Create a Payout](https://docs.bvnk.com/docs/creating-payouts.md) - [Initiate Payouts (ver. 2)](https://docs.bvnk.com/docs/initiate-payment-2.md) - [Listen for Payout Webhook](https://docs.bvnk.com/docs/listening-for-payout-webhooks-1.md) - [Integrate Customer Virtual Accounts](https://docs.bvnk.com/docs/customer-virtual-accounts.md) - [WooCommerce](https://docs.bvnk.com/docs/woocommerce.md): This guide helps you integrate and configure the BVNK WooCommerce plugin with your WooCommerce store, enabling secure cryptocurrency and stablecoin payments. - [Individual Requirements](https://docs.bvnk.com/docs/compliance-requirements-for-individuals2.md): This article provides a comprehensive summary of the required fields, document types, and applicable conditions for onboarding individual customers to our platform. - [Business Requirements](https://docs.bvnk.com/docs/embedded-compliance-requirements-businesses.md): This article outlines the requirements that must be met to successfully onboard a business EPC to the BVNK platform. - [Compliance Requirements](https://docs.bvnk.com/docs/compliance-requirements.md): For Embedded Partner Customers - [Add Documents to Customers](https://docs.bvnk.com/docs/add-documents-to-customers.md): Use the following endpoints to **attach documents** to an existing customer: at the **company level** or for a **specific associate** (beneficial owner, director, or signer). - [Create a Customer via API](https://docs.bvnk.com/docs/creating-an-embedded-customer-company-api.md): The endpoint described here enable you to create **company** or **individual** customers. - [Create a Customer via Portal](https://docs.bvnk.com/docs/creating-an-embedded-partner-customer-business-portal.md) - [Create an Embedded Partner Customer](https://docs.bvnk.com/docs/create-embedded-partner-customer.md): This guide provides a step-by-step process to create Embedded Partner Customer (EPC) accounts using BVNK Embedded Wallets. - [Gather Compliance Data for Onboarding](https://docs.bvnk.com/docs/onboard-epc.md): This guide explains how to gather compliance data with questionnaires and integrate them into the EPC onboarding process. - [Retrieve Customer Details](https://docs.bvnk.com/docs/retrieve-embedded-partner-customer.md) - [Prepare Customer Agreements](https://docs.bvnk.com/docs/signing-customer-agreements.md): The BVNK Agreements API enables you to create and manage agreements between BVNK and your customers (referred to as Embedded Partner Customers). This section describes the BVNK Agreements flow, enabling your Embedded Partner Customers to review and accept required agreements seamlessly. - [Integrate Embedded Wallets](https://docs.bvnk.com/docs/embedded-wallets.md): This guide provides essential instructions to help you get started with BVNK’s Embedded Customer Wallets product. - [Crypto Pay-ins](https://docs.bvnk.com/docs/crypto-pay-in.md) - [Crypto Payouts](https://docs.bvnk.com/docs/crypto-payouts.md) - [Internal Transfers](https://docs.bvnk.com/docs/listening-for-internal-transfer.md): With internal transfer webhook, you can receive real-time notifications to your system about key internal transfer events, such as initiation, completion, or failure, enabling automated updates without manual intervention. - [Fiat Payouts](https://docs.bvnk.com/docs/listening-for-payout-webhooks-2.md): The following guide describes how to enable payout webhook. - [Fiat Pay-ins](https://docs.bvnk.com/docs/step-5-get-notified-about-payins.md): A pay-in webhook delivers real-time notifications about key events, such as initiation, completion, or failure, ensuring automated updates in your system. - [Create a Customer Wallet](https://docs.bvnk.com/docs/step-2-creating-a-customer-wallet-and-virtual-account.md) - [Retrieve Customer Wallets](https://docs.bvnk.com/docs/retrieve-customer-wallets.md): This endpoint allows you to retrieve all wallets associated with a specific Embedded Partner Customer, offering a detailed overview of their account. - [Create an Internal Transfer](https://docs.bvnk.com/docs/step-3-creating-a-transfer.md): This endpoint is used to facilitate internal transfers. You can transfer both fiat and crypto funds. - [Charge Customer Fees](https://docs.bvnk.com/docs/charge-customer-fees.md): This guide explains how to implement customer fees for transactions using our API. - [Check Payout Status](https://docs.bvnk.com/docs/check-the-status-of-a-payout-1.md): The Payout Status API endpoint allows you to check the current status of an initiated payout. It can also be used to verify the payout's state after receiving status change webhooks or whenever additional confirmation is required - [Make Crypto Payments from Embedded Customer Wallets](https://docs.bvnk.com/docs/create-a-crypto-payout.md): This guide explains how to initiate incoming and outgoing payments for an Embedded Partner Customer’s wallet. - [Make a Stablecoin Payout from Your Partner Wallet](https://docs.bvnk.com/docs/create-embedded-partner-customer-payout.md): This guide focuses on the peculiarities of Stablecoin Payouts made from a pre-funded wallet, which are specific to the Embedded Model. Before continuing, see the [Create a payout](https://docs.bvnk.com/docs/creating-a-payout) guide to gain a general understanding of the Payout API. - [Make and Accept Payments](https://docs.bvnk.com/docs/step-4-creating-a-payout.md): Embedded Partner Customers can complete payouts to other bank accounts using their Virtual Account. - [Make a Fiat Payout](https://docs.bvnk.com/docs/making-payouts-to-a-business.md): This endpoint allows you to make a payout to a Business or an Individual. - [Receive Payment into EPC Wallet](https://docs.bvnk.com/docs/receive-payment-into-epc-wallet.md) - [Try Fiat Payments in Simulator](https://docs.bvnk.com/docs/banking-simulator.md) - [Enable Notifications for Fiat Payments](https://docs.bvnk.com/docs/enabling-webhooks-for-fiat-payments.md) - [Enable Internal Transfers Notifications](https://docs.bvnk.com/docs/listening-for-internal-transfers-webhooks.md) - [Enable Pay-in Notifications](https://docs.bvnk.com/docs/listening-for-pay-in-webhooks.md) - [Enable Payout Notifications](https://docs.bvnk.com/docs/listening-for-payment-out-webhooks.md) - [Enable Wallet Creation Notifications](https://docs.bvnk.com/docs/listening-for-wallet-creation-request-webhooks.md) - [Validate FIAT Payment Webhooks](https://docs.bvnk.com/docs/validating-fiat-webhooks.md) - [Check Payout Status](https://docs.bvnk.com/docs/fiat-payout-status.md): The Payout Status API endpoint allows you to check the current status of an initiated payout. It can also be used to verify the payout's state after receiving status change webhooks or whenever additional confirmation is required. - [Make Fiat Payouts](https://docs.bvnk.com/docs/fiat-payouts-to-a-business.md): The following guide explains how you can make payouts to business or individual customers using the same endpoint. - [Integrate Fiat Payments](https://docs.bvnk.com/docs/fiat-payments.md) - [Show List of Transactions](https://docs.bvnk.com/docs/listing-transactions.md) - [Refund Pay-ins](https://docs.bvnk.com/docs/refund-payments.md) - [Create a Payout](https://docs.bvnk.com/docs/creating-a-payout.md) - [Enable a Crypto Payout Approval](https://docs.bvnk.com/docs/enabling-a-crypto-payout-approval-flow.md) - [Estimate Crypto Payouts](https://docs.bvnk.com/docs/estimate-crypto-payouts.md) - [Send Crypto Payouts](https://docs.bvnk.com/docs/sending-crypto-payouts.md) - [Listen for Payout Webhooks](https://docs.bvnk.com/docs/listening-for-payout-webhooks.md) - [Two Step Crypto Payouts](https://docs.bvnk.com/docs/two-step-crypto-payouts.md) - [Understanding Payout Workflow](https://docs.bvnk.com/docs/understanding-the-workflow-of-a-payout.md) - [Working with different crypto currency payouts](https://docs.bvnk.com/docs/working-with-different-crypto-currency-payouts.md) ## API Reference - [Get Customer Fee Wallets](https://docs.bvnk.com/reference/getcustomerfeewallets.md): Retrieves the list of available wallets that can receive customer fees. For more information, refer to [Customer fees](https://docs.bvnk.com/docs/charge-customer-fees#/). - [Set Wallet for Customer Fees](https://docs.bvnk.com/reference/setcustomerfeewallet.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 processing transactions. For more information, refer to [Customer fees](https://docs.bvnk.com/docs/charge-customer-fees#/). - [Create Report Schedule](https://docs.bvnk.com/reference/createreportschedule.md): Creates a new scheduled report that will be automatically generated and delivered according to the specified frequency and delivery preferences. Each user can create only one schedule per account. - [Delete Report Schedule](https://docs.bvnk.com/reference/deletereportschedule.md): Deletes an existing report schedule. Only the user who created the schedule can delete it. Once deleted, no further reports will be generated according to this schedule. - [Get Supported Timezones](https://docs.bvnk.com/reference/getsupportedtimezones.md): Retrieves a list of all supported timezones that can be used when creating or updating report schedules. Each timezone includes both the IANA timezone identifier and a human-readable label with UTC offset. - [List Report Schedules](https://docs.bvnk.com/reference/listreportschedules.md): Retrieves a paginated list of report schedules for the authenticated user's account. Returns all schedules created by the user with their current configuration and delivery preferences. - [Update Existing Report Schedule](https://docs.bvnk.com/reference/updatereportschedule.md): Updates an existing scheduled report with new frequency and delivery preferences. Only the user who created the schedule can update it. - [List Wallet Balances](https://docs.bvnk.com/reference/walletbalancelist.md): Retrieves the balances of your wallets on platform. - [Create Wallet](https://docs.bvnk.com/reference/walletcreate.md): Creates a wallet on the BVNK platform. - [List Wallets](https://docs.bvnk.com/reference/walletlist.md): Retrieves a list of wallets on your account. Displays the first 10 wallets without max set to higher - [List Transactions](https://docs.bvnk.com/reference/walletlisttransactions.md): Retrieves a paginated list of transactions for a specific wallet. Supports filtering by `walletId` and optional date range. The date range can be applied to the `createdAt` or `updatedAt` timestamp, determined by the `filterMode`. If omitted, the `filterMode` defaults to `CREATED_AT`. Refer to the [Fiat payments guide](https://docs.bvnk.com/docs/listing-transactions). - [Get Wallet](https://docs.bvnk.com/reference/walletread.md): Retrieves detailed information about a specific wallet. - [Transactions Report](https://docs.bvnk.com/reference/wallettransactionreport.md): Creates a report of all transactions from a wallet in the specified format and sends it via the preferred delivery method: WEBHOOK or EMAIL. **Note**: Reports are delivered instantly but the data has a one-hour lag for Production environment and eight-hour delay in Sandbox. For example, a report requested at 9:00 AM will include transactions only up to 8:00 AM. See the [Receive Transactions Report via Webhook](https://docs.bvnk.com/docs/receive-transaction-history-report-via-webhook) guide for more information. - [Create Channel](https://docs.bvnk.com/reference/channelcreate.md): Creates a channel that your end users can openly send payments to. - [List Channels](https://docs.bvnk.com/reference/channellist.md): Retrieves all channels related to a Wallet ID. - [List Channel Payments](https://docs.bvnk.com/reference/channelpaymentlist.md): Retrieves a list of payments to a channel on a specific Wallet ID. - [Get Channel Payment](https://docs.bvnk.com/reference/channelpaymentread.md): Retrieves a specific payment made into a channel. - [Get Channel](https://docs.bvnk.com/reference/channelread.md): Retrieves a specific channel by UUID. - [Create an Estimate Payout](https://docs.bvnk.com/reference/payestimate.md): Retrieves latest exchange rates, fees and network costs for a crypto payout without creating an actual payout. Provide either `walletRequiredAmount` (amount to send) or `paidRequiredAmount` (amount the recipient should receive). See the [Estimate Crypto Payouts](https://docs.bvnk.com/docs/estimate-crypto-payouts#/) guide for details. - [Accept an Estimated Payout](https://docs.bvnk.com/reference/payestimateaccept.md): Accepts the current estimate and converts it into a pending crypto payment. - [Update an Existing Estimate Payout](https://docs.bvnk.com/reference/payestimateupdate.md): Refreshes the quote using the latest exchange rates and fees. Call periodically (e.g., every 30 seconds) with either `walletRequiredAmount` or `paidRequiredAmount` to recalculate the other. - [Confirm Payment](https://docs.bvnk.com/reference/paymentconfirm.md): Confirms a two-step payout. - [Accept Payment](https://docs.bvnk.com/reference/paymentaccept.md): Accepts a pending payment with currency or payout information. - [Create Payment](https://docs.bvnk.com/reference/paymentcreate.md): Creates an incoming (type IN) or outcoming (type OUT) crypto payment. Alternatively, it creates a crypto payment that is either sent from an Embedded Partner Customer's wallet or deposited into it. For more information, see the [Make Crypto Payments](https://docs.bvnk.com/docs/create-a-crypto-payout#/) guide. There are two flows depending on specifying `payOutDetails`: - If you add `PayOutDetails` with all its child parameters, the payment is successfully created and the funds are sent to the specified wallet, with no further actions needed. - If not included in the request, in the response you receive `redirectUrl`. This is a link to a page, where to you can redirect your Customer so they can finalize the payment. - [List Payments](https://docs.bvnk.com/reference/paymentlist.md): Retrieves a list of payments on a specific Wallet ID. - [Validate Address](https://docs.bvnk.com/reference/paymentoutvalidate.md): Validates that a crypto address is correct. Use this endpoint to validate that an address exists, is correctly formatted, and includes all the required data. This endpoint can help prevent your end users losing funds when submitting a payout. - [Get Payment](https://docs.bvnk.com/reference/paymentread.md): Retrieves details of a specific payment using the UUID of the payment. - [Update Payment](https://docs.bvnk.com/reference/paymentupdate.md): Updates a pending payment with currency or payout information. - [List Exchange Rates](https://docs.bvnk.com/reference/list-exchange-rates.md): Lists available exchange rates for a given currency. - [List Crypto Currencies](https://docs.bvnk.com/reference/listcurrenciescrypto.md): Retrieves a list of all cryptocurrencies available on the BVNK platform. This list represents cryptocurrencies that end users can select whilst making a payment. For sandbox, only Ethereum (ETH) is fully functional. - [List Wallet Currencies](https://docs.bvnk.com/reference/listcurrenciesdeposit.md): These are the currencies that can be used to create a new wallet. - [List Fiat Currencies](https://docs.bvnk.com/reference/listcurrenciesfiat.md): Retrieves a list of all display fiat currencies available on BVNK's Crypto Payments API. This list refers to currencies merchants can display on a payment page to an end user. It does not represent the list of currencies that can be held on the platform in wallets. - [Get Exchange Rate](https://docs.bvnk.com/reference/readexchangerate.md): Provides a mid market exchange rate between two assets. - [Create on-ramp payment rule](https://docs.bvnk.com/reference/paymentrulecreate.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 defines the flow to activate: - `payment:payin:fiat` — on-ramp For more information, see the [Automate Fiat-to-Crypto Transfers](https://docs.bvnk.com/docs/automate-fiat-to-crypto-transfers#/) guide. - [Update Payment Rule](https://docs.bvnk.com/reference/paymentruleupdate.md): Partially updates a previously created payment rule. Only properties included in the request are updated; omitted fields remain unchanged. Setting a nullable property to null clears it. - [Confirm Beneficiary's Name](https://docs.bvnk.com/reference/payoutconfirmbeneficiaryv2.md): Confirms a payout when the beneficiary name check returns a mismatch warning. If not confirmed within five minutes, the action expires. In this case, make a new payout. - [Initiate Payout (ver. 2)](https://docs.bvnk.com/reference/payoutcreatev2.md): Creates a payout to business or individual customers. In case of payment in Euro, the transaction is subject to **Verification of Payee** (VoP): if the beneficiary's name in the request doesn't match the name in the beneficiary's bank account, the status 202 Verification Failed is returned. To proceed with the payment, you must [Confirm Beneficiary's name](https://docs.bvnk.com/reference/payoutconfirmbeneficiaryv2#/). For the details, refer to the [Initiate Payouts (ver. 2)](https://docs.bvnk.com/docs/initiate-payment-2#/) guide. - [Get Payout](https://docs.bvnk.com/reference/payoutread.md): Retrieves a specific payout. You can also use this endpoint to check the status of the crypto or fiat payout. **Note**: The PENDING_APPROVAL status is only relevant for **fiat payouts**. - [Verify Beneficiary's Name](https://docs.bvnk.com/reference/verifybeneficiary.md): Verifies the beneficiary's name. You can call this endpoint before creating a payout via [`POST /payment/v2/payouts`](https://docs.bvnk.com/reference/payoutcreatev2#/) to verify the beneficiary's name and receive a verification ID that can be used in subsequent payout requests. When using this endpoint, make sure you specify the same beneficiary's names as you will use in the payload of the [Initiate Payout](https://docs.bvnk.com/reference/payoutcreatev2#/) request. - [Estimate Refund Fee](https://docs.bvnk.com/reference/estimaterefundfee.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 issuing a refund. The fee amount may vary depending on the merchant contract with BVNK. - [Refund Pay-in](https://docs.bvnk.com/reference/refundpayin.md): Initiates seamless one-click refund processing for any previous pay-in. Once accepted, a refund transaction appears in your merchant portal and can be acquired via API. Upon activation, the system automatically generates a new transaction according to our standard workflow. You can request multiple refunds for the same transaction, as long as the total refunded amount doesn't exceed what was originally paid in. - [Simulate Pay-in](https://docs.bvnk.com/reference/simulatepayin.md): Simulates pay-ins with different currencies and payment methods in the Sandbox environment. - [Create Wallet](https://docs.bvnk.com/reference/createcustomerwallet.md): Creates a fiat or crypto wallet for a specific Embedded Partner Customer, generating a unique virtual account tied to the wallet. --- For more information, how to apply it in the Embedded Wallets flow, refer to the [Create a customer wallet](https://docs.bvnk.com/docs/step-2-creating-a-customer-wallet-and-virtual-account#/create-a-customer-wallet) guide. - [List all Customer Wallets](https://docs.bvnk.com/reference/ledgerwalletlist.md): Retrieves a list of wallets associated with Embedded Partner Customer. Request without parameters returns all existing wallets. Specify `customerReference` in query to retrieve wallet details of the specific EPC. - [Get Wallet](https://docs.bvnk.com/reference/ledgerwalletread.md): Retrieves a specific wallet by its ID - [List Wallet Profiles](https://docs.bvnk.com/reference/walletprofiles.md): Returns available wallet profiles based on optional filters for currency codes and payment methods. --- For more information, how to apply it in the Embedded Wallets flow, refer to the [Assign a wallet profile](https://docs.bvnk.com/docs/step-2-creating-a-customer-wallet-and-virtual-account#/assign-a-wallet-profile) guide. - [Create Customer](https://docs.bvnk.com/reference/createcustomer.md): Creates an Embedded Partner Customer account. The customer can be 'Individual' or 'Company'. - [List Required Information](https://docs.bvnk.com/reference/getcustomerinforequired.md): Retrieves detailed information about what documents and data are required for customer onboarding when their status is `INFO_REQUIRED`. This endpoint provides specific requirements for documents, questionnaires, and additional data needed to complete the onboarding process. - [Get Customer](https://docs.bvnk.com/reference/getcustomerwithexternalstatus.md) - [List Industries](https://docs.bvnk.com/reference/getindustries.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/reference/getmonthlyexpectedvolumes.md): Retrieves a definitive list of Expected Monthly Volume values, which can be included in the payload when creating a customer. - [List Customers](https://docs.bvnk.com/reference/listaccountcustomers.md): Retrieves the full list of Customers. - [Remove a document](https://docs.bvnk.com/reference/deletedocument.md): Deletes a specified document from a Customer's profile. - [Get Customer Documents](https://docs.bvnk.com/reference/getcustomerdocuments.md): Retrieves the details of the specific document added for the Customer. If no parameters are specified, retrieves the array of available documents. - [Get document download URL](https://docs.bvnk.com/reference/getdocumenturl.md): Retrieves a temporary URL for document download. - [Create Agreement Signing Session](https://docs.bvnk.com/reference/createagreementsession.md) - [Retrieve Agreement Session Status](https://docs.bvnk.com/reference/getagreementsessionstatus.md): Returns the current status of an agreement session using its reference ID. - [Update Agreement Session Status](https://docs.bvnk.com/reference/updateagreementsession.md): Updates the signing status of an agreement session. Typically used after user submission to mark the session as SIGNED or DECLINED. - [Upload Documents to Customer](https://docs.bvnk.com/reference/uploadcustomerdocuments.md): Attach one or more documents to a customer's profile. This can be either a company customer (with optional linkage to a specific associate) or an individual customer. Files must be base64-encoded before submission. - For company-level documents, omit `customerPersonReference`. - For associate-level documents, provide the `customerPersonReference`. - The customer must be in `INFO_REQUIRED` status. - [Create Merchant ID](https://docs.bvnk.com/reference/merchantidcreate.md): Generate a Merchant ID for your account to process pay-ins and pay-outs through our API. A Merchant ID is essential as it designates the account wallet where incoming pay-ins will be settled. For instance, if a Merchant ID is associated with a EUR wallet ID, any incoming USDT payment will be automatically converted to EUR and deposited in the designated EUR wallet. Vice versa, any outgoing USDT payment will be automatically converted and withdrawn from the designated EUR wallet. For further information, please visit https://docs.bvnk.com/docs/creating-your-first-merchant to learn more about creating your first Merchant ID. - [List Merchant IDs](https://docs.bvnk.com/reference/merchantidlist.md): Retrieves merchant IDs setup on your account. - [Complete Onboarding](https://docs.bvnk.com/reference/completeonboarding.md): Sends the confirmation of the onboarding completion. * In the sandbox environment, Customer verification is automatically approved. * In production, if the EPC meets all compliance requirements, the status will update to `VERIFIED`. If there are outstanding requirements or issues, the `INFO_REQUIRED` status is assigned, prompting manual review or further actions. If the verification is unsuccessful, the `REJECTED` status is assigned. **Note**: Run this endpoint 10 seconds after uploading the documents. This time is needed for the system to acknowledge the documents and update the status. - [Create or Update Account Webhook URL](https://docs.bvnk.com/reference/createaccountwebhook.md): Creates or updates the the main account webhook URL that all webhooks are sent to. - [Onboard Embedded Merchant](https://docs.bvnk.com/reference/createembeddedpartnermerchant.md): Creates the Embedded Partner Merchant account. - [Get Questionnaire Definition](https://docs.bvnk.com/reference/getquestionnairedefinitions.md): Fetches quiestionnaire schemas with questions, answer types, option lists. You can render the questionnaire in your UI. Questionnaires include the following sections: - [Search Questionnaire Submissions](https://docs.bvnk.com/reference/getquestionnaires.md): Returns previously submitted questionnaire answer sets matching the supplied filters - [Submit Questionnaire](https://docs.bvnk.com/reference/submitquestionnaireresponses.md): Submit questionnaire answers provided by EPCs. BVNK validates completeness asynchronously and transitions the customer to the next onboarding state when all required answers are present. In case some answers are missing, BVNK specifies them and waits for all the answers to be submitted - [Fetch Account Webhook URL](https://docs.bvnk.com/reference/getaccountwebhook.md): Fetches the the main account webhook URL that all webhooks are sent to. - [Fetch Agreements](https://docs.bvnk.com/reference/getagreements.md): Fetch all required agreement documents needed to onboard an Embedded Partner Merchant. - [Fetch Country Codes](https://docs.bvnk.com/reference/listcountries.md): Fetch list of all countries and associated ISO codes. - [Accept Quote](https://docs.bvnk.com/reference/quoteaccept.md): Executes a quote. - [Create Quote](https://docs.bvnk.com/reference/quotecreate.md): Creates a quote to convert currency between wallets. - [List Quotes](https://docs.bvnk.com/reference/quotelist.md): Retrieves all quotes on a specific Merchant ID. - [Get Quote](https://docs.bvnk.com/reference/quoteread.md): Retrieves a specific quote. - [Create Internal Transfer](https://docs.bvnk.com/reference/transfercreate.md): Create an internal Fiat transfer to an existing beneficiary wallet. - [Create Internal Transfer (ver. 2)](https://docs.bvnk.com/reference/transfercreatev2.md): Creates an internal stablecoin and fiat transfer between EPC and EP wallets. Payment combinations: - Crypto to crypto - Fiat to fiat - [Get Transfer](https://docs.bvnk.com/reference/transferread.md): Retrieves a specific transfer details. - [Get Transfer (ver. 2)](https://docs.bvnk.com/reference/transferreadv2.md): Retrieves a specific transfer details. - [List Transfer Beneficiaries](https://docs.bvnk.com/reference/transfersbeneficiaryread.md): Retrieves a list of beneficiaries eligible for transfers for a specified wallet. - [Channel transaction confirmed](https://docs.bvnk.com/reference/channeltransactionconfirmed.md): The `bvnk:payment:channel:transaction-confirmed` webhook is triggered when a new channel transaction is confirmed on chain, and the transaction has been processed. - [Channel transaction detected](https://docs.bvnk.com/reference/channeltransactiondetected.md): The `bvnk:payment:channel:transaction-detected` webhook is triggered when a new channel transaction is detected, and the transaction has not yet been confirmed. - [Channel transaction placed on hold](https://docs.bvnk.com/reference/channeltransactiononhold.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 programme. If the payment is released, you will receive the `bvnk:payment:channel:transaction-confirmed` event. - [Cryptocurrency refund initiated](https://docs.bvnk.com/reference/cryptorefundinitiated.md): Triggered when a cryptocurrency payment refund is initiated. This webhook indicates that a refund process has been started for a crypto payment. - [Cryptocurrency payment status change](https://docs.bvnk.com/reference/cryptostatuschange.md): Triggered when the status of a cryptocurrency payment changes. This webhook provides real-time updates on crypto payment processing status. - [Cryptocurrency transaction late](https://docs.bvnk.com/reference/cryptotransactionlate.md): Triggered when a cryptocurrency transaction is received after the payment has expired or been completed. This webhook indicates that funds were received for a payment that is no longer active. - [Cryptocurrency transaction on hold](https://docs.bvnk.com/reference/cryptotransactiononhold.md): Triggered when a cryptocurrency transaction is placed on hold under BVNK's compliance program. This webhook indicates that the transaction requires manual review before processing. - [Cryptocurrency transaction settled](https://docs.bvnk.com/reference/cryptotransactionsettled.md): Triggered when a cryptocurrency transaction is settled. This webhook indicates that the transaction has been fully processed and settled. - [Customer document status change notification](https://docs.bvnk.com/reference/customerdocumentstatuschange.md): Triggered when a customer document verification status changes. This webhook provides real-time updates on document compliance status. - [Customer status change notification](https://docs.bvnk.com/reference/customerstatuschange.md): Triggered when a customer's status changes to `INFO_REQUIRED`, `PENDING`, `VERIFIED`, or `REJECTED`. This webhook provides real-time updates on customer onboarding and compliance status. - [Customer update notification](https://docs.bvnk.com/reference/customerupdate.md): Triggered when customer information is updated. This is usually done by Sumsub verification link when customer data is populated from Sumsub. - [Fiat payment status change notification](https://docs.bvnk.com/reference/paymentpayinstatuschange.md): Triggered when the status of an incoming fiat payment changes. This webhook provides real-time updates on payment processing status. - [Fiat pay-in status change notification (v2)](https://docs.bvnk.com/reference/paymentpayinstatuschangev2.md): Triggered when the status of an incoming fiat payment changes (version 2). This webhook provides real-time updates on pay-in processing status with enhanced data structure. - [Fiat payout status change notification (v1)](https://docs.bvnk.com/reference/paymentpayoutstatuschange.md): Triggered when the status of an outgoing fiat payment changes (version 1). This webhook provides real-time updates on payout processing status. - [Fiat payout status change notification (v2)](https://docs.bvnk.com/reference/paymentpayoutstatuschangev2.md): Triggered when the status of an outgoing fiat payment changes (version 2). This webhook provides real-time updates on payout processing status with enhanced data structure. - [Ledger report ready notification](https://docs.bvnk.com/reference/ledgerreportready.md): Triggered when a ledger report is ready for download. This webhook provides real-time updates on report generation completion. - [Internal transfer status change notification](https://docs.bvnk.com/reference/paymenttransferstatuschange.md): Triggered when the status of an internal payment transfer changes. This webhook provides real-time updates on internal transfer processing status. - [Internal transfer status change notification (v2)](https://docs.bvnk.com/reference/paymenttransferstatuschangev2.md): Triggered when the status of an internal payment transfer changes (version 2). This webhook provides real-time updates on internal transfer processing status with enhanced data structure. - [Ledger wallet creation notification](https://docs.bvnk.com/reference/ledgerwalletcreate.md): A wallet creation webhook provides real-time notifications to your system when a new wallet is successfully created. - [Authentication](https://docs.bvnk.com/reference/authentication-1.md) - [Errors](https://docs.bvnk.com/reference/errors.md) - [Idempotency](https://docs.bvnk.com/reference/idempotency.md) - [Metadata](https://docs.bvnk.com/reference/metadata.md) - [Overview](https://docs.bvnk.com/reference/overview.md) - [Pagination](https://docs.bvnk.com/reference/pagination.md) - [Postman Collection](https://docs.bvnk.com/reference/testing-the-api-endpoints-using-a-postman-collection.md): A Postman collection can help you get started with some basic request examples ## Changelog - [Channels redirectUrl changes](https://docs.bvnk.com/changelog/channels-redirecturl-changes.md) - [Important Notice Regarding JSON Deserialization](https://docs.bvnk.com/changelog/important-notice-regarding-json-deserialization.md) - [Payment risk object data will no longer be available starting October 2023](https://docs.bvnk.com/changelog/payment-risk-object-data-will-no-longer-be-available-starting-october-2023.md) - [Exporting wallet transactions to CSV for a period in time](https://docs.bvnk.com/changelog/date-filter-for-wallet-transactions.md) - [Improvement to the payment statuses in the Wallets tab](https://docs.bvnk.com/changelog/improvement-to-the-payment-statuses-in-the-wallets-tab.md)