POST /transactions/recurring/get
The /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 an Item that has already been initialized with Transactions (either during Link, by specifying it in /link/token/create
; or after Link, by calling /transactions/get
or /transactions/sync
).
When using Recurring Transactions, for best results, make sure to use the days_requested
parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call /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 /transactions/sync
listen for the SYNC_UPDATES_AVAILABLE
webhook and check that the historical_update_complete
field in the payload is true
. If using /transactions/get
, listen for the HISTORICAL_UPDATE
webhook.
After the initial call, you can call /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.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
client_id |
String | No |
Your Plaid API |
options |
Object | No |
An optional object to be used with the request. If specified, |
options.include_personal_finance_category |
Boolean | No |
Personal finance categories are now returned by default. Default value: false |
access_token |
String | Yes |
The access token associated with the Item data is being requested for. |
secret |
String | No |
Your Plaid API |
account_ids[] |
Array | No |
An optional list of Note: An error will be returned if a provided |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.