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

# Get Settlement

Retrieve details of a specific settlement.

<EndpointHeader verb="GET" path="/merchant/api/v1/settlements/{id}" />

## Request

### Path Parameters

<ParamTable
  rows={[
    { name: "id", type: "string", required: true, desc: "Settlement 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" },
  ]}
/>

## Response

### Success (200 OK)

```json
{
  "success": true,
  "data": {
    "settlementId": "stl_xxxxx",
    "merchantId": "mer_xxxxx",
    "amount": 100000,
    "settlementFee": 500,
    "netAmount": 99500,
    "currency": "USD",
    "type": "standard",
    "priority": "normal",
    "status": "COMPLETED",
    "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" },
  ]}
/>

<CodeRail>

## Examples

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

```bash
curl -X GET "https://api.zenpayz.com/merchant/api/v1/settlements/stl_xxxxx" \
  -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
const settlement = await zenpays.settlements.get('stl_xxxxx');
```

  </TabItem>
</Tabs>

</CodeRail>
