---
title: "List payment types"
method: GET
path: "/payment_types"
tags: ["Payment Types"]
---

# List payment types

`GET /payment_types`

Returns a paginated collection of payment types.

🔒 Requires: `payment_types:read` scope

## Query parameters

- `after` integer
- `before` integer
- `page_size` integer
- `deleted` boolean
- `outlet_id` string
- `currency` string
- `only_lspay` boolean

## Response `200`

- PaymentTypeCollection
  - `data` PaymentType[], required — An array of payment types.
    - `config` object, nullable — Payment type configuration. Shape varies by payment type.
    - `created_at` string, date-time, nullable — The creation timestamp.
    - `deleted_at` string, date-time, nullable — The deletion timestamp.
    - `disabled` boolean, required — Indicates if the payment type is disabled.
    - `gateway` boolean — Indicates if the payment type is a gateway type.
    - `id` string, required — Auto-generated object ID.
    - `internal` boolean, required — Indicates if the payment type is for internal use only.
    - `is_editable` boolean, nullable — Indicates if the payment type can be edited. Omitted when not applicable.
    - `name` string, required — The name of the payment type.
    - `name_changed_by_user` boolean — Indicates if the name was customised by the retailer.
    - `outlet_ids` string[], nullable — The list of outlet IDs this payment type is associated with.
    - `payment_type` GlobalPaymentType — The global (platform-level) payment type definition associated with a retailer payment type.
      - `badge` string, nullable — URL of the payment type badge image.
      - `category` string, required — The category of the payment type.
      - `configuration_url` string, nullable — URL for configuring this payment type.
      - `description` string, nullable — A description of the payment type.
      - `header` string, nullable — The display header for the payment type.
      - `id` integer, required — The global payment type ID.
      - `internal` boolean, required — Indicates if this is an internal payment type.
      - `logo` string, nullable — URL of the payment type logo.
      - `name` string, required — The name of the global payment type.
      - `online_only` boolean, required — Indicates if this payment type is available online only.
      - `platforms` string[], nullable, required — The platforms on which this payment type is supported.
      - `referred_inactive` boolean, required — Indicates if the payment type was referred but is inactive.
      - `show_banner` boolean, required — Indicates if a banner should be shown for this payment type.
      - `subcategory` string, required — The subcategory of the payment type.
      - `subtext` string, nullable — Additional display text shown below the payment type name.
    - `type_id` integer, required — 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`.
    - `version` integer, required — Auto-incrementing object version number.
  - `version` Version, required — An object containing the highest and lowest version numbers for all items of the returned collection.
    - `max` integer, nullable, required — Highest version number of the payload, or `null` when the result set is empty.
    - `min` integer, nullable, required — Lowest version number of the payload, or `null` when the result set is empty.

---

[API](https://skmtc.dev/lightspeedhq/apis/api-2026-07.md) · [All operations](https://skmtc.dev/lightspeedhq/apis/api-2026-07/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/lightspeedhq/api-2026-07/revisions/72d4ceb46dbb/schema)