Get Invoice

Retrieve a single invoice by its ID, including all line items and payment details.

GEThttps://api.zenpayz.com/merchant/api/v1/invoices/:invoiceId

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
invoiceId REQUIRED	string	The invoice ID (e.g. inv_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",
    "issueDate": "2024-01-15T00:00:00.000Z",
    "dueDate": "2024-02-15T00:00:00.000Z",
    "subtotal": 250.00,
    "taxRate": 10,
    "taxAmount": 25.00,
    "discountAmount": 0,
    "totalAmount": 275.00,
    "amountPaid": 0,
    "amountDue": 275.00,
    "notes": "Thank you for your business",
    "terms": "Net 30",
    "lineItems": [
      {
        "id": "li_001",
        "productId": "prod_a1b2c3d4e5f6g7h8",
        "description": "Pro Plan - Monthly",
        "quantity": 5,
        "unitPrice": 50.00,
        "taxRate": 0,
        "amount": 250.00,
        "sortOrder": 0
      }
    ],
    "metadata": {},
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:30:00.000Z"
  },
  "message": "Invoice 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 /invoices/:invoiceId",
    "user_type": "merchant"
  }
}

Error Responses

Code	HTTP	Message
UNAUTHORIZED	401	Invalid API key
INVOICE_NOT_FOUND	404	Invoice does not exist

Examples

cURL

curl -X GET https://api.zenpayz.com/merchant/api/v1/invoices/inv_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"

JavaScript

const response = await fetch('https://api.zenpayz.com/merchant/api/v1/invoices/inv_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.invoiceNumber); // "INV-2024-0001"
console.log(result.data.totalAmount); // 275.00

SDK

const invoice = await zenpays.invoices.get('inv_a1b2c3d4e5f6g7h8');

console.log(invoice.invoiceNumber); // "INV-2024-0001"
console.log(invoice.totalAmount); // 275.00

Related Endpoints

• Create Invoice
• Update Invoice
• Send Invoice
• Cancel Invoice