Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Bearer token authentication for agent-scoped endpoints. The token is the accessToken returned when redeeming a device code via POST /agents/device-codes/{code}/redeem. Agent credentials are user-scoped: all requests are automatically bound to the agent's associated customer and subject to the agent's policy.

Query Parameters

accountIdentifier
string

Filter by account identifier (matches either sender or receiver)

senderAccountIdentifier
string

Filter by sender account identifier

receiverAccountIdentifier
string

Filter by receiver account identifier

status
enum<string>

Filter by transaction status Status of a payment transaction.

Available options:
CREATED,
PENDING,
PROCESSING,
COMPLETED,
REJECTED,
FAILED,
REFUNDED,
EXPIRED
type
enum<string>

Filter by transaction type Type of transaction (incoming payment or outgoing payment)

Available options:
INCOMING,
OUTGOING
reference
string

Filter by reference

startDate
string<date-time>

Filter by start date (inclusive) in ISO 8601 format

endDate
string<date-time>

Filter by end date (inclusive) in ISO 8601 format

limit
integer
default:20

Maximum number of results to return (default 20, max 100)

Required range: 1 <= x <= 100
cursor
string

Cursor for pagination (returned from previous request)

sortOrder
enum<string>
default:desc

Order to sort results in

Available options:
asc,
desc

Response

Successful operation

data
(Incoming Transaction · object | Outgoing Transaction · object | Card Transaction · object)[]
required

List of transactions matching the criteria

hasMore
boolean
required

Indicates if more results are available beyond this page

nextCursor
string

Cursor to retrieve the next page of results (only present if hasMore is true)

totalCount
integer

Total number of transactions matching the criteria (excluding pagination)