List Transactions

A filtered read-model over Payout, projected to date / to-from / amount / account / derived-method / status, newest-first and paged by cursor. Narrow with any of beneficiary_id, status, and from/to date bounds (they compose); results are scoped to the caller’s Business and environment, so a foreign id yields an empty list.

GET /v1/reporting/transactions

List the Transactions ledger for the current Business and environment

cURL

curl --request GET \
  --url https://api.example.com/v1/reporting/transactions \
  --header 'Authorization: Bearer <token>'

200

{
  "transactions": [
    {
      "id": "<string>",
      "type": "payout",
      "created_at": "2023-11-07T05:31:56Z",
      "beneficiary_id": "<string>",
      "beneficiary_name": "<string>",
      "amount_minor": 123,
      "currency": "<string>",
      "account_label": "<string>",
      "method": "ach",
      "status": "pending_approval"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

Authorization · string · header · required

Cleff API key issued to a Business that self-registers via POST /v1/registration

Query Parameters

beneficiary_id · string

limit · number

cursor · string

status · enum<string>

Available options: pending_approval, approved, rejected, disbursed, failed, returned, canceled, settled, compliance_hold

from · string

Inclusive lower bound on the transaction date (ISO-8601 date or timestamp).

to · string

Inclusive upper bound on the transaction date (ISO-8601 date or timestamp). A date-only value covers the whole day.

Response

200

application/json

transactions · object[] · required

Show child attributes

next_cursor · string | null · required

Opaque cursor for the next (older) page — the id of the last row returned — or null on the last page. Pass it back as ?cursor= to fetch the next page.