List transaction category rules | Sample

3 body fields

Transaction rule listing details for an end user.

client_idstringoptional

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.

secretstringoptional

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.

client_user_idstringrequired

A unique ID representing the end user whose rules should be listed.

2 status codes

200Returns an array of the user's transaction category rules and a request identifier.

rulesarray<TransactionsCategoryRule>required

A list of the user's transaction rules

request_idstringrequired

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

defaultReturns an error object containing an error type, error code, error message, display message, and related troubleshooting information.

error_typestringrequired

A broad categorization of the error. Safe for programmatic use.

Allowed:INVALID_REQUESTINVALID_RESULTINVALID_INPUTINSTITUTION_ERRORRATE_LIMIT_EXCEEDEDAPI_ERRORITEM_ERRORASSET_REPORT_ERRORBASE_REPORT_ERRORRECAPTCHA_ERROROAUTH_ERRORPAYMENT_ERROR

error_codestringrequired

The particular error code. Safe for programmatic use.

error_code_reasonstringoptional

The specific reason for the error code. Currently, reasons are only supported for OAuth-based item errors; `null` will be returned otherwise. Safe for programmatic use. Possible values: `OAUTH_INVALID_TOKEN`: The user's OAuth connection to this institution has been invalidated. `OAUTH_CONSENT_EXPIRED`: The user's access consent for this OAuth connection to this institution has expired. `OAUTH_USER_REVOKED`: The user's OAuth connection to this institution is invalid because the user revoked their connection.

error_messagestringrequired

A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.

display_messagestringrequired

A user-friendly representation of the error code. `null` if the error is not related to user action. This may change over time and is not safe for programmatic use.

request_idstringoptional

A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.

causesarrayoptional

In this product, a request can pertain to more than one Item. If an error is returned for such a request, `causes` will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified. `causes` will be provided for the `error_type` `ASSET_REPORT_ERROR` or `CHECK_REPORT_ERROR`. `causes` will also not be populated inside an error nested within a `warning` object.

statusintegeroptional

The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.

documentation_urlstringoptional

The URL of a Plaid documentation page with more information about the error

suggested_actionstringoptional

Suggested steps for resolving the error

required_account_subtypesarray<string>optional

A list of the account subtypes that were requested via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product.

provided_account_subtypesarray<string>optional

A list of the account subtypes that were extracted but did not match the requested subtypes via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product.

Error handling

client_user_id is required and must identify the end user whose transaction rules you want to list.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { apiKey: process.env.API_KEY },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.list.create({
  clientUserId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  clientId: "c0a80123-4567-89ab-cdef-0123456789ab",
  secret: "sk_live_4eC39Hq",
});

{
  "rules": [
    {
      "id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNo",
      "user_id": "usr_9nSp2KuZ2x4JDw",
      "created_at": "2022-02-28T11:00:00Z",
      "updated_at": "2022-02-28T11:00:00Z",
      "pfc_primary_category": "FOOD_AND_DRINK",
      "pfc_detailed_category": "FOOD_AND_DRINK_FAST_FOOD",
      "rule_details": {
        "field": "MERCHANT_NAME",
        "type": "SUBSTRING_MATCH",
        "query": "Burger Shack"
      }
    },
    {
      "id": "eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBF",
      "user_id": "usr_9nSp2KuZ2x4JDw",
      "created_at": "2022-02-27T14:50:00Z",
      "updated_at": "2022-02-27T14:50:00Z",
      "pfc_primary_category": "TRANSFER_IN",
      "pfc_detailed_category": "TRANSFER_IN_ACCOUNT_TRANSFER",
      "rule_details": {
        "field": "TRANSACTION_ID",
        "type": "EXACT_MATCH",
        "query": "kgygNvAVPzSX9KkddNdWHaVGRVex1MHm3k9no"
      }
    }
  ],
  "request_id": "4zlKapIkTm8p5KM"
}

Request

Response

Errors