Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Settlements

List Settlements

Retrieve a list of Settlement resources.

get/settlements

Query parameters

after_cursorstring

Return every resource created after the cursor value.

before_cursorstring

Return every resource created before the cursor value.

application_idstring
Example:APc9vhYcPsRuTSpKD9KpMtPe

Filter by Application ID.

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.

funding_transfer_idstring

Filter by a funding_transfer a Settlement has created.

idstring

Filter by id.

is_exceptionboolean

Filter to return if settlement is an exception settlement.

limitinteger
Example:10

The numbers of items to return.

merchant_idstring
Example:MUeDVrf2ahuKc9Eg5TeZugvs

Filter by Merchant ID.

status'APPROVED' | 'AWAITING_APPROVAL'

Filter by the status of the Settlement. Merchants only receive payouts when Settlements are APPROVED. For more information, see Payouts.

tags.keystring
Example:card_type

Filter by the tag's key. For more information, see Tags.

tags.valuestring
Example:business_card

Filter by the tag's value. For more information, see Tags.

total_amountinteger

Filter by a total_amount equal to the given value.

total_amount.lteinteger
Example:2000

Filter by an total_amount less than or equal to the given value.

total_amount.ltinteger
Example:2000

Filter by an total_amount less than the given value.

total_amount.gteinteger
Example:2

Filter by an total_amount greater than or equal to the given value.

total_amount.gtinteger
Example:2

Filter by an total_amount greater than the given value.

transfer_idstring

Filter by a transfer_id a Settlement has accrued.

split_transfer_idstring

Filter by a split_transfer_id a Settlement has accrued.

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 resources

Example response

{
  "_embedded": {
    "settlements": [
      {
        "destination": "PIxxxxxxxxxxxxxxxxxx"
      }
    ]
  }
}