Skip to main content
POST
List transactions

Authorizations

API-KEY
string
header
required

Your partner API key.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Path Parameters

userId
string
required

The customer — a cus_… reference id.

Example:

"cus_3HfG8kLp2QwE7rTy9UiO"

Body

application/json

All fields are optional.

page
integer

Zero-based page index.

size
integer

Page size. 0 returns every transaction.

sortBy
string

field,direction. createdOn,desc is recommended; the default order is not meaningful.

status
string

One status, e.g. COMPLETE.

endlTransactionMode
string[]

Match any of these modes.

depositType
string[]

Match any of these deposit types.

recipientType
string[]

Match any of these recipient types.

sourceCurrency
string[]

Match any of these source currencies.

sentOrReceived
string

Sent or Received.

dateRange
enum<string>

Window to filter by. Default ALL_TIME.

Available options:
ALL_TIME,
YESTERDAY,
LAST_7_DAYS,
SINGLE,
CUSTOM
startDate
string

DD-MM-YYYY, UTC. With SINGLE or CUSTOM.

endDate
string

DD-MM-YYYY, UTC. With CUSTOM.

Recipient first or last name. Not the txn_ id: use Get transaction for that.

Response

A page of the customer's transactions. Unwrapped.

txns
object[]

The page of transaction objects.

totalCount
integer

Matches across all pages.