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

# List payment methods

> Retrieve a list of all active payment methods available for your store. This endpoint returns details such as the payment provider, configuration status, and availability, allowing you to manage and display supported payment options in your checkout flow.



## OpenAPI

````yaml GET /2023-11/admin/payment-methods
openapi: 3.0.3
info:
  title: Genuka V2 - API
  version: 1.0.0
  contact: {}
servers:
  - url: https://api-staging.genuka.com
  - url: https://api.genuka.com
security:
  - bearerAuth: []
tags:
  - name: Public Routes
  - name: Pages
  - name: Collections
  - name: Shops
  - name: Products
  - name: Articles
  - name: Discounts
  - name: Blogs
  - name: Company
  - name: Review
    description: |-
      ``` json
      {
      "title": "",
      "quantity": "",
      "product_variant": "",
      "date": "",
      "company_id": "",
      "shops": []
      }

       ```
  - name: Private Routes
  - name: Authentication
  - name: Apps
  - name: Accounting
  - name: Addresses
  - name: Customer
  - name: Analytics
  - name: Articles1
  - name: Availabilities
  - name: API Keys
  - name: Orders
  - name: Bills
  - name: Blogs1
  - name: Calendar Events
  - name: Collections1
  - name: Company1
  - name: Customers
  - name: Deliveries
    description: |-
      ``` json
      {
      "title": "",
      "quantity": "",
      "product_variant": "",
      "date": "",
      "company_id": "",
      "shops": []
      }

       ```
  - name: Discount
  - name: Domains
    description: |-
      ``` json
      {
      "domain": "",
      "company_id": ""
      }

       ```
  - name: Analytics1
  - name: Orders1
  - name: Payments
  - name: Pages1
  - name: Production
  - name: Bill of Materials
  - name: Payments1
  - name: Payments Methods
  - name: Workflows
  - name: New Folder
  - name: Wallet
  - name: Marketing
  - name: Campaigns
  - name: Templates
  - name: Products1
  - name: Product Variants
  - name: Analytics12
  - name: Services
    description: >-
      Services are "Products" that have a duration in minutes, a buffer time and
      a list of users able to provide the service.
  - name: SupplierProducts
  - name: Shops1
    description: >-
      Shops are sort of subsidiary of companies. A Company can have many Shops.
      Each shop can have 0 or more .  
        
      But all of them are properties of a Company.
  - name: Warehouses
    description: >-
      Warehouses are places where stocks are placed.


      Shop which are physical or virtual point of sales can be attached to one
      or many warehouses to take their products.
  - name: Stocks
    description: |-
      ``` json
      {
      "title": "",
      "quantity": "",
      "product_variant": "",
      "date": "",
      "company_id": "",
      "shops": []
      }

       ```
  - name: Review1
    description: |-
      ``` json
      {
      "title": "",
      "quantity": "",
      "product_variant": "",
      "date": "",
      "company_id": "",
      "shops": []
      }

       ```
  - name: ReviewCriterion
    description: |-
      ``` json
      {
      "title": "",
      "quantity": "",
      "product_variant": "",
      "date": "",
      "company_id": "",
      "shops": []
      }

       ```
  - name: StockMovements
    description: |-
      ``` json
      {
      "title": "",
      "quantity": "",
      "product_variant": "",
      "date": "",
      "company_id": "",
      "shops": []
      }

       ```
  - name: Suppliers
  - name: Treasury Accounts
    description: Comptes de trésorerie
  - name: Users
  - name: Wrapped
  - name: Returns
  - name: Webhooks
  - name: Customer Routes
  - name: Authentication1
  - name: Addresses1
  - name: Orders12
  - name: Payments12
  - name: Review12
    description: |-
      ``` json
      {
      "title": "",
      "quantity": "",
      "product_variant": "",
      "date": "",
      "company_id": "",
      "shops": []
      }

       ```
  - name: Developer Routes
  - name: Authentication12
  - name: Apps1
  - name: Apps Shortcut
  - name: Products12
    description: Developer can access a company product through its app
