BPN OpenAPI
  1. Use Case
BPN OpenAPI
  • Getting Started
    • Introduction to BPN
    • Key Concepts & Terminology
    • Architecture Overview
  • Onboarding & Prerequisites
    • Product Demo
    • Sandbox & Test Environment
    • Signature Authentication Mechanism
  • Use Case
    • Transfer
    • Vault
    • On/Off Ramp
    • Compliance (Travel Rule Information Submission)
    • Fiat Collection(BRL PIX for example)
  • API Reference
    • Account Management
      • Inquiry Master VA Balance
      • 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
      • 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
      • Create Payment Link
      • List Payment links
      • Get Curreny Network Config
    • Mock
      • Mock Virtual account Payin Order
  • 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
  • Appendix
    • Enum
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
    • 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 QR Code/Dynamic QR Code/PIX KEY (Create Virtual Account)#

When opening a virtual account, you can generate Static QR Codes, Dynamic QR Codes, and Static Pix Keys through the same API(create virtaul account). Please note:
1.
A Dynamic QR Code has a maximum validity of 6 hours (custom validity periods will be supported in the future).
2.
Before creating a Pix Key:
• If using an email as the key, the email must first be validated through the OTP verification API(send email verify code).
• If using a random key, no validation is required.
3.
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

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

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
Inquiry Master VA Balance
Built with