Overview

Endpoint

Parameters

Response

Retrieve details of a specific account by account number.

Get Account

This HTTP GET request retrieves account information for a specific account number. The response will be in JSON format with a 200 status code. The response body will include details such as the bank name, bank code, account name, account number, balance, available balance, account status, owner's information, account type, mode, and creation/update timestamps.

Example Response:

``` json
{
    "status": "",
    "message": "",
    "data": {
        "id": "",
        "account": {
            "bank_name": "",
            "bank_code": "",
            "account_name": "",
            "account_number": "",
            "balance": 0,
            "available_balance": 0,
            "locked": true
        },
        "owner": {
            "id": "",
            "first_name": "",
            "last_name": "",
            "email": "",
            "phone": ""
        },
        "is_static": true,
        "mode": "",
        "created_at": "",
        "updated_at": ""
    }
}

 ```

apikeyAuth

Replace {{base_url}} with your API base URL (e.g., https://api.example.com)

Fetch Account

Carbon Business API documentation provides all the necessary information to integrate with our platform, including guides, API references, and endpoint examples.

Carbon Business API

Learn about the Carbon Business API, its features, and how it enables seamless integration of financial services into your applications.

Introduction

Get started with the Carbon Business API by generating your API key, making your first request, and exploring the API.

Quickstart

Learn how to authenticate with the Carbon Business API.

Authentication

We use the conventional HTTP response codes to indicate the success or failure of an API request.

Error Handling

Learn how to use the Carbon BaaS SDK for seamless integration via npm.

Node/Javascript

Integrate MCP to enable search functionality for Carbon Business API documentation.

MCP Integration

Create a new customer with detailed information.

Create Customer

Retrieve details of a specific customer by ID.

Fetch Customer

Retrieve a list of customers with pagination support.

Fetch Customers

Create a new virtual account for a customer.

Create Account

Retrieve a list of accounts with pagination.

Fetch Accounts

Retrieve the balance of a specific account.

Fetch Balance

Flush the balance of an account to another account.

Flush Account

Initiate a payout to a beneficiary account.

Create Payout

Retrieve the status of a specific payout by reference.

Fetch Payout Status

Retrieve details of a specific payout transaction by reference.

Fetch Payout Transaction

Retrieve transaction details for a specific account and reference.

Verify Transaction

Retrieve a list of transactions for a specific account.

Fetch Transactions

Retrieve a list of banks and financial institutions

Get Banks

Resolve account details using the bank code and account number

Resolve Account

Uptime Monitoring

Retrieve the history of webhook events with pagination.

Webhook Events

Resend a webhook event to the specified endpoint.

API Documentation

Customers

Accounts

Payouts

Transactions

Banks

Webhooks

Get Account

Overview

Endpoint

Parameters

Response

Authorizations

Headers

Path Parameters

Response

API Documentation

Customers

Accounts

Payouts

Transactions

Banks

Webhooks

​Overview

​Endpoint

​Parameters

​Response

Authorizations

Headers

Path Parameters

Response

Overview

Endpoint

Parameters

Response