Linked Invoices

Retrieve all invoices linked to a specific payment link.

GEThttps://api.zenpayz.com/merchant/api/v1/payment-links/:linkId/invoices

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

Path Parameters

Parameter	Type	Description
linkId REQUIRED	string	The payment link ID (e.g. pl_a1b2c3d4e5f6g7h8)

Response

Success (200 OK)

{
  "success": true,
  "data": [
    {
      "invoiceId": "inv_a1b2c3d4e5f6g7h8",
      "invoiceNumber": "INV-2024-0001",
      "customerId": "cust_a1b2c3d4e5f6g7h8",
      "customerEmail": "john@example.com",
      "customerName": "John Doe",
      "currency": "USD",
      "status": "SENT",
      "totalAmount": 275.00,
      "amountPaid": 0,
      "amountDue": 275.00,
      "issueDate": "2024-01-15T00:00:00.000Z",
      "dueDate": "2024-02-15T00:00:00.000Z",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "invoiceId": "inv_c3d4e5f6g7h8i9j0",
      "invoiceNumber": "INV-2024-0002",
      "customerId": "cust_a1b2c3d4e5f6g7h8",
      "customerEmail": "john@example.com",
      "customerName": "John Doe",
      "currency": "USD",
      "status": "DRAFT",
      "totalAmount": 150.00,
      "amountPaid": 0,
      "amountDue": 150.00,
      "issueDate": "2024-01-20T00:00:00.000Z",
      "dueDate": "2024-02-20T00:00:00.000Z",
      "createdAt": "2024-01-20T10:30:00.000Z"
    }
  ],
  "message": "Linked invoices retrieved successfully",
  "error": null,
  "meta": {
    "request_id": "req_xxxxx",
    "timestamp": "2024-01-15T10:30:00.000Z",
    "processing_time_ms": 30,
    "api_version": "v1",
    "endpoint": "GET /payment-links/:linkId/invoices",
    "user_type": "merchant"
  }
}

Error Responses

Code	HTTP	Message
UNAUTHORIZED	401	Invalid API key
PAYMENT_LINK_NOT_FOUND	404	Payment link does not exist

Examples

cURL

curl -X GET https://api.zenpayz.com/merchant/api/v1/payment-links/pl_a1b2c3d4e5f6g7h8/invoices \
  -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 response = await fetch('https://api.zenpayz.com/merchant/api/v1/payment-links/pl_a1b2c3d4e5f6g7h8/invoices', {
  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); // Array of linked invoices
console.log(result.data.length); // 2

SDK

const invoices = await zenpays.paymentLinks.listInvoices('pl_a1b2c3d4e5f6g7h8');

console.log(invoices); // Array of linked invoices
console.log(invoices.length); // 2

Related Endpoints

• Get Payment Link
• Create Payment Link
• Update Payment Link
• Get Invoice