Request

Parameters

Response

Example Response

Overview

Retrieve the status of a specific payout by reference.

Fetch Payout Status

### Retrieve Payout Status

This endpoint makes an HTTP GET request to retrieve the status of a payout with a specific reference from the provided base URL.

#### Request Body

This request does not require a request body.

#### Response Body

The response will be in JSON format and will include the following parameters:

- `status` (string): The status of the payout.
    
- `message` (string): A message related to the payout status.
    
- `amount` (number): The payout amount.
    
- `total` (number): The total amount.
    
- `fee` (number): The fee associated with the payout.
    
- `reference` (string): The reference of the payout.
    
- `uniqueRef` (string): The unique reference of the payout.
    
- `beneficiary` (object): An object containing the beneficiary details including:
    
    - `bankCode` (string): The bank code of the beneficiary.
        
    - `accountNumber` (string): The account number of the beneficiary.
        
    - `accountName` (string): The account name of the beneficiary.
        
    - `bankName` (string): The bank name of the beneficiary.
        

#### Example Response

``` json
{
    "status": "",
    "message": "",
    "data": {
        "status": "",
        "message": "",
        "amount": 0,
        "total": 0,
        "fee": 0,
        "reference": "",
        "uniqueRef":"",
        "providerReference": "",
        "beneficiary": {
            "bankCode": "",
            "accountNumber": "",
            "accountName": "",
            "bankName": ""
        }
    }
}


 ```

apikeyAuth

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

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 details of a specific account by account number.

Get 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 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.

Name	In	Type	Required	Description
`x-carbon-key`	Header	`string`	Yes	API key for authentication.
`reference`	Path	`string`	Yes	The unique reference of the payout.

API Documentation

Customers

Accounts

Payouts

Transactions

Banks

Webhooks

Fetch Payout Status

Overview

Request

Parameters

Response

Example Response

Authorizations

Headers

Path Parameters

Response

API Documentation

Customers

Accounts

Payouts

Transactions

Banks

Webhooks

​Overview

​Request

​Parameters

​Response

​Example Response

Authorizations

Headers

Path Parameters

Response

Overview

Request

Parameters

Response

Example Response