<!-- ZenPays documentation · https://docs.zenpays.com/docs/rest-api/endpoints/payouts/batch-payout-items -->

# Batch Payout Items

Retrieve individual payouts within a batch, with optional status filtering and pagination.

<EndpointHeader verb="GET" path="/payment/api/v1/batch-payouts/{batchId}/payouts" />

## Request

### Path Parameters

<ParamTable
  rows={[
    { name: "batchId", type: "string", required: true, desc: "Batch payout ID" },
  ]}
/>

### Headers

<ParamTable
  label="Header"
  rows={[
    { name: "Authorization", required: true, desc: "`Bearer {api_key}`" },
    { name: "X-Signature", required: true, desc: "HMAC-SHA256 signature" },
    { name: "X-Timestamp", required: true, desc: "ISO 8601 timestamp" },
    { name: "X-Secret-Salt", required: true, desc: "Secret salt for HMAC validation" },
  ]}
/>

### Query Parameters

<ParamTable
  rows={[
    { name: "page", type: "number", desc: "Page number (default: 1)" },
    { name: "limit", type: "number", desc: "Items per page (default: 50)" },
    { name: "status", type: "string", desc: "Filter by payout status" },
  ]}
/>

## Response

### Success (200 OK)

```json
{
  "success": true,
  "data": {
    "payouts": [
      {
        "payoutId": "payout_xxxxx",
        "beneficiaryName": "Alice Smith",
        "beneficiaryAccount": "1234567890",
        "amount": 5000,
        "currency": "INR",
        "status": "completed",
        "payoutType": "imps",
        "tspProvider": "paytara",
        "externalPayoutId": "ext_xxxxx",
        "createdAt": "2024-01-15T10:30:00.000Z"
      },
      {
        "payoutId": "payout_yyyyy",
        "beneficiaryName": "Bob Johnson",
        "beneficiaryVpa": "bob@upi",
        "amount": 3000,
        "currency": "INR",
        "status": "failed",
        "payoutType": "upi",
        "failureReason": "Invalid VPA",
        "createdAt": "2024-01-15T10:30:01.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 50,
      "total": 2,
      "totalPages": 1,
      "hasNext": false,
      "hasPrev": false
    }
  }
}
```

<CodeRail>

## Examples

<Tabs groupId="language">
  <TabItem value="curl" label="cURL" default>

```bash
curl "https://api.zenpays.com/payment/api/v1/batch-payouts/batch_xxxxx/payouts?status=failed" \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-15T10:30:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt"
```

  </TabItem>
  <TabItem value="sdk" label="SDK">

```javascript
// Get all failed payouts in a batch
const { data } = await zenpays.payouts.getBatchPayouts('batch_xxxxx', {
  status: 'failed',
})

data.forEach(payout => {
  console.log(`${payout.payoutId}: ${payout.failureReason}`)
})
```

  </TabItem>
</Tabs>

</CodeRail>

## Related Endpoints

- [Get Batch Payout](/docs/rest-api/endpoints/payouts/get-batch-payout)
- [Create Batch Payout](/docs/rest-api/endpoints/payouts/create-batch-payout)
- [Get Payout](/docs/rest-api/endpoints/payouts/get-payout)
