JUjustifi
Platform Settlements

List Platform Settlements

List the disbursements between JustiFi and your platform — when each happens, how much, which way the money goes, and the reference to reconcile it against your bank statement. Read-only and scoped to the platform your credentials belong to.

This answers "when were we paid" directly. The same facts are derivable from /v1/payables/platform_ledger by filtering to txn_type=settlement, but a ledger entry is one line: it carries neither the reference nor what the disbursement covered, and it does not exist until after the money has moved. A settlement appears here while it is still scheduled.

Optionally narrow to a status or a window (created_after/created_before).

get/payables/platform_settlements

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

status'scheduled' | 'in_transit' | 'paid' | 'failed' | 'canceled' | 'forwarded'

filter settlements by status

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 settlements

idunknown required
typestring required

the object type

Example response

{
  "type": "array",
  "data": [
    {
      "id": "pst_abc123",
      "type": "platform_settlement",
      "platform_account_id": "acc_123xyz",
      "status": "paid",
      "direction": "paid_out",
      "amount_cents": 124500,
      "currency": "usd",
      "entries_count": 42,
      "ledger_entry_id": "ple_123xyz",
      "external_reference": "WIRE-20260819-0042",
      "scheduled_at": "2026-08-19T12:00:00Z",
      "recorded_at": "2026-08-21T09:30:00Z",
      "created_at": "2026-08-19T12:00:00Z",
      "updated_at": "2026-08-21T09:30:00Z"
    }
  ],
  "page_info": {
    "start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd",
    "end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd"
  }
}

Changes

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