KashierDevelopersKashier Developers
API reference and playgroundInvoices

Share invoice

curl -X POST "https://test-api.kashier.io/v2/paymentRequest/share" \  -H "Content-Type: application/json" \  -d '{    "operation": "email",    "key": "[email protected]",    "urlIdentifier": "PR-XXXXXXXXXX"  }'
{  "body": {    "paymentRequestId": "PR-XXXXXXXXXX",    "lastShareStatus": {      "email": {        "status": "pending"      }    }  },  "message": "success"}

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 clicked. This endpoint is rate-limited.

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Which invoice to share, with whom, and over which channel.

Response Body

application/json

application/json

application/json

application/json

application/json

POST
/v2/paymentRequest/share

Update invoice PUT

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.

Export invoices GET

Exports the invoices matching your filters as a spreadsheet, returned inline in the response. For large exports use Export invoices asynchronously instead, which emails you the file once it is ready.