GET
View a register payment method
Company space For: Manager · Permission: register_payment_methods.retrieve 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.

Path Parameters

registerPaymentMethod
string
required

Identifier of the register payment method (27-character KSUID).

Query Parameters

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

200 - application/json

Resource.

id

Identifier of the register payment method (27-character KSUID).

company_id

Identifier of the company the record belongs to.

organization_id

Identifier of the organization the record belongs to.

cash_register_id

Identifier of the cash register the method belongs to.

payment_method

Payment method code, for example cash.

supports_incoming
boolean

True when the register can receive payments with this method on this money account, narrowed to the company's current grant and the account's activity.

supports_outgoing
boolean

True when the register can pay out with this method on this money account, narrowed in the same way.

money_account_id

Identifier of the money account receiving or paying the funds; null for cash.

label

Display label; for money accounts the account name followed by the method.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).