Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Transfers

List Transfers

Retrieve a list of Transfers.

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

{% admonition type="info" %} If no query parameters are specified in the request the API automatically limits the response to records from the last 30 days. You can request older data by passing an explicit created_at.lte filter. {% /admonition %}

get/transfers

Query parameters

after_cursorstring

Return every resource created after the cursor 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.

amountinteger
Example:100

Filter by an amount equal to the given value.

bank_return_reason_codestring
Example:R03,R07

Filter bank reversals by ACH Return Code. Use comma-separation to query for multiple values.

before_cursorstring

Return every resource created before the cursor value.

buyer_business_namestring
Example:Finix%20Flowers

Filter by the Buyer Identity's business name (exact match).

buyer_business_name.likestring
Example:finix

Filter by the Buyer Identity's business name (partial match).

buyer_doing_business_asstring
Example:Finix%20Flowers

Filter by the Buyer Identity's Doing Business As (exact match).

buyer_doing_business_as.likestring
Example:finix

Filter by the Buyer Identity's Doing Business As (partial match).

buyer_identity_first_namestring
Example:John

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

buyer_identity_first_name.likestring
Example:joh

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

buyer_identity_idstring
Example:ID6Qm3BQUxGFcCWZ185TS8sn

Filter by the Buyer Identity's ID.

buyer_identity_last_namestring
Example:Doe

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

buyer_identity_last_name.likestring
Example:do

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

buyer_identity_namestring
Example:John%20Doe

Filter by the Buyer Identity's full personal name (exact match).

buyer_identity_name.likestring
Example:john

Filter by the Buyer Identity's full personal name (partial match).

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.

currencystring
Example:USD

Filter by the currency of the resource.

devicestring
Example:DVsEanpBtsAVvCHbNXkFaH6f

Filter by the device's ID.

idstring

Filter by id.

idempotency_idstring
Example:15d32948-c766-4033-8d87-dfbdcabcbc5c

Filter by Idempotency ID.

instrument_account_last4string

For BANK_ACCOUNT Payment Instruments, filter by the last-4 digits of the bank account number (i.e., from the Payment Instrument's masked_account_number).

instrument_binstring

For PAYMENT_CARD Payment Instruments, filter by the first-6 digits of the card's number (i.e., the Payment Instrument's bin).

instrument_brand_typestring
Example:MASTERCARD

For PAYMENT_CARD Payment Instruments, filter by the card's brand.

instrument_card_last4string

For PAYMENT_CARD Payment Instruments, filter by the last-4 digits of the card's number (i.e., the Payment Instrument's last_four).

instrument_issuer_countrystring
Example:USA,CAN

For PAYMENT_CARD Payment Instruments, filter by the card's issuing country (i.e., the Payment Instrument's issuer_country). Use comma-separation to query for multiple values.

instrument_namestring
Example:Business%20Card

Filter by the Payment Instrument's name (exact match).

instrument_type'PAYMENT_CARD' | 'BANK_ACCOUNT'
Example:PAYMENT_CARD

Filter by the Payment Instrument's type.

limitinteger
Example:10

The numbers of items to return.

merchantstring
Example:MUtAWVfXkf149BVi2cL2HvPU

Filter by the Merchant's ID (i.e., the Transfer's merchant).

merchant_identity_idstring
Example:IDtX3ciHPq2DDquCQJRwj7VW

Filter by the Merchant's Identity ID (i.e., the Transfer's merchant_identity).

merchant_identity_namestring
Example:Finix%20Flowers

Filter by the Merchant's name (i.e., the Merchant's merchant_name).

merchant_midstring
Example:FNXkitpwdmgMJ8Vz9FxKBCSza

Filter by the Merchant's Merchant Identification Number (MID) (i.e., the Merchant's mid).

merchant_processor_idstring
Example:DUMMY_V1

Filter by the Merchant's processor (i.e., the Merchant's processor).

ready_to_settle_at.gtestring date-time
Example:2023-06-28T00:00:00

Filter where ready_to_settle_at is after the given date. Only available on Finix-Version: 2022-02-01. For more details, see Versioning.

ready_to_settle_at.ltestring date-time
Example:2023-06-28T00:00:00

Filter where ready_to_settle_at is before the given date. Only available on Finix-Version: 2022-02-01. For more details, see Versioning.

state'ALL' | 'CANCELED' | 'FAILED' | 'PENDING' | 'RETURNED' | 'SUCCEEDED'
Example:SUCCEEDED

Filter by the transfer's state.

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.

trace_idstring
Example:021fc4ed-f0a8-4932-820c-b22b542526f8

Filter by trace_id.

type'ALL' | 'DEBIT' | 'CREDIT' | 'REVERSAL' | 'SETTLEMENT'
Example:REVERSAL

Filter by Transfer type.

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 objects.

Example response

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