Plaid
Plaid connects to people's bank, card and loan accounts at thousands of institutions — including card issuers such as American Express that offer no transaction API of their own.
Authentication
- Client ID, secret and Item access token
Actions
- Get accountsList the accounts of the connection's Item — checking, savings, credit cards, loans — with their ids, names, masks, types and the balances Plaid last cached (not fetched live; use plaid:getbalances for a real-time figure).
- Get ItemRead the connection's Item: the institution it is linked to (institutionid, institutionname), the Plaid products billed and available on it, when the end user's consent expires, and any Item error, such as ITEMLOGINREQUIRED when the user must sign in to the bank again.
- Get liabilitiesRead the credit cards, mortgages and student loans of the connection's Item: for a card, the last statement balance, minimum payment, next payment due date and APRs — the scheduled outflows a cashflow forecast needs.
- Get real-time balancesFetch each account's balance live from the institution: available, current and limit, so a credit card's current balance is what is owed right now.
- Get transactionsRead the connection's transactions between two dates, newest first, with the accounts they belong to and totaltransactions for the whole window.
- Sync transactionsPull the transaction changes on the connection's Item since a cursor: transactions added, modified and removed, plus nextcursor and hasmore.
Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.