API Reference

List payment types

get
https://{domain_prefix}.retail.lightspeed.app/api/2026-04/payment_types

Returns a paginated collection of payment types.

🔒 Requires: payment_types:read scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64

The lower limit for the version numbers to be included in the response.

int64

The upper limit for the version numbers to be included in the response.

integer

The maximum number of items to be returned in the response.

boolean

If true, includes deleted payment types in the response.

string

Filters payment types by outlet. Only effective when the payment_type_controls feature is enabled.

string

Filters payment types by currency code (ISO 4217, e.g. "AUD", "USD").

boolean

If true, returns only LSPay payment types.

Response

Updated 2 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago