List Virtual Account - BPN OpenAPI

Purpose:
To retrieve a list of virtual accounts created under a business or its sub-users, with support for filtering by account details, currency, creation date, and pagination.

What this endpoint does:

Returns detailed information about virtual accounts, including account numbers, bank details, status, and associated user/sub-user IDs. This endpoint is useful for operational tracking, reconciliation, customer service support, and back-office reporting.

Keynotes:

Supports multiple filters such as accountId, subUserId, currency, and creation time range (startTimestamp, endTimestamp).

Pagination parameters pageNum and pageSize help manage large result sets.

Returned account details may vary depending on currency and jurisdiction — e.g., IBAN and SWIFT codes may not be applicable in all cases.

Account status values typically include:

INIT： Account creation initiated but not yet active

SUCCESS： Account successfully created and active

FAIL： Account creation failed

Useful for listing all virtual accounts associated with a business for audit, support, or transaction routing purposes.

traceId is always returned for troubleshooting and request correlation.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

Example

{
    "status": 200,
    "data": {
        "pageNumber": 55,
        "pageSize": 8,
        "totalPage": 69,
        "totalRow": 73,
        "records": [
            {
                "virtualAccountId": "6",
                "externalAccountId": "42",
                "accountName": "Investment Account",
                "bankName": "Test Bank",
                "currency": "BRL",
                "status": "SUCCESS",
                "qrCode": "58",
                "qrCodeImage": "https://loremflickr.com/400/400?lock=8282583396766534",
                "subAccountType": "consequat sit cillum pariatur aute",
                "expireTime": "2025-12-16 02:43:52",
                "amount": "411.89",
                "pixKeyType": "DYNAMIC",
                "pixKey": "XXXXXXXXX",
                "rfiStatus": "AWAITING_SUBMISSION"
            },
            {
                "virtualAccountId": "30",
                "externalAccountId": "79",
                "accountName": "Savings Account",
                "bankName": "Bessie Boehm",
                "currency": "velit eu dolore",
                "status": "velit Duis cillum dolore",
                "qrCode": "71",
                "qrCodeImage": "https://loremflickr.com/400/400?lock=1490647520379366",
                "subAccountType": "incididunt proident ex",
                "expireTime": "2025-12-16 11:07:54",
                "amount": "810.49",
                "pixKeyType": "fugiat aliquip ex eiusmod deserunt",
                "pixKey": "dolor et Duis dolore Lorem",
                "rfiStatus": "AWAITING_SUBMISSION"
            },
            {
                "virtualAccountId": "15",
                "externalAccountId": "67",
                "accountName": "Personal Loan Account",
                "bankName": "Ms. Chelsea Boyle PhD",
                "currency": "ut pariatur reprehenderit eiusmod tempor",
                "status": "nulla in pariatur",
                "qrCode": "57",
                "qrCodeImage": "https://loremflickr.com/400/400?lock=129177682950569",
                "subAccountType": "est aliquip minim",
                "expireTime": "2025-12-16 00:24:58",
                "amount": "197.39",
                "pixKeyType": "ex ullamco incididunt est",
                "pixKey": "laborum sunt ut",
                "rfiStatus": "SUBMITTED"
            }
        ]
    },
    "traceId": "52"
}