POST
Set register payment methods
Company space For: Manager · Permission: register_payment_methods.create Conditions
  • The cash register must not be locked.
  • At least one of money_accounts, include_cash or cash_supports_outgoing must be provided.
  • Each money account must exist in the company, be active and not duplicated in the request.
  • Each account needs at least one incoming or outgoing method; incoming methods need an account that supports incoming and outgoing methods one that supports outgoing.
  • Each method must be accepted by the account type and be allowed by the current plan.
  • The company must hold an operation grant on the money account for the direction.
What else happens
  • Creates or updates the register payment method for each account and method pair, setting its incoming and outgoing flags and its label.
  • When include_cash or cash_supports_outgoing is true, creates or updates the register’s cash method with those flags. Existing rows not listed are left as they are.
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

response
enum<string>
default:none

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

Available options:
none,
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: .

Body

application/json
cash_register_id
string
required

Identifier of the cash register (27-character KSUID). Required; must belong to the company and not be locked.

Required string length: 27
include_cash
boolean

When true, the cash method is enabled for incoming payments on the register. Default false.

cash_supports_outgoing
boolean

When true, the cash method is enabled for outgoing payments. Default false.

money_accounts
object[]

Money accounts to link, each with the methods accepted. Required when neither include_cash nor cash_supports_outgoing is true.

Response

Resource (only with response=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).