---
title: "List payment methods"
method: GET
path: "/payment_methods"
tags: ["payment_methods"]
---

# List payment methods

`GET /payment_methods`

Retrieve an ordered and paginated list of all retained payment methods in the authenticated environment.

*States*
Payment methods can exist in several states in the Spreedly vault - retained, redacted, cached, or used. Retained payment methods are stored in Spreedly's vault until redacted. Redacted payment methods are payment methods that were either not retained or have been manually redacted. Cached payment methods are payment methods that have not been retained but have not yet been automatically redacted yet. Cached payment methods can still be retained. For more information, please see our guide on [retaining payment methods](https://developer.spreedly.com/docs/create-transactions#retain).

If no state parameter or an invalid state parameter is passed, list will only return retained payment methods. If the state parameter is passed, list will return those parameters: retained, redacted, cached, used.

Example: `https://core.spreedly.com/v1/payment_methods.json?state=retained,redacted,cached,used`

If the state parameter is combined with other existing parameters such as metadata, both will be considered.

Example: `https://core.spreedly.com/v1/payment_methods.json?metadata[customer_id]=123abc&state=redacted,retained`

## Query parameters

- `order` string
- `since_token` string
- `metadata` string
- `state` string
- `count` string

## Response `200`

successful

- PaymentMethodsResponse
  - `payment_methods` PaymentMethod[] — Root element
    - `token` string — The token identifying the payment method in the Spreedly vault
    - `created_at` string — The time the payment method token was created
    - `updated_at` string — The time the payment method token was last updated
    - `email` string — The email address of the customer associated with this credit card
    - `storage_state` string — The `storage_state` (retained, redacted, cached, used) of the payment method
    - `test` boolean — `true` if this payment method is a test payment method and cannot be used against real gateways or receivers
    - `metadata` object — metadata key-value pairs (limit 25). Keys are limited to 50 characters. Values are limited to 500 characters and cannot contain compounding data types
    - `callback_url` string — The URL where Spreedly will attempt delivery of asynchronous results for 3DS and offsite transactions. Transaction results are posted in the format specified by `callback_format` if provided or XML if `callback_format` is not present or null. (default: `null`)
    - `last_four_digits` string — The last four digits of the credit card number. This can be displayed to the user.
    - `first_six_digits` string — The first six digits of the credit card number. This can be displayed to the user.
    - `card_type` string — The [type](https://developer.spreedly.com/docs/supported-payment-methods), or brand, of the card. Please see the `card_type_mapping` function below for more detail.
    - `first_name` string — The first name of the cardholder
    - `last_name` string — The last name of the cardholder
    - `month` string — The expiration month
    - `year` string — The expiration year
    - `address1` string — The first line of the billing address
    - `address2` string — The second line of the billing address
    - `city` string — The city of the billing address
    - `state` string — The state of the billing address
    - `zip` string — The zip code of the billing address
    - `country` string — The country code of the billing address
    - `phone_number` string — The phone number of the billing address
    - `company` string — The company of the cardholder
    - `full_name` string — The full name of the cardholder.
    - `eligible_for_card_updater` string — `true` if this payment method should be included in Account Updater
    - `shipping_address1` string — The first line of the shipping address
    - `shipping_address2` string — The second line of the shipping address
    - `shipping_city` string — The city of the shipping address
    - `shipping_state` string — The state of the shipping address
    - `shipping_zip` string — The zip code of the shipping address
    - `shipping_country` string — The country code of the shipping address
    - `issuer_identification_number` string — The numbers of the PAN required to identify the card issuer.
    - `click_to_pay` string — `true` if the card was tokenized using Click to Pay
    - `managed` string — The value indicating the payment method's management status.
    - `payment_method_type` string — The type of this payment method, e.g., `credit_card`, `bank_account`, `apple_pay`, `google_pay`, `third_party_token`, etc…
    - `errors` string — If the payment method is invalid (missing required fields, etc…), there will be associated error messages here
    - `fingerprint` string — An identifying string that will match all cards in the environment with the same PAN
    - `verification_value` string — The obscured verification value (CVV), e.g., XXX or XXXX
    - `number` string — The obscured credit card number, e.g., XXXX-XXXX-XXXX-4444
    - `bin_metadata` object — BIN metadata is available in the response if the card is enrolled in Advanced Vault. See [BIN metadata](https://developer.spreedly.com/docs/bin-metadata) for more information.
      - `card_brand` string
      - `card_category` string
      - `card_type` string
      - `issuing_bank` string
      - `issuing_country_iso_number` string
      - `issuing_country_iso_a2_code` string
      - `issuing_country_iso_a3_code` string
      - `issuing_country_iso_name` string
      - `issuing_bank_phone_number` string
      - `issuing_bank_website` string
      - `bin_type` string
      - `regulated` string
      - `max_pan_length` string
      - `message` string
    - `subscribed_to_mastercard_abu` boolean — `true` if this payment method is subscribed to Mastercard ABU updating service
    - `last_successfully_used` string, date-time, nullable — The time (UTC) the payment method was last successfully transacted with. The following transaction types are considered: Authorization, Purchase, Verification, GeneralCredit, OffsiteVerification, or OffsitePurchase

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.dev/spreedly/apis/spreedly-api-v1.md) · [All operations](https://skmtc.dev/spreedly/apis/spreedly-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/spreedly/spreedly-api-v1/revisions/72ba4e23e65c/schema)