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

# Preview Payout

:::danger[Deprecated — Do Not Use]
This endpoint is **deprecated** and will be removed in a future release. It is no longer maintained and may produce unexpected behavior.

**Use [Payout Intents](/docs/rest-api/endpoints/payout-intents/create-payout-intent) instead.** Payout Intents include built-in preview and confirmation steps.
:::

Preview a payout to see available methods, fees, and estimated delivery time before creating.

<EndpointHeader verb="POST" path="/merchant/api/v1/payouts/preview" />

## Request

### 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" },
    { name: "Content-Type", required: true, desc: "`application/json`" },
  ]}
/>

### Body Parameters

<ParamTable
  rows={[
    { name: "amount", type: "number", required: true, desc: "Payout amount (minimum 1)" },
    { name: "currency", type: "string", desc: "3-character currency code (default: `INR`)" },
    { name: "country", type: "string", desc: "2-character ISO country code" },
    { name: "payoutType", type: "string", desc: "Preferred payout type (`IMPS`, `NEFT`, `RTGS`, `UPI`)" },
  ]}
/>

## Response

### Success (200 OK)

```json
{
  "success": true,
  "data": {
    "availableMethods": [
      {
        "type": "IMPS",
        "name": "IMPS",
        "fees": 25,
        "estimatedTime": "instant",
        "minAmount": 1,
        "maxAmount": 50000000,
        "available": true
      },
      {
        "type": "NEFT",
        "name": "NEFT",
        "fees": 15,
        "estimatedTime": "2-4 hours",
        "minAmount": 1,
        "maxAmount": 100000000,
        "available": true
      },
      {
        "type": "RTGS",
        "name": "RTGS",
        "fees": 50,
        "estimatedTime": "30 minutes",
        "minAmount": 200000,
        "maxAmount": null,
        "available": false,
        "reason": "Amount below minimum"
      }
    ],
    "recommendedMethod": "IMPS",
    "walletBalance": {
      "available": 5000000,
      "currency": "INR"
    }
  }
}
```

<CodeRail>

## Examples

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

```bash
curl -X POST https://api.zenpays.com/merchant/api/v1/payouts/preview \
  -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" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 10000,
    "currency": "INR",
    "country": "IN"
  }'
```

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

```javascript
const preview = await zenpays.payouts.preview({
  amount: 10000,
  currency: 'INR',
  country: 'IN',
});

console.log(`Recommended: ${preview.recommendedMethod}`);
preview.availableMethods.forEach(m => {
  console.log(`${m.name}: Fee ${m.fees}, Time: ${m.estimatedTime}`);
});
```

  </TabItem>
</Tabs>

</CodeRail>
