--- title: "List Transfer Attempts" method: GET path: "/transfer_attempts" tags: ["Transfer Attempts"] --- # List Transfer Attempts `GET /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. ## Query parameters - `amount` integer - `amount.gt` integer - `amount.gte` integer - `amount.lt` integer - `amount.lte` integer - `application_id` string - `authorization_id` string - `buyer_email` string - `buyer_email.like` string - `buyer_first_name` string - `buyer_first_name.like` string - `buyer_last_name` string - `buyer_last_name.like` string - `entity_id` string - `entity_type` 'CHECKOUT_FORM' | 'PAYMENT_LINK' | 'PAYOUT_LINK' - `is_authorization` boolean - `merchant_id` string - `payment_instrument_id` string - `state` 'FAILED' | 'PENDING' | 'SUCCEEDED' - `transfer_id` string - `after_cursor` string - `before_cursor` string - `created_at.gte` string, date-time - `created_at.lte` string, date-time - `id` string - `limit` integer - `tags.key` string - `tags.value` string - `updated_at.gte` string, date-time - `updated_at.lte` string, date-time ## Headers - `Finix-Version` string ## Response `200` List of `Transfer Attempt` resources - object - `page` Page — Details the page that's returned. - `limit` integer — The number of entries to return. - `next_cursor` string, nullable — The cursor to use for the next page of results. - `_embedded` object - `transfer_attempts` union[] - union - TransferAttemptCheckoutForm — Schema for a `Transfer Attempt` originating from a `Checkout Form`. - `id` string — The ID of the `Transfer Attempt` resource. - `created_at` string, date-time — Timestamp of when the object was created. - `updated_at` string, date-time — Timestamp of when the object was last updated. - `amount` integer — The total amount that will be debited in cents (e.g. 100 cents to debit $1.00). - `application_id` string — The `Application` associated with the `Transfer`. - `authorization_id` string — The `Authorization` associated with the `Transfer Attempt`, if applicable. - `buyer_details` object — Object containing details about the buyer. - `first_name` string — First name of the buyer. - `last_name` string — Last name of the buyer. - `email` string — Email address of the buyer. - `identity_id` string — The `Identity` `id` of the buyer. - `phone` string — Phone number of the buyer. - `billing_address` object — The primary address associated with the `Payment Instrument`. - … - `shipping_address` string — Shipping or mailing address of the buyer. - `currency` 'CAD' | 'USD' — ISO 4217 3-letter currency code. - `entity_id` string — The `Checkout Form` that initiated the `Transfer Attempt`. - `entity_type` 'CHECKOUT_FORM' — The type of entity that initiated the `Transfer Attempt`. - `failure_code` string, nullable — The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/additional-resources/developers/implementation-and-testing/failure-codes). - `failure_message` string, nullable — A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment. - `is_authorization` boolean — Whether the `Transfer Attempt` was created from an `Authorization`. - `merchant_id` string — The ID of the Merchant linked to the `Checkout Form` that initiated the `Transfer Attempt`. - `operation_key` 'PUSH_TO_CARD' | 'PULL_FROM_CARD' | 'CARD_PRESENT_SALE' | 'CARD_PRESENT_UNREFERENCED_REFUND' | 'SALE' | 'UNREFERENCED_REFUND' | 'MERCHANT_CREDIT_ADJUSTMENT' | 'MERCHANT_DEBIT_ADJUSTMENT', nullable — Details the operation that's performed in the transaction. - `payment_frequency` string, nullable — This field does not apply to `Transfer Attempt` resources originating from a `Checkout Form` and will always return `null`. - `payment_instrument_id` string — The `Payment Instrument` to be debited upon success of the `Transfer Attempt`. - `receipt_requested_delivery_methods` object[] — A list of requested delivery methods. Each method specifies the type of delivery and the destination(s) where the receipt should be sent. - `type` 'EMAIL' | 'SMS' | 'PRINT', required — The method of receipt delivery. - `destinations` string[], required — A list of destination addresses or identifiers where the receipt should be sent. - `state` 'PENDING' | 'FAILED' | 'SUCCEEDED' — The state of the `Transfer Attempt`. - `tags` Tags, nullable — Include up to 50 `key: value` pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual `values` is 500. (For example, `order_number: 25`, `item_type: produce`, `department: sales`) - `transfer_id` string — The `Transfer` associated with the `Transfer Attempt`. - `type` 'DEBIT' | 'CREDIT' — Type of `Transfer`. - TransferAttemptPaymentLink — Schema for a `Transfer Attempt` originating from a `Payment Link`. - `id` string — The ID of the `Transfer Attempt` resource. - `created_at` string, date-time — Timestamp of when the object was created. - `updated_at` string, date-time — Timestamp of when the object was last updated. - `amount` integer — The total amount that will be debited in cents (e.g. 100 cents to debit $1.00). - `additional_buyer_charges` AdditionalBuyerCharges, nullable — Additional charges will be incurred by the buyer. The following rules apply: - The `Merchant` must be enabled to charge these surcharges by setting the appropriate flags for each applicable surcharge to `true` using the PUT `/merchants` endpoint. - Only _one_ of the following charges can be applied during creation. - `convenience_amount` integer, nullable — A convenience fee to charge the buyer for the transaction. This object property is mutually exclusive. - `rent_surcharge_amount` integer, nullable — A rent surcharge to charge the buyer for the transaction. This object property is mutually exclusive. - `surcharge_amount` integer, nullable — A surcharge amount to charge the buyer for the transaction. This object property is mutually exclusive. - `amount_requested` integer — Details the `amount` that was requested to get debited from the `source` when the transaction was created. - `application_id` string — The `Application` associated with the `Transfer`. - `authorization_id` string — The `Authorization` associated with the `Transfer Attempt`, if applicable. - `buyer_details` object — Object containing details about the buyer. This object is only used for `SINGLE_USE` payment links. - `first_name` string — First name of the buyer. - `last_name` string — Last name of the buyer. - `email` string — Email address of the buyer. - `identity_id` string — The `Identity` `id` of the buyer. - `phone` string — Phone number of the buyer. - `billing_address` object — The primary address associated with the `Payment Instrument`. - … - `shipping_address` string — Shipping or mailing address of the buyer. - `currency` 'CAD' | 'USD' — ISO 4217 3-letter currency code. - `entity_id` string — The `Payment Link` that initiated the `Transfer Attempt`. - `entity_type` 'PAYMENT_LINK' — The type of entity that initiated the `Transfer Attempt`. - `failure_code` string, nullable — The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/additional-resources/developers/implementation-and-testing/failure-codes). - `failure_message` string, nullable — A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment. - `is_authorization` boolean — Whether the `Transfer Attempt` was created from an `Authorization`. - `merchant_id` string — The ID of the `Merchant` resource associated with the `Payment Link` that initiated the `Transfer Attempt`. - `operation_key` 'PUSH_TO_CARD' | 'PULL_FROM_CARD' | 'CARD_PRESENT_SALE' | 'CARD_PRESENT_UNREFERENCED_REFUND' | 'SALE' | 'UNREFERENCED_REFUND' | 'MERCHANT_CREDIT_ADJUSTMENT' | 'MERCHANT_DEBIT_ADJUSTMENT', nullable — Details the operation that's performed in the transaction. - `payment_frequency` 'ONE_TIME' | 'RECURRING' — Whether the `Payment Link` associated with the `Transfer Attempt` is single-use or recurring. - `payment_instrument_id` string — The `Payment Instrument` to be debited upon success of the `Transfer Attempt`. - `receipt_requested_delivery_methods` object[] — A list of requested delivery methods. Each method specifies the type of delivery and the destination(s) where the receipt should be sent. - `type` 'EMAIL' | 'SMS' | 'PRINT', required — The method of receipt delivery. - `destinations` string[], required — A list of destination addresses or identifiers where the receipt should be sent. - `state` 'PENDING' | 'FAILED' | 'SUCCEEDED' — The state of the `Transfer Attempt`. - `tags` Tags, nullable — Include up to 50 `key: value` pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual `values` is 500. (For example, `order_number: 25`, `item_type: produce`, `department: sales`) - `transfer_id` string — The `Transfer` associated with the `Transfer Attempt`. - `type` 'DEBIT' | 'CREDIT' — Type of `Transfer`. - TransferAttemptPayoutLink — Schema for a `Transfer Attempt` originating from a `Payout Link`. - `id` string — The ID of the `Transfer Attempt` resource. - `created_at` string, date-time — Timestamp of when the object was created. - `updated_at` string, date-time — Timestamp of when the object was last updated. - `amount` integer — The total amount that will be debited in cents (e.g. 100 cents to debit $1.00). - `application_id` string — The `Application` associated with the `Transfer`. - `authorization_id` string — The `Authorization` associated with the `Transfer Attempt`, if applicable. - `buyer_details` object, nullable — This field does not apply to `Transfer Attempt` resources originating from a `Payout Link` and will always return `null`. - `first_name` string — First name of the buyer. - `last_name` string — Last name of the buyer. - `email` string — Email address of the buyer. - `identity_id` string — The `Identity` `id` of the buyer. - `phone` string — Phone number of the buyer. - `billing_address` object — The primary address associated with the `Payment Instrument`. - … - `currency` 'CAD' | 'USD' — ISO 4217 3-letter currency code. - `entity_id` string — The `Payout Link` that initiated the `Transfer Attempt`. - `entity_type` 'PAYOUT_LINK' — The type of entity that initiated the `Transfer Attempt`. - `failure_code` string, nullable — The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/additional-resources/developers/implementation-and-testing/failure-codes). - `failure_message` string, nullable — A human-readable description of why the transaction was declined. This will also include a suggestion on how to complete the payment. - `is_authorization` boolean — Whether the `Transfer Attempt` was created from an `Authorization`. - `merchant_id` string — The ID of the `Merchant` resource associated with the `Payout Link` that initiated the `Transfer Attempt`. - `operation_key` 'PUSH_TO_CARD' | 'PULL_FROM_CARD' | 'CARD_PRESENT_SALE' | 'CARD_PRESENT_UNREFERENCED_REFUND' | 'SALE' | 'UNREFERENCED_REFUND' | 'MERCHANT_CREDIT_ADJUSTMENT' | 'MERCHANT_DEBIT_ADJUSTMENT', nullable — Details the operation that's performed in the transaction. - `payment_frequency` string, nullable — This field does not apply to `Transfer Attempt` resources originating from a `Payout Link` and will always return `null`. - `payment_instrument_id` string — The `Payment Instrument` to be debited upon success of the `Transfer Attempt`. - `receipt_requested_delivery_methods` object[] — A list of requested delivery methods. Each method specifies the type of delivery and the destination(s) where the receipt should be sent. - `type` 'EMAIL' | 'SMS' | 'PRINT', required — The method of receipt delivery. - `destinations` string[], required — A list of destination addresses or identifiers where the receipt should be sent. - `recipient_details` object — Details of the recipient of the payout. - `business_address` object, nullable — The primary address for the legal entity. - … - `business_name` string, nullable — Abbreviated names of the business. If there are no abbreviated name, leave this field blank. - `doing_business_as` string — Alternate names of the business. If there are no other names, pass the same value used for `business_name` (max 60 characters). - `email` string — The email address of the principal control owner (max 100 characters). - `first_name` string — The legal first name of the control owner (max 20 characters). - `last_name` string — The `Identity` owner's legal last name. - `personal_address` object — The home address of the principal control owner. This field is used for identity verification purposes. - … - `personal_tax_id_provided` boolean — Whether a personal tax ID was provided by the recipient. - `business_tax_id_provided` boolean — Whether a business tax ID was provided by the recipient. - `phone` string — The principal control owner's phone number (max 10 characters). - `type` 'PERSONAL' | 'BUSINESS' — Whether the recipient is considered "PERSONAL" or a "BUSINESS". - `recipient_merchant_id` string — The `Merchant` resource linked to the recipient targeted by the `Payout Link`. - `state` 'PENDING' | 'FAILED' | 'SUCCEEDED' — The state of the `Transfer Attempt`. - `tags` Tags, nullable — Include up to 50 `key: value` pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual `values` is 500. (For example, `order_number: 25`, `item_type: produce`, `department: sales`) - `transfer_id` string — The `Transfer` associated with the `Transfer Attempt`. - `type` 'DEBIT' | 'CREDIT' — Type of `Transfer`. - `_links` object - `self` Self — Link to the resource that was used in the request. - `href` string - `next` Next — Link to the next page of entries. - `href` string ## Other responses - `401` — Unauthorized. Authentication is required and has failed or has not been provided. - `403` — Forbidden. The client is authenticated but does not have permission to access the resource. - `406` — Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted. - `422` — Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed. --- [API](https://skmtc.net/finix/apis/finix-api-reference.md) · [All operations](https://skmtc.net/finix/apis/finix-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/finix/finix-api-reference/versions/5426f6f99c52/schema)