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

# List payment methods

> Every payment method Shoply supports, and for each whether this store has connected it and switched it on, in the order its checkout offers them. Never a method's credentials. `meta.balance` says whether buyers may pay with their store balance. A method's name here is the name the rest of the API uses for it. `meta.order` is every method the store has connected and every custom payment method it has (paid outside Shoply: "List custom payment methods"), by name or id, in the checkout's one order. Each method's `unpaidHours` is its own time for an unpaid order, or null for the store's, which is `meta.unpaid.hours`; `meta.routing.providers` is the card methods Payment Routing chooses between.

Needs the `payments.read` permission (Read Payment Methods).



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/payment-methods
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Blacklist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/payment-methods:
    get:
      tags:
        - Payment methods
      summary: List payment methods
      description: >-
        Every payment method Shoply supports, and for each whether this store
        has connected it and switched it on, in the order its checkout offers
        them. Never a method's credentials. `meta.balance` says whether buyers
        may pay with their store balance. A method's name here is the name the
        rest of the API uses for it. `meta.order` is every method the store has
        connected and every custom payment method it has (paid outside Shoply:
        "List custom payment methods"), by name or id, in the checkout's one
        order. Each method's `unpaidHours` is its own time for an unpaid order,
        or null for the store's, which is `meta.unpaid.hours`;
        `meta.routing.providers` is the card methods Payment Routing chooses
        between.


        Needs the `payments.read` permission (Read Payment Methods).
      operationId: paymentMethods.list
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        provider:
                          type: string
                        name:
                          type: string
                        kind:
                          type: string
                        blurb:
                          type: string
                        tagline:
                          type: string
                        accent:
                          type: string
                        site:
                          type: string
                        callbackUrl:
                          type: string
                        returnOrigin:
                          type: string
                        originHint:
                          type: string
                        callbackHint:
                          type: string
                        copies:
                          type:
                            - array
                            - object
                        authorizeUrl:
                          type: string
                        connected:
                          type: boolean
                        enabled:
                          type: boolean
                        usable:
                          type: boolean
                        ready:
                          type: boolean
                        testMode:
                          type: boolean
                        modes:
                          type:
                            - array
                            - object
                        mode:
                          type: string
                        label:
                          type: string
                        buyerLabel:
                          type: string
                        defaultLabel:
                          type: string
                        fields:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                              label:
                                type: string
                              placeholder:
                                type: string
                              required:
                                type: boolean
                              max:
                                type: integer
                              secret:
                                type: boolean
                              showCallback:
                                type: boolean
                              mode:
                                type: string
                              isSet:
                                type: boolean
                              value:
                                type: string
                        toggles:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                              label:
                                type: string
                              hint:
                                type: string
                              group:
                                type: string
                              needs:
                                type: string
                              'on':
                                type: boolean
                        unpaidHours:
                          nullable: true
                        updatedAt:
                          nullable: true
                  meta:
                    type: object
                    properties:
                      order:
                        type:
                          - array
                          - object
                      balance:
                        type: object
                        properties:
                          enabled:
                            type: boolean
                          holders:
                            type: integer
                      unpaid:
                        type: object
                        properties:
                          hours:
                            type: integer
                          presets:
                            type: array
                            items:
                              type: integer
                          least:
                            type: integer
                          most:
                            type: integer
                      routing:
                        type: object
                        properties:
                          providers:
                            type:
                              - array
                              - object
              example:
                success: true
                message: null
                code: null
                data:
                  - provider: nowpayments
                    name: NOWPayments
                    kind: crypto
                    blurb: >-
                      Accept crypto through your NOWPayments account. Payouts go
                      to your wallet. NOWPayments charges its own fee of 0.5% to
                      1%.
                    tagline: Accept crypto at checkout, paid out to your own wallet.
                    accent: '#64acff'
                    site: https://account.nowpayments.io/
                    callbackUrl: >-
                      http://localhost:8000/api/payments/nowpayments/callback/743d82fb-6aad-44bb-ab00-d54c4b0eecb7
                    returnOrigin: ''
                    originHint: ''
                    callbackHint: ''
                    copies: []
                    authorizeUrl: ''
                    connected: false
                    enabled: false
                    usable: false
                    ready: false
                    testMode: false
                    modes: []
                    mode: ''
                    label: ''
                    buyerLabel: Cryptocurrency (NOWPayments)
                    defaultLabel: Cryptocurrency (NOWPayments)
                    fields:
                      - name: api_key
                        label: API Key
                        placeholder: XXXXXXX-XXXXXXX-XXXXXXX-XXXXXXX
                        required: true
                        max: 255
                        secret: true
                        showCallback: false
                        mode: ''
                        isSet: false
                        value: ''
                      - name: ipn_secret
                        label: IPN Secret Key
                        placeholder: ''
                        required: true
                        max: 255
                        secret: true
                        showCallback: true
                        mode: ''
                        isSet: false
                        value: ''
                    toggles:
                      - name: require_billing
                        label: Require Billing Information
                        hint: >-
                          Ask crypto buyers for their name and address at
                          checkout.
                        group: ''
                        needs: ''
                        'on': false
                    unpaidHours: null
                    updatedAt: null
                  - provider: stripe
                    name: Stripe
                    kind: fiat
                    blurb: >-
                      Accept cards through your Stripe account. iDEAL and
                      Bancontact also appear on orders priced in euros.
                    tagline: >-
                      Accept cards on your checkout, paid into your Stripe
                      account.
                    accent: '#635bff'
                    site: https://dashboard.stripe.com/apikeys
                    callbackUrl: >-
                      http://localhost:8000/api/payments/stripe/callback/743d82fb-6aad-44bb-ab00-d54c4b0eecb7
                    returnOrigin: ''
                    originHint: ''
                    callbackHint: ''
                    copies: []
                    authorizeUrl: ''
                    connected: false
                    enabled: false
                    usable: false
                    ready: false
                    testMode: false
                    modes: []
                    mode: ''
                    label: ''
                    buyerLabel: Credit/Debit Card (Stripe)
                    defaultLabel: Credit/Debit Card (Stripe)
                    fields:
                      - name: secret_key
                        label: Secret Key
                        placeholder: sk_live_... or rk_live_...
                        required: true
                        max: 255
                        secret: true
                        showCallback: false
                        mode: ''
                        isSet: false
                        value: ''
                      - name: publishable_key
                        label: Publishable Key
                        placeholder: pk_live_...
                        required: true
                        max: 255
                        secret: false
                        showCallback: false
                        mode: ''
                        isSet: false
                        value: ''
                    toggles:
                      - name: require_billing
                        label: Require Billing Information
                        hint: >-
                          Ask card buyers for their name and billing address at
                          checkout.
                        group: ''
                        needs: ''
                        'on': false
                    unpaidHours: null
                    updatedAt: null
                meta:
                  order: []
                  balance:
                    enabled: false
                    holders: 0
                  unpaid:
                    hours: 24
                    presets:
                      - 1
                      - 2
                    least: 1
                    most: 336
                  routing:
                    providers: []
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const result = await shoply.paymentMethods.list();
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $result = $shoply->paymentMethods->list();
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.paymentMethods.list()
components:
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

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