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

# The PayoutMethod object

Describes an available payout method and its constraints. Use this information to display available payout options to users and validate payout requests.

## Fields

<ParamTable
  label="Field"
  rows={[
    { name: "id", type: "string", required: true, desc: "Unique identifier for the payout method" },
    { name: "type", type: "'bank_transfer' | 'upi' | 'wallet' | 'crypto'", required: true, desc: "Type of payout method" },
    { name: "name", type: "string", required: true, desc: "Display name for the payout method" },
    { name: "currencies", type: "string[]", required: true, desc: "Currencies supported by this payout method" },
    { name: "countries", type: "string[]", required: true, desc: "Countries where this payout method is available" },
    { name: "minAmount", type: "number", required: false, desc: "Minimum payout amount (in smallest currency unit)" },
    { name: "maxAmount", type: "number", required: false, desc: "Maximum payout amount (in smallest currency unit)" },
    { name: "processingTime", type: "string", required: false, desc: "Estimated processing time (e.g., '1-2 business days')" },
    { name: "fees", type: "{\n    /** Fixed fee amount per payout */\n    fixed?: number\n    /** Percentage fee (e.g., 0.5 for 0.5%) */\n    percentage?: number\n  }", required: false, desc: "Fee structure for this payout method" },
  ]}
/>

## Example

```json
{
  "id": "obj_1a2b3c",
  "type": "bank_transfer",
  "name": "string",
  "currencies": [],
  "countries": [],
  "minAmount": 5000,
  "maxAmount": 5000,
  "processingTime": "string"
}
```
