Retrieve Transactions by Date Range
POST https://{{env_url}}/transactions/get
The /transactions/get
endpoint allows developers to receive user-authorized transaction data for credit and depository-type Accounts. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available.
You must wait to retrieve transactions after creating an Item
as it takes a couple seconds for Plaid to grab transaction
data initially. If you don't, you will receive a PRODUCT_NOT_READY
error. A good practice is to retrieve the data when you are notified that it's ready via webhook.
Request Body
{"client_id"=>"{{client_id}}", "secret"=>"{{secret_key}}", "access_token"=>"{{access_token}}", "start_date"=>"2023-04-14", "end_date"=>"2024-04-17", "options"=>{"include_personal_finance_category"=>true}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"account":{"account_id":"BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp","balances":{"available":110.94,"current":110.94,"iso_currency_code":"USD","limit":null,"unofficial_currency_code":null},"mask":"0000","name":"Plaid Checking","official_name":"Plaid Gold Standard 0% Interest Checking","subtype":"checking","type":"depository"},"transactions":[{"account_id":"BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp","account_owner":null,"amount":28.34,"iso_currency_code":"USD","unofficial_currency_code":null,"category":["Food and Drink","Restaurants","Fast Food"],"category_id":"13005032","check_number":null,"counterparties":[{"name":"DoorDash","type":"marketplace","logo_url":"https://plaid-counterparty-logos.plaid.com/doordash_1.png","website":"doordash.com","entity_id":"YNRJg5o2djJLv52nBA1Yn1KpL858egYVo4dpm","confidence_level":"HIGH"},{"name":"Burger King","type":"merchant","logo_url":"https://plaid-merchant-logos.plaid.com/burger_king_155.png","website":"burgerking.com","entity_id":"mVrw538wamwdm22mK8jqpp7qd5br0eeV9o4a1","confidence_level":"VERY_HIGH"}],"date":"2023-09-28","datetime":"2023-09-28T15:10:09Z","authorized_date":"2023-09-27","authorized_datetime":"2023-09-27T08:01:58Z","location":{"address":null,"city":null,"region":null,"postal_code":null,"country":null,"lat":null,"lon":null,"store_number":null},"name":"Dd Doordash Burgerkin","merchant_name":"Burger King","merchant_entity_id":"mVrw538wamwdm22mK8jqpp7qd5br0eeV9o4a1","logo_url":"https://plaid-merchant-logos.plaid.com/burger_king_155.png","website":"burgerking.com","payment_meta":{"by_order_of":null,"payee":null,"payer":null,"payment_method":null,"payment_processor":null,"ppd_id":null,"reason":null,"reference_number":null},"payment_channel":"online","pending":true,"pending_transaction_id":null,"personal_finance_category":{"primary":"FOOD_AND_DRINK","detailed":"FOOD_AND_DRINK_FAST_FOOD","confidence_level":"VERY_HIGH"},"personal_finance_category_icon_url":"https://plaid-category-icons.plaid.com/PFC_FOOD_AND_DRINK.png","transaction_id":"yhnUVvtcGGcCKU0bcz8PDQr5ZUxUXebUvbKC0","transaction_code":null,"transaction_type":"digital"},{"account_id":"BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp","account_owner":null,"amount":72.1,"iso_currency_code":"USD","unofficial_currency_code":null,"category":["Shops","Supermarkets and Groceries"],"category_id":"19046000","check_number":null,"counterparties":[{"name":"Walmart","type":"merchant","logo_url":"https://plaid-merchant-logos.plaid.com/walmart_1100.png","website":"walmart.com","entity_id":"O5W5j4dN9OR3E6ypQmjdkWZZRoXEzVMz2ByWM","confidence_level":"VERY_HIGH"}],"date":"2023-09-24","datetime":"2023-09-24T11:01:01Z","authorized_date":"2023-09-22","authorized_datetime":"2023-09-22T10:34:50Z","location":{"address":"13425 Community Rd","city":"Poway","region":"CA","postal_code":"92064","country":"US","lat":32.959068,"lon":-117.037666,"store_number":"1700"},"name":"PURCHASE WM SUPERCENTER #1700","merchant_name":"Walmart","merchant_entity_id":"O5W5j4dN9OR3E6ypQmjdkWZZRoXEzVMz2ByWM","logo_url":"https://plaid-merchant-logos.plaid.com/walmart_1100.png","website":"walmart.com","payment_meta":{"by_order_of":null,"payee":null,"payer":null,"payment_method":null,"payment_processor":null,"ppd_id":null,"reason":null,"reference_number":null},"payment_channel":"in store","pending":false,"pending_transaction_id":"no86Eox18VHMvaOVL7gPUM9ap3aR1LsAVZ5nc","personal_finance_category":{"primary":"GENERAL_MERCHANDISE","detailed":"GENERAL_MERCHANDISE_SUPERSTORES","confidence_level":"VERY_HIGH"},"personal_finance_category_icon_url":"https://plaid-category-icons.plaid.com/PFC_GENERAL_MERCHANDISE.png","transaction_id":"lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje","transaction_code":null,"transaction_type":"place"}],"total_transactions":1,"request_id":"Wvhy9PZHQLV8njG"}