Skip to main content
POST
/
transactions
/
get
/transactions/get
curl --request POST \
  --url http://localhost:8080/plaid-compatible/transactions/get \
  --header 'Content-Type: application/json' \
  --header 'PLAID-CLIENT-ID: <api-key>' \
  --data '{
  "client_id": "<string>",
  "options": {
    "account_ids": [
      "<string>"
    ],
    "count": 123,
    "offset": 123,
    "include_original_description": true,
    "include_personal_finance_category": true
  },
  "access_token": "<string>",
  "secret": "<string>",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25"
}'
{
  "accounts": [
    {
      "account_id": "<string>",
      "balances": {
        "available": 123,
        "current": 123,
        "limit": 123,
        "iso_currency_code": "<string>"
      },
      "mask": "<string>",
      "name": "<string>",
      "type": "investment",
      "subtype": {}
    }
  ],
  "transactions": [
    {
      "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>"
      }
    }
  ],
  "total_transactions": 123,
  "item": {
    "item_id": "<string>",
    "institution_id": "<string>",
    "webhook": "<string>",
    "error": {
      "error_type": "INVALID_REQUEST",
      "error_code": "<string>",
      "error_message": "<string>",
      "display_message": "<string>",
      "request_id": "<string>",
      "causes": [
        {}
      ],
      "status": 123,
      "documentation_url": "<string>",
      "suggested_action": "<string>"
    },
    "available_products": [
      "transactions"
    ],
    "billed_products": [
      "transactions"
    ],
    "products": [
      "transactions"
    ],
    "consented_products": [
      "transactions"
    ]
  },
  "request_id": "<string>"
}

Authorizations

​
PLAID-CLIENT-ID
string
header
required

Headers

​
Plaid-Version
string | null

Body

application/json

TransactionsGetRequest defines the request schema for /transactions/get

​
access_token
string
required

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

​
start_date
string<date>
required

The earliest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.

​
end_date
string<date>
required

The latest date for which data should be returned. Dates should be formatted as YYYY-MM-DD.

​
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.

​
options
object | null

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

​
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.

Response

OK

TransactionsGetResponse defines the response schema for /transactions/get

​
accounts
AccountBase · object[]
required

An array containing the accounts associated with the Item for which transactions are being returned. Each transaction can be mapped to its corresponding account via the account_id field.

​
transactions
Transaction · object[]
required

An array containing transactions from the account. Transactions are returned in reverse chronological order, with the most recent at the beginning of the array. The maximum number of transactions returned is determined by the count parameter.

​
total_transactions
integer
required

The total number of transactions available within the date range specified. If total_transactions is larger than the size of the transactions array, more transactions are available and can be fetched via manipulating the offset parameter.

​
item
object
required

Metadata about the Item.

​
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.