GET
List transactions

Authorizations

X-API-Key
string
header
required

Query Parameters

academyId
integer[]

Academy ids to include. Defaults to all academies the key can access.

Required range: x >= 1
paidFrom
string<date>
required

Start of the window, inclusive. Interpreted as a calendar date in each academy's own timezone, not as a UTC instant. A request covering academies in different timezones therefore reads a different UTC range for each.

paidTo
string<date>
required

End of the window, inclusive, as a calendar date in each academy's own timezone (see paidFrom). Window capped at 366 days.

type
enum<string>[]

Row types to include.

Available options:
payment,
sale,
refund,
chargeback
method
enum<string>[]

Payment methods to include. Refund and chargeback rows never match a method filter.

Available options:
cc,
bank,
manual,
cash,
check,
referral,
invoice,
ideal,
bancontact,
balance,
skipped
membershipId
integer[]

Membership plan ids to include.

Required range: x >= 1
cursor
string

Opaque cursor from a previous page's meta.nextCursor.

perPage
integer
default:100

Number of items per page

Required range: 1 <= x <= 100

Response

Transactions

data
object[]
required
meta
object
required

Pagination block for cursor-paginated lists. There is no total, lastPage, or links block: clients walk forward by passing nextCursor back until it comes back null.