List payments

get

https://api.smoothpos.net/payments.json

Returns payments across all your sales, oldest first.

Results are paged (50 per page by default, up to 250 with limit). If there's another page, you'll get an X-Next-Page header. Request that path to continue.

See Filtering, sorting and search for how the filters, ranges and sort work.

Required permission (any one of these):

Group	Permission
Sales	List and view sale payments
Sales	Record payments (includes view)

Query Params

limit

integer

1 to 250

Defaults to 50

How many results per page. Defaults to 50, maximum 250.

cursor

string

Paging cursor. Don't build it yourself; take the whole path from the X-Next-Page header.

payment_methods

string

Comma-separated list matched against payment_method_id.

sales

string

Comma-separated list matched against sale_id.

stores

string

Comma-separated list matched against store_id.

register_in

string

Comma-separated list matched against register.

amount_less_than

string

Up to (including) the amount.

amount_greater_than

string

From (including) the amount.

ids

string

Comma-separated list matched against id.

since_id

integer

Greater than (not including) the id.

serial_number

string

Exact match on serial_number.

payment_method_id

string

^\d+(,\d+)*$

Matches one payment method id or a comma-separated list (up to 200).

sale_id

string

^\d+(,\d+)*$

Matches one sale id or a comma-separated list (up to 200).

store_id

string

^\d+(,\d+)*$

Matches one store id or a comma-separated list (up to 200).

string

^\d+(,\d+)*$

Matches one register or a comma-separated list (up to 200).

min_amount

number

Minimum amount, inclusive.

max_amount

number

Maximum amount, inclusive.

created_from

string

From this created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

created_to

string

Up to this created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

string

Text search: matches records where any of name, serial_number contains this text (up to 200 characters).

sort

string

Sort order. Use sort=key for ascending or sort=-key for descending, for example sort=-created. Keys: id, created, amount. The older sort_field=key&sort=asc|desc style still works.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

404Not found, or your X-Smoothpos-Auth token is missing or invalid. (Smooth POS uses 404 for auth failures too.) Possible error messages: no payments found not authorised