Skip to main content
The Recurring Transactions response separates recurring transactions into inflows (income) and outflows (expenses), with details about frequency, amounts, and status.

​
Inflow attributes

AttributeTypeDescription
source_idstringUnique identifier of the income source
source_namestringName of the income source (e.g. employer name)
account_idstringID of the associated account
descriptionstringTransaction description
frequencystringPayment frequency (WEEKLY, BIWEEKLY, MONTHLY, etc.)
average_amountstringAverage payment amount
median_amountstringMedian payment amount
last_amountstringMost recent payment amount
logo_urlstringLogo URL for the source
statusstringactive, inactive, or irregular
income_typestringType of income (e.g. salary)
first_detectedstringDate first detected (YYYY-MM-DD)
last_transaction_datestringDate of most recent transaction
next_expected_datestringPredicted next payment date
historical_transactionsarray of objectsPast transactions for this source

​
Outflow attributes

AttributeTypeDescription
source_idstringUnique identifier of the expense source
source_namestringName of the merchant or service
account_idstringID of the associated account
categoriesarray of stringsAssigned categories
descriptionstringTransaction description
merchant_category_codestringISO 18245 category code
frequencystringPayment frequency
statusstringactive, inactive, or irregular
average_amountstringAverage payment amount
median_amountstringMedian payment amount
last_amountstringMost recent payment amount
logo_urlstringLogo URL for the merchant
first_detectedstringDate first detected (YYYY-MM-DD)
last_transaction_datestringDate of most recent transaction
next_expected_datestringPredicted next payment date
historical_transactionsarray of objectsPast transactions for this source

​
Endpoints

​
Example response

{
  "recurring_transactions": {
    "inflows": [
      {
        "source_id": "a1b2c3d4e5f6789012345678abcdef01",
        "source_name": "Acme Corp",
        "account_id": "24d7e80942ce4ad58a93f70ce4115f5c",
        "description": "Salary",
        "frequency": "BIWEEKLY",
        "average_amount": "3500.00",
        "median_amount": "3500.00",
        "last_amount": "3500.00",
        "status": "active",
        "income_type": "salary",
        "first_detected": "2024-01-01",
        "last_transaction_date": "2024-11-15",
        "next_expected_date": "2024-11-29"
      }
    ],
    "outflows": [
      {
        "source_id": "f9e8d7c6b5a4321098765432fedcba10",
        "source_name": "Netflix",
        "account_id": "24d7e80942ce4ad58a93f70ce4115f5c",
        "categories": ["Entertainment"],
        "description": "NETFLIX.COM",
        "frequency": "MONTHLY",
        "status": "active",
        "average_amount": "15.99",
        "median_amount": "15.99",
        "last_amount": "15.99",
        "first_detected": "2024-01-15",
        "last_transaction_date": "2024-11-15",
        "next_expected_date": "2024-12-15"
      }
    ]
  }
}