POST
/
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

Response

200
application/json

OK

TransactionsSyncResponse defines the response schema for /transactions/sync