> ## Documentation Index
> Fetch the complete documentation index at: https://www.commercengine.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List all saved payment methods

> This endpoint acts as a proxy for JusPay's Fetch Saved Payment Methods API. It enables to securely retrieve a list of payment methods (such as saved cards, UPI handles, wallets) that have been previously stored for a given customer.

The operation helps streamline the checkout flow by allowing users to quickly select from existing payment methods, reducing input friction and improving conversion.

You can filter the results by payment method type using the payment_method query parameter. Multiple payment methods can be specified by separating them with commas (e.g., payment_method=upi_collect,card,wallet).

API documentation of JusPay can be found at below link:

https://juspay.io/in/docs/api-reference/docs/express-checkout/fetch-saved-payment-methods



## OpenAPI

````yaml https://openapi.commercengine.io/ce-storefront.json get /customers/{customer_id}/payment-methods
openapi: 3.2.0
info:
  version: '1.0'
  title: CE Storefront APIs
  summary: Customer-facing e-commerce API for building exceptional shopping experiences
  description: >-
    Public-facing API for Commerce Engine storefronts, enabling seamless
    shopping experiences with product browsing, cart management, checkout
    processing, user accounts, and order tracking. Perfect for building web,
    mobile, and headless commerce applications.
  contact:
    name: Support
    email: support@commercengine.io
    url: https://www.commercengine.io/contact-us
  license:
    url: https://www.commercengine.io/contact-us
    name: All Rights Reserved
servers:
  - url: https://staging.api.commercengine.io/api/v1/{store_id}/storefront
    description: Staging Server
    variables:
      store_id:
        description: Store ID
        default: store_id
    x-speakeasy-server-id: staging
  - url: https://prod.api.commercengine.io/api/v1/{store_id}/storefront
    description: Prod Server
    variables:
      store_id:
        description: Store ID
        default: store_id
    x-speakeasy-server-id: prod
