Bank Transactions

Overview

From the Bank Transactions endpoint, you can retrieve and refresh 24 months of historical bank transaction data, including geolocation, merchant, and category information from the business' banking service provider. See Bank Transactions endpoint for more details..

❗️
Railz does not support pushing bank transactions to banking service providers.

Data Model

Field	Type	Description
id sortable, filterable	string	The unique ID of the transaction. Case sensitive.
accountId sortable, filterable	string	The ID of the bank account in which this transaction occurred.
date sortable, filterable	string See Date	For pending transactions, the date that the transaction occurred; for posted transactions, the date that the transaction posted.
authorizedOnDate sortable, filterable	string See Date	The date that the transaction was authorized.
isPending sortable, filterable	boolean	When true, identifies the transaction as pending or unsettled.
amount sortable, filterable	decimal	The settled value of the transaction, denominated in the account's currency, as stated in currency. Positive values when money moves out of the account; negative values when money moves in. For example, debit card purchases are positive; credit card payments, direct deposits, and refunds are negative.
currency	string	The ISO-4217 currency code of the transaction or unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
transactionType sortable, filterable	string	An identifier classifying the transaction type. This field is only populated for European institutions. For institutions in the US and Canada, this field is set to null. Possible values: `adjustment`, `atm`, `bankCharge`, `billPayment`, `cash`, `cashback`, `cheque`, `directDebit`, `interest`, `purchase`, `standingOrder`, `transfer`
paymentChannel sortable, filterable	string	The channel used to make a payment. Possible values: `online`, `inStore`, `other`
categories	array	A hierarchical array of the categories to which this transaction belongs. See Plaid Categories for more details.
merchantName sortable, filterable	string	The merchant name, as extracted by Plaid.
merchantStoreNumber	string	The merchant defined store number where the transaction occurred.
description	string	The merchant name or transaction description.
location	object	A location representing where a transaction took place.

Location

Field	Type	Description
line1	string	Line 1 of the address.
line2	string	Line 2 of the address.
city	string	City of the address.
region	string	Region of the address.
country	string	Country of the address as 3 ISO alpha-3 characters. See Country
postalCode	string	Postal code or zip code of the address.

Example Data

{
  "data":
  [
    {
      "id": "lPNjeW1nR6CDn5okmGQ6hEpMo4lLNoSrzqDje",
      "accountId": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",
      "date": "2017-01-29",
      "authorizedOnDate": "2017-01-29",
      "isPending": false,
      "amount": 100,
      "currency": "CAD",
      "transactionType": "debit",
      "paymentChannel": "online",
      "categories":
      [
        "Shops",
        "Computers and Electronics"
      ],
      "merchantName": "Apple",
      "merchantStoreNumber": "1235",
      "description": "Apple Store",
      "location":
      {
        "line1": "300 Post St",
        "line2": "string",
        "city": "San Francisco",
        "region": "CA",
        "country": "USA",
        "postalCode": "94108"
      }
    }
  ]
}