Open Register

Opens a register, creating a new register session with the given opening balances. Requires the Create Register Session (p/c-register-session) permission on the register's location. Fails if the register is already open, or if the same client_id already has another register open. Note the returned register object may still reflect the pre-open state; fetch the sessions list or register detail afterwards to get the new session.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Register id.

Body Params
string
required

Caller-chosen identifier of the client/device opening the register.

balances
array of objects | null

Opening balances per payment type.

balances
Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

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