Skip to main content
GET
Get Virtual Account
Returns one virtual account with its current status, bank details and balances. This is the endpoint to poll after Create Virtual Account: a new virtual account is pending with no bank details until the provider issues them. Requires an API key with read access on the virtual_accounts scope.

Path Parameters

string
required
The account’s external ID (starts with acct_)
string
required
The virtual account group’s external ID (starts with vag_). A group belonging to another account returns 404.
string
required
The virtual account’s external ID (starts with va_). It must sit in this group on this account: a virtual account in another group of the same account returns 404.

Response

string
Virtual account identifier (starts with va_)
string
Always returns "virtual_account"
string
Account ID (starts with acct_). The response does not repeat group_id.
string
Currency code of the virtual account
string
Virtual account status:
  • pending: created, bank details not yet issued. Not payable, and not usable as a payout funding source or transfer leg.
  • active: bank details issued and provisioned_at set. Payable, and usable for payouts and transfers. It also shows up in List Deposit Instructions.
  • frozen: balance movements blocked by Hop.
  • disabled: closed by Hop; terminal.
string
Label, or null
object
Balance buckets, each a decimal string formatted for the currency
string
Account holder a payer should address the deposit to, or null while pending
string
Bank holding the account, or null while pending
string
Full account number, or null while pending and on accounts identified by IBAN
string
Account number masked as **** + last 4. The IBAN is masked instead when there is no account number. null while pending.
string
Full IBAN, or null while pending and on accounts identified by account number
string
SWIFT/BIC code, or null
string
Routing number or sort code, or null
string
What routing_number holds, for example ROUTING_NUMBER or SORT_CODE; null when there is no routing number
object
Bank address for wire instructions (address_line, city, region, postal_code, country), or null
object
Account holder address for wire instructions, same shape as bank_address, or null
string
ISO 8601 timestamp when the bank details became available, or null while pending. Treat status being active together with a non-null provisioned_at as the signal that the virtual account is ready to receive money.
string
ISO 8601 timestamp when created
string
ISO 8601 timestamp when last updated
string
Actor that created the virtual account: the API key id (starts with ak_) when opened through this API, otherwise the actor Hop recorded
string
Actor that last updated the virtual account, or null

Errors

Request Example

Response Example