Creates a bank transaction.

POST /banking/bank-transactions

Group: Banking › Bank Transactions · Operation ID: createBankTransaction

The response contains only the new transaction's id. Read the record with GET banking/bank-transactions/:id.

bankAccountId, amount, currency, externalCreationDate and externalTransactionId are required. externalTransactionId must be unique across the tenant and is how the source system's own identifier is stored. A repeat fails with DUPLICATE_EXTERNAL_TRANSACTION_ID, which names the existing transaction.

amount is a decimal in the transaction currency. A negative amount is money leaving the account.

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.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.

Request body

Required, application/json: createBankTransactionInput.

Field Type Required Description
bankAccountId string yes The bank account the transaction belongs to. See id on GET banking/bank-accounts/:id.
amount string (decimal) yes The transaction amount, as a decimal in the transaction currency. A negative amount is money leaving the account.
currency string yes The currency of the transaction. Format ISO 4217, for example 'USD'. It governs the amount.
externalCreationDate string (date) yes The date the transaction was created in the source system. Use format YYYY-MM-DD.
externalTransactionId string yes The transaction's identifier in the system it was imported from. Must be unique across the tenant.
description string no A human-readable description of the transaction.
externalDescription string no The description exactly as the source system supplied it, before any normalization.
payeeOrPayor string no The name of the counterparty the money went to or came from.
externalId string no Another identifier the source system has for this record, distinct from externalTransactionId and not unique.
transactionPaymentMethod string no How the payment was made. The values are 'ACH', 'WIRE' and 'Unknown'.
notes string no Free-form notes for the transaction.
externalPaymentId string no The identifier of the payment in the source system this transaction settles.

Example:

{
  "bankAccountId": "9effa2ff-bc94-44bc-b706-a5f95f792407",
  "amount": "-1250.00",
  "currency": "USD",
  "externalCreationDate": "2026-02-14",
  "externalTransactionId": "ACME-TXN-88213",
  "description": "Consulting, February",
  "externalDescription": "<externalDescription>",
  "payeeOrPayor": "Acme Consulting LLC",
  "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transactionPaymentMethod": "ACH",
  "notes": "<notes>",
  "externalPaymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response

200 Success

Under data (createBankTransactionOutput):

Field Type Required Description
id string yes The unique identifier for the created bank transaction.

Response headers

Errors

Code Status
REFERENCE_NOT_FOUND 400
INVALID_FIELD_VALUE 400
DUPLICATE_EXTERNAL_TRANSACTION_ID 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses