Skip to main content
List transactions

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Minimum string length: 1

Query Parameters

amount:gte
integer

Greater than or equal to this value.

Required range: 0 <= x <= 9007199254740991
amount:gt
integer

Greater than this value.

Required range: 0 <= x <= 9007199254740991
amount:lte
integer

Less than or equal to this value.

Required range: 0 <= x <= 9007199254740991
amount:lt
integer

Less than this value.

Required range: 0 <= x <= 9007199254740991
created_at:gte
string<date-time>

Greater than or equal to this value.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
created_at:gt
string<date-time>

Greater than this value.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
created_at:lte
string<date-time>

Less than or equal to this value.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
created_at:lt
string<date-time>

Less than this value.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$
currency
string[]

The currency amount shows.

Required array length: 1 - 100 elements
Pattern: ^[A-Z]{3}$
cursor
string

An opaque cursor from next_cursor, valid with the filters it was issued for.

Required string length: 1 - 1024
include
enum<string>[]

Link fields to hydrate into entities, comma-separated. Sending it replaces the default, which is nothing.

Available options:
customer_details
is_test
boolean
default:false

Lists test records instead of live ones. One list holds one kind.

limit
integer
default:25

The page size.

Required range: 1 <= x <= 100
order_id
string[]

An exact match.

Required array length: 1 - 100 elements
Required string length: 1 - 255
Required array length: 1 - 100 elements
payout_id
string[]
Required array length: 1 - 100 elements
status
enum<string>[]
Required array length: 1 - 6 elements
Available options:
pending,
processing,
completed,
failed,
cancelled,
unresolved
type
enum<string>[]
Required array length: 1 - 3 elements
Available options:
payment,
refund,
reversal

Response

A list of transaction, in the summary view. Or the whole result as one file, for an Accept that asks for one.

result
object[]
required
entities
object
required

Included linked resources, keyed by URI.

not_included
object[]
required
pagination
object
required