POST /transactions/enrich

The /transactions/enrich endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.

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
`transactions[]`	Array	Yes	An array of transaction objects to be enriched by Plaid. Maximum of 100 transactions per request.
`transactions[].id`	String	Yes	A unique ID for the transaction used to help you tie data back to your systems.
`transactions[].account_subtype`	String	No	The account subtype associated with the transaction. For a full list of valid types and subtypes, see the Account schema.
`transactions[].mcc`	String	No	Merchant category codes (MCCs) are four-digit numbers that describe a merchant's primary business activities.
`transactions[].description`	String	Yes	The raw description of the transaction. If you have location data in available an unstructured format, it may be appended to the `description` field.
`transactions[].direction`	String	Yes	The direction of the transaction from the perspective of the account holder: `OUTFLOW` - Includes outgoing transfers, purchases, and fees. (Typically represented as a negative value on checking accounts and debit cards and a positive value on credit cards.) `INFLOW` - Includes incoming transfers, refunds, and income. (Typically represented as a positive value on checking accounts and debit cards and a negative value on credit cards.) Possible values: `"OUTFLOW"` `"INFLOW"`
`transactions[].location`	Object	No	A representation of where a transaction took place. Use this field to pass in structured location information you may have about your transactions. Providing location data is optional but can increase result quality. If you have unstructured location information, it may be appended to the `description` field.
`transactions[].location.region`	String	No	The region or state where the transaction occurred.
`transactions[].location.postal_code`	String	No	The postal code where the transaction occurred.
`transactions[].location.country`	String	No	The country where the transaction occurred.
`transactions[].location.city`	String	No	The city where the transaction occurred.
`transactions[].location.address`	String	No	The street address where the transaction occurred.
`transactions[].date_posted`	String	No	The date the transaction posted, in ISO 8601 (YYYY-MM-DD) format.
`transactions[].client_account_id`	String	No	A unique account id used to group transactions for a given account, as a unique identifier from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_account_id.
`transactions[].amount`	Number	Yes	The absolute value of the transaction (>= 0). When testing Enrich, note that `amount` data should be realistic. Unrealistic or inaccurate `amount` data may result in reduced quality output.
`transactions[].client_user_id`	String	No	A unique user id used to group transactions for a given user, as a unique identifier from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.
`transactions[].account_type`	String	No	The account type associated with the transaction. For a full list of valid types and subtypes, see the Account schema.
`transactions[].iso_currency_code`	String	Yes	The ISO-4217 currency code of the transaction e.g. USD.
`client_id`	String	No	Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
`options`	Object	No	An optional object to be used with the request.
`options.include_legacy_category`	Boolean	No	Include `legacy_category` and `legacy_category_id` in the response (in addition to the default `personal_finance_category`). Categories are based on Plaid's legacy taxonomy. For a full list of legacy categories, see `/categories/get`. Default value: false
`secret`	String	No	Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
`account_type`	String	Yes	The account type for the requested transactions (either `depository` or `credit`).

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.