1. Wallet
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 · Statuses
      • VA · Payout
      • VA · RFI
      • VA · Currencies & limits
      • VA Opening
        • VND VA Opening
        • BRL VA Opening
    • Wallet
      • Wallet · Transfer
      • Wallet · Assets & limits
      • Wallet · Deposit whitelist
      • Wallet · PaymentLink
      • Wallet Overview
      • Wallet · Deposit
      • Wallet · Statuses
      • Wallet · Withdraw
    • 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
      • Deposit Whitelist
        • Get Deposit Whitelist Options
        • Register Deposit Source Address
        • List Deposit Source Addresses
        • Get Deposit Source Address
        • Disable Deposit Source Address
        • Submit Payer Details for a Received Deposit
        • Save Sub-wallet Payer Profile
        • Update Sub-wallet Payer Profile
        • Get Sub-wallet Payer Profile
        • Get Deposit Whitelist Case
      • 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
      • Get Transaction Detail
      • List Wallet Transactions
      • Get Wallet Transaction Detail
    • 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
      • FE: Deposit Travel Rule
      • External Provider · Deposit whitelist
      • 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
      • Create deposit Travel Rule link
      • Create deposit Travel Rule detail link
    • Mock
      • Mock Virtual account Payin Order
      • Mock wallet deposit transaction
      • Mock Payin Order Refund
      • Mock Payout Order Update Status
    • Pay Session
      • Request Pay Session
    • Files
      • Request File Upload URL
  • Webhooks
    • Webhooks Overview
    • KYB notifications
    • Event catalogue
    • Resend Fail Webhook
    • 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 Update
    • Crypto Deposit Order Notification
    • Collect Order Updated
    • Usd Payout Order Updated
    • onboard result
    • partner order status
    • PaymentLink Notification
    • Deposit Whitelist Notification
  • Partner Flow
    • Share KYB/KYC and open account directly
    • Get KYB/KYC submit + open account status
    • Get Stablecoin Quote
    • Create Stable Order
    • Get Order (Single) Detail
    • List Orders(Batch)
    • Submit hash
  • Appendix
    • Enums quick reference
    • Enum
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
  • Errors
    • Error codes catalogue
  • Change Log
    • 2026-09-21 Virtual Account independent refund orders
    • Wallet deposit source-address whitelist
  1. Wallet

Wallet · Deposit

Parent: Overview
Updated: 2026-08-05
Deposited funds are gated on the payer source address. After chain confirmation the order is PROCESSING and the
money sits in the unavailable balance of the receiving wallet until the source address is whitelisted and the payer
details pass review. Full flow, statuses and APIs: Wallet · Deposit whitelist.
Wallet deposits usually follow one of two paths: on-chain address deposit, or Payment Link collection (funds land in the collect wallet first, then optionally Transfer to the operation wallet for Convert).

A. On-chain deposit#

Flow#

Steps#

1.
(If needed) Open / create a sub-wallet: POST /v1/wallet/create/sub
2.
GET /v1/wallet/deposit-address (with currency, network, walletId, etc.)
3.
Hand the address to the payer for the on-chain transfer
4.
Listen for DEPOSIT_ORDER_NOTIFICATION
5.
If sender details are required: DEPOSIT_SENDER_DETAIL_UPDATED → POST /v1/wallet/add-deposit-sender
6.
If the payer source address is not whitelisted, DEPOSIT_ORDER_NOTIFICATION arrives with status PROCESSING and whiteListStatus init (or rejected after a failed review) → POST /v1/wallet/deposit-whitelist/transactions/{transactionId}/submit. On approval whiteListStatus becomes approved and the available balance increases — see Wallet · Deposit whitelist
7.
Reconcile via GET /v1/wallet/asset-balance / GET /v1/wallet/transaction/list

Reconciliation keys#

On-chain tx hash (when present in the callback / data) + webhook eventId + walletId

B. Payment Link collection#

Payment Link APIs live under API Reference · Payment Link. They complement on-chain Deposit; they do not replace Convert.

Flow#

Steps#

1.
POST /v1/stable/collect/create-payment-link
2.
Hand the payment link to the payer
3.
Receive PAYMENT_LINK_UPDATED; query via POST /v1/stable/collect/payment-links if needed
4.
If funds cannot be matched: UNALLOCATED_FUND_RECEIVED → abnormal-fund APIs
5.
(Optional) After funds enter the collect wallet, Transfer to the operation wallet, then Convert

Reconciliation keys#

userOrderNo / paymentId + webhook eventId

Wallet + Payment Link overview#

Typical paths:
1.
Own on-chain deposit: create/sub → deposit-address → credit operation / target wallet
2.
Payment Link collection: create-payment-link → collect wallet → transfer → operation wallet → Convert

Limits#

Deposit has no public unified “minimum fiat amount” table; arrival depends on network confirmation and risk controls. See assets-and-limits.md.
Previous
Wallet Overview
Next
Wallet · Statuses
Built with