Developers

Search for documents

Dev

Transactions

Operations related to transactions

All endpoints require a JWT Bearer token in the Authorization header.

POST /v1/transactions/aggregated

Get aggregated transaction data

Request body (required)

Read-only Aggregation parameters for transaction data

Field

Type

Required

Description

$match

object

No

The match stage of the aggregation pipeline

$group

object

No

The group stage of the aggregation pipeline

$project

object

No

The project stage of the aggregation pipeline

$sort

object

No

The sort stage of the aggregation pipeline

$limit

number

No

The limit stage of the aggregation pipeline

$skip

number

No

The skip stage of the aggregation pipeline

$lookup

object

No

The lookup stage of the aggregation pipeline

$unwind

string

No

The unwind stage of the aggregation pipeline

$count

string

No

The count stage of the aggregation pipeline

Responses

Status

Description

200

Successfully retrieved aggregated transaction data

POST /v1/transactions/data-summary

Get transaction data summary by UTC day (end-inclusive)

Request body (required)

Filters for transaction data summary. Days are computed in UTC and the end date is end-inclusive

Field

Type

Required

Description

stores

array<string>

Yes

List of store IDs to include in the summary

startDate

string

Yes

Start date/time. UTC day computation uses this lower bound inclusive.

endDate

string

Yes

End date/time (inclusive).

currency

string

Yes

Currency code (server-enforced AvailableCurrencies enum)

Responses

Status

Description

200

Successfully retrieved per-day transaction data summary