BatchTransaction

Transaction event and its lifecycle history. Amounts are integer minor currency units. metadata belongs to this event; retain event_id for outcome recovery.

  • account_id
    Type: string
    required
  • apple_transaction_id
    Type: string
    required
  • card
    Type: string
    required
  • card_brand
    Type: string
    required
  • card_type
    Type: string
    required
  • created_at
    Type: integer
    required

    Integer numbers.

  • currency
    Type: string
    required
  • event_id
    Type: string
    required
  • mid
    Type: string
    required
  • payment_method
    Type: string
    required
  • processor_mid
    Type: string
    required
  • processor_tid
    Type: string
    required
  • reader_identifier
    Type: string
    required
  • subtotal
    Type: integer
    required

    Integer numbers.

  • tid
    Type: string
    required
  • total_amount
    Type: integer
    required

    Integer numbers.

  • transaction_id
    Type: string
    required
  • additional_details
    Type: Additional Detailsnullable
    Properties: 1
  • batch_id
    Type: stringnullable
  • batch_refunded_amount
    Type: integer
    min:  
    0

    Sum of successful refund operations for this transaction in the requested batch only, in minor currency units. Unlike refunded, this excludes refunds in other batches.

  • device_id
    Type: stringnullable
  • device_type
    Type: stringnullable
  • gateway
    Type: stringnullable
  • gateway_transaction_id
    Type: stringnullable
  • gateway_transaction_response
    Type: Gateway Transaction Responsenullable
    Properties: 1
  • history
    Type: array of objectnullable
    Properties: 1
  • location_id
    Type: stringnullable
  • merchant_name
    Type: stringnullable
  • metadata
    Type: Metadatanullable
    Properties: 1
  • owner_id
    Type: stringnullable
  • parent_account_ids
    Type: array of stringnullable
  • processor
    Type: stringnullable
  • processor_response_code
    Type: stringnullable
  • processor_response_message
    Type: stringnullable
  • psp
    Type: stringnullable
  • refund_amount
    Type: integer
    min:  
    0

    Successful refund amount for this event, in minor currency units. Zero for non-refund, failed, and settlement-only events. History events also include this field.

  • refunded
    Type: integernullable

    Integer numbers.

  • reversed
    Type: integernullable

    Integer numbers.

  • status
    Type: stringnullable
  • status_reason
    Type: stringnullable
  • surcharge_amount
    Type: integernullable

    Integer numbers.

  • surcharge_applied
    Type: boolean
  • surcharge_basis
    Type: stringnullable
  • surcharge_confirmation_required
    Type: booleannullable
  • surcharge_rate
    Type: numbernullable
  • surcharge_source
    Type: stringnullable
  • tax_amount
    Type: integernullable

    Integer numbers.

  • tax_basis
    Type: stringnullable
  • tax_rate
    Type: integernullable

    Tax rate in basis points; 850 means 8.5%.

  • tax_source
    Type: stringnullable
  • terminal_details
    Type: Terminal Detailsnullable
    Properties: 1
  • tip_amount
    Type: integernullable

    Integer numbers.

  • tip_capture_mode
    Type: stringnullable
  • tip_type
    Type: stringnullable
  • transaction_type
    Type: stringnullable