Create invoice

curl -X POST "https://test-api.kashier.io/v2/paymentRequest" \  -H "Content-Type: application/json" \  -d '{    "paymentType": "simple",    "totalAmount": 100,    "currency": "EGP",    "description": "Invoice for consulting services",    "customerName": "Ahmed Hassan",    "email": "[email protected]",    "phoneNumber": "+201000000000",    "referenceId": "REF-001",    "isManualCapture": false  }'

{  "body": {    "paymentRequestId": "PR-XXXXXXXXXX",    "merchantId": "MID-XXXX-XXXX",    "paymentType": "simple",    "totalAmount": 100,    "currency": "EGP",    "description": "Invoice for consulting services",    "customerName": "Ahmed Hassan",    "email": "[email protected]",    "referenceId": "REF-001",    "state": "submitted",    "paymentStatus": "unpaid",    "isManualCapture": false,    "availableAmountForRefund": 0,    "creationDate": "2026-07-30 09:12:44.201000+00:00",    "dueDate": null,    "transactions": []  },  "message": "success"}

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 you can send to the customer. The invoice starts unpaid; use Share invoice to deliver it, or send the link yourself.

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.

The invoice to create. paymentType decides the shape — simple is a bare amount to collect, professional adds line items and a due date, and order is an order link.

paymentType*string

The kind of invoice to mint. simple produces a PR-… identifier, professional an INV-…, and order an ORD-….

Value in

"simple"
"professional"
"order"

totalAmount*number

The amount to collect, in the invoice currency. Must be at least 1.

currency*string

ISO 4217 currency code (e.g., EGP).

Value in

"EGP"
"USD"
"GBP"
"EUR"

description*string

Free-text description shown to the customer on the payment page.

customerName*string

email?string

Customer email — the default recipient when you share the invoice by email.

phoneNumber?string

Customer mobile number — the default recipient when you share the invoice by SMS.

referenceId?string

Your own reference for the invoice. Kashier stores it alongside the invoice so you can reconcile against your books.

dueDate?string

Date the invoice falls due (e.g., 2030-01-01).

tax?number

Tax percentage applied to the invoice.

isManualCapture*boolean

When true, a card payment against this invoice is only authorized and you capture it later. Defaults to false.

state?string

Whether to save the invoice as a draft or publish it as submitted. Only a submitted invoice is payable.

Value in

"draft"
"submitted"

invoiceItems?array<>

Line items, for a professional invoice.

extraFees?array<>

Extra fees added on top of the line items.

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Create invoice

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`