Skip to main content
GET
Get Virtual Account
Retrieve a specific virtual account for the authenticated tenant.

Endpoint

Path Parameters

string
required
Virtual account ID.

Response Fields

string
Unique identifier for the virtual account.
string
Tenant that owns the account.
string
Customer assigned to the account.
string
Provider account number.
string
Name on the account.
string
Provider bank code or slug.
string
Human-readable bank name.
string
Provider selected for the account.
string
Current account status.
string
Account type stored by the service.
number
Total inbound amount recorded on this account, in minor units.
number
Number of recorded inbound credits.
object | null
Account metadata.
string | null
Provider expiry timestamp if the account allocation is temporary.
string
ISO 8601 creation timestamp.
string
ISO 8601 last-update timestamp.

Example Request

Example Response

Error Responses

Use Cases

Show customers their account number and bank details in your app.
Confirm whether an account is active, frozen, closed, or expired before presenting it to users.
Use total_received_minor and transaction_count for reporting and reconciliation.

Next Steps

List Accounts

View all virtual accounts

Close Account

Close the account

Webhooks

Handle account events