Skip to main content
GET
List payments

Authorizations

Authorization
string
header
required

API key from Developers → API Keys, sent as Authorization: Bearer .

Query Parameters

page
integer
Required range: x >= 1
page_size
integer
Required range: 1 <= x <= 100
cursor
string

Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.

sort
string

attr[,attr]:asc|desc — sortable: id, amount, payment_type_id, patient_id, location_id, updated, created, payment_date, status

id
string

Filter: operator:value

amount
string

Filter: operator:value

payment_type_id
string

Filter: operator:value

patient_id
string

Filter: operator:value

location_id
string

Filter: operator:value

service
string

Filter: operator:value

service_id
string

Filter: operator:value

third_party
string

Filter: operator:value

third_party_id
string

Filter: operator:value

note
string

Filter: operator:value

updated
string

Filter: operator:value

created
string

Filter: operator:value

payment_date
string

Filter: operator:value

status
string

Filter: operator:value

metadata
object

Filter by integrator metadata: metadata[key]=operator:value

Response

Page of payments

data
object[]
meta
object