Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Content-Type must be set to application/json
Path Parameters
The UUID of the business to fetch bank transactions for
Query Parameters
Comma-separated list of reference numbers to filter transactions. Only transactions with reference numbers matching any value in this list will be returned.
The start date of the transaction range to fetch.
The end date of the transaction range to fetch.
The direction of the transaction to fetch.
INFLOW
, OUTFLOW
The categorization status of the transaction to fetch.
CATEGORIZED
, UNCATEGORIZED
, PENDING
, MATCHED
The minimum amount of the transaction to fetch.
The maximum amount of the transaction to fetch.
Substring to search for in description transactions. Only exact matches will be returned.
Regex to search for in description transactions. Regex will be parsed exactly as given and an error will be returned if the regex is invalid.
Comma-separated list of external account (e.g. Plaid account) IDs. This will filter for bank transactions within the provided list of accounts.
Filter transactions by exact memo match.
Filter transactions where memo contains this substring.
UUID of the customer to filter transactions by.
External ID of the customer to filter transactions by.
UUID of the vendor to filter transactions by.
External ID of the vendor to filter transactions by.
Filter transactions by whether they are matched (true) or not matched (false).
Filter transactions by category identifier or stable name.
Filter transactions by whether they are categorized (true) or not categorized (false).
Substring to search for in merchant name. Only exact matches will be returned.
Regex to search for in merchant name. Regex will be parsed exactly as given and an error will be returned if the regex is invalid.
Response
Unique identifier of the bank transaction
Unique identifier of the business the bank transaction is associated with
Source of the transaction.
UNIT
, PLAID
, API
, STRIPE
, CUSTOM
External transaction ID from the source platform (e.g, Plaid transaction ID)
"g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko"
External account ID from the source platform (e.g, Plaid account ID)
"Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG"
Timestamp when the transaction was imported
Date of the transaction
Direction of the transaction.
CREDIT
, DEBIT
Transaction amount in cents
Name of the transaction counterparty
"WeWork"
Description of the transaction.
"WeWork monthly rent payment"
Name of the bank account
"Plaid Checking"
The status of the transaction’s categorization in Layer’s systems.
PENDING
, READY_FOR_INPUT
, CATEGORIZED
, SPLIT
, LAYER_REVIEW
, JOURNALING
, MATCHED
The category assigned to the transaction. Only populated for transactions that have a finalized category.
The method used to classify the transaction.
SMS
, API
, LAYER_AUTO
, LAYER_MANUAL
REVENUE
, EXPENSE
, EXCLUDE
Memo for any text you would like to associate with the bank transaction (for example, to display to end users).
Arbitrary custom metadata in JSON format with a size limit of 10KB
{
"custom_field": "value",
"any valid json": "below 10kb",
"nested": { "meaning of life": 42, "array": [] }
}
Any (typically user-visible) identifier you would like to associate with the bank transaction. Can be used to filter when listing bank transactions.