BatchWithTransactions

Batch response enriched with transactions.

account_id
Type: string · Account Id
required
captured_amount
Type: integer · Captured Amount
min:
0
required

Integer numbers.
id
Type: string · Id
required
opened_at
Type: string · Opened AtFormat: date-time
required

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
processor_config_id
Type: string · Processor Config Id
required
processor_name
Type: string · Processor Name
required
refunded_amount
Type: integer · Refunded Amount
min:
0
required

Integer numbers.
status
Type: string · BatchStatusenum
required

Possible lifecycle statuses for settlement batches.
values
- open
- closed
- submitted
- accepted
- partially_accepted
- rejected
- cancelled
terminal_id
Type: string · Terminal Id
required
transaction_count
Type: integer · Transaction Count
min:
0
required

Integer numbers.
batch_metadata
Type: object | null · Batch Metadata
closed_at
Type: string | null · Closed AtFormat: date-time

the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
processor_batch_id
Type: string | null · Processor Batch Id
response
Type: object | null · Response
transactions
Type: array object[] · Transactions

Transactions associated with this batch
Model to represent a transaction
- account_id
  Type: string · Account Id
  required
  
  Account ID of the merchant that owns this transaction
- apple_transaction_id
  Type: string · Apple Transaction Id
  required
  
  Apple Pay transaction identifier
- card
  Type: string · Card
  required
  
  Masked card number (e.g., '****1234')
- card_brand
  Type: string · Card Brand
  required
  
  Card brand (e.g., 'VISA', 'MASTERCARD', 'AMEX')
- card_type
  Type: string · Card Type
  required
  
  Type of card used ('Credit' or 'Debit')
- created_at
  Type: integer · Created At
  required
  
  Transaction creation timestamp in milliseconds since epoch
- currency
  Type: string · Currency
  required
  
  ISO 4217 currency code (e.g., 'USD', 'EUR')
- event_id
  Type: string · Event Id
  required
  
  Unique identifier for this specific transaction event (for idempotency)
- mid
  Type: string · Mid
  required
  
  Merchant ID assigned by Koard
- payment_method
  Type: string · Payment Method
  required
  
  Payment method used (e.g., 'apple_pay', 'credit_card')
- processor_mid
  Type: string · Processor Mid
  required
  
  Merchant ID assigned by the payment processor (e.g., PayRoc)
- processor_tid
  Type: string · Processor Tid
  required
  
  Terminal ID assigned by the payment processor
- reader_identifier
  Type: string · Reader Identifier
  required
  
  Unique identifier for the card reader device
- subtotal
  Type: integer · Subtotal
  required
  
  Subtotal amount in cents (before tax, tip, and surcharge)
- tid
  Type: string · Tid
  required
  
  Terminal ID assigned by Koard
- total_amount
  Type: integer · Total Amount
  required
  
  Total transaction amount in cents (subtotal + tax + tip + surcharge)
- transaction_id
  Type: string · Transaction Id
  required
  
  Unique identifier for the transaction across all events
- additional_details
  Type: object | null · Additional Details
  
  Additional transaction details as key-value pairs
- batch_id
  Type: string | null · Batch Id
- device_id
  Type: string | null · Device Id
  
  Physical device identifier (e.g., iPad serial number)
- gateway
  Type: string | null · Gateway
  
  Payment gateway used for processing
- gateway_transaction_id
  Type: string | null · Gateway Transaction Id
  
  Transaction ID returned by the payment gateway
- gateway_transaction_response
  Type: object | null · Gateway Transaction Response
  
  Raw response from the payment gateway
- history
  Type: array object[] | null · History
  
  Historical events for this transaction
  
  Empty object
- location_id
  Type: string | null · Location Id
  
  Location/store ID where transaction occurred
- merchant_name
  Type: string | null · Merchant Name
  
  Name of the merchant for this transaction
- owner_id
  Type: string | null · Owner Id
- parent_account_ids
  Type: array string[] | null · Parent Account Ids
- processor
  Type: string | null · Processor
  
  Payment processor name (e.g., 'payroc', 'stripe')
- processor_response_code
  Type: string | null · Processor Response Code
  
  Response code from the payment processor
- processor_response_message
  Type: string | null · Processor Response Message
  
  Response message from the payment processor
- refunded
  Type: integer | null · Refunded
  
  Total amount refunded in cents
- reversed
  Type: integer | null · Reversed
  
  Total amount reversed in cents
- status
  Type: string | null · Status
  
  Current transaction status
- status_reason
  Type: string | null · Status Reason
  
  Reason for the current transaction status
- surcharge_amount
  Type: integer | null · Surcharge Amount
  
  Surcharge amount in cents
- surcharge_applied
  Type: boolean · Surcharge Applied
  
  Whether a surcharge was applied to this transaction
- surcharge_rate
  Type: number | null · Surcharge Rate
  
  Surcharge rate as a decimal (e.g., 0.035 = 3.5%)
- tax_amount
  Type: integer | null · Tax Amount
  
  Tax amount in cents
- tax_rate
  Type: number | null · Tax Rate
  
  Tax rate as a percentage (e.g., 8.5 = 8.5%)
- tip_amount
  Type: integer | null · Tip Amount
  
  Tip amount in cents
- tip_type
  Type: string | null · Tip Type
  
  Type of tip calculation method
- transaction_type
  Type: string | null · Transaction Type
  
  Type of transaction operation