Settlement Batches

Settle a terminal manually and search historical settlement batches.

Transactions that run through the gateway are grouped into settlement batches before they fund. This page covers two operations: manually settling a single terminal, and searching your historical settlement batches.

Manually settle a terminal

POST /api/terminal/{terminal_id}/settle

Send a POST to this endpoint to close out a specific terminal's current batch. The terminal will settle immediately, and the batch will move into processing.

Finding the batch number

Once a terminal transaction has been processed, the batch number appears in the response payload at data.response_body.terminal.processor_specific.BatchNum. See the terminal tab on the Sale / Auth page for an example of that response shape.

Search settlement batches

POST /api/settlement/batch/search

Retrieve the settlement batches that match a filter. You can scope by date range and by batch ID, paginated with limit and offset.

Request body

Field	Type	Default	Description
`batch_date`	object	—	Wraps a start and end date, both in UTC `YYYY-MM-DDTHH:MM:SSZ`.
`batch_date.start_date`	string	`""`	Lower bound. Inclusive.
`batch_date.end_date`	string	`""`	Upper bound. Inclusive.
`settlement_batch_id`	object	—	Match or exclude a specific batch ID.
`settlement_batch_id.operator`	string	—	Either `=` or `!=`.
`settlement_batch_id.value`	string	—	The batch ID to match or exclude.
`limit`	integer	`10`	How many results to return. Range 1–100.
`offset`	integer	`0`	How many to skip. Range 1–1000.

Example

curl -X POST https://sandbox.fluidpay.com/api/settlement/batch/search \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY" \
  -d '{
    "batch_date": {
      "start_date": "2025-01-01T00:00:00Z",
      "end_date": "2025-01-31T23:59:59Z"
    },
    "limit": 50
  }'