Overview
The Virtual Accounts API allows you to create and manage virtual IBANs for wallets. Virtual accounts provide dedicated bank account details that can be used to receive funds directly into a wallet, simplifying the funding process for your users. Virtual accounts support both COLLECTION and USER_OWNED purposes, with country-specific IBAN generation.Methods
Create
Create a new virtual account for a wallet.The virtual account object to create
The wallet identifier
Optional idempotency key to ensure request uniqueness
VirtualAccount - The created virtual account object
Example:
Get
Retrieve a virtual account by its ID.The wallet identifier
The virtual account identifier
VirtualAccount - The virtual account object
Example:
GetAll
Retrieve all virtual accounts for a specific wallet.The wallet identifier
Pagination object
Sorting configuration object
VirtualAccount[] - Array of virtual account objects
Example:
Deactivate
Deactivate a virtual account.The wallet identifier
The virtual account identifier to deactivate
VirtualAccount - The deactivated virtual account object
Example:
GetAvailabilities
Retrieve available virtual account configurations by country and currency.VirtualAccountAvailabilities - Object containing available virtual account configurations
Example:
VirtualAccount Entity
TheVirtualAccount entity represents a virtual IBAN with the following properties:
The unique identifier of the virtual account
Unix timestamp of when the virtual account was created
Custom data that you can add to this item
The ID of the wallet
The credited user ID
The type of the virtual account. Allowed values:
COLLECTION, USER_OWNEDThe country of the IBAN (ISO 3166-1 alpha-2 format). Must correspond to the currency of the wallet.
The status of the virtual account. See
VirtualAccountStatus for possible values.Whether the virtual account is active or not
Information about the account owner
Local account details including IBAN, BIC, and other country-specific information
International account details (when applicable)
Capabilities of the virtual account (e.g., supported payment methods)
Result code if the creation failed
Result message providing details about any errors
VirtualAccountAvailabilities Entity
Contains information about available virtual account configurations:Array of available local virtual account configurations by country and currency
Array of available international virtual account configurations
VirtualAccountAvailability Entity
Country code (ISO 3166-1 alpha-2)
Currency code (ISO 4217)
Whether virtual accounts are available for this country/currency combination