Fetch recurring transaction streams
Changed onThe /processor/transactions/recurring/get endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user's checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments.
This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in /link/token/create; or after Link, by calling /processor/transactions/get or /processor/transactions/sync). Once all historical transactions have been fetched, call /processor/transactions/recurring/get to receive the Recurring Transactions streams and subscribe to the RECURRING_TRANSACTIONS_UPDATE webhook. To know when historical transactions have been fetched, if you are using /processor/transactions/sync listen for the SYNC_UPDATES_AVAILABLE webhook and check that the historical_update_complete field in the payload is true. If using /processor/transactions/get, listen for the HISTORICAL_UPDATE webhook.
After the initial call, you can call the /processor/transactions/recurring/get endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the RECURRING_TRANSACTIONS_UPDATE webhook to be notified when new updates are available.
To receive Transactions webhooks for a processor token, set its webhook URL via the /processor/token/webhook/update endpoint.
Request
- Base URLhttps://production.plaid.com
- URLhttps://production.plaid.com/processor/transactions/recurring/get
- AuthAPI key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version
Request body
Response
OK
Changes
- warning
added the new
CRA_PARTNER_INSIGHTS_ERRORenum value to theresponse property for the response status - warning
added the new
CRA_REPORT_ERRORenum value to theresponse property for the response status
- warning
- warning
added the new
ASSETS_ERRORenum value to theresponse property for the response status - warning
added the new
CRA_MONITORING_ERRORenum value to theresponse property for the response status - warning
added the new
CREDIT_PROFILE_REPORT_ERRORenum value to theresponse property for the response status - warning
added the new
ENCOMPASS_ERRORenum value to theresponse property for the response status - warning
added the new
ENRICH_ERRORenum value to theresponse property for the response status - warning
added the new
FRAUD_INSIGHTS_ERRORenum value to theresponse property for the response status - warning
added the new
FREDDIE_MAC_ERRORenum value to theresponse property for the response status - warning
added the new
LINK_DELIVERY_ERRORenum value to theresponse property for the response status - warning
added the new
PROFILE_ERRORenum value to theresponse property for the response status - warning
added the new
RECURRING_TRANSACTIONS_ERRORenum value to theresponse property for the response status - warning
added the new
STATEMENTS_ERRORenum value to theresponse property for the response status - warning
added the new
TRANSFER_RECURRING_ERRORenum value to theresponse property for the response status - warning
added the new
TRANSFER_REFUND_ERRORenum value to theresponse property for the response status
- warning