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
All
Pages
Start typing to search…

Getting Setup

  • Welcome to the BVNK Developer Hub
  • Getting Started with BVNK
  • Creating your 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

  • 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
    • Two Step 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
  • 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 Wallet Details
      • Listening for Payin Webhooks
    • Step 3: Creating a Transfer
      • Check the Status of a 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
      • Listening for Payout Webhooks
  • Embedded Customer Wallets
    • Compliance Requirements for Embedded Business Customers
    • Compliance Requirements for Embedded Individual Customers
    • Listening for Webhooks
    • Creating an Embedded Customer - Merchant Portal
      • Step 1: Creating an Embedded Customer
      • Step 2: Creating a Wallet for an Embedded Customer
      • Step 3: Initiating an Internal Transfer for an Embedded Customer
      • Step 4: Initiating a Payout for an Embedded Customer
    • Creating an Embedded Customer - API
      • Step 1: Creating an Embedded Customer
      • Step 2: Creating a Wallet for an Embedded Customer
      • Step 3: Initiating an Internal Transfer for an Embedded Customer
      • Step 4: Initiating a Payout for an Embedded Customer

Payment API

  • Fiat Payments
    • Understanding the workflow of fiat payouts
    • Making Payouts to a Business
    • Making Payouts to an Individual
    • Check the Status of a Payout
    • Enabling Webhooks for Fiat Payments
      • Listening for Payout Webhooks
      • Listening for Payin Webhooks
      • Listening for Internal Transfers Webhooks
      • Listening for Wallet Creation Webhooks

Error Reference

  • Error and Warning Dictionary

Upcoming features

  • Third Party Providers (TPPs)
  • Provide party information for crypto payments
  • Receive transaction history report via webhook
  • Embedded Customer Wallets [Early Access]
    • Creating an Embedded Partner Customer (Business)
      • Retrieve Embedded Partner Customer Details
    • Step 2: Creating a Stablecoin Payout

Step 1: Creating an Embedded Customer

Sharing the Agreements Link

Uploading KYC Documents

Workflow of an Embedded Customer

Updated 4 months ago


Listening for Webhooks
Step 2: Creating a Wallet for an Embedded Customer