PaginatedBatches

Paginated batch list.

  • batches
    Type: array object[] · Batches
    required

    List of settlement batches

    Complete batch response model.

    • 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
  • limit
    Type: integer · Limit
    required

    Number of items per page

  • offset
    Type: integer · Offset
    required

    Starting position

  • page
    Type: integer · Page
    required

    Current page number

  • total
    Type: integer · Total
    required

    Total number of items available

  • propertyName
    Type: anything