Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Settlements

List all Transfers in a Settlement

<u>This endpoint is deprecated</u>.<br/>

Use List all Entries in a Settlement instead.

Retrieve a list of every Transfer in a Settlement that has a type of DEBIT or REFUND. This is not an exhaustive list of everything that comprises a settlement. We recommend using List Settlement Entries.

For details on how to query endpoints using the available parameters, see Query Parameters.

get/settlements/{settlement_id}/transfers

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.

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.

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 Transfer resources

Example response

{
  "_embedded": {
    "transfers": [
      {
        "amount": 5000,
        "amount_requested": 100,
        "merchant": "MUxxxxxxxxxxxxxxxxxxxxxxx",
        "merchant_identity": "IDxxxxxxxxxxxxxxxxxxxxxxxx",
        "network_details": {
          "brand": "VISA"
        }
      }
    ]
  }
}