Transactions

A transaction is an individual entry as it would appear in your bank's portal or statement. Throughout a given business day, the bank may send you pending transactions which are notifications of activity that have not posted yet. Pending transactions will have a posted value of false and are deleted when the posted transactions for that bank account are imported, which typically occurs early the following morning. The posted transactions are the final record of activity for that given business day. The pending and posted transactions will have different IDs.

Given the immutability of posted transactions, none of attributes outside of metadata are editable.

Attribute

Description

id
string

Unique identifier for the transaction.

amount
int32

Value in specified currency's smallest unit. e.g. $10 would represented as 1000.

currency
string

Currency that this transaction is denominated in.

direction
string

Either credit or debit.

vendor_description
string

The transaction detail text that often appears in on your bank statement and in your banking portal.

vendor_code
string

When applicable, the bank-given code that determines the transaction's category. For most banks this is the BAI2/BTRS transaction code.

vendor_code_type
string

The type of vendor_code being reported. Can be one of bai2, swift, cleartouch, or silvergate.

vendor_id
string

An identifier given to this transaction by the bank.

as_of_date
date

The date on which the transaction occurred.

as_of_time
time

The time on which the transaction occurred. Depending on the granularity of the timestamp information received from the bank, it may be null.

internal_account_id
string

The ID of the account for this transaction.

metadata
object

Additional data represented as key-value pairs. Both the key and value must be strings. See Metadata

posted
boolean

This field will be true if the transaction has posted to the account.

vendor_customer_id
string

An identifier given to this transaction by the bank, often null.

reconciled
boolean

This field will be true if a transaction is reconciled by the Modern Treasury system. This means that it has transaction line items that sum up to the transaction's amount.

details
object

This field contains additional information that the bank provided about the transaction. This is structured data. Some of the data in here might overlap with what is in the vendor_description. For example, the OBI could be a part of the vendor description, and it would also be included in here.
The attributes that are passed through the details field will vary based on your banking partner.
Currently, the following keys may be in the details object: originator_name, originator_to_beneficiary_information.

live_mode
boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

type
string

The type of the transaction. Can be one of ach, wire, check, rtp, book, or sen.

{
  "id": "7fb6c79f-5100-4929-8622-a62c247187d8",
  "amount": 20000,
  "currency": "USD",
  "direction": "debit",
  "vendor_description": "Generic Money Transfer",
  "vendor_code": "495",
  "vendor_id": null,
  "as_of_date": "2018-11-07",
  "as_of_time": null,
  "internal_account_id": "dcac4afe-41b5-4963-a1e5-9abc06e99c00",
  "metadata": {},
  "posted": true,
  "vendor_customer_id": null,
  "reconciled": false,
  "details": {},
  "live_mode": true,
  "type": "ach",
  "created_at": "2019-11-09T00:11:07Z",
  "updated_at": "2019-11-09T00:11:07Z"
}