security: []
tags:
  - name: section-identity
    summary: Identity
    kind: nav
  - name: Authentication
    description: >-
      Start an anonymous session for each visitor, then sign them in or register
      them with a one-time password over SMS, WhatsApp or email, or with a
      password. Every flow ends in the access and refresh tokens your app sends
      with each request.
    summary: Authentication
    kind: nav
    parent: section-identity
  - name: Account recovery
    description: >-
      Get a shopper back into their account: reset a forgotten password, or find
      the account by its KYC document numbers and sign in with the one-time code
      sent to it.
    summary: Account recovery
    kind: nav
    parent: section-identity
  - name: Users
    description: >-
      The signed-in shopper's `User`: read and update the profile, manage the
      profile image, change the password, check whether the email and phone are
      verified, and deactivate or delete the account.
    summary: Users
    kind: nav
    parent: section-identity
  - name: Customer attributes
    description: >-
      The store's customer attributes (`StorefrontAttribute`) and the shopper's
      values for them (`UserAttributeValue`), for building profile forms.
    summary: Customer attributes
    kind: nav
    parent: section-identity
  - name: section-customers
    summary: Customers
    kind: nav
  - name: Addresses
    description: >-
      The customer's saved addresses, as `CustomerAddress` objects, to offer at
      checkout and manage on the account page.
    summary: Addresses
    kind: nav
    parent: section-customers
  - name: Bank accounts
    description: >-
      The customer's bank accounts, as `CustomerBankAccount` objects: add,
      update, verify and remove them.
    summary: Bank accounts
    kind: nav
    parent: section-customers
  - name: KYC documents
    description: >-
      The KYC documents the store requires (`KycDocumentConfig`) and the ones
      the customer has added (`Document`). Verify a document number before
      saving it.
    summary: KYC documents
    kind: nav
    parent: section-customers
  - name: Saved payment methods
    description: >-
      The cards, UPI IDs and wallets the customer has saved, to offer at
      checkout.
    summary: Saved payment methods
    kind: nav
    parent: section-customers
  - name: Mandates
    description: >-
      Recurring-payment mandates the customer authorizes (`CustomerMandate`):
      create, update, pause, resume or revoke them, and list the debits
      scheduled against them (`MandateDebitSchedule`).
    summary: Mandates
    kind: nav
    parent: section-customers
  - name: Loyalty
    description: >-
      The store's `LoyaltyProgram` and the customer's standing in it: their
      `CustomerLoyalty` and `LoyaltyPointActivity`. Redeem points on a cart
      under Carts.
    summary: Loyalty
    kind: nav
    parent: section-customers
  - name: Credit
    description: >-
      What the customer can spend on credit: their bank-transfer
      `CustomerCreditBalance` and their credit line
      (`CustomerCreditLineBalance`). Apply the credit balance to a cart under
      Carts.
    summary: Credit
    kind: nav
    parent: section-customers
  - name: section-catalog
    summary: Catalog
    kind: nav
  - name: Products
    description: >-
      Browse and search the store's catalog: list `Product`s and SKUs, read a
      product and its variants, and show similar, up-sell and cross-sell items.
    summary: Products
    kind: nav
    parent: section-catalog
  - name: Categories
    description: >-
      The store's categories, as `ProductCategory` objects with their child
      categories, for navigation and filtering.
    summary: Categories
    kind: nav
    parent: section-catalog
  - name: Reviews
    description: >-
      Reviews of products and sellers: show them, let a shopper review a
      product, and list what the customer has reviewed or can review next.
    summary: Reviews
    kind: nav
    parent: section-catalog
  - name: Marketplace catalog
    description: >-
      A marketplace's catalog as shoppers browse it: `MarketplaceProduct`s with
      their seller, variants, SKUs, categories and reviews, plus search and
      recommendations.
    summary: Marketplace catalog
    kind: nav
    parent: section-catalog
  - name: section-shopping
    summary: Shopping
    kind: nav
  - name: Carts
    description: >-
      The shopper's `Cart`: create it, add, update or remove items, set the
      address, and apply loyalty points or credit balance. Each update returns
      the full, updated `Cart`.
    summary: Carts
    kind: nav
    parent: section-shopping
  - name: Coupons & promotions
    description: >-
      The coupons and promotions a shopper can use: list what the store offers,
      see which apply to a cart and why the rest don't, and apply or remove a
      coupon.
    summary: Coupons & promotions
    kind: nav
    parent: section-shopping
  - name: Fulfillment
    description: >-
      How an order reaches the shopper: check that a pincode is serviceable,
      list the delivery and collect-in-store options for a cart, and save the
      cart's choice.
    summary: Fulfillment
    kind: nav
    parent: section-shopping
  - name: Wishlist
    description: Products the shopper saved for later, as `Item` objects.
    summary: Wishlist
    kind: nav
    parent: section-shopping
  - name: section-orders
    summary: Orders
    kind: nav
  - name: Orders
    description: >-
      Place an order from the cart and follow it afterwards: list orders, read
      an `OrderDetail`, cancel it, list its shipments, and offer past items
      again.
    summary: Orders
    kind: nav
    parent: section-orders
  - name: Order payments
    description: >-
      Pay for an order after checkout: poll its payment status, retry or cancel
      a payment request, and list its `OrderPayment`s and refunds.
    summary: Order payments
    kind: nav
    parent: section-orders
  - name: Returns
    description: >-
      Return delivered items: create an `OrderReturn`, add attachments, follow
      it, and cancel it.
    summary: Returns
    kind: nav
    parent: section-orders
  - name: section-payments
    summary: Payments
    kind: nav
  - name: Payments
    description: >-
      The payment methods the store accepts and the checks around paying with
      them: card BIN details, VPA and IFSC lookups, and authenticating a payment
      with a direct OTP.
    summary: Payments
    kind: nav
    parent: section-payments
  - name: PayU
    description: >-
      Generate the hash PayU requires on the requests your app sends it, such as
      validating a UPI ID or saving and retrieving cards.
    summary: PayU
    kind: nav
    parent: section-payments
  - name: section-store
    summary: Store
    kind: nav
  - name: Store
    description: >-
      The store your app runs on: check that it exists and read its
      `StoreConfig`, from brand and currency to KYC, customer groups and payment
      providers.
    summary: Store
    kind: nav
    parent: section-store
  - name: Sellers
    description: >-
      A marketplace's sellers: a seller's profile (`SellerDetail`) and the
      sellers authorized for a customer (`SellerInfo`).
    summary: Sellers
    kind: nav
    parent: section-store
  - name: Locations
    description: Countries, states and pincodes for address forms.
    summary: Locations
    kind: nav
    parent: section-store
  - name: Newsletter
    description: Sign a shopper up for the store's newsletter.
    summary: Newsletter
    kind: nav
    parent: section-store
externalDocs:
  url: https://llm-docs.commercengine.io
  description: Commerce Engine API Reference Documentation
paths:
  /customers/{customer_id}/payment-methods:
    parameters:
      - name: customer_id
        in: path
        description: Customer Id
        required: true
        schema:
          type: string
    get:
      tags:
        - Saved payment methods
      summary: List all saved payment methods
      description: >-
        This endpoint acts as a proxy for JusPay's Fetch Saved Payment Methods
        API. It enables to securely retrieve a list of payment methods (such as
        saved cards, UPI handles, wallets) that have been previously stored for
        a given customer.


        The operation helps streamline the checkout flow by allowing users to
        quickly select from existing payment methods, reducing input friction
        and improving conversion.


        You can filter the results by payment method type using the
        payment_method query parameter. Multiple payment methods can be
        specified by separating them with commas (e.g.,
        payment_method=upi_collect,card,wallet).


        API documentation of JusPay can be found at below link:


        https://juspay.io/in/docs/api-reference/docs/express-checkout/fetch-saved-payment-methods
      operationId: list-saved-payment-methods
      parameters:
        - name: payment_methods
          in: query
          description: >-
            Comma-separated `UPI_COLLECT`, `CARD` and `WALLET`,
            case-insensitive. Unrecognized entries are ignored; with no
            recognized entry, returns all methods.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  success:
                    type: boolean
                  content:
                    properties:
                      saved_payment_methods:
                        $ref: '#/components/schemas/SavedPaymentMethod'
                    type: object
          links:
            CreateOrder:
              operationId: create-order
              description: >-
                Create an order using a saved payment method. Use the saved
                payment method details to construct a `JusPayExpressCheckout`
                payment method payload.
        '400':
          $ref: '#/components/responses/BadRequest'
          description: '`payment-gateway-error`: payment configuration failed.'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - Authorization: []
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/storefront/operations/list-saved-payment-methods
        description: API reference for the list-saved-payment-methods operation
