1. Use Case
BPN OpenAPI
  • Getting Started
    • Introduction to BPN
    • Architecture Overview
  • Onboarding & Prerequisites
    • Product Demo
    • Sandbox & Test Environment
    • Signature Authentication Mechanism
  • Use Case
    • Fiat Vitual Account
    • Convert Stablecoins
    • Transfer
    • Wallet
    • Compliance (Travel Rule Information Submission)
  • API Reference
    • KYB
      • Share KYB/KYC Info For Sub User
      • Get KYB Sub User Status
    • Account Management
      • Inquiry Master VA Balance
      • List Primary Virtual Accounts
      • Create Virtaul Account
      • Get Virtual Account Detail
      • List Virtual Account
      • Send Email Verify Code
      • Query bank info by account number
      • Payout via Virtual Account
      • Refund Virtual Account Order
      • Get Virtual Account Order Detail
      • List Virtual Account Orders
      • Submit Invoice
      • Get Invoice list Status
      • List Banks
      • Add Bank Account
      • List Bank Account
      • List RFI Sub Virtual Account
      • Get Sub Virtual Account RFI Template Info
      • Sub Virtual Account Submit RFI
    • Wallet
      • List Wallets
      • List Sub Account
      • Create Sub Account
      • Wallet Internal Transfer
      • Query Wallet Internal Transfer Detail
      • List Wallet Internal Transfer order
      • Get Asset Balance
      • Get Deposit Address
      • Add Deposit Sender
      • Add Withdraw Whitelist
      • Delete Withdraw Whiltelist
      • Request Withdraw
      • Query Transaction History
    • FX
      • Inquery FX Rate
    • BPN Transactions
      • Get Stablecoin Quote
      • Create Stable Order
      • Get Order (Single) Detail
      • List Orders(Batch)
    • Reconciliation
      • Get Reconciliation Order List By Page
    • Crypto Payment Link
      • Abnormal fund
        • Abnormal funds
        • Matchable Payment links
        • Link Order(Abnormal fund)
        • Submit to platform
      • Create Payment Link
      • List Payment links
      • Get Curreny Network Config
    • External Provider
      • FE: Create stablecoin collection sub-account link
      • Create stablecoin collection sub-account link
      • Get sub wallet account
      • List sub wallet accounts
      • Change sub wallet status
      • Query stablecoin collection order list
      • Query stablecoin collection order status
      • Get quote
      • Accept stablecoin collection order
      • Reject stablecoin collection order
      • Query USD balance
      • USD Payout (withdrawal)
      • Query USD Payout order status
      • Query USD Payout order list
    • Mock
      • Mock Virtual account Payin Order
      • Mock wallet deposit transaction
      • Mock Payin Order Refund
      • Mock Payout Order Update Status
    • Pay Session
      • Request Pay Session
  • Webhooks & Events
    • Resend Fail Webhook
      POST
    • Open Virtual Account Status
    • Virtual Account Payment Status
    • Virtual Account Invoice update
    • Transaction Status Notification
    • KYB Status Notification
    • Deposit Sender Detail Required
    • Abnormal Fund Notification
    • WALLET_TRANSFER_ORDER_UPDATED
    • Sub Virtual Account RFI Required
    • Sub Wallet Update
    • wallet address whitelist Copy
    • Crypto Deposit Order Notification
    • Collect Order Updated
    • Usd Payout Order Updated
    • onboard result
    • partner order status
    • PaymentLink Notification
  • Partner Flow
    • inquiry supported currency
    • KYC/KYB Sharing
    • inquiry onboard status
    • get price
    • Create order
    • order list
    • inquiry single order
    • get user deposit address
    • get payment instruction
    • sync fund notification
    • daily settlement records
  • Appendix
    • Enum
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
    • Version History
  1. Use Case

Fiat Vitual Account

Fiat Virtual Accounts & Settlement#

This guide shows how to provision virtual accounts (VA) for local fiat currencies, receive incoming payments, handle refunds, and query balances. The virtual account creation, webhook notification, refund, and query flow is largely the same across all supported local payment methods — we use Brazil's PIX as the worked example throughout. Only method-specific payload fields differ per market.
Applies to all supported local currencies
The APIs, parameters, and lifecycle shown below are shared across markets. Only the local-method-specific payload fields differ (e.g., PIX Key for BRL, CLABE for MXN, collection account for NGN/KES). If you've integrated one corridor, adding another is mostly a matter of swapping the payment method identifier.
Next step
Once funds settle to your VA balance, you can convert them to USDC/USDT. See Convert Stablecoins for the conversion flow.

1. Create Virtual Account#

All local payment methods are provisioned through the same API (create virtual account). The account types supported per currency:
CurrencySupported Account Types
BRLStatic PIX Key, Dynamic QR Code
MXNCLABE account
NGNCollection account
KESCollection account
COPDynamic Payment Link, Static collection account
BRL (PIX) — specific notes:
1.
A Dynamic QR Code has a maximum validity of 72 hours.
2.
When creating a PIX Key, the system will also generate a corresponding Static QR Code together with it.
Receive Open Virtual Account Status: Open Virtual Account Status

2. Receive Funds via Webhook#

After payers transfer to the VA (PIX QR scan, CLABE transfer, etc.), subscribe to our webhook to get real-time payment status updates.
API reference: virtual account payment status

3. Refund to Original Route#

If a received payment needs to be returned via the same route, call:
API reference: refund virtual account order

4. List Virtual Account Orders#

Batch query VA inbound orders for operational review:
API reference: list virtual account

5. Master VA Balance Inquiry#

Check the total balance across the master VA:
API reference: Master VA balance inquiry

6. Reports#

For end-of-period billing and reconciliation reports of all VA inbound payments:
API reference: list virtual account orders (reporting)
Previous
Signature Authentication Mechanism
Next
Convert Stablecoins
Built with