KashierDevelopersKashier Developers
API reference and playgroundInvoices

Update invoice

curl -X PUT "https://test-api.kashier.io/v2/paymentRequest/string" \  -H "Content-Type: application/json" \  -d '{    "operation": "edit",    "totalAmount": 100,    "description": "Updated invoice",    "customerName": "Ahmed Hassan"  }'
{  "body": {    "paymentRequestId": "PR-XXXXXXXXXX",    "merchantId": "MID-XXXX-XXXX",    "totalAmount": 100,    "currency": "EGP",    "description": "Updated invoice",    "state": "submitted",    "paymentStatus": "unpaid"  },  "message": "success"}

Updates an invoice, or cancels it. Send operation: cancel to cancel an unpaid invoice; send any of the editable fields to change it. Only unpaid invoices can be edited.

Authorization

secretKey
Authorization<token>

Merchant secret key used to identify the merchant, obtained from Kashier's dashboard. Pass the raw secret key value in the Authorization header (NOT a "Bearer" token).

In: header

Path Parameters

paymentRequestId*string

The invoice identifier (e.g., PR-XXXXXXXXXX).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

The fields to change on an existing invoice. Send operation: cancel to cancel it instead of editing it.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

PUT
/v2/paymentRequest/{paymentRequestId}

Delete invoice DELETE

Deletes an invoice. The invoice is soft-deleted — it stops being payable and disappears from List invoices, but its history is retained.

Share invoice POST

Sends the invoice's payment link to a customer by email or SMS. Kashier records the delivery outcome on the invoice, so a later Get invoice shows whether the message was delivered, opened, or click…