<!-- ZenPays documentation · https://docs.zenpayz.com/docs/reference/objects/settlement -->

# The Settlement object

Represents a settlement of funds to a merchant's bank account. Settlements aggregate transaction proceeds and transfer them to the merchant's designated bank account.

## Fields

<ParamTable
  label="Field"
  rows={[
    { name: "id", type: "string", required: true, desc: "Unique identifier for the settlement" },
    { name: "merchantId", type: "string", required: true, desc: "ID of the merchant receiving the settlement" },
    { name: "amount", type: "number", required: true, desc: "Settlement amount in the smallest currency unit" },
    { name: "currency", type: "string", required: true, desc: "Three-letter ISO currency code" },
    { name: "status", type: "SettlementStatus", required: true, desc: "Current status of the settlement [SettlementStatus](/docs/reference/enums/settlement-status)" },
    { name: "bankAccountId", type: "string", required: false, desc: "ID of the bank account receiving the settlement" },
    { name: "transactionCount", type: "number", required: true, desc: "Number of transactions included in this settlement" },
    { name: "periodStart", type: "string", required: true, desc: "Start of the settlement period (ISO 8601)" },
    { name: "periodEnd", type: "string", required: true, desc: "End of the settlement period (ISO 8601)" },
    { name: "processedAt", type: "string", required: false, desc: "ISO 8601 timestamp when the settlement was processed" },
    { name: "failureReason", type: "string", required: false, desc: "Reason for failure if the settlement failed" },
    { name: "createdAt", type: "string", required: true, desc: "ISO 8601 timestamp when the settlement was created" },
    { name: "updatedAt", type: "string", required: true, desc: "ISO 8601 timestamp when the settlement was last updated" },
  ]}
/>

## Example

```json
{
  "id": "obj_1a2b3c",
  "merchantId": "merchant_1a2b3c",
  "amount": 5000,
  "currency": "USD",
  "status": "pending",
  "bankAccountId": "bankaccount_1a2b3c",
  "transactionCount": 1,
  "periodStart": "string",
  "periodEnd": "string",
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}
```