Skip to main content
Required scopes: payments_read

Arguments

String
Forward pagination cursor — returns items after it. Cursors are positions in the filtered list, so a row can shift onto another page if new activity lands in the requested range.
String
Backward pagination cursor — returns items before it. Cursors are positions in the filtered list, so a row can shift onto another page if new activity lands in the requested range.
Inclusive first order date, as a US Eastern (America/New_York) calendar day. Rejected when it is after dateTo.
Inclusive last order date, as a US Eastern (America/New_York) calendar day.
Int
Forward pagination: returns the first N items (max 100, default 25). Use with after; mutually exclusive with last/before.
Int
Backward pagination: returns the last N items (max 100, default 25). Use with before; mutually exclusive with first/after.
Matches order reference, checkout id, receipt number, merchant reference, or customer name. Fewer than 2 characters is rejected.

Returns

A paginated list of PaymentTransaction items.

Example