Payments
Fetch all payments
Returns a paginated list of payments across all events for the business. Results can be filtered by event ID or date range.
Each payment includes amount breakdowns (charge, tip, tax, fees, net), processor details, and associated event information.
The response includes meta.total_count and meta.per_page for pagination.
Required permission: assigned_event_read_pricing or unassigned_event_read_pricing
get/api/v1/event_payments
Request
- Base URL: https://api.checkcherry.com
- URL: https://api.checkcherry.com/api/v1/event_payments
- Auth: none declared. Required headers: Api-Key
Query parameters
event_idinteger
Filter payments by event ID
payment_date_startstring
Filter payments on or after this date (YYYY-MM-DD)
payment_date_endstring
Filter payments on or before this date (YYYY-MM-DD)
pageinteger
Page number for pagination (default: 1)
perinteger
Number of results per page (default: 25)
Headers
Api-Keystring required
Your Integration Key
Response
payments found
Changes
No recorded changes to this operation across all 2 revisions of this API.