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

Transfer

Transfer is a core BPN capability designed to fix two persistent problems in cross-border, cross-currency settlement: slow settlement cycles and unfavorable FX spreads.
By leveraging stablecoin-backed liquidity and on/off-ramp rails, BPN enables fiat-to-fiat settlement across currencies with near-real-time speed and competitive FX, while keeping compliance and reconciliation simple.
(Reference: GET /stable/order/get-quote, POST /stable/order/submit-order)
We support two service patterns:
Transfer Contract (Standing Settlement)
Single Transfer (Single Settlement)
Think of this as a settlement contract similar to traditional acquiring, but multi-currency and programmable.
How it works
1.
The merchant creates a Transfer Contract: fromCurrency → toCurrency, payer & beneficiary details, settlement rules (e.g., choose transfer plan, min amounts, fee model).
2.
BPN assigns merchant-specific payment instructions (e.g., dedicated virtual account, QR, or reference code) for the payer currency.
3.
On any business day, the merchant sends funds to the assigned instructions.
4.
BPN executes conversion using stablecoin liquidity, then pays out in the beneficiary currency per the agreement.
5.
The merchant receives webhooks and can query Order Inquiry for reconciliation.
When to use
• Daily/weekly settlement from A currency to B currency with predictable flows.
• Marketplace/operator settlements, payroll batches, or platform treasury sweeps.
Reference Flow
create transfer contract.png

Benefits at a glance#

Speed
Near-real-time fiat settlement, T+0/T+1 optional.
FX Efficiency
Stablecoin liquidity routes deliver tighter spreads.
Programmability
Agreements encode rules; one-off transfers keep ad-hoc flows simple.
Operational Clarity
Webhooks + inquiry APIs for traceability and reconciliation.
Previous
Signature Authentication Mechanism
Next
Vault
Built with