---
title: "Flush a settlement batch"
method: POST
path: "/payments/batches/{id}/flush"
tags: ["Payments"]
---

# Flush a settlement batch

`POST /payments/batches/{id}/flush`

Flushes the queued `batch-settlement` items in a batch into a single aggregate on-chain settlement: it settles the aggregate amount, writes a parent batch ledger row (`reference.kind = "batch"`) plus any fee row, and marks the items flushed.

## Path parameters

- `id` string, required

## Request body

- PaymentBatchFlushRequest
  - `limit` integer

## Response `200`

OK

- PaymentBatchFlushResponse
  - `flush` PaymentBatchFlush, required
    - `asset` string
    - `batchId` string, required
    - `completedAt` string, date-time
    - `createdAt` string, date-time
    - `error` string
    - `feeAmount` string
    - `feeLedgerTxIds` string[]
    - `flushId` string, required
    - `grossAmount` string
    - `itemCount` integer, required
    - `itemIds` string[]
    - `metadata` object
    - `netAmount` string
    - `network` string
    - `onChainTx` string
    - `parentLedgerTxId` string
    - `status` 'flushed' | 'failed', required
    - `updatedAt` string, date-time

---

[API](https://skmtc.net/tiny/apis/tiny-place-network-api.md) · [All operations](https://skmtc.net/tiny/apis/tiny-place-network-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tiny/tiny-place-network-api/revisions/fb85a82845ac/schema)