GET
List register payment methods
Company space For: Manager · Permission: register_payment_methods.list Conditions
  • sort_by is one of label, payment_method or created_at.
Part of Set up cash registers.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cash_register_id
string | null

Returns only the payment methods of this cash register.

Required string length: 27
money_account_id
string | null

Returns only the payment methods linked to this money account.

Required string length: 27
payment_method
enum<string> | null

Returns only this payment method (a PaymentMethodEnum value, for example cash).

Available options:
cash,
credit_card,
bank_transfer,
mobile_money,
cheque,
other
label
string | null

Returns only payment methods whose label contains this text.

Maximum string length: 100
per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
label,
payment_method,
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, company_id, organization_id, cash_register_id, payment_method, supports_incoming, supports_outgoing, money_account_id, label, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource.

data
RegisterPaymentMethodResource · object[]
required

Items of this page.

meta
object
required

Pagination details.