Jump to Content
BVNK API DocsSandbox LoginProduction LoginStatus PageLog In
Quickstart GuidesAPI Reference and endpointsChangelogDiscussions
Sandbox LoginProduction LoginStatus PageLog InBVNK API Docs
Quickstart Guides
Quickstart GuidesAPI Reference and endpointsChangelogDiscussions

Getting Setup

  • Welcome to the BVNK Developer Hub
  • Getting Started with BVNK
  • Generating API Keys
  • Creating your first Wallet
  • Creating your first Merchant
  • Authenticating on the API
  • Creating a Webhook Listener
  • Managing Date and Time
  • Currencies
  • Testing your Integration
    • Setting Up a MetaMask Ethereum Wallet for ETH and USDT ERC20 tokens
    • Setting Up a TronLink Wallet for TRX and USDT TRC20 tokens
  • How to retrieve wallet transactions
  • Uptime and incident handling

Use case guides

  • Embedded Wallets
    • Step 1. Creating an Embedded Partner Customer
      • Creating a Customer via Portal
      • Signing Customer Agreements
      • Creating a Customer (Business) via API
      • Creating a Customer (Individual) via API
      • Retrieve Monthly Expected Volumes References
      • Retrieve Industry References
      • Retrieve Embedded Customer Details
    • Step 2: Creating a Customer Wallet and Virtual Account
      • Retrieve Customer Wallets
    • Step 3: Creating a Transfer
      • Check the Status of a Transfer
      • Listening for Internal Transfer
    • Step 4: Creating a Payout
      • Understanding the workflow of fiat payouts
      • Making Payouts to a Business
      • Making Payouts to an Individual
      • Check the Status of a Payout
      • Making Stablecoin Payout
      • Listening for Payout Webhooks
    • Step 5: Payins Notificiations
    • Compliance Requirements
      • Business Requirements
      • Individual (Consumer) Requirements
  • Building a crypto payments gateway
    • Understanding the workflow of a payment
    • Creating a payment
    • Sending the user to pay
    • Setting up Currency options for Pay-ins and Pay-outs
    • Listening for payment webhooks
    • Payment exception scenarios
    • Over payments
    • Under payments
    • Late payments
    • Refund payments
  • Sending crypto payouts
    • Understanding the workflow of a payout
    • Creating a payout
    • Listening for payout webhooks
    • Working with different crypto currency payouts
    • Enabling a crypto payout approval flow
    • Two Step Crypto Payouts
    • Get an Estimate for Crypto Payouts
  • Adding crypto top-ups
    • Understanding the workflow with channels
    • Creating a channel
    • Listening for channel webhooks
  • Settling your merchants in stablecoins
    • Tracking fiat settlements
    • Converting fiat settlements to stablecoins
    • Collecting a crypto address from your merchant
    • Settling to your merchant
    • Listening for webhooks to update settlement status
  • Fiat Payments
    • Understanding the workflow of fiat payouts
    • Fiat Payments Simulator
      • Payin Simulator
      • Payouts Simulator
    • Making Payouts to a Business
    • Making Payouts to an Individual
    • Check the Status of a Payout
    • Listing Transactions
    • Enabling Webhooks for Fiat Payments
      • Listening for Payout Webhooks
      • Listening for Payin Webhooks
      • Listening for Internal Transfers Webhooks
      • Listening for Wallet Creation Webhooks
      • Validating FIAT Payment webhooks
  • Customer Virtual Accounts
    • Step 1: Creating a Customer
      • Creating a Company Customer
      • Creating an Individual Customer
      • Retrieve Industry References
      • Retrieve Monthly Expected Volumes References
      • Retrieve Customer Details
    • Step 2: Creating a Customer Wallet and Virtual Account
      • Retrieve Customer Wallets
      • Listening for Payin Webhooks
    • Step 3: Creating a Transfer
      • Check the Status of a Transfer
      • Listening for Internal Transfer Webhooks
    • Step 4: Creating a Payout
      • Understanding the workflow of fiat payouts
      • Making Payouts to a Business
      • Making Payouts to an Individual
      • Check the Status of a Payout
      • Listening for Payout Webhooks
  • E-Commerce Plug-ins
    • WooCommerce

Error Reference

  • Error and Warning Dictionary

Upcoming features

  • Refund payments (beta)
  • Third Party Providers (TPPs)
  • Provide party information for crypto payments
  • Receive transaction history report via webhook