1. Get started
BPN OpenAPI
  • Get started
    • Introduction to BPN
    • Introduction to API
    • Architecture Overview
    • Authentication
    • Environments
    • Response envelope
    • Idempotency
  • Guides
    • Virtual Account
      • Virtual Account Overview
      • VA · Payin
      • VA · Payout
      • VA · RFI
      • VA · Statuses
      • VA · Currencies & limits
    • Wallet
      • Wallet Overview
      • Wallet · Deposit
      • Wallet · Withdraw
      • Wallet · Transfer
      • Wallet · Statuses
      • Wallet · Assets & limits
    • Convert
      • Convert Overview
      • Convert · Quote & submit
      • Convert · Business types
      • Convert · Pairs & limits
      • Convert · Statuses
  • API Reference
    • Virtual Account
      • Virtual Account field notes
      • Inquiry Master VA Balance
      • List Primary Virtual Accounts
      • Create Virtual Account
      • Get Virtual Account Detail
      • List Virtual Account
      • List Virtual Account Orders
      • Get Virtual Account Order Detail
      • Refund Virtual Account Order
      • List RFI Sub Virtual Account
      • Get Sub Virtual Account RFI Template Info
      • Sub Virtual Account Submit RFI
      • Add Bank Account
      • List Bank Account
      • List Banks
      • Payout via Virtual Account
      • Send Email Verify Code
    • Wallet
      • Wallet field notes
      • Get Asset Balance
      • Get Deposit Address
      • Add Deposit Sender
      • Add Withdraw Whitelist
      • Delete Withdraw Whiltelist
      • Request Withdraw
      • Query Wallet Internal Transfer Detail
      • List Wallet Internal Transfer order
      • Wallet Internal Transfer
      • Create Sub Account
      • Query Transaction History
      • List Wallets
      • List Sub Account
    • 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
    • Convert
      • Convert field notes
      • Inquery FX Rate
      • Get Stablecoin Quote
      • Create Stable Order
      • Get Order (Single) Detail
      • List Orders(Batch)
    • KYB
      • Share KYB/KYC Info For Sub User
      • Get KYB Sub User Status
    • Reconciliation
      • Get Reconciliation Order List By Page
    • 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
      • Mock Payin Order Refund
      • Mock Payout Order Update Status
    • Pay Session
      • Request Pay Session
  • Webhooks
    • Webhooks Overview
    • Event catalogue
    • KYB notifications
    • 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_TRANSFER_ORDER_UPDATED
    • Sub Virtual Account RFI Required
    • Sub Wallet Update
    • wallet address whitelist Copy
    • Crypto Deposit Order Notification
    • Collect Order Updated
    • Usd Payout Order Updated
    • onboard result
    • partner order status
    • PaymentLink Notification
  • Partner Flow
    • inquiry supported currency
    • KYC/KYB Sharing
    • inquiry onboard status
    • get price
    • Create order
    • order list
    • inquiry single order
    • get user deposit address
    • get payment instruction
    • sync fund notification
    • daily settlement records
  • Appendix
    • Enums quick reference
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
  • Errors
    • Error codes catalogue
  1. Get started

Introduction to API

Introduction#

Environments: sandbox / prod · APIs: Merchant /v1, /v2 · Updated: 2026-08-05

1. Audience#

For technical integrators with BPN merchant API access. Read the Guide for your product:
ProductAssetCapabilitiesGuide
Virtual AccountFiatpayin / payoutVA Overview
WalletStablecoindeposit / withdrawWallet Overview
ConvertFXSTABLE_BUY / SELL / TRANSFER / SWAPConvert Overview
Out of scope for default merchant docs: Partner /api/v1/*, /v1/stable/mock/*.

2. Base URL#

EnvironmentBase URL
Sandboxhttps://sandbox.bpn.finance/prod-api/mapi
ProductionContact BPN
Details: Environments.

3. Auth (summary)#

HeaderMeaning
API-KEYMerchant apiKey
API-TIMESTAMPUnix epoch milliseconds
API-SIGNATUREHEX_LOWER(HMAC_SHA256(apiSecret, compactJson(body) + "&" + timestamp))
Details and Java / Python examples: Authentication. Webhook verification: Webhooks Overview.

4. Response envelope#

{
  "status": 200,
  "code": "string",
  "msg": "OK",
  "success": true,
  "traceId": "string",
  "data": {}
}
The field name is msg (not message). Treat business outcome via success; include traceId in support tickets. See Response envelope.

5. Three product boundaries (required)#

ProductPath prefixNot the same as
VA/v1/virtual-account/*On-chain stablecoin deposit / withdraw
Wallet/v1/wallet/*Fiat bank payin / payout
Convert/v1/stable/order/*Wallet deposit / withdraw itself
STABLE_TRANSFER: fiat → fiat (e.g. local currency to USD)
STABLE_SWAP: stablecoin → stablecoin
Payment Link (/v1/stable/collect/*) and V2 Collect (/v2/stable/collect/*) are separate products and are not folded into the three main Guides (Wallet Guide has a cross-link at the end)

6. Suggested reading order#

1.
This page (auth + boundaries)
2.
Authentication / Environments
3.
One product Guide end-to-end
4.
Webhooks Overview
5.
Idempotency · Error codes catalogue
Previous
Introduction to BPN
Next
Architecture Overview
Built with