List my virtual accounts

GET

virtual-accounts

curl --request GET \
  --url https://api.example.com/v1/virtual-accounts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/virtual-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/virtual-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/virtual-accounts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/virtual-accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "accountName": "Zuba John Doe",
    "accountNumber": "8012345678",
    "accountType": "fixed_va",
    "bankName": "Wema Bank",
    "clientId": "456e7890-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "currency": "NGN",
    "enabled": true,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "updatedAt": "2023-11-07T05:31:56Z",
    "accountId": {},
    "bankAddress": {},
    "country": {},
    "displayName": {},
    "iban": "GB50IKMA24711059277481",
    "providerStatus": {},
    "provisioningStatus": {},
    "routingNumber": "138344690",
    "sortCode": "247110",
    "sweepable": true,
    "updatedBy": {}
  }
]

Authorizations

Authorization

string

header

required

Enter Auth0 JWT token

Headers

Zuba-Account-Id

string<uuid>

Optional. Names an owned sub-account (UUID) to act on. Omit to act at the master (tenant) level. Naming an account this key does not own returns 403 not_account_owner.

Response

Active virtual accounts for the request owner

accountName

object | null

required

Account name (format: "Zuba {Merchant Name}")

Example:

"Zuba John Doe"

accountNumber

object | null

required

Virtual account number. For a GBP SCAN account this is the UK domestic (Faster Payments) account number that pairs with sortCode, not the default identifier; for EUR it is the IBAN.

Example:

"8012345678"

accountType

string

required

Account type

Example:

"fixed_va"

bankName

object | null

required

Bank name where the virtual account is held

Example:

"Wema Bank"

clientId

string<uuid>

required

Client ID this virtual account belongs to

Example:

"456e7890-e89b-12d3-a456-426614174000"

createdAt

string<date-time>

required

Creation timestamp

Example:

"2024-01-15T10:30:00.000Z"

currency

string

required

Currency of the virtual account

Example:

"NGN"

enabled

boolean

required

Routing eligibility. False for failed or incomplete provider workflows.

string<uuid>

required

Unique identifier for the virtual account

Example:

"123e4567-e89b-12d3-a456-426614174000"

status

enum<string>

required

Current status of the virtual account

Available options:

pending,

active,

inactive

Example:

"active"

updatedAt

string<date-time>

required

Last update timestamp

accountId

object | null

Owning sub-account; null for the client master account.

bankAddress

object | null

Institution or branch address supplied by the provider.

country

object | null

ISO 3166-1 alpha-2 country of the receiving account.

displayName

object | null

The name submitted to the provider as the account holder when the account was opened. On accounts opened in the owner's own name this is the owner's KYB-approved legal name; on accounts opened before that was enforced it may be an internal label or the client id, and is not a verified legal name. Null on rails that submit no holder name, where accountName is the only name reported.

iban

object | null

IBAN for the account — the GB IBAN for a GBP SCAN account (whose accountNumber is the SCAN number), or the primary IBAN for EUR. Null when the account exposes no IBAN.

Example:

"GB50IKMA24711059277481"

providerStatus

object | null

Raw provider account status when supplied.

provisioningStatus

object | null

Asynchronous provisioning workflow status when supplied.

routingNumber

object | null

Routing number for USD wire accounts (US ABA). Null for accounts without one (e.g. EUR/GBP).

Example:

"138344690"

sortCode

object | null

Sort code for GBP SCAN accounts (UK Faster Payments). Null for accounts without one (e.g. EUR/IBAN accounts).

Example:

"247110"

sweepable

boolean | null

Per-account treasury-sweep override (admin view only). true/false override the client policy default; null inherits it. Null for merchant callers.

updatedBy

object | null

List my virtual accounts

curl --request GET \
  --url https://api.example.com/v1/virtual-accounts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/virtual-accounts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/virtual-accounts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/virtual-accounts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/virtual-accounts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

[
  {
    "accountName": "Zuba John Doe",
    "accountNumber": "8012345678",
    "accountType": "fixed_va",
    "bankName": "Wema Bank",
    "clientId": "456e7890-e89b-12d3-a456-426614174000",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "currency": "NGN",
    "enabled": true,
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "active",
    "updatedAt": "2023-11-07T05:31:56Z",
    "accountId": {},
    "bankAddress": {},
    "country": {},
    "displayName": {},
    "iban": "GB50IKMA24711059277481",
    "providerStatus": {},
    "provisioningStatus": {},
    "routingNumber": "138344690",
    "sortCode": "247110",
    "sweepable": true,
    "updatedBy": {}
  }
]