BPN OpenAPI
  1. Account Management
BPN OpenAPI
  • Getting Started
    • Introduction to BPN
    • Key Concepts & Terminology
    • Architecture Overview
  • Onboarding & Prerequisites
    • Product Demo
    • Sandbox & Test Environment
    • Signature Authentication Mechanism
  • Use Case
    • Transfer
    • Vault
    • On/Off Ramp
    • Compliance (Travel Rule Information Submission)
    • Fiat Collection(BRL PIX for example)
  • API Reference
    • Account Management
      • Inquiry Master VA Balance
        GET
      • Create Virtaul Account
        POST
      • Get Virtual Account Detail
        GET
      • List Virtual Account
        GET
      • Send Email Verify Code
        POST
      • Query bank info by account number
        POST
      • Payout via Virtual Account
        POST
      • Refund Virtual Account Order
        POST
      • Get Virtual Account Order Detail
        GET
      • List Virtual Account Orders
        GET
      • Submit Invoice
        POST
      • Get Invoice list Status
        GET
      • List Banks
        GET
      • Add Bank Account
        POST
      • List Bank Account
        GET
      • List RFI Sub Virtual Account
        GET
      • Get Sub Virtual Account RFI Template Info
        GET
      • Sub Virtual Account Submit RFI
        POST
    • Wallet
      • List Wallets
      • List Sub Account
      • Create Sub Account
      • Wallet Internal Transfer
      • 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
      • Create Payment Link
      • List Payment links
      • Get Curreny Network Config
    • Mock
      • Mock Virtual account Payin Order
  • 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
  • Appendix
    • Enum
    • Virtual Account(VA) Support List & KYB requirement
  • Release Notes & Changelog
    • Version History
  • Schemas
    • walletBalance
    • walletAddress
    • transactionRecord
  1. Account Management

Get Virtual Account Detail

GET
/v1/virtual-account/sub/get
This API is used to retrieve detailed information of a specific sub virtual account.
By providing either the internal virtualAccountId or the externalAccountId, the caller can query the configuration and current status of a single designated sub-account.
This endpoint is typically used for account inquiry, account validation, and operational checks when managing virtual accounts under a master virtual account structure.

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 --request GET '/v1/virtual-account/sub/get?virtualAccountId=&externalAccountId'

Responses

🟢200OK
application/json
Body

Examples
{
    "status": 200,
    "code": null,
    "msg": "OK",
    "data": {
        "virtualAccountId": "3121",
        "externalAccountId": "EX1231",
        "accountName": "apisuu mxn 123003",
        "accountNumber": "646180191200694532",
        "bankName": "XXXX Bank",
        "bankCode": "001",
        "currency": "MXN",
        "status": "SUCCESS",
        "qrCode": "",
        "qrCodeImage": "",
        "subAccountType": "STATIC",
        "amount": null,
        "pixKeyType": null,
        "pixKey": null,
        "expireTime": null,
        "rfiStatus": "AWAITING_SUBMISSION"
    },
    "traceId": "Auto:a4eecf6114104fd791fad1b6aed856af",
    "success": true
}
Previous
Create Virtaul Account
Next
List Virtual Account
Built with