1. Partner Flow
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
      • Prepay Whitelist for One-Time Payment Link
      • Prepay Whitelist for Permanent Payment Link
    • 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 Payment Link deposit
      • 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
      POST
    • Get KYB/KYC submit + open account status
      GET
    • List Banks
      GET
    • Check Account
      POST
    • Add Account
      POST
    • Get Stablecoin Quote
      POST
    • Create Stable Order
      POST
    • Get Order (Single) Detail
      GET
    • List Orders(Batch)
      GET
    • Submit hash
      POST
    • Order Status Notification (STABLE_ORDER_UPDATED)
  • 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. Partner Flow

Get Order (Single) Detail

GET
/v1/stable/order/query-detail

Get Order Detail (Partner Flow)#

GET /v1/stable/order/query-detail — query one order by merchantOrderId or orderId (one is required; use the same values as submit-order).

orderStatus#

orderStatusfinalmeaning
INITnoOrder created; processing has not started yet.
PROCESSINGnoOrder is being processed; fiat payout is in progress.
SUCCESSyesFiat paid out to targetAccountId.
FAILyesOrder failed. See failCode / failReason.
REFUNDINGnoStablecoin refund to userRefundCryptoAddress is in progress.
REFUNDEDyesRefund succeeded: stablecoin returned to userRefundCryptoAddress.
REFUNDED = refund succeeded (stablecoin sent back to userRefundCryptoAddress).
In rare cases the receiving bank / mobile money operator returns the payout after SUCCESS; the order then moves SUCCESS → REFUNDING → REFUNDED and the stablecoin is refunded to userRefundCryptoAddress.
Only update your ledger on a final status. INIT / PROCESSING / REFUNDING are intermediate — keep polling (or wait for the webhook).
When orderStatus=FAIL, read failCode / failReason.

Polling#

Poll at most once every 5 seconds per order. If an order stays in an intermediate status longer than expected, contact support with orderId and traceId; do not submit a new order for the same merchantOrderId.

HKD (RD Wallet) partners#

HKD orders may also return AWAITING_FUNDS and EXPIRED, and use redirectUrl / nextAction / externalOrderId / depositAddress. These fields are null for KES / UGX / TZS.
Webhook: STABLE_ORDER_UPDATED — see Order Status Notification (STABLE_ORDER_UPDATED) in this folder. The webhook status is lowercase (init / success / fail / refunded); this endpoint returns uppercase orderStatus.

Request

Query Params

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 '/v1/stable/order/query-detail?merchantOrderId=PARTNER_ORDER_20261020_0001&orderId=ST2026102014120391827364519283'

Responses

🟢200OK
application/json
Bodyapplication/json

Examples
{
    "status": 200,
    "code": null,
    "msg": "OK",
    "data": {
        "orderId": "ST2026102014120391827364519201",
        "merchantOrderId": "PARTNER_ORDER_20261020_0001",
        "externalOrderId": null,
        "orderStatus": "INIT",
        "businessType": "STABLE_SELL",
        "paymentMethod": "BANK_TRANSFER",
        "sourceCurrency": "USDT",
        "targetCurrency": "KES",
        "sourceAmount": 100.0,
        "targetAmount": 12721.5,
        "ourFee": 1.0,
        "ourFeeCurrency": "USDT",
        "payInFee": 0,
        "payInFeeCurrency": "USDT",
        "payOutFee": 0,
        "payOutFeeCurrency": "KES",
        "redirectUrl": null,
        "nextAction": null,
        "depositAddress": null,
        "failCode": null,
        "failReason": null,
        "createdTime": 1792483200000,
        "completedTime": null,
        "sourceAccountId": null,
        "targetAccountId": "12991",
        "qrCode": null,
        "qrCodeImg": null
    },
    "traceId": "Auto:0d1e2f3a4b5c46d7e8f9a0b1c2d3e401",
    "success": true
}
Previous
Create Stable Order
Next
List Orders(Batch)
Built with