Get Bank Transaction

GET /banking/bank-transactions/{id}

Group: Banking › Bank Transactions · Operation ID: getBankTransaction

Returns the bank transaction with the given identifier. Use the transaction's id, not its bankTransactionNumber.

A bank transaction is a single movement of funds on a bank account. There is no direction field: a negative amount is money out and a positive amount is money in.

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.
id path string yes The unique identifier for the bank transaction to return.

Response

200 Success

Under data (getBankTransactionOutput):

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

Errors

Code Status
NOT_FOUND 400

Statuses