# List Payment Links Retrieve a paginated list of payment links with optional filtering and sorting. ## Request ### Headers ### Query Parameters ## Response ### Success (200 OK) ```json { "success": true, "data": { "items": [ { "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", "shortCode": "ZP-XYZ789", "shortUrl": "https://pay.zenpayz.com/s/ZP-XYZ789", "createdAt": "2024-01-15T10:30:00.000Z", "updatedAt": "2024-01-15T10:30:00.000Z" } ], "total": 1, "page": 1, "limit": 20, "totalPages": 1 }, "message": "Payment links retrieved successfully", "error": null, "meta": { "request_id": "req_xxxxx", "timestamp": "2024-01-15T10:30:00.000Z", "processing_time_ms": 35, "api_version": "v1", "endpoint": "GET /payment-links", "user_type": "merchant" } } ``` ### Error Responses ## Examples ```bash curl -X GET "https://api.zenpayz.com/merchant/api/v1/payment-links?status=ACTIVE&page=1&limit=20" \ -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" ``` ```javascript const params = new URLSearchParams({ status: 'ACTIVE', page: '1', limit: '20', }); const response = await fetch(`https://api.zenpayz.com/merchant/api/v1/payment-links?${params}`, { 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.items); // Array of payment links console.log(result.data.total); // Total count ``` ```javascript const links = await zenpays.paymentLinks.list({ status: 'ACTIVE', page: 1, limit: 20, }); console.log(links.items); // Array of payment links console.log(links.total); // Total count ``` ## Related Endpoints - [Create Payment Link](/docs/rest-api/endpoints/billing/payment-links/create-payment-link) - [Get Payment Link](/docs/rest-api/endpoints/billing/payment-links/get-payment-link) - [Payment Link Analytics](/docs/rest-api/endpoints/billing/payment-links/payment-link-analytics)