Find recurring groups in a transaction history

POST

Identifies and categorizes recurring patterns found in the transaction history of the account holder, such as periodic payments or subscriptions. These patterns are called recurrence groups.

Complete guide: Recurrence.

Path parameters

idstringRequired

Response

Successful Response

idstring

A unique UUID identifier for the group

start_datestring

The date of the oldest transaction in the group

end_datestring

The date of the most recent transaction in the group

total_amountdouble

The sum of all transaction amounts in this group

average_amountdouble

The average amount per transaction in this group

periodicity_in_daysdouble

The estimated number of days between transactions in this group

periodicityenum

A human-readable description of the transaction frequency

counterpartyobject

Counterparty of the transactions

categoriesobject

Categories of the transactions in the recurrence group

transaction_idslist of strings

Transactions in this recurrence group

entry_type"incoming" or "outgoing"
Allowed values: incomingoutgoing

The direction of the flow of the money for the transactions within the group.