<!-- ZenPays documentation · https://docs.zenpayz.com/docs/rest-api/endpoints/billing/payment-links/deactivate-payment-link -->

# Deactivate Payment Link

Deactivate a payment link. The link status will be set to `INACTIVE` and it will no longer accept payments.

<EndpointHeader verb="POST" path="/merchant/api/v1/payment-links/:linkId/deactivate" />

## 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`" },
  ]}
/>

### Path Parameters

<ParamTable
  rows={[
    { name: "linkId", type: "string", required: true, desc: "The payment link ID (e.g. `pl_a1b2c3d4e5f6g7h8`)" },
  ]}
/>

## Response

### Success (200 OK)

```json
{
  "success": true,
  "data": {
    "linkId": "pl_a1b2c3d4e5f6g7h8",
    "status": "INACTIVE",
    "deactivatedAt": "2024-01-16T14:20:00.000Z"
  },
  "message": "Payment link deactivated successfully",
  "error": null,
  "meta": {
    "request_id": "req_xxxxx",
    "timestamp": "2024-01-16T14:20:00.000Z",
    "processing_time_ms": 30,
    "api_version": "v1",
    "endpoint": "POST /payment-links/:linkId/deactivate",
    "user_type": "merchant"
  }
}
```

### Error Responses

<ErrorTable
  rows={[
    { code: "UNAUTHORIZED", status: "401", message: "Invalid API key" },
    { code: "PAYMENT_LINK_NOT_FOUND", status: "404", message: "Payment link does not exist" },
    { code: "PAYMENT_LINK_ALREADY_INACTIVE", status: "409", message: "Payment link is already inactive" },
  ]}
/>

<CodeRail>

## Examples

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

```bash
curl -X POST https://api.zenpayz.com/merchant/api/v1/payment-links/pl_a1b2c3d4e5f6g7h8/deactivate \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-16T14:20:00.000Z" \
  -H "X-Signature: a1b2c3d4e5f6..." \
  -H "X-Secret-Salt: your_secret_salt" \
  -H "Content-Type: application/json"
```

  </TabItem>
  <TabItem value="javascript" label="JavaScript">

```javascript
const response = await fetch('https://api.zenpayz.com/merchant/api/v1/payment-links/pl_a1b2c3d4e5f6g7h8/deactivate', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'X-Timestamp': timestamp,
    'X-Signature': signature,
    'X-Secret-Salt': secretSalt,
    'Content-Type': 'application/json',
  },
});

const result = await response.json();
console.log(result.data.status); // "INACTIVE"
```

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

```javascript
const result = await zenpays.paymentLinks.deactivate('pl_a1b2c3d4e5f6g7h8');

console.log(result.status); // "INACTIVE"
```

  </TabItem>
</Tabs>

</CodeRail>

## Related Endpoints

- [Get Payment Link](/docs/rest-api/endpoints/billing/payment-links/get-payment-link)
- [Update Payment Link](/docs/rest-api/endpoints/billing/payment-links/update-payment-link)
- [List Payment Links](/docs/rest-api/endpoints/billing/payment-links/list-payment-links)
