transactionsSync
POST {{baseUrl}}/transactions/sync
The /transactions/sync
endpoint returns item transactions as a set of delta updates.
Subsequent calls to the endpoint using the cursor returned in the response will return new added, modified, and removed transactions since the last call to the endpoint
The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
Request Body
{"access_token"=>"<string>", "client_id"=>"5fd43aad1186c30013d6f3e2", "secret"=>"<string>", "cursor"=>"<string>", "count"=>100}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"added":[{"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"}}],"modified":[{"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"}}],"removed":[{"transaction_id":"\u003cstring\u003e"},{"transaction_id":"\u003cstring\u003e"}],"next_cursor":"\u003cstring\u003e","has_more":"\u003cboolean\u003e","request_id":"\u003cstring\u003e"}