BPN OpenAPI
  1. Use Case
BPN OpenAPI
  • Getting Started
    • Introduction to BPN
    • Key Concepts & Terminology
    • Architecture Overview
  • Onboarding & Prerequisites
    • Product Demo
    • Sandbox & Test Environment
  • Use Case
    • Transfer
    • Vault
    • On/Off Ramp
    • Compliance (Travel Rule Information Submission)
    • Fiat Collection(BRL PIX for example)
  • API Reference
    • KYB
      • Share KYB Info For Sub User
      • Get KYB Sub User Status
    • Account Management
      • add bank account
      • list bank account
      • create virtaul account
      • list virtual account
      • Master VA balance inquiry
      • list virtual account orders
      • refund virtual account order
    • Wallet
      • Get Asset Balance
      • Get Deposit Address
      • Add Deposit Sender
      • Add Withdraw Whitelist
      • Delete Withdraw Whiltelist
      • Request Withdraw
      • Query Transaction History
    • FX
      • fx inquery
    • BPN Transactions
      • get stablecoin quote
      • create stable order
      • get order (single) detail
      • list orders(batch)
    • Reconciliation
  • Webhooks & Event
    • resend fail webhook
      POST
    • Open Virtual Account Status
      POST
    • virtual account payment status
      POST
    • Transaction Status Notification
      POST
    • KYB Status Notification
      POST
    • Deposit Sender Detail Required
      POST
  • Appendix
    • Enum
    • Virtual Account(VA) Support List
  • Release Notes & Changelog
    • Version History
    • Version History
  • Schemas
    • walletBalance
    • walletAddress
    • transactionRecord
  1. Use Case

Fiat Collection(BRL PIX for example)

This guide shows how to accept PIX payments, buy/sell USDC using Virtual Account (VA) balances, and query bills/transactions. All examples are minimal and easy to copy.

1. PIX Collection Service#

1.1 Create a Static PIX QR (Create Virtual Account)#

Before accepting PIX, create a seller-specific static QR via the create virtual account API. The response contains the static QR and VA details.
Create Virtual Account API link: create virtaul account
Receive Open Virtual Account Status: Open Virtual Account Status

1.2 Receive Funds via Webhook (Real-time Notifications)#

After buyers pay the PIX QR, subscribe to our webhook to get instant updates. Use the virtual account payment status payload.
Useful Link: virtual account payment status

1.3 Refund to Original Route (Refund Virtual Account Order)#

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

1.4 List All PIX Transactions (List Virtual Account Orders)#

Batch query all PIX VA orders: list virtual account orders

1.5 Master VA Balance Inquiry#

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

2. Buy Crypto Using VA Funds (USDC)#

You can use VA balances to buy USDC. The flow is:
(1) Get quote (price + fees) → returns a quote_id
(2) Create order (confirm buy/sell/transfer) with that quote_id
Note
• The quote & order APIs are shared across transfer, buy, and sell.
• Distinguish by type when placing the order.
• For sell orders, you must first add a bank account (or list an existing one).

2.1 Get Stablecoin Quote#

API reference: get stablecoin quote

2.2 Create Stable Order (Confirm)#

API reference: create stable order

3. Bank Accounts (for Sell)#

Before sell, add a payout bank account or select an existing one.
API reference: add bank account

4. Billing & Reports#

4.1 PIX Inbound List#

Use List Virtual Account Orders to batch query PIX incoming payments: list virtual account orders

4.2 Buy/Sell/Transfer Orders (Batch)#

Use List Orders (batch) to query trading & transfer history: list orders(batch)
Previous
Compliance (Travel Rule Information Submission)
Next
Share KYB Info For Sub User
Built with