Skip to main content
Search 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

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
limit
integer
default:25

The page size.

Required range: 1 <= x <= 100

Body

application/json
type
enum<string>[]
Required array length: 1 - 3 elements
Available options:
payment,
refund,
reversal
status
enum<string>[]
Required array length: 1 - 6 elements
Available options:
pending,
processing,
completed,
failed,
cancelled,
unresolved
currency
string[]
conditionally required
Required array length: 1 - 100 elements
Pattern: ^[A-Z]{3}$
amount
object
created_at
object
Required array length: 1 - 100 elements
payout_id
string[]
Required array length: 1 - 100 elements
order_id
string[]
Required array length: 1 - 100 elements
Required string length: 1 - 255
is_test
boolean
default:false

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

q
string

A contains match on the order ID, the transaction number, the name and email given on the payment transaction, and the customer's name as their bank has it.

Required string length: 1 - 255
customer_email
string<email>

An exact match on the email given on the payment transaction.

Maximum string length: 320
Pattern: ^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$

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