<!-- ZenPays documentation · https://docs.zenpayz.com/docs/rest-api/endpoints/settlements/create-settlement -->

# Create Settlement

Create a settlement request to withdraw funds to your bank account.

<EndpointHeader verb="POST" path="/merchant/api/v1/settlements/create" />

## 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: "Settlement amount" },
    { name: "bankAccountId", type: "string", required: true, desc: "Bank account ID to settle to" },
    { name: "description", type: "string", desc: "Description for the settlement" },
    { name: "priority", type: "string", desc: "Settlement priority" },
    { name: "type", type: "string", desc: "Settlement type" },
    { name: "scheduledDate", type: "string", desc: "ISO 8601 date for scheduled settlement" },
  ]}
/>

## Response

### Success (201 Created)

```json
{
  "success": true,
  "data": {
    "settlementId": "stl_xxxxx",
    "merchantId": "mer_xxxxx",
    "amount": 100000,
    "settlementFee": 500,
    "netAmount": 99500,
    "currency": "USD",
    "type": "standard",
    "priority": "normal",
    "status": "PENDING",
    "description": "Monthly settlement",
    "bankAccountId": "ba_xxxxx",
    "scheduledDate": null,
    "createdAt": "2024-01-15T10:30:00.000Z"
  }
}
```

### Response Fields

<ParamTable
  rows={[
    { name: "settlementId", type: "string", desc: "Unique settlement identifier" },
    { name: "merchantId", type: "string", desc: "Merchant identifier" },
    { name: "amount", type: "number", desc: "Requested settlement amount" },
    { name: "settlementFee", type: "number", desc: "Fee charged for the settlement" },
    { name: "netAmount", type: "number", desc: "Amount after fees" },
    { name: "currency", type: "string", desc: "ISO 4217 currency code" },
    { name: "type", type: "string", desc: "Settlement type" },
    { name: "priority", type: "string", desc: "Settlement priority" },
    { name: "status", type: "string", desc: "Settlement status" },
    { name: "description", type: "string", desc: "Settlement description" },
    { name: "bankAccountId", type: "string", desc: "Target bank account" },
    { name: "scheduledDate", type: "string", desc: "Scheduled settlement date, if any" },
    { name: "createdAt", type: "string", desc: "ISO 8601 creation timestamp" },
  ]}
/>

### Error Responses

<ErrorTable
  rows={[
    { code: "INVALID_AMOUNT", status: "400", message: "Amount below minimum" },
    { code: "UNAUTHORIZED", status: "401", message: "Invalid API key" },
    { code: "INSUFFICIENT_BALANCE", status: "402", message: "Wallet balance too low" },
    { code: "BANK_ACCOUNT_NOT_FOUND", status: "404", message: "Bank account doesn't exist" },
  ]}
/>

<CodeRail>

## Examples

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

```bash
curl -X POST https://api.zenpayz.com/merchant/api/v1/settlements/create \
  -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": 100000,
    "bankAccountId": "ba_xxxxx",
    "description": "Monthly settlement",
    "priority": "normal",
    "type": "standard"
  }'
```

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

```javascript
const settlement = await zenpays.settlements.create({
  amount: 100000,
  bankAccountId: 'ba_xxxxx',
  description: 'Monthly settlement',
  priority: 'normal',
  type: 'standard',
});
```

  </TabItem>
</Tabs>

</CodeRail>

## Settlement Status

| Status | Description |
|--------|-------------|
| `PENDING` | Settlement created, awaiting processing |
| `PROCESSING` | Being processed |
| `COMPLETED` | Funds transferred to bank |
| `FAILED` | Settlement failed |
| `CANCELLED` | Settlement was cancelled |
