# List Payment Instruments

Retrieve a list of . 

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

Endpoint: GET /payment_instruments
Version: 2022-02-01
Security: BasicAuth

## Header parameters:

  - `Accept` (string)
    Body Header

## Query parameters:

  - `account_last4` (string)
    Filter by the last 4 digits of the account if available.
    Example: "4242"

  - `account_routing_number` (string)
    Filter by the account routing number if available.
    Example: "9444"

  - `after_cursor` (string)
    Return every resource created after the cursor value.

  - `application` (string)
    Filter by  ID.
    Example: "APc9vhYcPsRuTSpKD9KpMtPe"

  - `before_cursor` (string)
    Return every resource created before the cursor value.

  - `bin` (string)
    Filter by Bank Identification Number (BIN). The BIN is the first 6 digits of the masked number.
    Example: "411111"

  - `created_at.gte` (string)
    Filter where  is after the given date.
    Example: "2022-09-27T11:21:23"

  - `created_at.lte` (string)
    Filter where  is before the given date.
    Example: "2026-09-27T11:21:23"

  - `expiration_month` (string)
    Filter by the expiration month associated with the  if applicable. This filter only applies to payment cards.
    Example: "9"

  - `expiration_year` (string)
    Filter by the 4 digit expiration year associated with the Payment Instrument if applicable. This filter only applies to payment cards.
    Example: "2029"

  - `last4` (string)
    Filter by the last 4 digits of the  card. This filter only applies to payment cards.
    Example: "0454"

  - `limit` (integer)
    The numbers of items to return.
    Example: 3

  - `name` (string)
    Filter by the name.

  - `owner_identity_id` (string)
    Filter by the owner id of the associated .
    Example: "IDcWwprrKrD6cSh225JWPri3"

  - `type` (string)
    Filter by the  type.
    Enum: "ALL", "BANK_ACCOUNT", "PAYMENT_CARD"

  - `tags.key` (string)
    Filter by the tag's key. For more information, see Tags.
    Example: "card_type"

  - `tags.value` (string)
    Filter by the tag's value. For more information, see Tags.
    Example: "business_card"

## Response 200 fields (application/json):

  - `page` (object)
    Details the page that's returned.

  - `page.limit` (integer)
    The number of entries to return.

  - `page.next_cursor` (string,null)
    The cursor to use for the next page of results.

  - `_embedded` (object)
    List of  objects.

  - `_embedded.payment_instruments` (array)
    objects.

  - `_links` (object)
    For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these  to make your follow-up requests and quickly access relevant IDs.

  - `_links.next` (object)
    Link to the next page of entries.

  - `_links.next.href` (string)

  - `_links.self` (object)
    Link to the resource that was used in the request.

## Response 401 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "UNKNOWN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.self` (object)

  - `_embedded.errors._links.self.href` (string)

  - `_embedded.errors._links.source` (object)

## Response 403 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "FORBIDDEN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 406 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "NOT_FOUND"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)