> ## Documentation Index > Fetch the complete documentation index at: https://api-reference.hyperswitch.io/llms.txt > Use this file to discover all available pages before exploring further. # Payment Method - List Customer Saved Payment Methods > List the payment methods saved for a customer ## OpenAPI ````yaml get /v1/customers/{id}/saved-payment-methods openapi: 3.0.3 info: title: Hyperswitch - API Documentation description: > ## Get started Hyperswitch provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. You can consume the APIs directly using your favorite HTTP/REST library. We have a testing environment referred to "sandbox", which you can setup to test API calls without affecting production data. Currently, our sandbox environment is live while our production environment is under development and will be available soon. You can sign up on our Dashboard to get API keys to access Hyperswitch API. ### Environment Use the following base URLs when making requests to the APIs: | Environment | Base URL | |---------------|------------------------------------| | Sandbox | | | Production | | ## Authentication When you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant account, you are given a secret key (also referred as api-key) and a publishable key. You may authenticate all API requests with Hyperswitch server by providing the appropriate key in the request Authorization header. | Key | Description | |-----------------|-----------------------------------------------------------------------------------------------| | api-key | Private key. Used to authenticate all API requests from your merchant server | | publishable key | Unique identifier for your account. Used to authenticate API requests from your app's client | Never share your secret api keys. Keep them guarded and secure. contact: name: Hyperswitch Support url: https://hyperswitch.io email: support.global@juspay.io license: name: Apache-2.0 version: 0.1.0 servers: - url: https://sandbox.hyperswitch.io description: Sandbox Environment security: [] tags: - name: Merchant Account description: Create and manage merchant accounts - name: Profile description: Create and manage profiles - name: Merchant Connector Account description: Create and manage merchant connector accounts - name: Payments description: Create and manage one-time payments, recurring payments and mandates - name: Refunds description: Create and manage refunds for successful payments - name: Mandates description: Manage mandates - name: Customers description: Create and manage customers - name: Payment Methods description: Create and manage payment methods of customers - name: Disputes description: Manage disputes - name: API Key description: Create and manage API Keys - name: Payouts description: Create and manage payouts - name: payment link description: Create payment link - name: Routing description: Create and manage routing configurations - name: Event description: Manage events paths: /v1/customers/{id}/saved-payment-methods: get: tags: - Payment Methods summary: Payment Method - List Customer Saved Payment Methods description: List the payment methods saved for a customer operationId: List Customer Saved Payment Methods parameters: - name: id in: path description: The unique identifier for the customer required: true schema: type: string - name: X-Profile-Id in: header description: Profile ID associated to the payment method required: true schema: type: string example: pro_abcdefghijklmnop responses: '200': description: Payment Methods Retrieved content: application/json: schema: $ref: '#/components/schemas/CustomerPaymentMethodsListResponse' '404': description: Customer Not Found security: - api_key: [] components: schemas: CustomerPaymentMethodsListResponse: type: object required: - customer_payment_methods properties: customer_payment_methods: type: array items: $ref: '#/components/schemas/PaymentMethodResponseItem' description: List of payment methods for customer PaymentMethodResponseItem: type: object required: - id - customer_id - payment_method_type - payment_method_subtype - created - requires_cvv - is_default - psp_tokenization_enabled properties: id: type: string description: The unique identifier of the payment method. example: 12345_pm_01926c58bc6e77c09e809964e72af8c8 customer_id: type: string description: The unique identifier of the customer. example: 12345_cus_01926c58bc6e77c09e809964e72af8c8 maxLength: 64 minLength: 32 payment_method_type: $ref: '#/components/schemas/PaymentMethod' payment_method_subtype: $ref: '#/components/schemas/PaymentMethodType' recurring_enabled: type: boolean description: >- Indicates whether the payment method supports recurring payments. Optional. example: true nullable: true payment_method_data: allOf: - $ref: '#/components/schemas/PaymentMethodListData' nullable: true bank: allOf: - $ref: '#/components/schemas/MaskedBankDetails' nullable: true created: type: string format: date-time description: >- A timestamp (ISO 8601 code) that determines when the payment method was created example: '2023-01-18T11:04:09.922Z' requires_cvv: type: boolean description: Whether this payment method requires CVV to be collected example: true last_used_at: type: string format: date-time description: >- A timestamp (ISO 8601 code) that determines when the payment method was last used example: '2024-02-24T11:04:09.922Z' is_default: type: boolean description: Indicates if the payment method has been set to default or not example: true billing: allOf: - $ref: '#/components/schemas/Address' nullable: true network_tokenization: allOf: - $ref: '#/components/schemas/NetworkTokenResponse' nullable: true psp_tokenization_enabled: type: boolean description: >- Whether psp_tokenization is enabled for the payment_method, this will be true when at least one multi-use token with status `Active` is available for the payment method PaymentMethod: type: string description: 'Indicates the type of payment method. Eg: ''card'', ''wallet'', etc.' enum: - card - card_redirect - pay_later - wallet - bank_redirect - bank_transfer - crypto - bank_debit - reward - real_time_payment - upi - voucher - gift_card - open_banking - mobile_payment - network_token PaymentMethodType: type: string description: >- Indicates the sub type of payment method. Eg: 'google_pay' & 'apple_pay' for wallets. enum: - ach - affirm - afterpay_clearpay - alfamart - ali_pay - ali_pay_hk - alma - amazon_pay - paysera - apple_pay - atome - bacs - bancontact_card - becs - benefit - bizum - blik - bluecode - boleto - bca_bank_transfer - bni_va - breadpay - bri_va - bhn_card_network - card_redirect - cimb_va - classic - credit - crypto_currency - cashapp - dana - danamon_va - debit - duit_now - efecty - eft - eft_debit_order - eps - flexiti - fps - evoucher - giropay - givex - google_pay - go_pay - gcash - ideal - interac - indomaret - klarna - kakao_pay - local_bank_redirect - mandiri_va - knet - mb_way - mobile_pay - momo - momo_atm - multibanco - online_banking_thailand - online_banking_czech_republic - online_banking_finland - online_banking_fpx - online_banking_poland - online_banking_slovakia - oxxo - pago_efectivo - permata_bank_transfer - open_banking_uk - pay_bright - payjustnow - paypal - paze - pix - pix_key - pix_emv - pix_automatico_qr - pix_automatico_push - pay_safe_card - przelewy24 - prompt_pay - pse - qris - red_compra - red_pagos - samsung_pay - sepa - sepa_bank_transfer - sepa_guarenteed_debit - skrill - sofort - swish - touch_n_go - trustly - twint - upi_collect - upi_intent - upi_qr - vipps - viet_qr - venmo - walley - we_chat_pay - seven_eleven - lawson - mini_stop - family_mart - seicomart - pay_easy - local_bank_transfer - mifinity - open_banking_pis - direct_carrier_billing - instant_bank_transfer - instant_bank_transfer_finland - instant_bank_transfer_poland - revolut_pay - indonesian_bank_transfer - open_banking - network_token PaymentMethodListData: oneOf: - type: object required: - card properties: card: $ref: '#/components/schemas/CardDetailFromLocker' - type: object required: - bank_debit properties: bank_debit: $ref: '#/components/schemas/BankDebitDetailsPaymentMethod' - type: object required: - bank properties: bank: $ref: '#/components/schemas/Bank' - type: object required: - wallet properties: wallet: $ref: '#/components/schemas/WalletPaymentMethodData' MaskedBankDetails: type: object required: - mask properties: mask: type: string Address: type: object properties: address: allOf: - $ref: '#/components/schemas/AddressDetails' nullable: true phone: allOf: - $ref: '#/components/schemas/PhoneDetails' nullable: true email: type: string nullable: true NetworkTokenResponse: type: object required: - payment_method_data properties: payment_method_data: $ref: '#/components/schemas/NetworkTokenDetailsPaymentMethod' CardDetailFromLocker: type: object required: - saved_to_locker properties: issuer_country: allOf: - $ref: '#/components/schemas/CountryAlpha2' nullable: true last4_digits: type: string example: '4242' nullable: true expiry_month: type: string example: '10' nullable: true expiry_year: type: string example: '25' nullable: true card_holder_name: type: string example: John Doe nullable: true card_fingerprint: type: string example: fingerprint_12345 nullable: true nick_name: type: string example: Card nullable: true card_network: allOf: - $ref: '#/components/schemas/CardNetwork' nullable: true card_isin: type: string example: '4567890' nullable: true card_issuer: type: string example: Issuer Bank nullable: true card_type: type: string example: Credit nullable: true saved_to_locker: type: boolean example: true BankDebitDetailsPaymentMethod: oneOf: - type: object required: - ach_bank_debit properties: ach_bank_debit: type: object required: - account_number_last4_digits - routing_number_last4_digits - bank_name - bank_type - bank_holder_type properties: account_number_last4_digits: type: string routing_number_last4_digits: type: string bank_account_holder_name: type: string nullable: true bank_name: type: string example: ach bank_type: type: string example: checking bank_holder_type: type: string example: personal Bank: oneOf: - $ref: '#/components/schemas/AchBankTransfer' - $ref: '#/components/schemas/BacsBankTransfer' - $ref: '#/components/schemas/TrustlyBankTransfer' - $ref: '#/components/schemas/SepaBankTransfer' - $ref: '#/components/schemas/PixBankTransfer' - $ref: '#/components/schemas/OpenBanking' description: Deprecated - Use `BankTransfer` instead WalletPaymentMethodData: oneOf: - type: object required: - apple_pay properties: apple_pay: $ref: '#/components/schemas/PaymentMethodDataWalletInfo' - type: object required: - google_pay properties: google_pay: $ref: '#/components/schemas/PaymentMethodDataWalletInfo' - type: object required: - pay_pal properties: pay_pal: $ref: '#/components/schemas/PaypalRedirection' AddressDetails: type: object description: Address details properties: city: type: string description: The city, district, suburb, town, or village of the address. example: New York nullable: true maxLength: 50 country: allOf: - $ref: '#/components/schemas/CountryAlpha2' nullable: true line1: type: string description: The first line of the street address or P.O. Box. example: 123, King Street nullable: true maxLength: 200 line2: type: string description: >- The second line of the street address or P.O. Box (e.g., apartment, suite, unit, or building). example: Powelson Avenue nullable: true maxLength: 50 line3: type: string description: The third line of the street address, if applicable. example: Bridgewater nullable: true maxLength: 50 zip: type: string description: The zip/postal code for the address example: '08807' nullable: true maxLength: 50 state: type: string description: The address state example: New York nullable: true first_name: type: string description: The first name for the address example: John nullable: true maxLength: 255 last_name: type: string description: The last name for the address example: Doe nullable: true maxLength: 255 origin_zip: type: string description: The zip/postal code of the origin example: '08807' nullable: true maxLength: 50 PhoneDetails: type: object properties: number: type: string description: The contact number example: '9123456789' nullable: true country_code: type: string description: The country code attached to the number example: '+1' nullable: true NetworkTokenDetailsPaymentMethod: type: object properties: last4_digits: type: string example: '4242' nullable: true issuer_country: allOf: - $ref: '#/components/schemas/CountryAlpha2' nullable: true network_token_expiry_month: type: string example: '05' nullable: true network_token_expiry_year: type: string example: '27' nullable: true nick_name: type: string example: Card nullable: true card_holder_name: type: string example: John Doe nullable: true card_isin: type: string example: '16712672' nullable: true card_issuer: type: string example: Bank of America nullable: true card_network: allOf: - $ref: '#/components/schemas/CardNetwork' nullable: true card_type: type: string example: Credit nullable: true saved_to_locker: type: boolean par: type: string example: 522134KAVJ1JPZ8L77N0Z2LRYZS7J nullable: true CountryAlpha2: type: string enum: - AF - AX - AL - DZ - AS - AD - AO - AI - AQ - AG - AR - AM - AW - AU - AT - AZ - BS - BH - BD - BB - BY - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - IO - BN - BG - BF - BI - KH - CM - CA - CV - KY - CF - TD - CL - CN - CX - CC - CO - KM - CG - CD - CK - CR - CI - HR - CU - CW - CY - CZ - DK - DJ - DM - DO - EC - EG - SV - GQ - ER - EE - ET - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - DE - GH - GI - GR - GL - GD - GP - GU - GT - GG - GN - GW - GY - HT - HM - VA - HN - HK - HU - IS - IN - ID - IR - IQ - IE - IM - IL - IT - JM - JP - JE - JO - KZ - KE - KI - KP - KR - KW - KG - LA - LV - LB - LS - LR - LY - LI - LT - LU - MO - MK - MG - MW - MY - MV - ML - MT - MH - MQ - MR - MU - YT - MX - FM - MD - MC - MN - ME - MS - MA - MZ - MM - NA - NR - NP - NL - NC - NZ - NI - NE - NG - NU - NF - MP - 'NO' - OM - PK - PW - PS - PA - PG - PY - PE - PH - PN - PL - PT - PR - QA - RE - RO - RU - RW - BL - SH - KN - LC - MF - PM - VC - WS - SM - ST - SA - SN - RS - SC - SL - SG - SX - SK - SI - SB - SO - ZA - GS - SS - ES - LK - SD - SR - SJ - SZ - SE - CH - SY - TW - TJ - TZ - TH - TL - TG - TK - TO - TT - TN - TR - TM - TC - TV - UG - UA - AE - GB - UM - UY - UZ - VU - VE - VN - VG - VI - WF - EH - YE - ZM - ZW - US CardNetwork: type: string description: Indicates the card network. enum: - Visa - Mastercard - AmericanExpress - JCB - DinersClub - Discover - CartesBancaires - UnionPay - Interac - RuPay - Maestro - Star - Pulse - Accel - Nyce AchBankTransfer: type: object required: - bank_account_number - bank_routing_number properties: bank_name: type: string description: Bank name example: Deutsche Bank nullable: true bank_country_code: allOf: - $ref: '#/components/schemas/CountryAlpha2' nullable: true bank_city: type: string description: Bank city example: California nullable: true bank_account_number: type: string description: >- Bank account number is an unique identifier assigned by a bank to a customer. example: '000123456' bank_routing_number: type: string description: >- [9 digits] Routing number - used in USA for identifying a specific bank. example: '110000000' BacsBankTransfer: type: object required: - bank_account_number - bank_sort_code properties: bank_name: type: string description: Bank name example: Deutsche Bank nullable: true bank_country_code: allOf: - $ref: '#/components/schemas/CountryAlpha2' nullable: true bank_city: type: string description: Bank city example: California nullable: true bank_account_number: type: string description: >- Bank account number is an unique identifier assigned by a bank to a customer. example: '000123456' bank_sort_code: type: string description: >- [6 digits] Sort Code - used in UK and Ireland for identifying a bank and it's branches. example: 98-76-54 TrustlyBankTransfer: type: object required: - iban - country_code - account_number - bank_number properties: iban: type: string description: >- International Bank Account Number (iban) - used in many countries for identifying a bank along with it's customer. example: token_12345 country_code: $ref: '#/components/schemas/CountryAlpha2' account_number: type: string description: The account number, identifying the end-user's account in the bank. example: '69706212' bank_number: type: string description: >- The bank number identifying the end-user's bank in the given clearing house. example: '6112' SepaBankTransfer: type: object required: - iban - bic properties: bank_name: type: string description: Bank name example: Deutsche Bank nullable: true bank_country_code: allOf: - $ref: '#/components/schemas/CountryAlpha2' nullable: true bank_city: type: string description: Bank city example: California nullable: true iban: type: string description: >- International Bank Account Number (iban) - used in many countries for identifying a bank along with it's customer. example: DE89370400440532013000 bic: type: string description: >- [8 / 11 digits] Bank Identifier Code (bic) / Swift Code - used in many countries for identifying a bank and it's branches example: HSBCGB2LXXX PixBankTransfer: type: object required: - bank_account_number - pix_key - emv properties: bank_name: type: string description: Bank name example: Deutsche Bank nullable: true bank_branch: type: string description: Bank branch example: '3707' nullable: true bank_account_number: type: string description: >- Bank account number is an unique identifier assigned by a bank to a customer. example: '000123456' pix_key: type: string description: Unique key for pix customer example: '000123456' tax_id: type: string description: Individual taxpayer identification number example: '000123456' nullable: true emv: type: string description: String formatted QR code for pix payout example: >- 00020126580014br.gov.bcb.pix0114000123456785204000053039865802BR5925John Doe6009Sao Paulo61080540900062070503***63041D3D OpenBanking: type: object required: - account_holder_name - iban properties: account_holder_name: type: string description: Account holder name example: John Doe iban: type: string description: >- International Bank Account Number (iban) - used in many countries for identifying a bank along with it's customer. example: DE89370400440532013000 PaymentMethodDataWalletInfo: type: object properties: last4: type: string description: Last 4 digits of the card number nullable: true card_network: type: string description: The information of the payment method nullable: true type: type: string description: The type of payment method nullable: true card_exp_month: type: string description: The card's expiry month example: '10' nullable: true card_exp_year: type: string description: The card's expiry year example: '25' nullable: true auth_code: type: string description: Unique authorisation code for the payment example: '003225' nullable: true email: type: string description: Email address associated with the wallet (e.g. PayPal email) example: johntest@test.com nullable: true PaypalRedirection: type: object properties: email: type: string description: paypal's email address example: johntest@test.com nullable: true maxLength: 255 securitySchemes: api_key: type: apiKey in: header name: Authorization description: >- Format: `api-key=` Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application. ````