Skip to navigation

Get bank-reported transaction

View as Markdown

Returns a single bank-reported transaction line for a treasury account.

These records reflect activity supplied by your bank (for example through reconciliation or balance reporting). You cannot create or modify them through the API.

Path parameters

ParameterTypeRequiredDescription
account_idUUIDYesTreasury account identifier
bank_transaction_idUUIDYesBank transaction identifier

Response fields (data)

FieldTypeDescription
idUUIDOpaque identifier for this ingested bank line.
amount_in_minor_unitsIntegerTransaction amount in the smallest unit of the currency.
currency_codeStringISO 4217 currency code.
descriptionStringBank-reported transaction type description.
sender_infoStringSender name or reference from bank continuation text, when available. Omitted when unknown.
receiver_infoStringReceiver name or reference from bank continuation text, when available. Omitted when unknown.
continuation_textStringRaw bank-reported continuation text. Format varies by bank; treat as opaque. Omitted when the bank sent none.
directionStringcredit or debit, when known. Omitted when unknown.
transaction_dateDateBank-reported transaction date, when available. Omitted when unknown.

Success Responses

Status CodeDescription
200OK — bank-reported transaction

Error Responses

Status CodeError CodeDescription
401AUTHENTICATION_ERRORAuthentication credentials are invalid or missing
403AUTHORIZATION_ERRORYou do not have permission to perform this action
404NOT_FOUNDTreasury account or bank transaction not found

Authentication

x-api-keystring

RootPay API key sent in the x-api-key header. Keys are environment-scoped: live_* for production, test_* for sandbox.

Path parameters

account_idstringRequiredformat: "uuid"
Main operating account ID.
bank_transaction_idstringRequiredformat: "uuid"
Bank transaction ID.

Response

Successful Response
dataobject

Bank-reported activity line for a treasury account (TreasuryBankTransaction).

warningstring or nullOptional