tmb_…) is Ionic’s persisted record of a batch of
card-present transactions for one or more Terminals. It reports a lifecycle status, a
reconciliation_status, transaction counts, and totals in minor units. Batch
items (tbi_…) are the transaction records in a batch’s latest snapshot, linked
to a Charge or Refund where one exists. A settlement profile (stlp_…) is a
stable Ionic grouping that you can use to filter batches without relying on
hardware-specific or processing-specific identifiers.
Batches are read-only. Ionic never clears, forces, or closes a batch through
this API. Listing batches does not contact a Terminal, so use data_as_of,
stale_after, and is_stale to decide whether to refresh. See
The Terminal object for how Terminal refunds relate to
batch settlement, and Accept in-person terminal payments for the
payment flow.
Attributes
string
Unique identifier for the batch (
tmb_…).string
Whether the batch is
open, closing, or closed.string
Whether the batch’s transactions have been matched to your charges and refunds.
reconciled means every transaction is matched.array of strings
IDs of the terminals whose transactions are in this batch (
tmr_…).string
Three-letter ISO currency code, in lowercase.
integer
Number of transactions in the batch.
object
Money totals for the batch, in the smallest currency unit.
integer
Unix epoch seconds when the batch opened.
integer | null
Unix epoch seconds when the batch closed. Null until it closes.
Endpoints
Statuses
A batch has two status fields.
Both fields can be used as list filters.
Rules
- Batch item
operationis one ofsale,refund,void,reversal,authorization,ticket, ortip_adjustment. - Totals (
sales,refunds,voids,tips,fees,tax,net) are integers in minor currency units.netis null when it is not available. closed_atandreconciled_atare null until those events occur.- Platforms select an authorized connected account with
Ionic-Account.