Skip to main content
GET
/
v1
/
platform
/
disbursements
List Disbursements
curl --request GET \
  --url https://api.cadanapay.com/v1/platform/disbursements \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.cadanapay.com/v1/platform/disbursements"

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/platform/disbursements', 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/platform/disbursements",
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/platform/disbursements"

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/platform/disbursements")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.cadanapay.com/v1/platform/disbursements")

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
{
  "data": [
    {
      "id": "c6250a16-eb63-41de-a952-8122d305ebbf",
      "tenantKey": "tbl12101631",
      "status": "SUCCESS",
      "referenceId": "7b82d74e-4ad5-4fbf-af9c-a0f11b224c7a",
      "description": "January 2026 Payment",
      "type": "PAYROLL",
      "paymentMethod": "wallet",
      "paymentDetails": {
        "preferredMethod": "wallet",
        "wallet": {
          "type": "USER",
          "identifier": "060e3aeb-4a9d-4a90-aff5-17f8d69635ce",
          "currency": "USD"
        }
      },
      "userId": "060e3aeb-4a9d-4a90-aff5-17f8d69635ce",
      "personId": "8ab2ba37-3c37-485d-9af9-122d11c96bf9",
      "userName": "Reed Maygone",
      "amount": {
        "value": "1000.00",
        "currency": "USD"
      },
      "sourceAmount": {
        "value": "1000.00",
        "currency": "USD"
      },
      "feeAmount": {
        "value": "0.00",
        "currency": "USD"
      },
      "totalAmount": {
        "value": "1000.00",
        "currency": "USD"
      },
      "createdTimestamp": "2026-01-28 14:20:47 +0000 UTC",
      "lastUpdatedTimestamp": "2026-01-28 14:20:55 +0000 UTC"
    },
    {
      "id": "6658ae8b-07fd-4e33-b66d-eb1e1420e102",
      "tenantKey": "cad35916961",
      "status": "SUCCESS",
      "referenceId": "aaae74a1-b4ac-44e8-b3a8-abd3bcaa0d3b",
      "type": "PAYOUT",
      "fxRate": 5.7896,
      "paymentMethod": "bank",
      "paymentDetails": {
        "preferredMethod": "bank",
        "bank": {
          "accountName": "Maria Santos",
          "accountNumber": "00123456",
          "bankCode": "001",
          "bankName": "Banco do Brasil",
          "currency": "BRL"
        }
      },
      "userId": "3ace5e66-9981-4bdc-b694-8a4e5dd9d1c6",
      "userName": "Maria Santos",
      "amount": {
        "value": "578.96",
        "currency": "BRL"
      },
      "sourceAmount": {
        "value": "100.00",
        "currency": "USD"
      },
      "feeAmount": {
        "value": "13.50",
        "currency": "USD"
      },
      "totalAmount": {
        "value": "113.50",
        "currency": "USD"
      },
      "fxRevenueShare": {
        "amount": {
          "value": "1.00",
          "currency": "USD"
        },
        "rate": 1
      },
      "feeRevenueShare": {
        "amount": {
          "value": "10.00",
          "currency": "USD"
        }
      },
      "totalRevenueShare": {
        "value": "11.00",
        "currency": "USD"
      },
      "createdTimestamp": "2026-01-12 19:58:28 +0000 UTC",
      "lastUpdatedTimestamp": "2026-01-12 19:58:41 +0000 UTC"
    }
  ],
  "cursor": {
    "previous": null,
    "next": null
  }
}
{
"code": "invalid_request_body",
"message": "The request body provided is not valid",
"params": {
"field": "Value is invalid."
}
}
{
"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.

Query Parameters

businessId
string<uuid>

Scope results to a single business account. Returns only rows where that business's account is the sender or recipient — both money it sent (payroll, vendor payments, payouts) and money it received (deposits, refunds/reversals). This is narrower than tenantKey, which returns every row under a tenant.

currency
string

Filter by the business-facing currency — matches either the destination amount or the sourceAmount.

startDate
string<date>

Start of date range (ISO 8601, e.g. 2026-01-01). Defaults to 7 days ago.

endDate
string<date>

End of date range (ISO 8601, e.g. 2026-02-01). Defaults to now.

type
string

Comma-separated, repeatable filter of disbursement type(s) to include. Supported values: PAYROLL, PAYOUT, TRANSFER, CARD_MAINTENANCE_FEE, CARD_CREATION_FEE, STOCK_BUY, STOCK_SELL, PAYROLL_FEE, INTEREST. When scoped to a single business with businessId, the business-relevant types are PAYROLL_TOTAL, PAYROLL, PAYROLL_FEE, PAYROLL_REVERSAL, DEPOSIT, DEPOSIT_REVERSAL, VENDOR, REVENUE_SHARE_PAYOUT, REIMBURSEMENT, SUBSCRIPTION_PAYMENT, STATUTORY_DEPOSIT; by default the per-employee PAYROLL legs and PAYROLL_FEE are collapsed into the single PAYROLL_TOTAL row, and passing an explicit type returns the raw rows.

status
enum<string>

Filter by transaction status.

Available options:
SUCCESS,
FAILED,
INITIATED,
PROCESSING,
ROUTED
includeRevenueShare
boolean
default:false

Set to true to include the revenue-share fields (feeRevenueShare, fxRevenueShare, totalRevenueShare) in each item. Omitted by default.

limit
integer
default:50

Maximum number of items to return per page.

Required range: 1 <= x <= 100
next
string

Opaque cursor for the next page — pass the cursor.next value from the previous response. Keep paging until cursor.next is null.

previous
string

Cursor to fetch the previous page of results.

Response

List of disbursements across all platform businesses

data
object[]
cursor
object

Node pagination