paths:
  /2023-11/admin/payment-methods:
    get:
      tags:
        - Private Routes
        - Payments Methods
      summary: List
      description: List
      operationId: list15
      parameters:
        - name: page
          in: query
          schema:
            type: string
            example: '1'
        - name: per_page
          in: query
          schema:
            type: string
            example: '10'
        - name: include
          in: query
          schema:
            type: string
            example: treasuryAccount
        - name: anonymous
          in: query
          schema:
            type: string
            example: 'false'
        - name: x-company
          in: header
          schema:
            type: string
            example: '{{companyId}}'
        - name: x-shopid
          in: header
          schema:
            type: string
            example: 01hhfyppk2jxvz7rwbxnpnbqfb
      responses:
        '200':
          description: 200 OK
          headers:
            Cache-Control:
              schema:
                type: string
                example: no-cache, private
            Connection:
              schema:
                type: string
                example: keep-alive
            Content-Encoding:
              schema:
                type: string
                example: gzip
            Date:
              schema:
                type: string
                example: Fri, 10 Oct 2025 10:34:14 GMT
            Server:
              schema:
                type: string
                example: nginx/1.18.0 (Ubuntu)
            Transfer-Encoding:
              schema:
                type: string
                example: chunked
            Vary:
              schema:
                type: string
                example: Origin
            X-RateLimit-Limit:
              schema:
                type: string
                example: '6000'
            X-RateLimit-Remaining:
              schema:
                type: string
                example: '5984'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        account_id:
                          nullable: true
                          example: null
                        company_id:
                          type: string
                          example: 01hqydxwtxdj3kmzp3bz7jk73g
                        configurations:
                          example: []
                          anyOf:
                            - type: array
                              items: {}
                              example: []
                            - type: object
                              properties:
                                api_token:
                                  type: string
                                  example: '********************************'
                        id:
                          type: string
                          example: 01k1d8sk6mz3r0fyqwmqr1y9k7
                        metadata:
                          nullable: true
                          example: null
                        name:
                          type: string
                          example: Cash
                        processor:
                          type: string
                          example: cash
                        status:
                          type: number
                          example: 1
                        treasury_account:
                          type: object
                          properties:
                            accounting_account_code:
                              type: string
                              example: '571'
                            balance:
                              type: number
                              example: 26894
                            company_id:
                              type: string
                              example: 01hqydxwtxdj3kmzp3bz7jk73g
                            created_at:
                              type: string
                              example: '2025-07-29T09:32:00.000000Z'
                            id:
                              type: string
                              example: 01k1amypn6xycwe7w948jp82zm
                            label:
                              type: string
                              example: Cash
                            logoUrl:
                              nullable: true
                              example: null
                            metadata:
                              type: object
                              properties:
                                connected_api:
                                  type: boolean
                                  example: false
                                currency_code:
                                  type: string
                                  example: XAF
                                currency_name:
                                  type: string
                                  example: FCFA
                                notification:
                                  type: boolean
                                  example: false
                            shop_id:
                              nullable: true
                              example: null
                            type:
                              type: string
                              example: cash
                            updated_at:
                              type: string
                              example: '2025-10-03T10:35:05.000000Z'
                        treasury_account_id:
                          type: string
                          example: 01k1amypn6xycwe7w948jp82zm
                    example:
                      - account_id: null
                        company_id: 01hqydxwtxdj3kmzp3bz7jk73g
                        configurations: []
                        id: 01k1d8sk6mz3r0fyqwmqr1y9k7
                        metadata: null
                        name: Cash
                        processor: cash
                        status: 1
                        treasury_account:
                          accounting_account_code: '571'
                          balance: 26894
                          company_id: 01hqydxwtxdj3kmzp3bz7jk73g
                          created_at: '2025-07-29T09:32:00.000000Z'
                          id: 01k1amypn6xycwe7w948jp82zm
                          label: Cash
                          logoUrl: null
                          metadata:
                            connected_api: false
                            currency_code: XAF
                            currency_name: FCFA
                            notification: false
                          shop_id: null
                          type: cash
                          updated_at: '2025-10-03T10:35:05.000000Z'
                        treasury_account_id: 01k1amypn6xycwe7w948jp82zm
                      - account_id: null
                        company_id: 01hqydxwtxdj3kmzp3bz7jk73g
                        configurations:
                          api_token: '********************************'
                        id: 01k1d8vxr5dbcjpm0gh2yqaf59
                        metadata: null
                        name: PawaPay
                        processor: pawapay
                        status: 1
                        treasury_account:
                          accounting_account_code: '538'
                          balance: 37934
                          company_id: 01hqydxwtxdj3kmzp3bz7jk73g
                          created_at: '2025-07-30T09:58:30.000000Z'
                          id: 01k1d8vxr0xdthhtb6zy1e97dt
                          label: PawaPay
                          logoUrl: null
                          metadata:
                            connected_api: true
                            currency_code: XAF
                            currency_name: FCFA
                            notification: true
                          shop_id: null
                          type: pawapay
                          updated_at: '2025-10-03T10:35:13.000000Z'
                        treasury_account_id: 01k1d8vxr0xdthhtb6zy1e97dt
                  links:
                    type: object
                    properties:
                      first:
                        type: string
                        example: >-
                          http://genuka-api.test/2023-11/admin/payment-methods?page=1
                      last:
                        type: string
                        example: >-
                          http://genuka-api.test/2023-11/admin/payment-methods?page=1
                      next:
                        nullable: true
                        example: null
                      prev:
                        nullable: true
                        example: null
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: number
                        example: 1
                      from:
                        type: number
                        example: 1
                      last_page:
                        type: number
                        example: 1
                      links:
                        type: array
                        items:
                          type: object
                          properties:
                            active:
                              type: boolean
                              example: false
                            label:
                              type: string
                              example: '&laquo; Previous'
                            page:
                              type: number
                              nullable: true
                              example: null
                            url:
                              type: string
                              nullable: true
                              example: null
                        example:
                          - active: false
                            label: '&laquo; Previous'
                            page: null
                            url: null
                          - active: true
                            label: '1'
                            page: 1
                            url: >-
                              http://genuka-api.test/2023-11/admin/payment-methods?page=1
                          - active: false
                            label: Next &raquo;
                            page: null
                            url: null
                      path:
                        type: string
                        example: http://genuka-api.test/2023-11/admin/payment-methods
                      per_page:
                        type: number
                        example: 10
                      to:
                        type: number
                        example: 2
                      total:
                        type: number
                        example: 2
              examples:
                200 OK:
                  value:
                    data:
                      - account_id: null
                        company_id: 01hqydxwtxdj3kmzp3bz7jk73g
                        configurations: []
                        id: 01k1d8sk6mz3r0fyqwmqr1y9k7
                        metadata: null
                        name: Cash
                        processor: cash
                        status: 1
                        treasury_account:
                          accounting_account_code: '571'
                          balance: 26894
                          company_id: 01hqydxwtxdj3kmzp3bz7jk73g
                          created_at: '2025-07-29T09:32:00.000000Z'
                          id: 01k1amypn6xycwe7w948jp82zm
                          label: Cash
                          logoUrl: null
                          metadata:
                            connected_api: false
                            currency_code: XAF
                            currency_name: FCFA
                            notification: false
                          shop_id: null
                          type: cash
                          updated_at: '2025-10-03T10:35:05.000000Z'
                        treasury_account_id: 01k1amypn6xycwe7w948jp82zm
                      - account_id: null
                        company_id: 01hqydxwtxdj3kmzp3bz7jk73g
                        configurations:
                          api_token: '********************************'
                        id: 01k1d8vxr5dbcjpm0gh2yqaf59
                        metadata: null
                        name: PawaPay
                        processor: pawapay
                        status: 1
                        treasury_account:
                          accounting_account_code: '538'
                          balance: 37934
                          company_id: 01hqydxwtxdj3kmzp3bz7jk73g
                          created_at: '2025-07-30T09:58:30.000000Z'
                          id: 01k1d8vxr0xdthhtb6zy1e97dt
                          label: PawaPay
                          logoUrl: null
                          metadata:
                            connected_api: true
                            currency_code: XAF
                            currency_name: FCFA
                            notification: true
                          shop_id: null
                          type: pawapay
                          updated_at: '2025-10-03T10:35:13.000000Z'
                        treasury_account_id: 01k1d8vxr0xdthhtb6zy1e97dt
                    links:
                      first: >-
                        http://genuka-api.test/2023-11/admin/payment-methods?page=1
                      last: >-
                        http://genuka-api.test/2023-11/admin/payment-methods?page=1
                      next: null
                      prev: null
                    meta:
                      current_page: 1
                      from: 1
                      last_page: 1
                      links:
                        - active: false
                          label: '&laquo; Previous'
                          page: null
                          url: null
                        - active: true
                          label: '1'
                          page: 1
                          url: >-
                            http://genuka-api.test/2023-11/admin/payment-methods?page=1
                        - active: false
                          label: Next &raquo;
                          page: null
                          url: null
                      path: http://genuka-api.test/2023-11/admin/payment-methods
                      per_page: 10
                      to: 2
                      total: 2
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````