Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Transfer Attempts

List Transfer Attempts

Retrieve a list of all Transfer Attempt resources, or filter the results to a specific Checkout Form, Payment Link, and Payout Link using the entity_id query parameter.

get/transfer_attempts

Query parameters

amountinteger
Example:100

Filter by an amount equal to the given value.

amount.gtinteger
Example:100

Filter by an amount greater than.

amount.gteinteger
Example:100

Filter by an amount greater than or equal.

amount.ltinteger
Example:100

Filter by an amount less than.

amount.lteinteger
Example:100

Filter by an amount less than or equal.

application_idstring
Example:APc9vhYcPsRuTSpKD9KpMtPe

Filter by Application ID.

authorization_idstring
Example:AUogt3PgskE2ahBFmTpn2EGJ

Filter by Authorization ID.

buyer_emailstring
Example:john@example.com

Filter by the buyer's email address (exact match).

buyer_email.likestring
Example:john

Filter by the buyer's email address (partial match).

buyer_first_namestring
Example:John

Filter by the buyer's first name (exact match).

buyer_first_name.likestring
Example:joh

Filter by the buyer's first name (partial match).

buyer_last_namestring
Example:Doe

Filter by the buyer's last name (exact match).

buyer_last_name.likestring
Example:do

Filter by the buyer's last name (partial match).

entity_idstring
Example:checkout_form_ciADaDNMFAHdyNbDPuByS

Filter by the ID of the Checkout Form, Payment Link, or Payout Link.

entity_type'CHECKOUT_FORM' | 'PAYMENT_LINK' | 'PAYOUT_LINK'
Example:PAYMENT_LINK

Filter by the type of entity that initiated the Transfer Attempt.

is_authorizationboolean
Example:true

Filter by whether the Transfer Attempt is tied to an Authorization.

merchant_idstring
Example:MUeDVrf2ahuKc9Eg5TeZugvs

Filter by Merchant ID.

payment_instrument_idstring
Example:PIcgYZswyRfqSSbvMsxuaHxZ

Filter by Payment Instrument ID.

state'FAILED' | 'PENDING' | 'SUCCEEDED'
Example:SUCCEEDED

Filter by Transfer Attempt state.

transfer_idstring
Example:TRnH7FkSB7zePeHExNZwSb9H

Filter by Transfer ID.

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.

idstring

Filter by id.

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

Example response

{
  "_embedded": {
    "transfer_attempts": [
      {
        "amount": 5000,
        "application_id": "APfwZU6VSXNGRZi3ouEyLjAW",
        "merchant_id": "MUmfEGv5bMpSJ9k5TFRUjkmm",
        "transfer_id": "TR4XqdopsgBJmeVZznfFr9LZ"
      }
    ]
  }
}