Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Settlements

List Settlement Funding Transfer Attempts

Lists all settlement Funding Transfer Attempt resources associated for the Settlement. A Funding Transfer Attempt resource is created when requesting an instant payout of funds for the Settlement.

get/settlements/{settlement_id}/funding_transfer_attempts

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 Funding Transfer Attempts associated with a Settlement

Example response

{
  "_embedded": {
    "funding_transfer_attempts": [
      {
        "amount": 5000,
        "merchant_id": "MUxxxxxxxxxxxxxxxxxxxxxxx"
      }
    ]
  }
}