Transfer Attempts

A transfer_attempt is created when a buyer attempts to pay for a payment using a Payment Link or Checkout Form. Using Transfer Attempts, you can track the lifecycle of a payment or a series of payments if you are using a multi-use Payment Link.

Each transfer_attempt has as reference to a transfer_id to allow you to query it for additional data.

List Transfer Attempts

Retrieve a list of Transfer Attempt resources by providing the ID of the originating Checkout Form, Payment Link or Payout Link using the entity_id query parameter.

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

Request
query Parameters
after_cursor
string

Return every resource created after the cursor value.

Example: after_cursor=TRnasXQ5AmjsLnPMwnme7TL4
before_cursor
string

Return every resource created before the cursor value.

Example: before_cursor=TRnasXQ5AmjsLnPMwnme7TL4
entity_id
string

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

Example: entity_id=checkout_form_c6g1yfdPHzTNF6PyQzuwa
limit
integer

The numbers of items to return.

Example: limit=10
header Parameters
Finix-Version
string
Default: 2018-01-01

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

Example: 2022-02-01
Responses
200

List of Transfer Attempt objects.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

422

Invalid field

get/transfer_attempts
Request samples 
curl "https://finix.sandbox-payments-api.com/transfer_attempts?entity_id=checkout_form_c6g1yfdPHzTNF6PyQzuwa" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/json
{
  • "_embedded": {
    • "transfer_attempts": [
      ]
    },
  • "_links": {},
  • "page": {
    • "limit": 100,
    • "next_cursor": "ZTyLnqRtGpWxuTMeOVjPbR7y"
    }
}

Fetch a Transfer Attempt

Retrieve the details of a Transfer Attempt initiated from a Checkout Form, Payment Link or Payout Link.

Request
path Parameters
transfer_attempt_id
required
string

The ID of the Transfer Attempt.

header Parameters
Finix-Version
string
Default: 2018-01-01

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

Example: 2022-02-01
Responses
200

A single Transfer Attempt object.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

422

Invalid field

get/transfer_attempts/{transfer_attempt_id}
Request samples 
curl "https://finix.sandbox-payments-api.com/transfer_attempts/transfer_attempt_c6g1S77UKrNmRM4x1bFUf" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/json
{
  • "id": "transfer_attempt_c7QWvvkXN2Xkg6z1wyuKH",
  • "created_at": "2024-02-01T19:36:00.66Z",
  • "updated_at": "2024-02-01T19:36:00.66Z",
  • "amount": 647100,
  • "application_id": "APfwZU6VSXNGRZi3ouEyLjAW",
  • "buyer_details": {
    • "first_name": "John",
    • "last_name": "Adams",
    • "email": "segmewoodmerellc@gmail.com",
    • "identity_id": "IDdjTo3u82d5hBhViHrJo3eh",
    • "phone": null,
    • "billing_address": null,
    • "shipping_address": {
      }
    },
  • "currency": "USD",
  • "entity_id": "checkout_form_c5Z3t8acufWAeYJ7o5Cwf",
  • "entity_type": "CHECKOUT_FORM",
  • "merchant_id": "MUs6gqsciLh1vRtKMuw6MR8B",
  • "payment_frequency": null,
  • "payment_instrument_id": "PIqBEFHYg4xAAdnLnwN7MrYq",
  • "state": "SUCCEEDED",
  • "tags": { },
  • "transfer_id": "TR4XqdopsgBJmeVZznfFr9LZ"
}