Get bank-reported transaction

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

Parameter	Type	Required	Description
`account_id`	UUID	Yes	Treasury account identifier
`bank_transaction_id`	UUID	Yes	Bank transaction identifier

Response fields (data)

Field	Type	Description
`id`	UUID	Opaque identifier for this ingested bank line.
`amount_in_minor_units`	Integer	Transaction amount in the smallest unit of the currency.
`currency_code`	String	ISO 4217 currency code.
`description`	String	Bank-reported transaction type description.
`sender_info`	String	Sender name or reference from bank continuation text, when available. Omitted when unknown.
`receiver_info`	String	Receiver name or reference from bank continuation text, when available. Omitted when unknown.
`direction`	String	`credit` or `debit`, when known. Omitted when unknown.
`transaction_date`	Date	Bank-reported transaction date, when available. Omitted when unknown.

Success Responses

Status Code	Description
200	OK — bank-reported transaction

Error Responses

Status Code	Error Code	Description
401	AUTHENTICATION_ERROR	Authentication credentials are invalid or missing
403	AUTHORIZATION_ERROR	You do not have permission to perform this action
404	NOT_FOUND	Treasury account or bank transaction not found

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** | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `account_id` | UUID | Yes | Treasury account identifier | | `bank_transaction_id` | UUID | Yes | Bank transaction identifier | **Response fields** (`data`) | Field | Type | Description | |-------|------|-------------| | `id` | UUID | Opaque identifier for this ingested bank line. | | `amount_in_minor_units` | Integer | Transaction amount in the smallest unit of the currency. | | `currency_code` | String | ISO 4217 currency code. | | `description` | String | Bank-reported transaction type description. | | `sender_info` | String | Sender name or reference from bank continuation text, when available. Omitted when unknown. | | `receiver_info` | String | Receiver name or reference from bank continuation text, when available. Omitted when unknown. | | `direction` | String | `credit` or `debit`, when known. Omitted when unknown. | | `transaction_date` | Date | Bank-reported transaction date, when available. Omitted when unknown. | **Success Responses** | Status Code | Description | |-------------|-------------| | 200 | OK — bank-reported transaction | **Error Responses** | Status Code | Error Code | Description | |-------------|------------|-------------| | 401 | AUTHENTICATION_ERROR | Authentication credentials are invalid or missing | | 403 | AUTHORIZATION_ERROR | You do not have permission to perform this action | | 404 | NOT_FOUND | Treasury 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 null