Skip to main content
GET
/
v1
/
accounts
Fetch Accounts
curl --request GET \
  --url https://carbonapistagingsecure.getcarbon.co/baas/api/v1/accounts \
  --header 'apikey: <api-key>' \
  --header 'x-carbon-key: <x-carbon-key>'
const options = {
  method: 'GET',
  headers: {'x-carbon-key': '<x-carbon-key>', apikey: '<api-key>'}
};

fetch('https://carbonapistagingsecure.getcarbon.co/baas/api/v1/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://carbonapistagingsecure.getcarbon.co/baas/api/v1/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 => [
    "apikey: <api-key>",
    "x-carbon-key: <x-carbon-key>"
  ],
]);

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

curl_close($curl);

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

url = "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/accounts"

headers = {
    "x-carbon-key": "<x-carbon-key>",
    "apikey": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
require 'uri'
require 'net/http'

url = URI("https://carbonapistagingsecure.getcarbon.co/baas/api/v1/accounts")

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

request = Net::HTTP::Get.new(url)
request["x-carbon-key"] = '<x-carbon-key>'
request["apikey"] = '<api-key>'

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

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

func main() {

	url := "https://carbonapistagingsecure.getcarbon.co/baas/api/v1/accounts"

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

	req.Header.Add("x-carbon-key", "<x-carbon-key>")
	req.Header.Add("apikey", "<api-key>")

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

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

	fmt.Println(string(body))

}
{
  "status": "success",
  "message": "Account fetched successfully",
  "data": {
    "id": "3529237a-8ae1-4d63-a6ad-419fae3b9f5e",
    "account": {
      "bank_name": "CARBON",
      "bank_code": "565",
      "account_name": "Ola Ajayi",
      "account_number": "6009490194",
      "balance": 350833340,
      "available_balance": 350833340,
      "locked": false
    },
    "owner": {
      "id": "965c4bf7-e86b-45ca-b286-1ee6f32e991b",
      "first_name": "ola",
      "last_name": "ajayi",
      "email": "ola@yahoo.com",
      "phone": "08071000030"
    },
    "is_static": true,
    "mode": "sandbox",
    "created_at": "2024-02-28T01:01:29.000Z",
    "updated_at": "2024-02-28T01:01:29.000Z"
  }
}

​
Overview

This endpoint retrieves a list of accounts with pagination. It fetches a specified number of accounts per page, as per the provided page and limit parameters. You can also filter results by account_number or account_name.

​
Request

Method: GET
URL: /v1/accounts

​
Parameters

NameInTypeRequiredDescription
x-carbon-keyHeaderstringYesAPI key for authentication.
pageQueryintegerNoPage number for pagination.
limitQueryintegerNoNumber of accounts per page.
account_numberQuerystringNoFilter accounts by a specific account number.
account_nameQuerystringNoFilter accounts by account name (partial match).
customer_idQuerystringNoFilter accounts belonging to a specific customer.

​
Response

Status Code: 200 OK
Content-Type: application/json

​
Example Response

{
  "status": "success",
  "message": "Accounts fetched successfully",
  "data": [
    {
      "id": "3529237a-8ae1-4d63-a6ad-419fae3b9f5e",
      "account": {
        "bank_name": "CARBON",
        "account_name": "Ola Ajayi",
        "account_number": "6009490194",
        "balance": 350833340,
        "available_balance": 350833340,
        "locked": false
      },
      "owner": {
        "id": "965c4bf7-e86b-45ca-b286-1ee6f32e991b",
        "first_name": "Ola",
        "last_name": "Ajayi",
        "email": "ola@yahoo.com",
        "phone": "08071000030"
      },
      "is_static": true,
      "mode": "sandbox",
      "created_at": "2024-02-28T01:01:29.000Z",
      "updated_at": "2024-02-28T01:01:29.000Z"
    }
  ],
  "total": "1"
}

Authorizations

​
apikey
string
header
required

Provide your API key in the 'apikey' header.

Headers

​
x-carbon-key
string
required

Query Parameters

​
page
integer
​
limit
integer
​
account_number
string

Filter accounts by a specific account number.

​
account_name
string

Filter accounts by account name (partial match supported).

​
customer_id
string

Filter accounts belonging to a specific customer.

Response

200 - application/json

OK

The response is of type object.