Transactions: add transaction
transactions_addAdd a transaction to a payment account. Specify account number, recipient or sender, amount, and booking date to record a deposit or withdrawal.
Instructions
🟡 WRITE · creates data — Creates new records (receipts, transactions, postings, invoices, master data). Not idempotent — calling twice may create duplicates. add transaction Add a transaction to a payment account of the specified customer.
Endpoint: POST /transactions/add
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | No | The transaction type (e.g. 'Direct debit'). If specified, the field will be validated. An empty string is not considered a valid type. | |
| amount | Yes | The transaction's amount (positive for incoming and negative for outgoing payments) in the account's currency. '0.00' is not considered a valid transaction amount. | |
| account | Yes | The posting account number (e.g. '1200') of the account to which to add the transaction. The account must exist as a payment account for the customer. | |
| api_key | No | Optional. The BB customer api_key to act on. Defaults to the BB_API_KEY configured on the server — only set this to target a different customer. | |
| purpose | No | The transaction purpose - may also be an empty string. | |
| to_from | Yes | The payment recipient or sender | |
| currency | No | The transaction currency. Currently we support the following currencies: AED, AUD, BGN, BRL, CAD, CHF, CNY, COP, CYP, CZK, DKK, EUR, GBP, HKD, HRK, HUF, IDR, ILS, INR, ISK, JPY, KRW, LTL, LVL, MTL, MXN, MYR, NOK, NZD, PEN, PHP, PLN, QAR, ROL, RON, RUB, SEK, SGD, SIT, SKK, THB, TRL, TRY, UAH, USD, VND, ZAR If specified, the field will be validated. An empty string is not considered a valid type. | |
| bank_code | No | The bank code (or BIC) of the payment recipient or sender. If specified, the field will be validated. An empty string is not considered a valid bank code. | |
| bank_name | No | The bank name of the payment recipient or sender. If specified, the field will be validated. An empty string is not considered a valid bank name. | |
| value_date | No | The transaction's value date in format 'YYYY-MM-DD HH:II:SS' (e.g. '2017-04-26 00:00:00'). If not specified, the value date will be set to the same value as the booking date. If specified, the field will be validated. An empty string is not considered a valid date. | |
| booking_date | Yes | The transaction's booking date in format 'YYYY-MM-DD HH:II:SS' (e.g. '2017-04-26 00:00:00'). | |
| booking_text | No | The booking text - may also be an empty string. | |
| account_number | No | The account number (or IBAN) of the payment recipient or sender. If specified, the field will be validated. An empty string is not considered a valid account number. | |
| payment_reference | No | The payment reference id. If specified correctly, the added transaction will match with the corresponding receipt. |