KashierDevelopersKashier Developers
API reference and playgroundInvoices

List invoices

curl -X GET "https://test-api.kashier.io/v2/paymentRequests"
{  "body": [    {      "paymentRequestId": "PR-XXXXXXXXXX",      "merchantId": "MID-XXXX-XXXX",      "paymentType": "simple",      "totalAmount": 100,      "currency": "EGP",      "description": "Invoice for consulting services",      "customerName": "Ahmed Hassan",      "state": "submitted",      "paymentStatus": "unpaid",      "creationDate": "2026-07-30 09:12:44.201000+00:00"    }  ],  "pagination": {    "total": 42,    "limit": 20,    "page": 1,    "pages": 3  },  "message": "success"}

Lists your invoices, with pagination. Combine the filters to narrow the list down — for example paymentStatus=unpaid together with a date range to find everything still outstanding this month.

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

Query Parameters

paymentRequestId?string

Filter by a specific invoice identifier (e.g., PR-XXXXXXXXXX).

paymentStatus?string

Filter by payment status.

Value in

  • "unpaid"
  • "on hold"
  • "paid"
  • "voided"
state?string

Filter by the invoice lifecycle state.

Value in

  • "draft"
  • "submitted"
  • "cancelled"
  • "awaiting_approval"
  • "rejected"
customerName?string

Filter by customer name.

startDate?string

Start of the creation-date range (e.g., 2026-01-01).

endDate?string

End of the creation-date range (e.g., 2026-01-31).

startAmountRange?number

Minimum total amount.

endAmountRange?number

Maximum total amount.

limit?integer

Number of records per page.

page?integer

Page number.

Response Body

application/json

application/json

application/json

application/json

application/json

GET
/v2/paymentRequests

Create invoice POST

Creates an invoice (payment request). Kashier mints the invoice identifier for you — PR-… for a simple request, INV-… for a professional invoice, and ORD-… for an order — and returns a payment link…

Get invoice GET

Retrieves a single invoice, including its line items and any payment transactions recorded against it.