Plaid Spending by Card

info

This endpoint returns Plaid spending categories for a single credit card

HTTP REQUEST

GET /creditcard-plaid-bycard/{cardKey}

RESPONSE

[
  {
    "cardKey": "amex-gold",
    "cardName": "American Express® Gold",
    "cardIssuer": "American Express",
    "baseSpendAmount": 1.0,
    "baseSpendEarnType": "American Express Membership Rewards",
    "baseSpendEarnCategory": "Flex point",
    "baseSpendEarnCurrency": "points",
    "baseSpendEarnValuation": 2.2,
    "baseSpendEarnIsCash": 1,
    "baseSpendEarnCashValue": 0.6,
    "plaidDetailed": [
      {
        "plaidDetailed": "FOOD_AND_DRINK_COFFEE",
        "earnMultiplier": 4.0,
        "isDateLimit": 0,
        "limitBeginDate": "",
        "limitEndDate": "",
        "isSpendLimit": 0,
        "spendLimit": 0,
        "spendLimitResetPeriod": ""
      },
      {
        "plaidDetailed": "FOOD_AND_DRINK_FAST_FOOD",
        "earnMultiplier": 4.0,
        "isDateLimit": 0,
        "limitBeginDate": "",
        "limitEndDate": "",
        "isSpendLimit": 0,
        "spendLimit": 0,
        "spendLimitResetPeriod": ""
      },
      {
        "plaidDetailed": "FOOD_AND_DRINK_GROCERIES",
        "earnMultiplier": 4.0,
        "isDateLimit": 0,
        "limitBeginDate": "",
        "limitEndDate": "",
        "isSpendLimit": 1,
        "spendLimit": 25000,
        "spendLimitResetPeriod": "Year"
      },
      {
        "plaidDetailed": "FOOD_AND_DRINK_OTHER_FOOD_AND_DRINK",
        "earnMultiplier": 4.0,
        "isDateLimit": 0,
        "limitBeginDate": "",
        "limitEndDate": "",
        "isSpendLimit": 0,
        "spendLimit": 0,
        "spendLimitResetPeriod": ""
      },
      {
        "plaidDetailed": "FOOD_AND_DRINK_RESTAURANT",
        "earnMultiplier": 4.0,
        "isDateLimit": 0,
        "limitBeginDate": "",
        "limitEndDate": "",
        "isSpendLimit": 0,
        "spendLimit": 0,
        "spendLimitResetPeriod": ""
      },
      {
        "plaidDetailed": "TRAVEL_FLIGHTS",
        "earnMultiplier": 3.0,
        "isDateLimit": 0,
        "limitBeginDate": "",
        "limitEndDate": "",
        "isSpendLimit": 0,
        "spendLimit": 0,
        "spendLimitResetPeriod": ""
      }
    ]
  }
]

Notes

• Plaid taxonomy list: https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv
• Methodolgy is mapping between Rewards CC cateogries and Plaid taxonomy and is an estimate
• Rates can differ between cards based on MCC codes

Path Parameters

NAME	TYPE	DESCRIPTION	REQUIRED
cardKey	string	unique Rewards CC key ID	Yes

Examples

• /creditcard-plaid-bycard/amex-gold

Response Attributes

NAME	TYPE	DESCRIPTION
cardKey	string	Rewards Credit Card API unique card key
cardName	string	Name of credit card
cardIssuer	string	Issuing bank
baseSpendAmount	number	Points earned per dollar spend
baseSpendEarnType	string	Redemption program (e.g. American AAdvantage)
baseSpendEarnCategory	string	Spend earning category (e.g. Travel)
baseSpendEarnCurrency	string	Spend earning currenty type (rewards, miles, cashback, crypto, points)
baseSpendEarnValuation	string	Spend earning category (e.g. Travel)
baseSpendEarnIsCash	bit	Can points be convered to a statement credit? (0=no, 1=yes)
baseSpendEarnCashValue	number	If points can be cashed out (baseSpendEarnIsCash=1), what is the value per point (eg. AMEX MR can be cashed out at .6 cpp)
plaidDetailed	string	Plaid taxonomy category
earnMultiplier	number	points/miles per dollar
isDateLimit	bit	Is category date limited? (0=no, 1=yes)
limitBeginDate	date	Date spend bonus begins
limitEndDate	date	Date spend bonus ends
isSpendLimit	bit	Is there a spend limit? (0=no, 1=yes)
spendLimit	number	Spent limit amount if applies
spendLimitResetPeriod	string	If spend limit when the limit is reset (eg. Year)

Data Source(s)

Bank websites

Plaid