transactionsGet

POST {{baseUrl}}/transactions/get

The /transactions/get endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype student; coverage may be limited). For transaction history from investments accounts, use the Investments endpoint instead. 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.

Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in /transactions/get. For more details, see Pending and posted transactions.

Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the total_transactions response body field to fetch all available transactions.

Data returned by /transactions/get will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's status.transactions.last_successful_update field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the /transactions/refresh endpoint.

Note that data may not be immediately available to /transactions/get. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with transactions, or upon the first call to /transactions/get, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the INITIAL_UPDATE and HISTORICAL_UPDATE webhooks. If no transaction history is ready when /transactions/get is called, it will return a PRODUCT_NOT_READY error.

Request Body

{"access_token"=>"<string>", "start_date"=>"<string>", "end_date"=>"<string>", "client_id"=>"5fd43aad1186c30013d6f3e2", "options"=>{"account_ids"=>["<string>", "<string>"], "count"=>100, "offset"=>0, "include_original_description"=>false, "include_personal_finance_category_beta"=>false}, "secret"=>"<string>"}

HEADERS

RESPONSES

status: OK

{"accounts":[{"account_id":"\u003cstring\u003e","balances":{"available":"\u003cnumber,null\u003e","current":"\u003cnumber,null\u003e","limit":"\u003cnumber,null\u003e","iso_currency_code":"\u003cstring,null\u003e","unofficial_currency_code":"\u003cstring,null\u003e","last_updated_datetime":"\u003cstring,null\u003e"},"mask":"\u003cstring,null\u003e","name":"\u003cstring\u003e","official_name":"\u003cstring,null\u003e","type":"\u003cstring\u003e","subtype":"\u003cstring,number\u003e","verification_status":"\u003cstring\u003e"},{"account_id":"\u003cstring\u003e","balances":{"available":"\u003cnumber,null\u003e","current":"\u003cnumber,null\u003e","limit":"\u003cnumber,null\u003e","iso_currency_code":"\u003cstring,null\u003e","unofficial_currency_code":"\u003cstring,null\u003e","last_updated_datetime":"\u003cstring,null\u003e"},"mask":"\u003cstring,null\u003e","name":"\u003cstring\u003e","official_name":"\u003cstring,null\u003e","type":"\u003cstring\u003e","subtype":"\u003cstring,number\u003e","verification_status":"\u003cstring\u003e"}],"transactions":[{"pending_transaction_id":"\u003cstring,null\u003e","category_id":"\u003cstring,null\u003e","category":"\u003carray,null\u003e","location":{"address":"\u003cstring,null\u003e","city":"\u003cstring,null\u003e","region":"\u003cstring,null\u003e","postal_code":"\u003cstring,null\u003e","country":"\u003cstring,null\u003e","lat":"\u003cnumber,null\u003e","lon":"\u003cnumber,null\u003e","store_number":"\u003cstring,null\u003e"},"payment_meta":{"reference_number":"\u003cstring,null\u003e","ppd_id":"\u003cstring,null\u003e","payee":"\u003cstring,null\u003e","by_order_of":"\u003cstring,null\u003e","payer":"\u003cstring,null\u003e","payment_method":"\u003cstring,null\u003e","payment_processor":"\u003cstring,null\u003e","reason":"\u003cstring,null\u003e"},"account_owner":"\u003cstring,null\u003e","name":"\u003cstring\u003e","account_id":"\u003cstring\u003e","amount":"\u003cnumber\u003e","iso_currency_code":"\u003cstring,null\u003e","unofficial_currency_code":"\u003cstring,null\u003e","date":"\u003cstring\u003e","pending":"\u003cboolean\u003e","transaction_id":"\u003cstring\u003e","payment_channel":"\u003cstring\u003e","authorized_date":"\u003cstring,null\u003e","authorized_datetime":"\u003cstring,null\u003e","datetime":"\u003cstring,null\u003e","transaction_code":"\u003cstring\u003e","original_description":"\u003cstring,null\u003e","merchant_name":"\u003cstring,null\u003e","check_number":"\u003cstring,null\u003e","personal_finance_category":{"primary":"\u003cstring\u003e","detailed":"\u003cstring\u003e"}},{"pending_transaction_id":"\u003cstring,null\u003e","category_id":"\u003cstring,null\u003e","category":"\u003carray,null\u003e","location":{"address":"\u003cstring,null\u003e","city":"\u003cstring,null\u003e","region":"\u003cstring,null\u003e","postal_code":"\u003cstring,null\u003e","country":"\u003cstring,null\u003e","lat":"\u003cnumber,null\u003e","lon":"\u003cnumber,null\u003e","store_number":"\u003cstring,null\u003e"},"payment_meta":{"reference_number":"\u003cstring,null\u003e","ppd_id":"\u003cstring,null\u003e","payee":"\u003cstring,null\u003e","by_order_of":"\u003cstring,null\u003e","payer":"\u003cstring,null\u003e","payment_method":"\u003cstring,null\u003e","payment_processor":"\u003cstring,null\u003e","reason":"\u003cstring,null\u003e"},"account_owner":"\u003cstring,null\u003e","name":"\u003cstring\u003e","account_id":"\u003cstring\u003e","amount":"\u003cnumber\u003e","iso_currency_code":"\u003cstring,null\u003e","unofficial_currency_code":"\u003cstring,null\u003e","date":"\u003cstring\u003e","pending":"\u003cboolean\u003e","transaction_id":"\u003cstring\u003e","payment_channel":"\u003cstring\u003e","authorized_date":"\u003cstring,null\u003e","authorized_datetime":"\u003cstring,null\u003e","datetime":"\u003cstring,null\u003e","transaction_code":"\u003cstring\u003e","original_description":"\u003cstring,null\u003e","merchant_name":"\u003cstring,null\u003e","check_number":"\u003cstring,null\u003e","personal_finance_category":{"primary":"\u003cstring\u003e","detailed":"\u003cstring\u003e"}}],"total_transactions":"\u003cinteger\u003e","item":{"item_id":"\u003cstring\u003e","webhook":"\u003cstring,null\u003e","error":{"error_type":"\u003cstring\u003e","error_code":"\u003cstring\u003e","error_message":"\u003cstring\u003e","display_message":"\u003cstring,null\u003e","request_id":"\u003cstring\u003e","causes":["\u003cobject\u003e","\u003cobject\u003e"],"status":"\u003cnumber,null\u003e","documentation_url":"\u003cstring\u003e","suggested_action":"\u003cstring\u003e"},"available_products":["\u003cstring\u003e","\u003cstring\u003e"],"billed_products":["\u003cstring\u003e","\u003cstring\u003e"],"consent_expiration_time":"\u003cstring,null\u003e","update_type":"\u003cstring\u003e","institution_id":"\u003cstring,null\u003e","products":["\u003cstring\u003e","\u003cstring\u003e"]},"request_id":"\u003cstring\u003e"}