Get a virtual account
curl --request GET \
--url https://{host}/v1/virtual-accounts/{accountId} \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://{host}/v1/virtual-accounts/{accountId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/virtual-accounts/{accountId}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_number": "<string>",
"account_name": "<string>",
"type": "static",
"purpose": "<string>",
"owner_type": "<string>",
"status": "<string>",
"fee_bearer": "business",
"settles_to": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name_status": "<string>",
"label": "Lekki branch",
"settlement_account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_number": "<string>",
"account_name": "<string>"
},
"payment_terms": {
"reference": "INV-2026-0042",
"currency": "NGN",
"amount_minor": 2500000,
"fee_minor": 123,
"vat_minor": 123,
"charge_minor": 123,
"total_payable_minor": 123,
"settlement_minor": 123,
"expires_at": "2023-11-07T05:31:56Z",
"held_payments": 123,
"payer_name": "Adaeze Okafor",
"received_minor": 123,
"paid_at": "2023-11-07T05:31:56Z",
"transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"collection_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": null,
"code": "13"
}Virtual accounts
Get a virtual account
Gets one of the business’s virtual accounts, with name_status: whether payers see its name yet.
Required permission: feature:VIRTUAL_ACCOUNTS, virtual-accounts:read
GET
/
v1
/
virtual-accounts
/
{accountId}
Get a virtual account
curl --request GET \
--url https://{host}/v1/virtual-accounts/{accountId} \
--header 'X-Api-Key: <api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://{host}/v1/virtual-accounts/{accountId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{host}/v1/virtual-accounts/{accountId}"
headers = {"X-Api-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_number": "<string>",
"account_name": "<string>",
"type": "static",
"purpose": "<string>",
"owner_type": "<string>",
"status": "<string>",
"fee_bearer": "business",
"settles_to": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"name_status": "<string>",
"label": "Lekki branch",
"settlement_account": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"account_number": "<string>",
"account_name": "<string>"
},
"payment_terms": {
"reference": "INV-2026-0042",
"currency": "NGN",
"amount_minor": 2500000,
"fee_minor": 123,
"vat_minor": 123,
"charge_minor": 123,
"total_payable_minor": 123,
"settlement_minor": 123,
"expires_at": "2023-11-07T05:31:56Z",
"held_payments": 123,
"payer_name": "Adaeze Okafor",
"received_minor": 123,
"paid_at": "2023-11-07T05:31:56Z",
"transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"collection_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"code": "13"
}{
"success": true,
"message": "<string>",
"request_id": "01a1775167aa7693a7acd8df7b596118",
"data": null,
"code": "13"
}