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

# The BatchPayout object

Represents a batch payout with status and progress tracking.

:::note
13 of 13 fields on this object have no description yet. Field documentation lives in the SDK types (`types/payout.ts`) so it stays in one place — this page is generated from it.
:::

## Fields

<ParamTable
  label="Field"
  rows={[
    { name: "batchId", type: "string", required: true },
    { name: "status", type: "string", required: true },
    { name: "totalPayouts", type: "number", required: true },
    { name: "successfulPayouts", type: "number", required: true },
    { name: "failedPayouts", type: "number", required: true },
    { name: "pendingPayouts", type: "number", required: true },
    { name: "totalAmount", type: "number", required: true },
    { name: "currency", type: "string", required: true },
    { name: "estimatedFees", type: "number", required: true },
    { name: "totalDebitedAmount", type: "number", required: true },
    { name: "progressPercentage", type: "number", required: true },
    { name: "createdAt", type: "string", required: true },
    { name: "updatedAt", type: "string", required: true },
  ]}
/>

## Example

```json
{
  "batchId": "batch_1a2b3c",
  "status": "string",
  "totalPayouts": 5000,
  "successfulPayouts": 1,
  "failedPayouts": 1,
  "pendingPayouts": 1,
  "totalAmount": 5000,
  "currency": "USD",
  "estimatedFees": 5000,
  "totalDebitedAmount": 5000,
  "progressPercentage": 1,
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}
```