Cancel Invoice

Cancel an invoice. The invoice status will be updated to CANCELLED.

POSThttps://api.zenpayz.com/merchant/api/v1/invoices/:invoiceId/cancel

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",
    "status": "CANCELLED",
    "cancelledAt": "2024-01-16T14:20:00.000Z"
  },
  "message": "Invoice cancelled successfully",
  "error": null,
  "meta": {
    "request_id": "req_xxxxx",
    "timestamp": "2024-01-16T14:20:00.000Z",
    "processing_time_ms": 35,
    "api_version": "v1",
    "endpoint": "POST /invoices/:invoiceId/cancel",
    "user_type": "merchant"
  }
}

Error Responses

Code	HTTP	Message
UNAUTHORIZED	401	Invalid API key
INVOICE_NOT_FOUND	404	Invoice does not exist
INVOICE_ALREADY_CANCELLED	409	Invoice has already been cancelled
INVOICE_PAID	409	Cannot cancel a fully paid invoice

Examples

cURL

curl -X POST https://api.zenpayz.com/merchant/api/v1/invoices/inv_a1b2c3d4e5f6g7h8/cancel \
  -H "Authorization: Bearer zp_test_xxxxx" \
  -H "X-Timestamp: 2024-01-16T14:20: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/cancel', {
  method: 'POST',
  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.status); // "CANCELLED"

SDK

const result = await zenpays.invoices.cancel('inv_a1b2c3d4e5f6g7h8');

console.log(result.status); // "CANCELLED"

Related Endpoints

• Get Invoice
• Send Invoice
• List Invoices