Bank Transactions

GET /banking/bank-transactions

Group: Banking › Bank Transactions · Operation ID: bankTransactions

Returns a list of bank transactions. To filter by bank account or legal entity, use POST banking/bank-transactions/search.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
bankTransactionNumber — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
externalTransactionId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
externalPaymentId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
externalCreationDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
currency — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
matchStatus — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, bankTransactionNumber, externalTransactionId, externalCreationDate, amount, currency, matchStatus, lastModifiedDate
Selectable: id, bankTransactionNumber, externalTransactionId, externalPaymentId, endToEndId, externalCreationDate, description, externalDescription, additionalInformation, payeeOrPayor, amount, currency, matchStatus, notes, transactionPaymentMethod, accountName, sourceBankName, entityName, lastModifiedDate

Response

200 Success

Under data, an array of bankTransactionsRow:

Field	Type	Required	Description
`id`	string	no	The unique identifier for the bank transaction.
`bankTransactionNumber`	string or null	no	The bank transaction number. Absent until one has been assigned.
`externalTransactionId`	string	no	The identifier this transaction has in the bank or aggregator it was imported from. Unique across transactions.
`externalPaymentId`	string or null	no	The end-to-end payment identifier supplied by the integration, where the bank provides one.
`endToEndId`	string or null	no	A payment reference recovered from the external transaction data by the integration.
`externalCreationDate`	string (date)	no	The date the transaction was created in the source bank, not the date it was imported. Format YYYY-MM-DD.
`description`	string or null	no	The description recorded on the transaction.
`externalDescription`	string or null	no	The description as the bank supplied it, unmodified.
`additionalInformation`	string or null	no	Any additional detail the bank supplied with the transaction.
`payeeOrPayor`	string or null	no	The name of the counterparty the money went to or came from.
`amount`	string (decimal) or null	no	The transaction amount, as a decimal in the transaction currency. A negative amount is money leaving the account and a positive amount is money arriving.
`currency`	string or null	no	The currency of the transaction. Format ISO 4217, for example 'USD'. It governs the amount.
`matchStatus`	string or null	no	The reconciliation state of the transaction, computed from its matches. The states are 'unmatched', 'suggested', 'pending', 'matched', 'autoMatched' and 'needsAttention'.
`notes`	string or null	no	Free-form notes recorded against the transaction.
`transactionPaymentMethod`	string or null	no	How the payment was made, as reported by the integration. The values are 'ACH', 'WIRE' and 'Unknown'.
`accountName`	string or null	no	The name of the linked chart-of-accounts account. Suffixed with '(Inactive)' when the account link is broken.
`sourceBankName`	string or null	no	The name of the bank the account is held at.
`entityName`	string or null	no	The name of the legal entity the owning bank account belongs to.
`lastModifiedDate`	string (date-time) or null	no	The date and time the bank transaction last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error