List Payments by Register Session

Lists every payment recorded in a register session (open or closed), including reversals (negative amounts, payment_type suffixed /reversal). Requires the p/r-bill permission on the session's location. Get session ids from GET /locations/registers/sessions/location/{id}. CSV downloads (download=1) of an open session additionally require the p/amount-expected-register-session permission.

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

Register session id.

Query Params
integer

Page number (default 1).

integer

Items per page (default 20).

string

Filter by payment number (substring match).

string

Filter by payment type (substring match — cash also matches cash/reversal).

string

Filter by the bill number the payment was made against (substring match).

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