Transactions

Full PAN of the card being charged.

POS sale id (echoed onto the persisted Transaction row).

Register number at which the sale is being rung.

Operator/cashier identifier (echoed onto the persisted Transaction row).

When true, the cart approves whatever portion of the total the card can cover. When false, the cart rejects every line if the amount exceeds the available balance.

Optional ceiling on the total amount drawn from the card (allowance purses + main balance combined). Use when part of the cart has already been paid by another tender (cash, loyalty points, etc.) and only the remainder should be charged to this card. Lines are processed in order; once the cumulative approved amount reaches MaxCharge the remaining lines are approved for zero and returned with reason "Max charge reached.". When null (default) no ceiling is applied.

Optional amount of discount applied to the cart. this is just a passthrough from the POS to the API, it is not used for any calculations.

Cart lines. Must contain at least one entry.

Optional remark forwarded to the persisted Transaction row.

Card PIN entered at the register / self-checkout. Required only when the card (or its provider) requires a PIN; ignored otherwise. Never persisted.

Cardholder phone entered at the register / self-checkout. Required only when the card (or its provider) requires a phone; ignored otherwise. Any common format is accepted (normalised to E.164 server-side). Never persisted.

Optional client-supplied idempotency key — typically the POS transaction id. When a request repeats a previously committed key (per store) with the same card and line items, it is rejected as a duplicate charge (Duplicate_Charge) and the card is not charged again; reusing a key with a different payload (amount, card, or lines) is rejected with Idempotency_KeyReuse. Ignored on the quote path (quotes have no side effects).

Full PAN of the card being charged.

POS sale id (echoed onto the persisted Transaction row).

Register number at which the sale is being rung.

Operator/cashier identifier (echoed onto the persisted Transaction row).

When true, the cart approves whatever portion of the total the card can cover. When false, the cart rejects every line if the amount exceeds the available balance.

Optional ceiling on the total amount drawn from the card (allowance purses + main balance combined). Use when part of the cart has already been paid by another tender (cash, loyalty points, etc.) and only the remainder should be charged to this card. Lines are processed in order; once the cumulative approved amount reaches MaxCharge the remaining lines are approved for zero and returned with reason "Max charge reached.". When null (default) no ceiling is applied.

Optional amount of discount applied to the cart. this is just a passthrough from the POS to the API, it is not used for any calculations.

Cart lines. Must contain at least one entry.

Optional remark forwarded to the persisted Transaction row.

Card PIN entered at the register / self-checkout. Required only when the card (or its provider) requires a PIN; ignored otherwise. Never persisted.

Cardholder phone entered at the register / self-checkout. Required only when the card (or its provider) requires a phone; ignored otherwise. Any common format is accepted (normalised to E.164 server-side). Never persisted.

Optional client-supplied idempotency key — typically the POS transaction id. When a request repeats a previously committed key (per store) with the same card and line items, it is rejected as a duplicate charge (Duplicate_Charge) and the card is not charged again; reusing a key with a different payload (amount, card, or lines) is rejected with Idempotency_KeyReuse. Ignored on the quote path (quotes have no side effects).

Gets or sets the card number to process the transaction for.

Gets or sets the transaction amount. Must be positive (greater than zero). The TransactionType determines whether this is a credit (adds value) or debit (deducts value).

Gets or sets the sale ID associated with this transaction.

Gets or sets the register number where the transaction is occurring.

Gets or sets the user ID processing the transaction.

Gets or sets the type of transaction (Credit, Debit, etc.). Must be explicitly provided when not coming from route parameter.

Gets or sets a value indicating whether partial payment is accepted for debit transactions.

Gets or sets an optional remark or note about the transaction.

Card PIN entered at the register / self-checkout. Required only for debit transactions on cards that require a PIN; ignored otherwise. Never persisted.

Cardholder phone entered at the register / self-checkout. Required only for debit transactions on cards that require a phone; ignored otherwise. Never persisted.

Optional client-supplied idempotency key — typically the POS transaction id. When a request repeats a previously committed key (per store) with the same transaction type, card and amount, it is rejected as a duplicate charge (Duplicate_Charge) and no funds move; reusing a key with a different payload is rejected with Idempotency_KeyReuse.