A transaction is an individual entry of activity reported on statements from a vendor such as bank, or payment processor.
Throughout a given business day, there could be pending transactions which are notifications of activity that is not finalized. Pending transactions will have a posted value of false and are deleted when the posted transactions are imported, which could be at the end of day or early next 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 be 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 on your statement and portal. It can contain remittance information or descriptions about the payment. This field may contain sensitive information and is not included in API responses by default. Learn more about changing your settings here . |
| 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, bankprov, bnk_dev, cleartouch, column,currencycloud, cross_river, dc_bank, dwolla, evolve, goldman_sachs, iso20022, jpmc, mx, plaid, signet, silvergate, swift, us_bank or user. |
| 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 string | The time on which the transaction occurred, formatted as HH:MM:SS. Depending on the granularity of the timestamp information received from the bank, it may be null. |
| as_of_timezone string | The timezone in which the as_of_time is represented, as a database TZ identifier. Can be null if the bank does not provide a time or timezone info. |
| 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 |
| custom_identifiers object | Additional data to be used with reconciliation rules to further enhance custom matching. Similar to the custom_identifiers field in expected payments example. |
| 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. Attributes passed through the details field will vary based on your banking partner.This field may contain personally identifiable information (PII) and is not included in API responses by default. Learn more about changing your settings here. |
| 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. See Payment Orders for a list of possible types. This may not always match the outgoing Payment Order type as banks sometimes transform payments in transit to different rails. |
{
"id": "7fb6c79f-5100-4929-8622-a62c247187d8",
"amount": 20000,
"currency": "USD",
"direction": "debit",
"vendor_code": "495",
"vendor_id": null,
"as_of_date": "2018-11-07",
"as_of_time": "12:34:56,
"as_of_timezone": "America/Los_Angeles",
"internal_account_id": "dcac4afe-41b5-4963-a1e5-9abc06e99c00",
"metadata": {},
"custom_identifiers":{
"buyer_email_address": "[email protected]",
"payment_id": "abc123"
},
"posted": true,
"vendor_customer_id": null,
"reconciled": false,
"live_mode": true,
"type": "ach",
"created_at": "2019-11-09T00:11:07Z",
"updated_at": "2019-11-09T00:11:07Z"
}