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

# Get Payment Link

Retrieve a single payment link by its ID.

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

## 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",
    "title": "Pro Plan Payment",
    "description": "Payment for Pro Plan subscription",
    "amount": 4999,
    "currency": "INR",
    "status": "ACTIVE",
    "usageType": "SINGLE",
    "maxUses": null,
    "usageCount": 0,
    "expiresAt": "2024-02-15T23:59:59.000Z",
    "productId": "prod_a1b2c3d4e5f6g7h8",
    "customerId": null,
    "invoiceId": null,
    "paymentUrl": "https://pay.zenpayz.com/pl_a1b2c3d4e5f6g7h8",
    "shortCode": "ZP-XYZ789",
    "shortUrl": "https://pay.zenpayz.com/s/ZP-XYZ789",
    "metadata": {},
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z"
  },
  "message": "Payment link retrieved successfully",
  "error": null,
  "meta": {
    "request_id": "req_xxxxx",
    "timestamp": "2024-01-15T10:30:00.000Z",
    "processing_time_ms": 25,
    "api_version": "v1",
    "endpoint": "GET /payment-links/:linkId",
    "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" },
  ]}
/>

<CodeRail>

## Examples

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

```bash
curl -X GET https://api.zenpayz.com/merchant/api/v1/payment-links/pl_a1b2c3d4e5f6g7h8 \
  -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"
```

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

```javascript
const response = await fetch('https://api.zenpayz.com/merchant/api/v1/payment-links/pl_a1b2c3d4e5f6g7h8', {
  method: 'GET',
  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.title); // "Pro Plan Payment"
console.log(result.data.shortUrl); // "https://pay.zenpayz.com/s/ZP-XYZ789"
```

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

```javascript
const link = await zenpays.paymentLinks.get('pl_a1b2c3d4e5f6g7h8');

console.log(link.title); // "Pro Plan Payment"
console.log(link.shortUrl); // "https://pay.zenpayz.com/s/ZP-XYZ789"
```

  </TabItem>
</Tabs>

</CodeRail>

## Related Endpoints

- [Create Payment Link](/docs/rest-api/endpoints/billing/payment-links/create-payment-link)
- [Update Payment Link](/docs/rest-api/endpoints/billing/payment-links/update-payment-link)
- [Deactivate Payment Link](/docs/rest-api/endpoints/billing/payment-links/deactivate-payment-link)
- [Linked Invoices](/docs/rest-api/endpoints/billing/payment-links/linked-invoices)
