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>'
{
  "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
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
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 list of transaction types to include. Supported values: PAYROLL, PAYOUT, CARD_MAINTENANCE_FEE, CARD_CREATION_FEE, STOCK_BUY, STOCK_SELL, PAYROLL_FEE, INTEREST.

​
status
enum<string>

Filter by transaction status.

Available options:
SUCCESS,
FAILED,
INITIATED,
PROCESSING,
ROUTED
​
next
string

Cursor to fetch the next page of results.

​
previous
string

Cursor to fetch the previous page of results.

Response

List of disbursements across all platform businesses

​
data
object[]
​
cursor
object

Node pagination