v1
latestOpenAPI 3.1.02026-07-241910582.8 KBList Ledger Account Settlements
Query parameters
If you have specific IDs to retrieve in bulk, you can pass them as query parameters delimited with id[]=, for example ?id[]=123&id[]=abc.
Filter ledger account settlements by the settled ledger account id
ID of the settlement ledger transaction
ID of the ledger the settlement is in
For example, if you want to query for records with metadata key Type and value Loan, the query would be metadata%5BType%5D=Loan. This encodes the query parameters.
Use gt (>), gte (>=), lt (<), lte (<=), or eq (=) to filter by the created at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use created_at%5Bgt%5D=2000-01-01T12:00:00Z.
Use gt (>), gte (>=), lt (<), lte (<=), or eq (=) to filter by the created at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use created_at%5Bgt%5D=2000-01-01T12:00:00Z.
Response
200
Example response
[
{
"id": "dbdbbfe5-da56-4aaf-be36-3fbc415622dd",
"object": "ledger_account_payout",
"live_mode": true,
"description": "Alice's January payout",
"payout_ledger_account_id": "d44ad0d0-b3ea-4698-867d-09fe961e52a6",
"funding_ledger_account_id": "3824af4d-4151-48f6-8e8b-bf859cbddbcd",
"effective_at_upper_bound": "2023-01-01T00:00:00.000Z",
"status": "pending",
"amount": 1000,
"currency": "USD",
"ledger_transaction_id": "b47ce462-806b-4d5d-9476-9add11a42529",
"metadata": {
"foo": "bar"
},
"created_at": "2023-01-11T20:35:36Z",
"updated_at": "2023-01-11T20:36:02Z"
}
]