Skip to main content
GET
List Payments

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
per_page
integer | null
sort_by
string | null
sort_direction
enum<string> | null
Available options:
asc,
desc
location_id
string | null
id
string | null
payer
string | null
external_patient_id
string | null
payer_type
string | null
amount
integer[] | null
last4
string | null
comment
string | null
payment_mediums
string[] | null
status
enum<string>[] | null
Available options:
CANCELED,
CREATED,
FAILED,
IN_REVIEW,
PRESENTING,
PROCESSING,
SUCCEEDED
type
string | null
tags
string[] | null
created_date
tz
string | null
location_ids
string[] | null
creator_name
string | null
merchant_account_ids
string[] | null

Response

Successful Response

items
Page[PaymentTableItem] · object
required
hasInsurancePayments
boolean
required