1. Account Management
BPN OpenAPI
  • Getting Started
    • Introduction to BPN
    • Architecture Overview
  • Onboarding & Prerequisites
    • Product Demo
    • Sandbox & Test Environment
    • Signature Authentication Mechanism
  • Use Case
    • Fiat Collection via Virtual Accounts & Local Collection Rails
    • Convert Stablecoins
    • Transfer
    • Wallet
    • Compliance (Travel Rule Information Submission)
    • RFI process
  • API Reference
    • KYB
      • Share KYB/KYC Info For Sub User
      • Get KYB Sub User Status
    • Account Management
      • Create Virtaul Account
        POST
      • List Primary Virtual Accounts
        GET
      • Inquiry Master VA Balance
        GET
      • Add Bank Account
        POST
      • List Bank Account
        GET
      • List Banks
        GET
      • Submit Invoice
        POST
      • Send Email Verify Code
        POST
      • List Virtual Account
        GET
      • List RFI Sub Virtual Account
        GET
      • Sub Virtual Account Submit RFI
        POST
      • Get Sub Virtual Account RFI Template Info
        GET
      • Get Virtual Account Detail
        GET
      • List Virtual Account Orders
        GET
      • Get Virtual Account Order Detail
        GET
      • Refund Virtual Account Order
        POST
      • Payout via Virtual Account
        POST
      • Query bank info by account number
        POST
      • Get Invoice list Status
        GET
    • Wallet
      • List Wallets
      • List Sub Account
      • Create Sub Account
      • Wallet Internal Transfer
      • Query Wallet Internal Transfer Detail
      • List Wallet Internal Transfer order
      • 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
      • Mock Payin Order Refund
      • Mock Payout Order Update Status
    • Pay Session
      • Request Pay Session
  • Webhooks & Events
    • 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 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
    • Enum
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
  1. Account Management

Refund Virtual Account Order

POST
/v1/virtual-account/order/refund
The Refund API enables merchants to return funds back to the original payer’s account.
Refund by transaction reference: specify a particular pay-in transaction, and the system will process the refund directly to the corresponding payer account.
This ensures a seamless reversal process, fully compliant with payment regulations, while maintaining transparency for both merchants and customers.

Refund vs. Return#

A PayIn reversal follows one of two mutually-exclusive paths, decided by whether the funds have already been credited to the user balance:
Refund (funds already credited — customer- or operations-initiated, i.e. this API): the original PayIn order transitions SUCCESS → REFUNDING → REFUNDED, and a separate PAYIN_REFUND order is created (linked to the original via originalOrderId) that debits the balance and returns the funds to the payer. The merchant will therefore see two records: the original order plus the PAYIN_REFUND order.
Return (funds not yet credited — system-initiated, e.g. RFI/limit expiry, not triggered by this API): the original PayIn order is set to RETURNED directly. It is a single order, the balance is unchanged, and no new order is created.
This endpoint covers the Refund path only. RETURNED is system-initiated and is never produced by this API.

Request

Body Params application/json

Example
{
    "orderId": "string",
    "externalOrderId": "string"
}

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/virtual-account/order/refund' \
--header 'X-BPN-API-KEY: <api-key>' \
--header 'X-BPN-SIGNATURE: <api-key>' \
--header 'X-BPN-TIMESTAMP: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "orderId": "string",
    "externalOrderId": "string"
}'

Responses

🟢200OK
application/json
Bodyapplication/json

Example
{
    "status": 0,
    "message": "string",
    "data": {
        "orderId": "string",
        "externalOrderId": "string",
        "status": "string",
        "originalOrderId": "string"
    },
    "traceId": "string"
}
Previous
Get Virtual Account Order Detail
Next
Payout via Virtual Account
Built with