Skip to main content
POST
/
transactions
/
sync
/transactions/sync
curl --request POST \
  --url http://localhost:8080/plaid-compatible/transactions/sync \
  --header 'Content-Type: application/json' \
  --header 'PLAID-CLIENT-ID: <api-key>' \
  --data '{
  "client_id": "<string>",
  "access_token": "<string>",
  "secret": "<string>",
  "cursor": "<string>",
  "count": 123,
  "options": {
    "include_original_description": true,
    "include_personal_finance_category": true
  }
}'
{
  "added": [
    {
      "account_id": "<string>",
      "amount": 123,
      "iso_currency_code": "<string>",
      "category": [
        "<string>"
      ],
      "category_id": "<string>",
      "date": "2023-12-25",
      "name": "<string>",
      "merchant_name": "<string>",
      "original_description": "<string>",
      "pending": true,
      "transaction_id": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "personal_finance_category": {
        "primary": "<string>",
        "detailed": "<string>"
      }
    }
  ],
  "modified": [
    {
      "account_id": "<string>",
      "amount": 123,
      "iso_currency_code": "<string>",
      "category": [
        "<string>"
      ],
      "category_id": "<string>",
      "date": "2023-12-25",
      "name": "<string>",
      "merchant_name": "<string>",
      "original_description": "<string>",
      "pending": true,
      "transaction_id": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "personal_finance_category": {
        "primary": "<string>",
        "detailed": "<string>"
      }
    }
  ],
  "removed": [
    {
      "transaction_id": "<string>"
    }
  ],
  "next_cursor": "<string>",
  "has_more": true,
  "request_id": "<string>"
}

Authorizations

​
PLAID-CLIENT-ID
string
header
required

Headers

​
Plaid-Version
string | null

Body

application/json

TransactionsSyncRequest defines the request schema for /transactions/sync

​
access_token
string
required

The access token associated with the Item data is being requested for.

​
client_id
string | null

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

​
secret
string | null

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

​
cursor
string | null

The cursor value represents the last update requested. Providing it will cause the response to only return changes after this update. If omitted, the entire history of updates will be returned, starting with the first-added transactions on the item. Note: The upper-bound length of this cursor is 256 characters of base64.

​
count
integer | null

The number of transaction updates to fetch.

​
options
object | null

An optional object to be used with the request. If specified, options must not be null.

Response

OK

TransactionsSyncResponse defines the response schema for /transactions/sync

​
added
Transaction · object[]
required

Transactions that have been added to the Item since cursor ordered by ascending last modified time.

​
modified
Transaction · object[]
required

Transactions that have been modified on the Item since cursor ordered by ascending last modified time.

​
removed
RemovedTransaction · object[]
required

Transactions that have been removed from the Item since cursor ordered by ascending last modified time.

​
next_cursor
string
required

Cursor used for fetching any future updates after the latest update provided in this response. The cursor obtained after all pages have been pulled (indicated by has_more being false) will be valid for at least 1 year. This cursor should be persisted for later calls. If transactions are not yet available, this will be an empty string.

​
has_more
boolean
required

Represents if more than requested count of transaction updates exist. If true, the additional updates can be fetched by making an additional request with cursor set to next_cursor. If has_more is true, it’s important to pull all available pages, to make it less likely for underlying data changes to conflict with pagination.

​
request_id
string
required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.