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

# List Payment Methods

> Returns a list of available payment methods for this checkout.



## OpenAPI

````yaml /api-reference/storefront.yaml get /api/v2/storefront/checkout/payment_methods
openapi: 3.0.3
info:
  version: 2.0.0
  title: Storefront API
  description: >-
    Storefront API is a modern REST API based on the [JSON API
    spec](https://jsonapi.org/) which provides you with all the necessary
    endpoints to build amazing user interfaces either in JavaScript frameworks
    or native mobile libraries.


    Import to
    [Postman](https://raw.githubusercontent.com/spree/spree/main/docs/api-reference/storefront.yaml)
  contact:
    name: Vendo Connect Inc.
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  license:
    name: BSD-3-Clause
    url: https://github.com/spree/spree/blob/main/LICENSE.md
servers:
  - url: https://demo.spreecommerce.org
    description: demo
  - url: http://localhost:3000
    description: localhost
security: []
tags:
  - name: Account
  - name: Account / Address
  - name: Account / Credit Cards
  - name: Account / Orders
  - name: Cart
  - name: Cart / Line Items
  - name: Cart / Coupons
  - name: Cart / Other
  - name: Checkout
  - name: Checkout / State
  - name: Checkout / Shipments
  - name: Checkout / Payments
  - name: Checkout / Store Credit
  - name: Stripe
  - name: Adyen
  - name: Countries
  - name: Digital Downloads
  - name: Order Status
  - name: Products
  - name: Variants
  - name: Stores
  - name: Policies
  - name: Taxons
  - name: Vendors
  - name: Wishlists
  - name: Wishlists / Wished Items
paths:
  /api/v2/storefront/checkout/payment_methods:
    get:
      tags:
        - Checkout / Payments
      summary: List Payment Methods
      description: Returns a list of available payment methods for this checkout.
      operationId: payment-methods
      responses:
        '200':
          $ref: '#/components/responses/PaymentMethodList'
        '404':
          $ref: '#/components/responses/404NotFound'
      security:
        - orderToken: []
        - bearerAuth: []
components:
  responses:
    PaymentMethodList:
      description: 200 Success - Returns an array of `payment_method` objects.
      content:
        application/vnd.api+json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  $ref: '#/components/schemas/PaymentMethod'
            required:
              - data
          examples:
            List of Payment Methods:
              value:
                data:
                  - id: '1'
                    type: payment_method
                    attributes:
                      type: Spree::Gateway::Bogus
                      name: Credit Card
                      description: Bogus payment gateway.
                      preferences:
                        dummy_key: PUBLICKEY123
                  - id: '2'
                    type: payment_method
                    attributes:
                      type: Spree::PaymentMethod::Check
                      name: Check
                      description: Pay by check.
                      preferences: {}
    404NotFound:
      description: 404 Not Found - Resource not found.
      content:
        application/vnd.api+json:
          schema:
            properties:
              error:
                type: string
                example: The resource you were looking for could not be found.
                default: The resource you were looking for could not be found.
          examples:
            404 Example:
              value:
                error: The resource you were looking for could not be found.
  schemas:
    PaymentMethod:
      title: Payment Method
      description: ''
      type: object
      x-internal: false
      properties:
        id:
          type: string
          example: '1'
        type:
          type: string
          default: payment_method
        attributes:
          type: object
          properties:
            type:
              type: string
              example: Spree::Gateway::StripeGateway
            name:
              type: string
              example: Stripe
            description:
              type: string
              example: Stripe Payments
              nullable: true
            preferences:
              type: object
      required:
        - id
        - type
        - attributes
  securitySchemes:
    orderToken:
      type: apiKey
      in: header
      description: |-
        Order token to authorize Cart and Checkout requests.

        [How to obtain X-Spree-Order-Token](../authentication#for-guest-users)
      name: X-Spree-Order-Token
    bearerAuth:
      type: http
      scheme: bearer
      description: |-
        User token to authorize Cart and Checkout requests.

        It is required to associate Cart with the User.

````