Retrieve Transactions By Incremental Updates

POST https://{{env_url}}/processor/transactions/sync

(replaces /transactions/get and its associated webhooks for most common use-cases)

The /transactions/sync endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. /transactions/sync provides the same functionality as /transactions/get and can be used instead of /transactions/get to simplify the process of tracking transactions updates.

Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API.

In the first call to /transactions/sync for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as adds), which then generates a latest_cursor for that Item. In subsequent calls, send the latest_cursor to receive only the changes that have occurred since the previous call.

Due to the potentially large number of transactions associated with an Item, results are paginated. The has_more field specifies if additional calls are necessary to fetch all available transaction updates.

Whenever new or updated transaction data becomes available, /transactions/sync will provide these updates. 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, use the /transactions/refresh endpoint.

Note that for newly created Items, data may not be immediately available to /transactions/sync. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available.

To be alerted when new data is available, listen for the SYNC_UPDATES_AVAILABLE webhook.

Request Body

{"client_id"=>"{{client_id}}", "secret"=>"{{secret_key}}", "processor_token"=>"{{processor_token}}", "count"=>5}

HEADERS

RESPONSES

status: OK

{"added":[{"account_id":"8gvvg7mvvPHdDrybZ9ozTa5gzvAyEnFZ4y63e","account_owner":null,"amount":5.4,"authorized_date":"2022-05-04","authorized_datetime":null,"category":["Travel","Taxi"],"category_id":"22016000","check_number":null,"date":"2022-05-05","datetime":null,"iso_currency_code":"USD","location":{"address":null,"city":null,"country":null,"lat":null,"lon":null,"postal_code":null,"region":null,"store_number":null},"merchant_name":"Uber","name":"Uber 063015 SF**POOL**","payment_channel":"in store","payment_meta":{"by_order_of":null,"payee":null,"payer":null,"payment_method":null,"payment_processor":null,"ppd_id":null,"reason":null,"reference_number":null},"pending":false,"pending_transaction_id":null,"personal_finance_category":null,"transaction_code":null,"transaction_id":"8gvvg7mvvPHdDrybZ9ozTa5vQ1gvAehKQN7aL","transaction_type":"special","unofficial_currency_code":null},{"account_id":"8gvvg7mvvPHdDrybZ9ozTa5gzvAyEnFZ4y63e","account_owner":null,"amount":-500,"authorized_date":"2022-05-03","authorized_datetime":null,"category":["Travel","Airlines and Aviation Services"],"category_id":"22001000","check_number":null,"date":"2022-05-03","datetime":null,"iso_currency_code":"USD","location":{"address":null,"city":null,"country":null,"lat":null,"lon":null,"postal_code":null,"region":null,"store_number":null},"merchant_name":"United Airlines","name":"United Airlines","payment_channel":"other","payment_meta":{"by_order_of":null,"payee":null,"payer":null,"payment_method":null,"payment_processor":null,"ppd_id":null,"reason":null,"reference_number":null},"pending":false,"pending_transaction_id":null,"personal_finance_category":null,"transaction_code":null,"transaction_id":"EJnnJAKnnWt56Gw3JAQrUXvq6G4qrwC9A68Ql","transaction_type":"special","unofficial_currency_code":null},{"account_id":"8gvvg7mvvPHdDrybZ9ozTa5gzvAyEnFZ4y63e","account_owner":null,"amount":12,"authorized_date":"2022-05-02","authorized_datetime":null,"category":["Food and Drink","Restaurants","Fast Food"],"category_id":"13005032","check_number":null,"date":"2022-05-02","datetime":null,"iso_currency_code":"USD","location":{"address":null,"city":null,"country":null,"lat":null,"lon":null,"postal_code":null,"region":null,"store_number":"3322"},"merchant_name":"McDonald's","name":"McDonald's","payment_channel":"in store","payment_meta":{"by_order_of":null,"payee":null,"payer":null,"payment_method":null,"payment_processor":null,"ppd_id":null,"reason":null,"reference_number":null},"pending":false,"pending_transaction_id":null,"personal_finance_category":null,"transaction_code":null,"transaction_id":"W3pp3ZMppAu5p6KyJQqwURz16oJ13dtwNB3Mj","transaction_type":"place","unofficial_currency_code":null},{"account_id":"8gvvg7mvvPHdDrybZ9ozTa5gzvAyEnFZ4y63e","account_owner":null,"amount":4.33,"authorized_date":"2022-05-02","authorized_datetime":null,"category":["Food and Drink","Restaurants","Coffee Shop"],"category_id":"13005043","check_number":null,"date":"2022-05-02","datetime":null,"iso_currency_code":"USD","location":{"address":null,"city":null,"country":null,"lat":null,"lon":null,"postal_code":null,"region":null,"store_number":null},"merchant_name":"Starbucks","name":"Starbucks","payment_channel":"in store","payment_meta":{"by_order_of":null,"payee":null,"payer":null,"payment_method":null,"payment_processor":null,"ppd_id":null,"reason":null,"reference_number":null},"pending":false,"pending_transaction_id":null,"personal_finance_category":null,"transaction_code":null,"transaction_id":"AJ44JgV44WtZBAQDEJXjTMbyqjxy7Ei6VBLwx","transaction_type":"place","unofficial_currency_code":null},{"account_id":"8gvvg7mvvPHdDrybZ9ozTa5gzvAyEnFZ4y63e","account_owner":null,"amount":89.4,"authorized_date":"2022-04-30","authorized_datetime":null,"category":["Food and Drink","Restaurants"],"category_id":"13005000","check_number":null,"date":"2022-05-01","datetime":null,"iso_currency_code":"USD","location":{"address":null,"city":null,"country":null,"lat":null,"lon":null,"postal_code":null,"region":null,"store_number":null},"merchant_name":"Sparkfun","name":"SparkFun","payment_channel":"in store","payment_meta":{"by_order_of":null,"payee":null,"payer":null,"payment_method":null,"payment_processor":null,"ppd_id":null,"reason":null,"reference_number":null},"pending":false,"pending_transaction_id":null,"personal_finance_category":null,"transaction_code":null,"transaction_id":"GJRRJqzRR6t5AMRvalb3U9WrxenrPqSANZK9K","transaction_type":"place","unofficial_currency_code":null}],"has_more":true,"modified":[],"next_cursor":"CAESJUdKUlJKcXpSUjZ0NUFNUnZhbGIzVTlXcnhlbnJQcVNBTlpLOUsiDAjVvIWUBhCA1ZTWAyoMCNi8hZQGEIDt+LUC","removed":[],"request_id":"L7cfpY21SIa7IgK"}