components:
  schemas:
    SavedPaymentMethod:
      title: SavedPaymentMethod
      type: object
      externalDocs:
        url: >-
          https://llm-docs.commercengine.io/storefront/schemas/SavedPaymentMethod
        description: API reference for the SavedPaymentMethod schema
      properties:
        upi_collect:
          description: Returns an empty array.
          type: array
          items:
            type: object
            required:
              - count
              - last_used
              - vpa
            properties:
              count:
                type: integer
              last_used:
                type: string
              vpa:
                type: string
          maxItems: 0
        wallet:
          type: array
          items:
            type: object
            required:
              - id
              - wallet
              - gateway_reference_id
              - last_refreshed
            properties:
              linked:
                type: string
              id:
                type: string
              metadata:
                type: object
                properties:
                  mobile_number:
                    type: string
                  device_id:
                    type: string
                required:
                  - mobile_number
              wallet:
                type: string
              gateway_reference_id:
                type: string
              last_refreshed:
                type: string
              sub_details:
                type: object
                properties:
                  last_used:
                    type: string
                  current_balance:
                    type: string
                  last_refreshed:
                    type: string
                  payment_method:
                    type: string
                  payment_method_type:
                    type: string
                required:
                  - last_used
                  - current_balance
                  - last_refreshed
                  - payment_method
                  - payment_method_type
        card:
          type: array
          items:
            type: object
            required:
              - card_sub_type
              - extended_card_type
              - provider_category
              - vault_provider
              - card_type
              - card_token
              - card_exp_month
              - expired
              - tokenize_support
              - card_exp_year
              - name_on_card
              - country_code
              - card_number
            properties:
              card_sub_type:
                type: string
              extended_card_type:
                type: string
              card_global_fingerprint:
                type: string
              nickname:
                type: string
              provider_category:
                type: string
              vault_provider:
                type: string
              card_reference:
                type: string
              card_type:
                type: string
              metadata:
                type: object
                properties:
                  origin_merchant_id:
                    type: string
                required:
                  - origin_merchant_id
              card_issuer:
                type: string
              card_token:
                type: string
              card_exp_month:
                type: string
              provider:
                type: string
              card_sub_type_category:
                type: string
              expired:
                type: boolean
              card_fingerprint:
                type: string
              tokenize_support:
                type: boolean
              juspay_bank_code:
                type: string
              card_exp_year:
                type: string
              name_on_card:
                type: string
              country_code:
                type: string
              card_number:
                type: string
              card_isin:
                type: string
              card_brand:
                type: string
              card_issuer_country:
                type: string
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
              - code
            properties:
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              code:
                type: string
              errors:
                type: object
              details:
                type: string
    Unauthorized:
      description: >-
        Authentication failed. Codes include `token-required`, `token-expired`
        and `token_not_valid` for an invalid or expired token.
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
              - code
            properties:
              message:
                type: string
                examples:
                  - Not authorized for given operation on the Resource.
                x-speakeasy-error-message: true
              success:
                type: boolean
                default: false
              code:
                type: string
                examples:
                  - unauthorized
              details:
                type: string
    Forbidden:
      description: >-
        Access denied. `token-required` requires an authenticated session;
        `permission-denied` means the caller cannot access this resource. On
        POS, `session-expired` requires signing in again.
      content:
        application/json:
          schema:
            type: object
            required:
              - code
              - message
              - success
            properties:
              code:
                type: string
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              details:
                type: string
    NotFound:
      description: Requested resource not found
      content:
        application/json:
          schema:
            type: object
            required:
              - message
              - success
              - code
            properties:
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              code:
                type: string
              details:
                type: string
    InternalServerError:
      description: The request failed because of an unexpected error.
      content:
        application/json:
          schema:
            type: object
            required:
              - code
              - message
              - success
            properties:
              code:
                type: string
              message:
                type: string
                x-speakeasy-error-message: true
              success:
                type: boolean
              details:
                type: string
  securitySchemes:
    Authorization:
      type: http
      description: Access token
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.