JUjustifi
Platform Settlements

Get a Platform Settlement

get/payables/platform_settlements/{id}

Request

Path parameters

idstring required

the id of the resource

Headers

Authorizationstring required

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

Response

Successfully retrieved the settlement

idstring required

the object id, also found in the data object

typestring required

the object type

page_infounknown required

Example response

{
  "id": "prefix_xyz (same as id of data object)",
  "type": "platform_settlement",
  "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"
  }
}

Changes

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