Get the bank account number for a sub-account.
curl --request GET \
--url https://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details \
--header 'x-api-key: <api-key>'import requests
url = "https://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details', 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://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"payinCurrency": "NGN",
"details": {
"bankCode": "<string>",
"accountInfoType": "<string>",
"accountName": "John Doe",
"accountNumber": "230101010",
"bankName": "<string>",
"bankAddress": {
"streetAddress": "11 Main Street",
"city": "Gbagada",
"state": "Lagos",
"country": "NG",
"postalCode": "200124",
"apartmentNo": "5B"
},
"reference": "PROV123456"
}
}{
"code": "BAD_REQUEST",
"message": "Request could not be validated."
}{
"code": "UNAUTHORIZED",
"message": "Either client security header is missing or it is not valid."
}{
"code": "ACCESS_DENIED",
"message": "Expected permission or scope is not present."
}{
"code": "NOT_FOUND",
"message": "Information could not be found"
}{
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred."
}Virtual Account Number
Get Sub-account Number Details
Returns the bank account number (and bank details) generated for this sub-account in the given currency, if one exists.
GET
/
ledger
/
subaccounts
/
{subAccountIdRef}
/
account-details
Get the bank account number for a sub-account.
curl --request GET \
--url https://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details \
--header 'x-api-key: <api-key>'import requests
url = "https://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details', 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://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://business-api.onboard.xyz/ledger/subaccounts/{subAccountIdRef}/account-details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"payinCurrency": "NGN",
"details": {
"bankCode": "<string>",
"accountInfoType": "<string>",
"accountName": "John Doe",
"accountNumber": "230101010",
"bankName": "<string>",
"bankAddress": {
"streetAddress": "11 Main Street",
"city": "Gbagada",
"state": "Lagos",
"country": "NG",
"postalCode": "200124",
"apartmentNo": "5B"
},
"reference": "PROV123456"
}
}{
"code": "BAD_REQUEST",
"message": "Request could not be validated."
}{
"code": "UNAUTHORIZED",
"message": "Either client security header is missing or it is not valid."
}{
"code": "ACCESS_DENIED",
"message": "Expected permission or scope is not present."
}{
"code": "NOT_FOUND",
"message": "Information could not be found"
}{
"code": "INTERNAL_ERROR",
"message": "An internal server error occurred."
}Fetches virtual account number details for a sub-account.
Authorizations
Requires authentication via API key and HMAC signature.
x-api-key: Your API key generated from your Onboard Business dashboard.x-timestamp: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 secondsx-signature: SHA256 HMAC HEX signature calculated overt={x-timestamp}&{requestBody}using your API Secret.
Path Parameters
The unique onboard sub-account ID or reference
Query Parameters
Currency of the bank account number to generate or retrieve.
Example:
"NGN"
Response
Bank account number details
Destination account details the customer must pay into to fund the deposit. Mirrors a Beneficiary (without an id). Carries only the account details needed to make the payment; transaction context (amount, status, etc.) lives on the enclosing CashDepositTransaction.
details can be nullable when the account number provider is still generating it