Update POS Settings

PUT 
/api/pos/settings

Update the register settings. Requires a Bearer token with pos.manage.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

• payment_processor (required) — square or stripe.
• square_location_id (optional, nullable) — the Square location the Web Payments SDK initialises against.

The admin toggles (enabled, require_customer, auto_print_receipt) are managed via PUT /api/v2/settings/pos; this endpoint focuses on the operational card-processor config.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.