Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Payment Instruments

List Payment Instruments

Retrieve a list of Payment Instrument resources.

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/payment_instruments

Query parameters

after_cursorstring

Return every resource created after the cursor value.

before_cursorstring

Return every resource created before the cursor value.

account_last4string
Example:4242

Filter by the last 4 digits of the account if available.

account_routing_numberstring
Example:9444

Filter by the account routing number if available.

binstring
Example:411111

Filter by Bank Identification Number (BIN). The BIN is the first 6 digits of the masked number.

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.

expiration_monthstring
Example:9

Filter by the expiration month associated with the Payment Instrument if applicable. This filter only applies to payment cards.

expiration_yearstring
Example:2029

Filter by the 4 digit expiration year associated with the Payment Instrument if applicable. This filter only applies to payment cards.

idstring

Filter by id.

last4string
Example:0454

Filter by the last 4 digits of the Payment Instrument card. This filter only applies to payment cards.

limitinteger
Example:10

The numbers of items to return.

namestring

Filter by the name.

owner_identity_idstring
Example:IDcWwprrKrD6cSh225JWPri3

Filter by the owner id of the associated Identity.

type'ALL' | 'BANK_ACCOUNT' | 'PAYMENT_CARD'
Example:BANK_ACCOUNT

Filter by the Payment Instrument type.

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 Payment Instrument resources

Example response

{
  "_embedded": {
    "payment_instruments": [
      {
        "fingerprint": "FPRxxxxxxxxxxxxxxxxx"
      }
    ]
  }
}