BatchWithTransactions

Batch response enriched with transactions.

  • account_id
    Type: string
    required
  • captured_amount
    Type: integer
    min:  
    0
    required

    Integer numbers.

  • id
    Type: string
    required
  • opened_at
    Type: stringFormat: 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
    required
  • processor_name
    Type: string
    required
  • refunded_amount
    Type: integer
    min:  
    0
    required

    Integer numbers.

  • status
    Type: enum
    required

    Possible lifecycle statuses for settlement batches.

    values
    openclosedsubmittedacceptedpartially_acceptedrejectedcancelled
  • terminal_id
    Type: string
    required
  • transaction_count
    Type: integer
    min:  
    0
    required

    Integer numbers.

  • batch_metadata
    Type: Batch Metadatanullable
    Properties: 1
  • closed_at
    Type: stringFormat: date-timenullable

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • gateway
    Type: stringnullable
  • mid
    Type: stringnullable
  • processor_batch_id
    Type: string | null
  • rejection_reason
    Type: stringnullable
  • response
    Type: Responsenullable
    Properties: 1
  • terminal_name
    Type: stringnullable
  • tid
    Type: stringnullable
  • transactions
    Type: array of BatchTransaction

    Latest event in this batch for each transaction, with full lifecycle history (excluding that event), newest first. Each event retains its own batch_id and includes its successful refund_amount.

    Properties: 55