Bamboo provides multiple endpoints to retrieve virtual account information, depending on the identifier you prefer to use.

Use this endpoint when you have Bamboo's internal VirtualAccountId.
It returns the full account details and payment instructions.

Use this endpoint when you want to search using your own ExternalReference.
It returns the identical account details and payment instructions.

💡
These endpoints are helpful if you need to retrieve and display the payment instructions to the user again in your UI.
For real-time deposit notifications, Bamboo recommends using webhooks.

Retrieve Virtual Account

The Get Virtual Account operation returns the full details of an account, exactly as it was generated during creation. Both endpoints return the same response structure.

1. Choose your Environment

You must invoke a GET request to the following URLs according to your testing or production needs. Notice there are two different endpoints depending on the parameter you want to use for the search.

Search by Virtual Account ID:

Environment	Endpoint
Development/Stage	`https://api.stage.bamboopayment.com/v3/api/VirtualAccount/{virtualAccountId}`
Production	`https://api.bamboopayment.com/v3/api/VirtualAccount/{virtualAccountId}`

Search by External Reference:

Environment	Endpoint
Development/Stage	`https://api.stage.bamboopayment.com/v3/api/VirtualAccount/externalreference/{externalReference}`
Production	`https://api.bamboopayment.com/v3/api/VirtualAccount/externalreference/{externalReference}`

2. Building the Request

You only need to provide ONE of the following path parameters, depending on the endpoint you selected.

Parameter	Type	Required?	Description
`VirtualAccountId`	`string`	Cond.*	Bamboo's unique internal numeric identifier for this virtual account (e.g., `321355465202074912`). Required only for the ID-based endpoint.
`UniqueId`	`string`	Cond.*	Merchant's internal unique identifier for the customer (e.g., `Customer-123`). Required only for the Reference-based endpoint.

ℹ️
Account Idempotency
If a creation request is sent with an ExternalReference that already exists for your merchant account, the API will not create a new duplicate account. Instead, it will safely return the existing active Virtual Account details.

3. Response Parameters

The response structure is identical to the standard Create Virtual Account response, ensuring consistency across different endpoints and simplifying your integrations.

Parameter	Type	Description
`VirtualAccountId`	`string`	Bamboo's unique internal numeric identifier for this virtual account (e.g., `321355465202074912`).
`Status`	`string`	Current operational state. Will return `ACTIVE` if the account is ready to receive funds.
`Created`	`string`	ISO 8601 timestamp of the account creation.
`OwnershipModel`	`string`	The legal ownership model of the generated account. Values: `BAMBOO_OWNED` (Master/FBO account) or `NAMED_ACCOUNT` (Registered under specific user details).
`Country`	`string`	The ISO 2-letter country code (e.g., `MX`, `AR`).
`Currency`	`string`	The ISO 3-letter currency code (e.g., `MXN`, `ARS`).
`UniqueId`	`string`	The original reference you sent in the creation request.
`PaymentMethod`	`string`	The local clearinghouse network used (e.g., `SPEI`, `MCC`).
`PaymentInstrument`	`object`	Contains the actual banking details (such as CLABE or CVU) to be displayed to the user.
`AccountOwner`	`object`	Echoes the legal and personal details of the end-user provided in the original request.
`MetadataOut`	`object`	Additional metadata returned with the response.
`ErrorCode`	`string`	Error code if the fetch failed (will be `null` on success).
`ErrorDescription`	`string`	Detailed description of the error if the fetch failed (will be `null` on success).

Response Examples

{
  "VirtualAccountId": "321355465202074912",
  "Status": "ACTIVE",
  "Created": "2026-06-09T19:03:10.808Z",
  "OwnershipModel": "BAMBOO_OWNED",
  "Country": "MX",
  "Currency": "MXN",
  "UniqueId": "Customer-123",
  "PaymentMethod": "SPEI",
  "PaymentInstrument": {
    "Type": "CLABE",
    "BankAccount": "012700001234567890",
    "BankName": "STP",
    "BankAccountHolder": "ACME Corp - Bamboo Payments"
  },
  "AccountOwner": {
    "Type": "COMPANY",
    "BusinessName": "Acme Corp Latam",
    "FirstName": null,
    "LastName": null,
    "DocumentNumber": "ACME900101ABC",
    "DocumentType": "RFC",
    "Email": "[email protected]",
    "PhoneNumber": "+525512345678"
  },
  "MetadataOut": {
    "InternalSegment": "VIP_Customer"
  },
  "ErrorCode": null,
  "ErrorDescription": null
}

{
  "VirtualAccountId": "321355465202074913",
  "Status": "ACTIVE",
  "Created": "2026-06-09T19:05:00.000Z",
  "OwnershipModel": "NAMED_ACCOUNT",
  "Country": "AR",
  "Currency": "ARS",
  "ExternalReference": "Customer-123",
  "PaymentMethod": "BKT",
  "PaymentInstrument": {
    "Type": "CVU",
    "BankAccount": "0000003100000000000012",
    "BankName": "Bind",
    "BankAccountHolder": "Juan Pérez"
  },
  "AccountOwner": {
    "Type": "INDIVIDUAL",
    "BusinessName": null,
    "FirstName": "Juan",
    "LastName": "Pérez",
    "DocumentNumber": "20301234567",
    "DocumentType": "CUIT",
    "Email": "[email protected]",
    "PhoneNumber": "+5491123456789"
  },
  "MetadataOut": {
    "InternalSegment": "VIP_User"
  },
  "ErrorCode": null,
  "ErrorDescription": null
}

⚠️
Handling Not Found Errors
If the virtualAccountId or externalReference provided does not exist in Bamboo's database, the API will respond with an HTTP 204 No Content status code instead of an error object.