Skip to main content
GET
List payments

Authorizations

Authorization
string
header
required

Bearer credential for the public API. Vendor integrations should send a live COPE API key (ck_live_*; keys issued earlier as cope_sk_live_* keep working). Clerk bearer tokens are also accepted when paired with X-Cope-Business-Id.

Query Parameters

buyer_email
string

Exact match against the order's buyer email, case-insensitive.

cash_flow_from
string

Inclusive lower bound on cash_flow_at (when funds became available), ISO 8601. A bare date (YYYY-MM-DD) expands to the beginning of that day in UTC; a full date-time is used as given, and timezone-naive values are interpreted as UTC.

cash_flow_to
string

Inclusive upper bound on cash_flow_at (when funds became available), ISO 8601. A bare date (YYYY-MM-DD) expands to the end of that day in UTC; a full date-time is used as given, and timezone-naive values are interpreted as UTC.

created_from
string

Inclusive lower bound on created_at (the sale timestamp), ISO 8601. A bare date (YYYY-MM-DD) expands to the beginning of that day in UTC; a full date-time is used as given, and timezone-naive values are interpreted as UTC.

created_to
string

Inclusive upper bound on created_at (the sale timestamp), ISO 8601. A bare date (YYYY-MM-DD) expands to the end of that day in UTC; a full date-time is used as given, and timezone-naive values are interpreted as UTC.

page
integer

Page number for paginated results. Values below 1 and non-numeric values are ignored and the first page is returned; a page past the last one returns the last page.

Required range: x >= 1
per_page
integer

Number of records per page. Defaults to 12; values above 100 are clamped to 100; values below 1 and non-numeric values are ignored and the default is used.

Required range: 1 <= x <= 100

Response

Successful response

data
object[]
required
pagination
object
required