Create Payment Link

Create a new payment link that can be shared with customers to collect payments.

POSThttps://api.zenpayz.com/merchant/api/v1/payment-links

Bearer · API key

Request

Headers

Header	Description
Authorization REQUIRED	Bearer {api_key}
X-Signature REQUIRED	HMAC-SHA256 signature
X-Timestamp REQUIRED	ISO 8601 timestamp
X-Secret-Salt REQUIRED	Secret salt for HMAC validation
Content-Type REQUIRED	application/json

Body Parameters

Parameter	Type	Description
title REQUIRED	string	Payment link title (1-255 characters)
description OPTIONAL	string	Payment link description
amount REQUIRED	number	Payment amount (minimum 0.01)
currency OPTIONAL	string	Currency code (default: INR)
usageType OPTIONAL	string	Usage type (default: SINGLE). One of SINGLE, MULTI
maxUses OPTIONAL	number	Maximum number of uses (minimum 1, only for MULTI type)
expiresAt OPTIONAL	string	Expiration date (ISO 8601)
productId OPTIONAL	string	Associated product ID
customerId OPTIONAL	string	Associated customer ID
invoiceId OPTIONAL	string	Associated invoice ID
invoiceIds OPTIONAL	string[]	Array of associated invoice IDs
metadata OPTIONAL	object	Custom key-value pairs

Response

Success (201 Created)

{
  "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 created successfully",
  "error": null,
  "meta": {
    "request_id": "req_xxxxx",
    "timestamp": "2024-01-15T10:30:00.000Z",
    "processing_time_ms": 55,
    "api_version": "v1",
    "endpoint": "POST /payment-links",
    "user_type": "merchant"
  }
}

Error Responses

Code	HTTP	Message
VALIDATION_ERROR	400	Invalid request parameters
UNAUTHORIZED	401	Invalid API key
PRODUCT_NOT_FOUND	404	Associated product does not exist
INVOICE_NOT_FOUND	404	Associated invoice does not exist

Examples

cURL

curl -X POST https://api.zenpayz.com/merchant/api/v1/payment-links \
  -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 '{
    "title": "Pro Plan Payment",
    "description": "Payment for Pro Plan subscription",
    "amount": 4999,
    "currency": "INR",
    "usageType": "SINGLE",
    "expiresAt": "2024-02-15T23:59:59.000Z",
    "productId": "prod_a1b2c3d4e5f6g7h8"
  }'

JavaScript

const response = await fetch('https://api.zenpayz.com/merchant/api/v1/payment-links', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'X-Timestamp': timestamp,
    'X-Signature': signature,
    'X-Secret-Salt': secretSalt,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    title: 'Pro Plan Payment',
    description: 'Payment for Pro Plan subscription',
    amount: 4999,
    currency: 'INR',
    usageType: 'SINGLE',
    expiresAt: '2024-02-15T23:59:59.000Z',
    productId: 'prod_a1b2c3d4e5f6g7h8',
  }),
});

const result = await response.json();
console.log(result.data.linkId); // pl_a1b2c3d4e5f6g7h8
console.log(result.data.shortUrl); // "https://pay.zenpayz.com/s/ZP-XYZ789"

SDK

const link = await zenpays.paymentLinks.create({
  title: 'Pro Plan Payment',
  description: 'Payment for Pro Plan subscription',
  amount: 4999,
  currency: 'INR',
  usageType: 'SINGLE',
  expiresAt: '2024-02-15T23:59:59.000Z',
  productId: 'prod_a1b2c3d4e5f6g7h8',
});

console.log(link.linkId); // pl_a1b2c3d4e5f6g7h8
console.log(link.shortUrl); // "https://pay.zenpayz.com/s/ZP-XYZ789"

Related Endpoints

• List Payment Links
• Get Payment Link
• Update Payment Link
• Payment Link Analytics