Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

Merchant secret key, or an authorized Platform secret key with delegation where documented.

Headers

Ionic-Account
string

Merchant ID when an authorized Platform acts for a connected Merchant.

Pattern: ^mer_[0-9A-Za-z]{14}$

Path Parameters

id
string
required

Ionic Terminal batch ID.

Pattern: ^tmb_[0-9A-Za-z]{24}$

Response

The Terminal batch.

id
string
required
Pattern: ^tmb_[0-9A-Za-z]{24}$
object
enum<string>
required
Available options:
terminal_batch
merchant_id
string
required
Pattern: ^mer_[0-9A-Za-z]{14}$
livemode
boolean
required
settlement_profile_id
string
required
Pattern: ^stlp_[0-9A-Za-z]{24}$
terminal_ids
string[]
required
Pattern: ^tmr_[0-9A-Za-z]{14}$
status
enum<string>
required
Available options:
open,
closing,
closed
reconciliation_status
enum<string>
required
Available options:
not_started,
pending,
reconciled,
incomplete,
needs_attention
currency
string
required
Pattern: ^[a-z]{3}$
transaction_count
integer<int64>
required
matched_item_count
integer<int64>
required
unmatched_item_count
integer<int64>
required
totals
object
required
data_as_of
integer<int64>
required

Unix epoch seconds represented by this snapshot.

stale_after
integer<int64>
required

Unix epoch seconds after which this snapshot is stale.

is_stale
boolean
required
opened_at
integer<int64>
required
closed_at
integer<int64> | null
required
reconciled_at
integer<int64> | null
required
created_at
integer<int64>
required
updated_at
integer<int64>
required