> ## 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 custom payment methods

> The store's custom payment methods. Where each stands at checkout among the connected methods is `meta.order` in "List payment methods". `meta.max` is how many a store may have, and `meta.variables` the words its instructions and address may fill in.

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



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/custom-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}/custom-payment-methods:
    get:
      tags:
        - Custom payment methods
      summary: List custom payment methods
      description: >-
        The store's custom payment methods. Where each stands at checkout among
        the connected methods is `meta.order` in "List payment methods".
        `meta.max` is how many a store may have, and `meta.variables` the words
        its instructions and address may fill in.


        Needs the `payments.read` permission (Read Payment Methods).
      operationId: customMethods.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:
                        id:
                          type: string
                        kind:
                          type: string
                        name:
                          type: string
                        description:
                          type: string
                        instructions:
                          type: string
                        redirectUrl:
                          type: string
                        iconUrl:
                          nullable: true
                        asksProof:
                          type: boolean
                        requiresPicture:
                          type: boolean
                        enabled:
                          type: boolean
                  meta:
                    type: object
                    properties:
                      max:
                        type: integer
                      variables:
                        type: array
                        items:
                          type: string
              example:
                success: true
                message: null
                code: null
                data:
                  - id: custom_1e22c55a4dc40fc7
                    kind: redirect
                    name: Pay on Our Site
                    description: ''
                    instructions: ''
                    redirectUrl: https://pay.example.com/checkout?order={order}
                    iconUrl: null
                    asksProof: false
                    requiresPicture: false
                    enabled: true
                  - id: custom_c009621ccc3e9d74
                    kind: instructions
                    name: Bank Transfer (EU)
                    description: One to two working days
                    instructions: >-
                      Send **{amount} {currency}** to DE89 3704 0044 0532 0130
                      00, with `{order}` as the reference.
                    redirectUrl: ''
                    iconUrl: null
                    asksProof: false
                    requiresPicture: false
                    enabled: true
                meta:
                  max: 10
                  variables:
                    - order
                    - amount
        '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.customMethods.list();
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

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

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

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.customMethods.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.