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 Sub Virtual Account RFI Template Info

GET
/v1/virtual-account/sub/rfi-template
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

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 -g --request GET '/v1/virtual-account/sub/rfi-template?bizTypeList=["SUB_ACCOUNT_RFI_TIER_0","SUB_ACCOUNT_RFI_TIER_1","SUB_ACCOUNT_RFI_TIER_2"]'

Responses

🟢200OK
application/json
Body

Example
{
    "status": 200,
    "code": null,
    "msg": "OK",
    "data": [
        {
            "id": 23,
            "currency": "MXN",
            "bizType": "SUB_ACCOUNT_RFI_TIER_2",
            "questions": [
                {
                    "id": "RFI_TIER2_Certificate_of_incorporation_OR_business_license",
                    "label": "Certificate of incorporation / business license",
                    "type": "FILE",
                    "required": true,
                    "description": "Upload certificate of incorporation or business license document",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": null
                },
                {
                    "id": "RFI_TIER2_ID_cards_of_UBOs",
                    "label": "ID cards of UBOs",
                    "type": "FILE",
                    "required": true,
                    "description": "Upload ID documents of the Ultimate Beneficial Owners (UBOs)",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": null
                },
                {
                    "id": "RFI_TIER2_Proof_of_address_of_business",
                    "label": "Proof of address of business",
                    "type": "TEXT",
                    "required": true,
                    "description": "Enter proof of the business address",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": null
                }
            ]
        },
        {
            "id": 21,
            "currency": "MXN",
            "bizType": "SUB_ACCOUNT_RFI_TIER_0",
            "questions": [
                {
                    "id": "incorporated_country",
                    "label": "Incorporated country",
                    "type": "COUNTRY",
                    "required": true,
                    "description": "Enter incorporated country",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": null
                },
                {
                    "id": "incorporated_date",
                    "label": "Incorporated date",
                    "type": "TEXT",
                    "required": true,
                    "description": "Enter incorporated date",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": null
                },
                {
                    "id": "registration_number",
                    "label": "Registration number of incorporated entity",
                    "type": "TEXT",
                    "required": true,
                    "description": "Enter registration number of incorporated entity",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": null
                },
                {
                    "id": "business_type",
                    "label": "Industry, business type",
                    "type": "TEXT",
                    "required": true,
                    "description": "Enter industry and business type",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": null
                },
                {
                    "id": "company_address",
                    "label": "Company address on the registration",
                    "type": "TEXT",
                    "required": true,
                    "description": "Enter company address on the registration",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": null
                },
                {
                    "id": "phone_number",
                    "label": "Phone number",
                    "type": "PHONE",
                    "required": true,
                    "description": "Enter phone number",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": null
                },
                {
                    "id": "email",
                    "label": "Email",
                    "type": "EMAIL",
                    "required": true,
                    "description": "Enter email address",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": null
                }
            ]
        },
        {
            "id": 22,
            "currency": "MXN",
            "bizType": "SUB_ACCOUNT_RFI_TIER_1",
            "questions": [
                {
                    "id": "RFI_TIER1_Legal_Representative_Subtitle",
                    "label": "Legal Representative",
                    "type": "SUB TITLE",
                    "required": false,
                    "description": "Subtitle for Legal Representative section",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": null
                },
                {
                    "id": "RFI_TIER1_Legal_Representative_First_Name",
                    "label": "First Name",
                    "type": "TEXT",
                    "required": true,
                    "description": "Enter legal representative first name",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": "RFI_TIER1_Legal_Representative_Subtitle"
                },
                {
                    "id": "RFI_TIER1_Legal_Representative_Last_Name",
                    "label": "Last Name",
                    "type": "TEXT",
                    "required": true,
                    "description": "Enter legal representative last name",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": "RFI_TIER1_Legal_Representative_Subtitle"
                },
                {
                    "id": "RFI_TIER1_Legal_Representative_Nationality",
                    "label": "Nationality",
                    "type": "COUNTRY",
                    "required": true,
                    "description": "Select legal representative nationality",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": "RFI_TIER1_Legal_Representative_Subtitle"
                },
                {
                    "id": "RFI_TIER1_Legal_Representative_Birthdate",
                    "label": "Birthdate",
                    "type": "DATE",
                    "required": true,
                    "description": "DD / MM / YYYY",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": "RFI_TIER1_Legal_Representative_Subtitle"
                },
                {
                    "id": "RFI_TIER1_Legal_Representative_Passport_or_ID_number",
                    "label": "Passport or ID number",
                    "type": "TEXT",
                    "required": true,
                    "description": "Enter legal representative passport or ID number",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": "RFI_TIER1_Legal_Representative_Subtitle"
                },
                {
                    "id": "RFI_TIER1_UBO_Subtitle",
                    "label": "UBO",
                    "type": "SUB TITLE",
                    "required": false,
                    "description": "Subtitle for UBO section",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": null
                },
                {
                    "id": "RFI_TIER1_UBO_Same_as_Legal_Representative",
                    "label": "Same as Legal Representative?",
                    "type": "CHECKBOX",
                    "required": true,
                    "description": "Check if UBO is the same as legal representative",
                    "options": null,
                    "condition": null,
                    "parentSubtitleId": "RFI_TIER1_UBO_Subtitle"
                },
                {
                    "id": "RFI_TIER1_UBO_First_Name",
                    "label": "First Name",
                    "type": "TEXT",
                    "required": false,
                    "description": "Enter UBO first name",
                    "options": null,
                    "condition": {
                        "field": "RFI_TIER1_UBO_Same_as_Legal_Representative",
                        "operator": "eq",
                        "value": [
                            "false"
                        ]
                    },
                    "parentSubtitleId": "RFI_TIER1_UBO_Subtitle"
                },
                {
                    "id": "RFI_TIER1_UBO_Last_Name",
                    "label": "Last Name",
                    "type": "TEXT",
                    "required": false,
                    "description": "Enter UBO last name",
                    "options": null,
                    "condition": {
                        "field": "RFI_TIER1_UBO_Same_as_Legal_Representative",
                        "operator": "eq",
                        "value": [
                            "false"
                        ]
                    },
                    "parentSubtitleId": "RFI_TIER1_UBO_Subtitle"
                },
                {
                    "id": "RFI_TIER1_UBO_Nationality",
                    "label": "Nationality",
                    "type": "COUNTRY",
                    "required": false,
                    "description": "Select UBO nationality",
                    "options": null,
                    "condition": {
                        "field": "RFI_TIER1_UBO_Same_as_Legal_Representative",
                        "operator": "eq",
                        "value": [
                            "false"
                        ]
                    },
                    "parentSubtitleId": "RFI_TIER1_UBO_Subtitle"
                },
                {
                    "id": "RFI_TIER1_UBO_Birthdate",
                    "label": "Birthdate",
                    "type": "DATE",
                    "required": false,
                    "description": "DD / MM / YYYY",
                    "options": null,
                    "condition": {
                        "field": "RFI_TIER1_UBO_Same_as_Legal_Representative",
                        "operator": "eq",
                        "value": [
                            "false"
                        ]
                    },
                    "parentSubtitleId": "RFI_TIER1_UBO_Subtitle"
                },
                {
                    "id": "RFI_TIER1_UBO_Passport_or_ID_number",
                    "label": "Passport or ID number",
                    "type": "TEXT",
                    "required": false,
                    "description": "Enter UBO passport or ID number",
                    "options": null,
                    "condition": {
                        "field": "RFI_TIER1_UBO_Same_as_Legal_Representative",
                        "operator": "eq",
                        "value": [
                            "false"
                        ]
                    },
                    "parentSubtitleId": "RFI_TIER1_UBO_Subtitle"
                }
            ]
        }
    ],
    "traceId": "Auto:e71cdcae27534e858425980a9570a4e2",
    "success": true
}
Previous
List RFI Sub Virtual Account
Next
Sub Virtual Account Submit RFI
Built with