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

Vault

The Vault service is the foundation of BPN’s stablecoin asset management layer, providing merchants with secure and compliant wallet infrastructure.
It offers core wallet functionalities such as balance management, on-chain deposits, on-chain withdrawals, as well as whitelist management and Travel Rule compliance support.
While BPN’s Vault is primarily optimized for the BSC network, it is also compatible with other blockchain networks for deposit purposes. However, funds are strictly segregated per network — cross-chain balances are not automatically interchangeable.

Scope of Services#

Balance Inquiry
Retrieve real-time available and pending balances for a specific currency and network.
(Reference: GET /wallet/asset-balance)
Deposit Address Generation & On-chain Deposits
Generate a deposit address for a specific currency and network.
Each deposit request requires sender information to meet Travel Rule compliance.
(Reference: POST /wallet/add-deposit-sender)
Whitelist Management & On-chain Withdrawals
Add recipient addresses to the withdrawal whitelist before initiating transfers.
All withdrawal requests must include recipient details for compliance checks.
(Reference: POST /wallet/add-withdraw-whitelist, POST /wallet/withdraw)

Example Scenarios#

💡
Checking Wallet Balances Before Settlement
Before initiating a cross-currency settlement, the merchant calls the balance inquiry API to confirm available funds and ensure sufficient liquidity for the transaction.
💡
Making an On-chain Deposit
The merchant requests a deposit address for USDC on the BSC network, providing sender details for compliance purposes.
Once the funds are transferred to this address, the transaction is monitored, and the balance is updated after the required confirmations.
💡
Withdrawing to a Whitelisted Address
The merchant adds a counterparty’s wallet address to the whitelist in advance.
Once approved, they initiate a withdrawal, and BPN processes the transaction after validating both whitelist and Travel Rule data.

Key Advantages#

Security
Whitelist protection and network-level fund segregation.
Compliance
Travel Rule data capture ensures regulatory readiness.
Flexibility
Multi-network deposit support with BSC as the primary focus.
Ease of Integration
Abstracted blockchain complexity via standardized APIs.
Previous
Transfer
Next
On/Off Ramp
Built with