1. Webhooks
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
      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 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. Webhooks

Collect Order Updated

Webhook
POST
CollectOrderUpdate

Collect Order Updated#

COLLECT_ORDER_UPDATED — a stablecoin collection / payment-link order changed state. Deduplicate on
eventId.

Deposit whitelist#

data.whiteListStatus is the deposit-whitelist gate state of the crypto payment behind the order —
init / pending / approved / rejected, lowercase. It is null for orders that are not gated.
There is no separate whitelist webhook. Read the gate off this event:
SituationHow it looks
Payer details needed, first submissionorderStatus = PROCESSING and whiteListStatus = init
Review rejected, resubmitorderStatus = PROCESSING and whiteListStatus = rejected
Order finishedorderStatus = SUCCESS
Answer a gate with POST /v1/wallet/deposit-whitelist/transactions/{transactionId}/submit.
Until whiteListStatus is approved the funds sit in the unavailable balance of the receiving wallet
and cannot be withdrawn or converted, however far orderStatus has moved. Whitelist approval is not
announced on its own — this event reaching orderStatus = SUCCESS is the completion signal.

Refunds#

data.refundBy and data.refundReason carry the refund attribution.
refundBy is MERCHANT for a refund you triggered through POST /v2/stable/collect/order/reject, and
BPN for one the platform triggered on its own, so branch on it rather than assuming every refund is yours.
Guide: Wallet · Deposit whitelist

Request

Header Params

Body Params application/json

Example
{
  "data": {
    "orderId": "726300170547609600",
    "orderStatus": "PROCESSING",
    "acceptStatus": "ACCEPTING",
    "accountName": "TestSubWallet1772688467",
    "walletId": "3095",
    "currency": "USDC",
    "amount": "190.99",
    "completeTime": 1720606148703,
    "walletAddress": "1544594690749788162",
    "transactionId": "mock2s0260000004",
    "payer": {
      "walletAddress": "1544594690749788161",
      "walletNetwork": "ETH",
      "isCexAddress": true
    },
    "quote": {
      "quoteId": "37947e9f5ada4fa0b38955d3949bd9fc",
      "price": "1",
      "fee": "0",
      "expireTime": "2026-03-06T06:21:43.829Z"
    },
    "aml": {
      "amlStatus": "PASSED",
      "riskLevel": "LOW"
    },
    "whiteListStatus": "approved"
  },
  "eventId": "d4798719-1c9e-4ab9-b9f4-97dcfc25488b",
  "eventType": "COLLECT_ORDER_UPDATED",
  "referenceId": "726300170547609600",
  "status": "PROCESSING",
  "timestamp": 1772777203843
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://your-api-server.com' \
--header 'API-KEY: <api-key>' \
--header 'API-SIGNATURE: <api-key>' \
--header 'API-TIMESTAMP: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "data": {
    "orderId": "726300170547609600",
    "orderStatus": "PROCESSING",
    "acceptStatus": "ACCEPTING",
    "accountName": "TestSubWallet1772688467",
    "walletId": "3095",
    "currency": "USDC",
    "amount": "190.99",
    "completeTime": 1720606148703,
    "walletAddress": "1544594690749788162",
    "transactionId": "mock2s0260000004",
    "payer": {
      "walletAddress": "1544594690749788161",
      "walletNetwork": "ETH",
      "isCexAddress": true
    },
    "quote": {
      "quoteId": "37947e9f5ada4fa0b38955d3949bd9fc",
      "price": "1",
      "fee": "0",
      "expireTime": "2026-03-06T06:21:43.829Z"
    },
    "aml": {
      "amlStatus": "PASSED",
      "riskLevel": "LOW"
    },
    "whiteListStatus": "approved"
  },
  "eventId": "d4798719-1c9e-4ab9-b9f4-97dcfc25488b",
  "eventType": "COLLECT_ORDER_UPDATED",
  "referenceId": "726300170547609600",
  "status": "PROCESSING",
  "timestamp": 1772777203843
}'

Responses

🟢200OK
application/json
Bodyapplication/json

Example
{}
Previous
Crypto Deposit Order Notification
Next
Usd Payout Order Updated
Built with