latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

Data Enrichment.Enriched Transactions
REGION.US

List Enriched Transactions

List all enriched transactions for a user.

get/enrichment/v1/transactions

Query parameters

pageSizeinteger

The maximum number of items to return. This endpoint will not return more than 100 transactions per page.

pageTokenstring

The nextPageToken value returned from a previous List request, if any.

statusInstring[]

If set, only transactions with the given status will be returned. This parameter may be repeated to specify multiple statuses.

  • UNDEFINED: The transaction booking status is undefined.
  • PENDING: The transaction is pending at the financial institution.
  • BOOKED: The transaction is booked at the financial institution.
accountIdInstring[]

If set, only transaction with the given account ids will be returned. This parameter may be repeated to specify multiple account ids.

categoryIdInstring[]

If set, only transactions with specified categories will be returned. If a parent category is supplied it will be expanded to its child categories as well.

bookedDateGtestring

Specifies the earliest booked date for filtering transactions (inclusive lower bound). Supports two formats:

  • <b>Local Date:</b> YYYY-MM-DD (e.g., "2024-01-15") - interpreted as start of day UTC
  • <b>Zoned Date Time:</b> ISO-8601 format - exact timestamp
    • 2024-01-15T10:30:00Z
    • 2024-01-15T12:30:00+02:00
    • 2024-01-15T12:30:00.123+02:00

If not provided, the time range starts from the earliest transaction available.

bookedDateLtestring

Specifies the latest booked date for filtering transactions (inclusive upper bound). Supports two formats:

  • <b>Local Date:</b> YYYY-MM-DD (e.g., "2024-01-15") - interpreted as end of day UTC
  • <b>Zoned Date Time:</b> ISO-8601 format - exact timestamp
    • 2024-01-15T10:30:00Z (UTC)
    • 2024-01-15T12:30:00+02:00
    • 2024-01-15T12:30:00.123+02:00

If not provided, the time range extends until today. <b>DEPRECATED:</b> This parameter is deprecated for pagination use cases. Use bookedDateLt instead for closed boundaries and consistent pagination results.

bookedDateLtstring

Specifies the latest booked date for filtering transactions (exclusive upper bound). Only accepts <b>Zoned Date Time</b> in ISO-8601 format.

  • 2024-01-15T10:30:00Z (UTC)
  • 2024-01-15T12:30:00+02:00
  • 2024-01-15T12:30:00.123+02:00

This parameter is designed for pagination with closed boundaries, providing precise cursor-based filtering. Use this when you need exact timestamp filtering for consistent pagination results.

If not provided, the time range extends until today. <b>Note:</b> Cannot be used together with bookedDateLte - bookedDateLt takes precedence.

merchantIdInstring[]

If set, only transactions with specified merchants will be returned. <b>Disclaimer:</b> This filter is only available in selected markets.

brandIdInstring[]

If set, only transactions with specific brands will be returned. <b>Disclaimer:</b> This filter is only available in selected markets.

Response

Returns 200 Ok for successful operation.

Data20EnrichmentEnriched20TransactionsEnriched20Transactions20Response required— unresolved $ref