> ## 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. # List customer saved payment methods for a Payment > Lists all the applicable payment methods for a particular payment tied to the `client_secret`. ## OpenAPI ````yaml get /customers/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 - name: Authentication description: Create and manage authentication - name: Subscriptions description: Subscription management and billing endpoints - name: Card Issuer description: Create and manage card issuers paths: /customers/payment_methods: get: tags: - Payment Methods summary: List customer saved payment methods for a Payment description: >- Lists all the applicable payment methods for a particular payment tied to the `client_secret`. operationId: List Customer Payment Methods via Client Secret parameters: - name: client_secret in: query description: >- This is a token which expires after 15 minutes, used from the client to authenticate and create sessions from the SDK required: false schema: type: string nullable: true - name: accepted_countries in: query description: The two-letter ISO currency code required: false schema: type: array items: $ref: '#/components/schemas/CountryAlpha2' nullable: true - name: accepted_currencies in: query description: The three-letter ISO currency code required: false schema: type: array items: $ref: '#/components/schemas/Currency' nullable: true - name: amount in: query description: The amount accepted for processing by the particular payment method. required: false schema: type: integer format: int64 nullable: true - name: recurring_enabled in: query description: >- Indicates whether the payment method is eligible for recurring payments required: false schema: type: boolean nullable: true - name: installment_payment_enabled in: query description: >- Indicates whether the payment method is eligible for installment payments required: false schema: type: boolean nullable: true - name: limit in: query description: Indicates the limit of last used payment methods required: false schema: type: integer format: int64 nullable: true - name: card_networks in: query description: Indicates whether the payment method is eligible for card netwotks required: false schema: type: array items: $ref: '#/components/schemas/CardNetwork' nullable: true responses: '200': description: >- Payment Methods retrieved for customer tied to its respective client-secret passed in the param content: application/json: schema: $ref: '#/components/schemas/CustomerPaymentMethodsListResponse' '400': description: Invalid Data '404': description: Payment Methods does not exist in records security: - publishable_key: [] components: schemas: 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 Currency: type: string description: >- The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment. enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLF - CLP - CNY - COP - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STD - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TWD - TZS - UAH - UGX - USD - UYU - UZS - VES - VND - VUV - WST - XAF - XCD - XOF - XPF - YER - ZAR - ZMW - ZWL CardNetwork: type: string description: Indicates the card network. enum: - Visa - Mastercard - AmericanExpress - JCB - DinersClub - Discover - CartesBancaires - UnionPay - Interac - RuPay - Maestro - Star - Pulse - Accel - Nyce CustomerPaymentMethodsListResponse: type: object required: - customer_payment_methods properties: customer_payment_methods: type: array items: $ref: '#/components/schemas/CustomerPaymentMethod' description: List of payment methods for customer is_guest_customer: type: boolean description: >- Returns whether a customer id is not tied to a payment intent (only when the request is made against a client secret) nullable: true CustomerPaymentMethod: type: object required: - payment_token - payment_method_id - customer_id - payment_method - requires_cvv - default_payment_method_set properties: payment_token: type: string description: >- Token for payment method in temporary card locker which gets refreshed often example: 7ebf443f-a050-4067-84e5-e6f6d4800aef payment_method_id: type: string description: The unique identifier of the customer. example: pm_iouuy468iyuowqs customer_id: type: string description: The unique identifier of the customer. example: cus_y3oqhf46pyzuxjbcn2giaqnb44 maxLength: 64 minLength: 1 payment_method: $ref: '#/components/schemas/PaymentMethod' payment_method_type: allOf: - $ref: '#/components/schemas/PaymentMethodType' nullable: true payment_method_issuer: type: string description: >- The name of the bank/ provider issuing the payment method to the end user example: Citibank nullable: true payment_method_issuer_code: allOf: - $ref: '#/components/schemas/PaymentMethodIssuerCode' nullable: true recurring_enabled: type: boolean description: >- Indicates whether the payment method supports recurring payments. Optional. example: true nullable: true installment_payment_enabled: type: boolean description: >- Indicates whether the payment method is eligible for installment payments (e.g., EMI, BNPL). Optional. example: true nullable: true payment_experience: type: array items: $ref: '#/components/schemas/PaymentExperience' description: Type of payment experience enabled with the connector example: - redirect_to_url nullable: true card: allOf: - $ref: '#/components/schemas/CardDetailFromLocker' nullable: true metadata: type: object description: >- You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Metadata is useful for storing additional, structured information on an object. 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' nullable: true bank_transfer: allOf: - $ref: '#/components/schemas/Bank' nullable: true bank: allOf: - $ref: '#/components/schemas/MaskedBankDetails' nullable: true surcharge_details: allOf: - $ref: '#/components/schemas/SurchargeDetailsResponse' nullable: true 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' nullable: true default_payment_method_set: 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 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 PaymentMethodIssuerCode: type: string enum: - jp_hdfc - jp_icici - jp_googlepay - jp_applepay - jp_phonepay - jp_wechat - jp_sofort - jp_giropay - jp_sepa - jp_bacs PaymentExperience: type: string description: >- To indicate the type of payment experience that the customer would go through enum: - redirect_to_url - invoke_sdk_client - display_qr_code - one_click - link_wallet - invoke_payment_app - display_wait_screen - collect_otp CardDetailFromLocker: type: object required: - saved_to_locker properties: scheme: type: string nullable: true issuer_country: type: string nullable: true issuer_country_code: type: string nullable: true last4_digits: type: string nullable: true expiry_month: type: string nullable: true expiry_year: type: string nullable: true card_token: type: string nullable: true card_holder_name: type: string nullable: true card_fingerprint: type: string nullable: true nick_name: type: string nullable: true card_network: allOf: - $ref: '#/components/schemas/CardNetwork' nullable: true card_isin: type: string nullable: true card_issuer: type: string nullable: true card_type: type: string nullable: true saved_to_locker: type: boolean 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 MaskedBankDetails: type: object required: - mask properties: mask: type: string SurchargeDetailsResponse: type: object required: - surcharge - display_surcharge_amount - display_tax_on_surcharge_amount - display_total_surcharge_amount properties: surcharge: $ref: '#/components/schemas/SurchargeResponse' tax_on_surcharge: allOf: - $ref: '#/components/schemas/SurchargePercentage' nullable: true display_surcharge_amount: type: number format: double description: surcharge amount for this payment display_tax_on_surcharge_amount: type: number format: double description: tax on surcharge amount for this payment display_total_surcharge_amount: type: number format: double description: sum of display_surcharge_amount and display_tax_on_surcharge_amount 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 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 SurchargeResponse: oneOf: - type: object required: - type - value properties: type: type: string enum: - fixed value: $ref: '#/components/schemas/MinorUnit' - type: object required: - type - value properties: type: type: string enum: - rate value: $ref: '#/components/schemas/SurchargePercentage' discriminator: propertyName: type SurchargePercentage: type: object required: - percentage properties: percentage: type: number format: float 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 MinorUnit: type: integer format: int64 description: This Unit struct represents MinorUnit in which core amount works securitySchemes: publishable_key: type: apiKey in: header name: api-key description: >- Publishable keys are a type of keys that can be public and have limited scope of usage. ````