Generate batch settlement reports

Prerequisites

A valid API key — see Obtain API credentials

Batch reporting endpoints

Endpoint	Method	Description
`/v1/batches`	GET	List batches with pagination, sorting, and filtering
`/v1/batches/status`	GET	Check settlement status of batches

Option A: List batches

Send GET /v1/batches to retrieve a paginated list of batches.

Query parameters

Parameter	Type	Description
`skip`	string	Number of records to skip (offset)
`take`	string	Number of records to return per page
`sort_column`	string	Column to sort by
`sort_order`	string	`asc` or `desc`
`search_text`	string	Free-text search
`term`	string	Filter term

curl -G \
  https://api.dev.paradisegateway.net/v1/batches \
  -H "APIKEY: YOUR-API-KEY" \
  -d skip=0 \
  -d take=10 \
  -d sort_order=desc

Response

{
  "count": 47,
  "results": [
    {
      "id": "BATCH-01KFDKXMQ637EKEAY410MSQSXB",
      "batch_id": "BATCH-01KFDKXMQ637EKEAY410MSQSXB",
      "batch_number": "001",
      "batch_type": "card",
      "processor": "tsys",
      "status": "settled",
      "client_id": "CLIENT-3MtwBwLkdIwHu7ix28a3tqPa",
      "client_name": "Acme Jewelry",
      "approved_amount": 125000,
      "captured_amount": 125000,
      "refund_amount": 2500,
      "void_amount": 0,
      "net_amount": 122500,
      "batch_net_amount": 122500,
      "created_at": "2026-03-24T00:00:00Z",
      "closed_at_date_time": "2026-03-24T22:00:00Z",
      "settled_at_date_time": "2026-03-25T06:00:00Z"
    }
  ],
  "correlation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Key batch fields

Field	Description
`status`	Current batch state (for example, `open`, `closed`, `settled`)
`approved_amount`	Total approved amount in the batch (minor units)
`captured_amount`	Total captured amount
`refund_amount`	Total refunds in the batch
`void_amount`	Total voids in the batch
`batch_net_amount`	Net settlement amount (`captured - refunds - voids`)
`closed_at_date_time`	When the batch was closed
`settled_at_date_time`	When funds were settled

Option B: Check batch settlement status

Send GET /v1/batches/status to check which batches are in progress and which have completed.

Query parameters in batch settlement status

Parameter	Type	Description
`client_id`	string	Filter by client
`last_checked_at`	date-time	Only return batches updated after this timestamp

curl -G \
  https://api.dev.paradisegateway.net/v1/batches/status \
  -H "APIKEY: YOUR-API-KEY" \
  -d last_checked_at=2026-03-24T00:00:00Z

Response in batch settlement status

{
  "has_in_progress": true,
  "in_progress_batches": [
    { "batch_id": "BATCH-02LGEHRR1BZSPA6WRY1T3H4CD", "status": "closing" }
  ],
  "completed_batches": [
    { "batch_id": "BATCH-01KFDKXMQ637EKEAY410MSQSXB", "status": "settled" }
  ],
  "max_closed_at": "2026-03-24T22:00:00Z",
  "correlation_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}

Polling for settlement

Use last_checked_at with the max_closed_at value from the previous response to poll efficiently for newly completed batches without re-fetching old data.