GET
/
transaction
/
aggregation

Authorizations

X-API-Key
string
headerrequired

Authentication from public API requests

Query Parameters

accountId
string
deprecated

Use filter:accountId to filter by account ID

Pass in a legal entity ID to filter transactions by accounts under a specific legal entity.

filter:accountId
string

Pass in an account ID to filter transactions by account ID. This will return all transactions that match the account ID passed in.

filter:virtualAccountId
string

Pass in a virtual account ID to filter transactions by virtual account ID. This will return all transactions that match the virtual account ID passed in.

filter:from_date
string

Pass in a unix timestamp in milliseconds to filter transactions by date. This will return all transactions that occurred on or after the date passed in.

filter:to_date
string

Pass in a unix timestamp in milliseconds to filter transactions by date. This will return all transactions that occurred on or before the date passed in.

filter:from_authorized_at
string

Pass in a unix timestamp in milliseconds to filter transactions by authorization time. This will return all transactions that are authorized on or after the date passed in.

filter:to_authorized_at
string

Pass in a unix timestamp in milliseconds to filter transactions by authorization time. This will return all transactions that are authorized on or before the date passed in.

filter:status
enum<string>

Filter transactions by status

Available options:
pending,
posted,
failed
filter:detailed_status
enum<string>

Filter transactions by detailed status

Available options:
pending,
canceled,
failed,
settled,
declined,
refund,
reversed,
returned,
dispute
filter:cardId
string

Filter transactions by cardId

Response

200 - application/json
count
number
required

The total count of transactions.

totalIn
number
required

The total amount of money that arrived into the account, in cents.

totalOut
number
required

The total amount of money that was sent out of the account, in cents.

netChange
number
required

The net change, which is totalIn + totalOut.