Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Settlements

List all Entries in a Settlement

Retrieve a list of every Settlement Entry in a Settlement. A Settlement Entry is an object that describes the item inside of a Settlement.

A Settlement Entry can represent a Transfer, custom Fee, or Split Transfer.

get/settlements/{settlement_id}/entries

Query parameters

after_cursorstring

Return every resource created after the cursor value.

before_cursorstring

Return every resource created before the cursor value.

created_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where created_at is after the given date.

created_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where created_at is before the given date.

limitinteger
Example:10

The numbers of items to return.

updated_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where updated_at is after the given date.

updated_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where updated_at is before the given date.

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

List of Settlement Entry resources

Example response

{
  "_embedded": {
    "settlement_entries": [
      {
        "should_fund": true
      }
    ]
  }
}