Lightspeed Commerce Payment Types API

openapi: 3.2.0
info:
  contact:
    email: x-series.api@lightspeedhq.com
    name: Lightspeed Developer Relations
    url: https://developers.retail.lightspeed.app
  description: Lightspeed Retail (X-Series) API.
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://developers.lightspeedhq.com/terms
  title: 2026-07 Payment Types API
  version: 2026-07
servers:
- url: https://{domain_prefix}.retail.lightspeed.app/api/2026-07
  variables:
    domain_prefix:
      default: example
      description: Domain prefix of the store to be operated on
security:
- bearerAuth: []
tags:
- description: Payment Type operations
  name: Payment Types
paths:
  /payment_types:
    get:
      description: 'Returns a paginated collection of payment types.


        🔒 Requires: `payment_types:read` scope'
      operationId: ListPaymentTypes
      parameters:
      - description: The lower limit for the version numbers to be included in the response.
        in: query
        name: after
        schema:
          format: int64
          type: integer
      - description: The upper limit for the version numbers to be included in the response.
        in: query
        name: before
        schema:
          format: int64
          type: integer
      - description: The maximum number of items to be returned in the response.
        in: query
        name: page_size
        schema:
          type: integer
      - description: If true, includes deleted payment types in the response.
        in: query
        name: deleted
        schema:
          type: boolean
      - description: Filters payment types by outlet. Only effective when the payment_type_controls feature is enabled.
        in: query
        name: outlet_id
        schema:
          type: string
      - description: Filters payment types by currency code (ISO 4217, e.g. "AUD", "USD").
        in: query
        name: currency
        schema:
          type: string
      - description: If true, returns only LSPay payment types.
        in: query
        name: only_lspay
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                - id: 0adaafb3-6583-11e5-fb60-fd093076e9d3
                  name: Gift Card
                  type_id: 118
                  version: 1120194938
                - config:
                    url: /pay/dc85058a-a683-11e5-e112-51cc5a8ffc96
                  id: dc85058a-a683-11e5-e112-51cc5a8ffc96
                  name: Loyalty
                  type_id: 106
                  version: 342955
                - config:
                    print: true
                    url: https://sec.paymentexpress.com/pxmi/logon
                  id: dc85058a-a683-11e5-ef46-0b1f0d167dea
                  name: DPS
                  type_id: 3
                  version: 297938
                version:
                  max: 1120194938
                  min: 297938
              schema:
                $ref: '#/components/schemas/PaymentTypeCollection'
          description: ''
      summary: List payment types
      tags:
      - Payment Types
components:
  schemas:
    GlobalPaymentType:
      description: The global (platform-level) payment type definition associated with a retailer payment type.
      properties:
        badge:
          description: URL of the payment type badge image.
          type:
          - string
          - 'null'
        category:
          description: The category of the payment type.
          type: string
        configuration_url:
          description: URL for configuring this payment type.
          type:
          - string
          - 'null'
        description:
          description: A description of the payment type.
          type:
          - string
          - 'null'
        header:
          description: The display header for the payment type.
          type:
          - string
          - 'null'
        id:
          description: The global payment type ID.
          format: int64
          type: integer
        internal:
          description: Indicates if this is an internal payment type.
          type: boolean
        logo:
          description: URL of the payment type logo.
          type:
          - string
          - 'null'
        name:
          description: The name of the global payment type.
          type: string
        online_only:
          description: Indicates if this payment type is available online only.
          type: boolean
        platforms:
          description: The platforms on which this payment type is supported.
          items:
            type: string
          type:
          - array
          - 'null'
        referred_inactive:
          description: Indicates if the payment type was referred but is inactive.
          type: boolean
        show_banner:
          description: Indicates if a banner should be shown for this payment type.
          type: boolean
        subcategory:
          description: The subcategory of the payment type.
          type: string
        subtext:
          description: Additional display text shown below the payment type name.
          type:
          - string
          - 'null'
      required:
      - id
      - name
      - internal
      - platforms
      - category
      - subcategory
      - referred_inactive
      - show_banner
      - online_only
      type: object
    PaymentTypeCollection:
      properties:
        data:
          description: An array of payment types.
          items:
            $ref: '#/components/schemas/PaymentType'
          type: array
        version:
          $ref: '#/components/schemas/Version'
      required:
      - data
      - version
      type: object
    Version:
      description: An object containing the highest and lowest version numbers for all items of the returned collection.
      properties:
        max:
          description: Highest version number of the payload, or `null` when the result set is empty.
          format: int64
          type:
          - integer
          - 'null'
        min:
          description: Lowest version number of the payload, or `null` when the result set is empty.
          format: int64
          type:
          - integer
          - 'null'
      required:
      - max
      - min
      type: object
    PaymentType:
      properties:
        config:
          additionalProperties: true
          description: Payment type configuration. Shape varies by payment type.
          type:
          - object
          - 'null'
        created_at:
          description: The creation timestamp.
          format: date-time
          type:
          - string
          - 'null'
        deleted_at:
          description: The deletion timestamp.
          format: date-time
          type:
          - string
          - 'null'
        disabled:
          description: Indicates if the payment type is disabled.
          type: boolean
        gateway:
          description: Indicates if the payment type is a gateway type.
          type: boolean
        id:
          description: Auto-generated object ID.
          type: string
        internal:
          description: Indicates if the payment type is for internal use only.
          type: boolean
        is_editable:
          description: Indicates if the payment type can be edited. Omitted when not applicable.
          type:
          - boolean
          - 'null'
        name:
          description: The name of the payment type.
          type: string
        name_changed_by_user:
          description: Indicates if the name was customised by the retailer.
          type: boolean
        outlet_ids:
          description: The list of outlet IDs this payment type is associated with.
          items:
            type: string
          type:
          - array
          - 'null'
        payment_type:
          $ref: '#/components/schemas/GlobalPaymentType'
        type_id:
          description: The ID of the global payment type. It shouldn't be used to identify the payment type - there may be multiple payment types with the same `type_id`.
          type: integer
        version:
          description: Auto-incrementing object version number.
          format: int64
          type: integer
      required:
      - id
      - name
      - type_id
      - version
      - disabled
      - internal
      type: object
  securitySchemes:
    bearerAuth:
      description: Bearer Token for API authentication.
      scheme: bearer
      type: http
externalDocs:
  description: List of tz database time zones
  url: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones