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
      • 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
  • 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 address whitelist
    • Sub Virtual Account RFI Required
    • Sub Wallet Update
    • Crypto Deposit Order Notification
    • Collect Order Updated
    • Usd Payout Order Updated
  • Appendix
    • Enum
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
    • Version History
  • Schemas
    • walletBalance
    • walletAddress
    • transactionRecord
  1. Use Case

On/Off Ramp

The On/Off Ramp API suite enables seamless conversion between cryptocurrencies and fiat currencies, supporting end-to-end deposit, withdrawal and trading flows. It allows corporate clients to manage withdrawal destinations via adding bank accounts, cards or crypto wallet addresses, perform buy/sell transactions, retrieve live quotations, and monitor transaction statuses in real time. The APIs are designed for PSPs, fintechs, e-commerce platforms, and other KYB-approved corporate clients to embed compliant crypto-fiat services into their own applications.

Scope of Services#

Our On/Off Ramp APIs support:
Quotation Services
Retrieve real-time price quotations for buy/sell transactions
Cryptocurrency Withdrawal
Withdraw cryptocurrencies to added crypto wallet addresses.
Buy Crypto
Convert fiat to supported cryptocurrencies at competitive rates.
Sell Crypto
Liquidate crypto holdings into fiat currency & transfer to different beneficiaries, such as bank accounts and cards.
Bank Account Management
Add, list, and remove whitelisted bank accounts.
Card Management
Add a card for future withdrawals, list available cards, and remove linked cards.
Transaction Status Tracking
Check real-time status of on/off ramp transactions.
Transaction Details Retrieval
Fetch complete transaction details for records or audits.

Example Scenarios#

💡
E-commerce platform payouts
An online marketplace allows merchants to withdraw sales proceeds in their preferred fiat currency, funded from crypto earnings, directly to their whitelisted bank accounts.
💡
Gaming platform rewards
A gaming company offers players the option to cash out their in-game crypto earnings via a linked card, with settlement in minutes.
💡
PSP treasury management
A payment service provider converts part of their USDT reserves to USD and sends it to their corporate bank account for operational expenses.
💡
Instant quotation display
A fintech app displays real-time crypto-to-fiat rates before the user confirms a sell order, improving transparency.

Key Advantages#

One-stop integration
All on/off ramp needs handled through a single, well-documented API suite.
Faster settlements
Card withdrawals and certain bank transfers can be completed in near real-time.
Regulatory compliance
Built-in KYB, bank account/card whitelisting, and AML checks.
Transparent pricing
Live quotations ensure users lock in their desired exchange rates.
Global coverage
Support for multiple fiat currencies and major cryptocurrency pairs.
Previous
Vault
Next
Compliance (Travel Rule Information Submission)
Built with