JUjustifi
Platform Ledger

List Platform Ledger Entries

List the platform's ledger entries — one per fee the platform earned, per JustiFi fee (payment, return handling, NOC handling), or per settlement paying the platform its balance, each referencing its source. Read-only and append-only; scoped to the platform your credentials belong to.

The platform's outstanding balance is the sum of these entries; a settlement nets it toward zero. Optionally narrow to a window (created_after/created_before), a txn_type, or whether the entry has been settled (settled).

get/payables/platform_ledger

Request

Query parameters

after_cursorstring

token to fetch the next page of a list (the end_cursor from a previous response's page_info)

before_cursorstring

token to fetch the previous page of a list (the start_cursor from a previous response's page_info)

limitinteger

the number of resources to retrieve per page (default 25, max 100)

created_afterstring date-time

filter records created strictly after the date and time (UTC) specified. Dates without a time default to 00:00:00. ISO 8601 only — a value that is not one is a 400, never a filter that silently does nothing

created_beforestring date-time

filter records created strictly before the date and time (UTC) specified. Dates without a time default to 00:00:00. ISO 8601 only — a value that is not one is a 400, never a filter that silently does nothing

txn_type'processing_fee' | 'justifi_fee' | 'return_fee' | 'noc_fee' | 'settlement' | 'adjustment'

filter entries by transaction type

settledboolean

false returns the outstanding entries — those no settlement has covered yet, which together sum to the platform's current balance.

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Response

Successfully listed platform ledger entries

idunknown required
typestring required

the object type

Example response

{
  "type": "array",
  "data": [
    {
      "id": "ple_123xyz",
      "type": "ledger_entry",
      "platform_account_id": "acc_123xyz",
      "txn_type": "justifi_fee",
      "amount_cents": 1000,
      "currency": "usd",
      "payer_account_id": "payer_123xyz",
      "payee_payment_id": "pp_9",
      "source_type": "transfer",
      "source_id": "ptr_123",
      "settlement_id": "pst_987abc",
      "created_at": "2026-01-01T12:00:00Z"
    }
  ],
  "page_info": {
    "start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd",
    "end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.