Get Balance Ledger

Retrieve a business’s balance ledger — every credit and debit on the business’s balance, including funding deposits and outgoing payments, with the direction and balance effect of each entry. Use this endpoint to reconcile balance movements against your own books.

For full disbursement records of each movement — payment method, FX rate, and fee breakdown — use Platform Disbursements filtered by businessId instead.

GET /v1/businesses/{businessId}/transactions

Get Balance Ledger

cURL

curl --request GET \
  --url https://api.cadanapay.com/v1/businesses/{businessId}/transactions \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cadanapay.com/v1/businesses/{businessId}/transactions"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.cadanapay.com/v1/businesses/{businessId}/transactions', 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.cadanapay.com/v1/businesses/{businessId}/transactions",
  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.cadanapay.com/v1/businesses/{businessId}/transactions"

	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))

}

HttpResponse<String> response = Unirest.get("https://api.cadanapay.com/v1/businesses/{businessId}/transactions")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cadanapay.com/v1/businesses/{businessId}/transactions")

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

200

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "Completed",
      "vendorId": "<string>",
      "vendorName": "<string>",
      "reference": "<string>",
      "paymentDetails": {
        "preferredMethod": "Payroll",
        "momo": {
          "accountName": "John Doe",
          "provider": "MTN",
          "providerCode": "MTN",
          "phoneNumber": {
            "countryCode": "1",
            "number": "2345678901"
          },
          "currency": "GHS"
        },
        "bank": {
          "accountName": "John Doe",
          "accountNumber": "1234567890",
          "accountType": "Checking",
          "ownerType": "Individual",
          "bankCode": "EXMPJPJT",
          "bankName": "Gotham City Bank",
          "branchName": "Downtown Branch",
          "sortCode": "401234",
          "iban": "GB00000000000000000000",
          "provider": "wise",
          "currency": "USD",
          "beneficiaryId": {
            "type": "NIT",
            "value": "123456789"
          },
          "address": {
            "countryCode": "US",
            "line1": "Street 1",
            "line2": "Apt 1",
            "city": "Gotham",
            "postalCode": "10001",
            "state": "NY"
          },
          "phoneNumber": {
            "countryCode": "1",
            "number": "2345678901"
          },
          "email": "[e-mail]"
        },
        "swift": {
          "currency": "EUR",
          "iban": "DE00000000000000000000",
          "accountName": "John Doe",
          "accountNumber": "1234567890",
          "bankName": "Example Bank",
          "swiftCode": "EXMPDEFF",
          "address": {
            "countryCode": "US",
            "line1": "Street 1",
            "line2": "Apt 1",
            "city": "Gotham",
            "postalCode": "10001",
            "state": "NY"
          }
        },
        "ach": {
          "bankName": "Example Bank",
          "accountName": "John Doe",
          "routingNumber": "000000000",
          "accountNumber": "1234567890",
          "accountType": "Checking",
          "provider": "wise",
          "address": {
            "countryCode": "US",
            "line1": "Street 1",
            "line2": "Apt 1",
            "city": "Gotham",
            "postalCode": "10001",
            "state": "NY"
          }
        },
        "wallet": {
          "type": "user",
          "identifier": "69a2a928-ed49-4e53-92ec-a72b4ee7eacc",
          "currency": "USD"
        },
        "wire": {
          "bankName": "Example Bank",
          "accountName": "John Doe",
          "routingNumber": "000000000",
          "accountNumber": "123456789",
          "address": {
            "countryCode": "US",
            "line1": "Street 1",
            "line2": "Apt 1",
            "city": "Gotham",
            "postalCode": "10001",
            "state": "NY"
          }
        }
      },
      "amount": {
        "value": "10.00",
        "currency": "USD"
      },
      "transactionFee": {
        "value": "10.00",
        "currency": "USD"
      },
      "totalAmount": {
        "value": "10.00",
        "currency": "USD"
      },
      "sourceAmount": {
        "value": "10.00",
        "currency": "USD"
      },
      "fxRate": 123,
      "reason": "<string>",
      "bulkPaymentReference": "<string>",
      "createdTimestamp": 123,
      "lastUpdatedTimestamp": 123,
      "date": "2023-12-25"
    }
  ],
  "node": {
    "previous": "<string>",
    "next": "<string>"
  }
}

{
  "code": "invalid_request_body",
  "message": "The request body provided is not valid",
  "params": {
    "field": "Value is invalid."
  }
}

{
  "code": "resource_not_found",
  "message": "Requested resource could not be found."
}

{
  "code": "internal_error",
  "message": "An unexpected error occurred. Please try again later."
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey · string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

businessId · string · required

The unique identifier for the business

Query Parameters

currency · string · required

Currency code for transactions (required)

Example:

"USD"

startDate · string<date> · required

Start date for transactions filter (required)

Example:

"2024-01-01"

Response

200

application/json

List of business transactions

data · object[]

Show child attributes

node · object

Node pagination

Show child attributes