To simulate payment transactions using the Payments API in sandbox, set up a MetaMask Ethereum wallet and add test tokens to it. This process allows you to experiment with and verify the API's functionality in a sandbox environment.
To simulate payment transactions using the Payments API in sandbox, set up a TronLink wallet and add test tokens to it. This process allows you to experiment with and verify the API's functionality in a sandbox environment.
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, your customers may create a payout request, and your Ops team should verify and approve it. With the approval flows enabled, a payout will go to a pending state after the wallet details are provided. Then BVNK will wait for an Approve or a Reject call to proceed or cancel the payout.
When a payment exception (overpayment, underpayment, or late payment) occurs, BVNK can automatically refund the cryptocurrency directly to the wallet address that sent the original payment. Unlike the standard refund flow where a payout link is generated, refund to source address requires no action from you or your customers.
Create payment rule
As a partner, you can add a markup fee to your customers' transactions, enabling you to collect additional revenue from your customers.
Channels are static crypto addresses that remain open at all times for your customers, as part of the Crypto Payments offering. Each channel is unique to a customer and allows them to top up their accounts with any amount of crypto based on the channel reference. As a merchant, you choose the wallet currency (fiat or crypto) that you want to be settled in after BVNK processes your customer's crypto payment.
An on-ramp is the process of automatically converting value from fiat currency into crypto, offering customers greater financial flexibility by providing them direct access to crypto from fiat payments without multiple manual steps.
The Wallets v.1 functionality will be deprecated soon. However, you can still use it for existing integrations.
This endpoint is used to facilitate internal transfers. You can transfer both fiat and crypto funds.
This is a new Internal Transfers flow, which is recommended for all new integrations.
There are two ways to create a payout:
Comprehensive list of supported fiat and crypto currencies on the BVNK platform
BVNK Earn allows you to generate additional funds from your BVNK balances. Rewards is the first product in Earn, enabling stablecoin issuers to distribute rewards to stablecoin holders, which BVNK automatically passes on to you. No direct interaction with blockchain protocols or smart contracts is needed. Rewards is currently available for USDC, with OUSD support coming soon and plans to support additional stablecoins beyond that.
The customer stablecoin payment flow enables Payment Service Providers (PSPs) to offer stablecoin payouts to their customers without requiring direct integration with cryptocurrency infrastructure.
The final step is to implement exception handling within the payment flow. While the Receive Payment Notifications page outlines webhook types, the following guides offer more detailed scenario explanations.
Use this table to quickly identify which BVNK use case matches your business needs. Compare use cases to understand the target industries, currency flows, required delivery models, and available product features. Click the use case link to view detailed implementation guides, or use the Model links to learn more about the delivery models (Direct or Embedded) that support each use case.
This type of payment is specific for Merchant Payment Services / Payment Links only.
Receive the webhook
The Transfers v.3 API replaces the legacy Quote API for wallet-to-wallet currency conversion. Instead of creating a standalone quote and accepting it through a redirect flow, currency conversion is now a property of a transfer. Migrating to v.3 provides a single-field status model, digest-based quote acceptance, mandatory idempotency, and the option to replace polling with a webhook. This guide walks you through the required changes for a successful migration.
The Wallets API v.2 replaces v.1 endpoints, offering a simpler request model, more detailed responses, advanced Lucene-based filtering, and enhanced wallet lifecycle management. Migrating to v.2 streamlines your integration, reduces complexity, provides better reporting data, and enables more flexible wallet operations. This guide walks you through the required changes for a successful migration.
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 this case, the payment still transitions to a COMPLETE status.
Self-custody wallets are currently in beta and available to eligible BVNK customers. Some features may change as we continue to improve it. Please review the documentation and endpoints carefully, test everything in the sandbox, and reach out to the Solutions team if you need help.
---
---
Using BVNKs Receive products, you can collect crypto payments from your customers, allowing them to top up accounts or purchase goods and services from you whilst BVNK manages the conversion and settlement to your accounts.
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 response or redirect your user to a pre-built Hosted Payments Page.
Reconciliation allows you to verify that your internal transaction records match BVNK's transaction data. By comparing your system's records with BVNK's transaction reports, you can identify discrepancies, ensure accounting accuracy, and maintain compliance with financial reporting requirements.
When a payment exception occurs, BVNK offers automatic cryptocurrency refunds for partners who do not wish to hold these assets due to compliance concerns or who prefer not to process payments outside agreed payment rules.
Self-custody wallets are currently in beta and available to eligible BVNK customers. Some features may change as we continue to improve it. Please review the documentation and endpoints carefully, test everything in the sandbox, and reach out to the Solutions team if you need help.
The following guide describes how you can integrate stablecoin payments into your platform via BVNK.
When creating a payout, there are two possible flows:
Self-custody wallets are currently in beta and available to eligible BVNK customers. Some features may change as we continue to improve it. Please review the documentation and endpoints carefully, test everything in the sandbox, and reach out to the Solutions team if you need help.
This new wallets flow is recommended for all new integrations.
Underpayments occur when end-users do not transfer enough cryptocurrency to fulfill their payment obligation.