Retrieves details of a specific virtual bank account by its ID. Required scope: virtual-account:read.
Authorization
oauth2ClientCredentials virtual-account:readUse your OAuth client credentials to obtain a short-lived Bearer token from POST /oauth/token.
In: header
Scope: virtual-account:read
Path Parameters
ID of the virtual bank account to retrieve.
Response Body
application/json
application/json
application/json
curl --request GET \ --url 'https://example.com/api/external/virtual-bank-account/string'{ "message": "Virtual bank account retrieved successfully.", "data": { "id": "33580c65-d063-4138-a875-82ff09dfaeb5", "business_wallet_id": "b18ed308-5ac5-4e9e-bb16-8c03ec2d3c01", "currency_id": 1, "currency": "NGN", "account_number": "7880000024", "account_name": "John Doe", "bank_name": "78 Finance Company Limited", "bank_code": "123456", "provider": "BANK78", "account_reference": "2327323232", "reservation_reference": null, "rejection_reason": null, "status": "SUCCESSFUL" }}POSTCreate virtual bank account
Generates a new virtual bank account for the specified wallet. Supports NGN, GBP, USD, EUR. **Important:** Virtual bank accounts are not immediately issued. Account details are usually provided within a few minutes, but can take a few days if the customer is being reviewed manually or has not passed internal checks. The initial status will be PENDING until the account is fully provisioned. In the development environment, only NGN virtual bank accounts settle. Required scope: `virtual-account:create`.
GETGet identification type
Look up the country-specific identification type that a customer must provide as their `tin` value. Each country uses a different identification system (e.g. SSN in the US, BVN in Nigeria, NINO in the UK), and individual vs business customers within the same country may require different types. Call this endpoint before creating or updating a customer to know what field label to show in your UI and what value to collect. Save the collected value as the customer's `tin` field. Required scope: `virtual-account:read`.