Create payment page

curl -X POST "https://test-api.kashier.io/v2/paymentPage" \  -H "Content-Type: application/json" \  -d '{    "pageName": "Q1 Sales Page",    "description": "Payment page for Q1",    "currency": "EGP",    "type": "regular",    "isMobileRequired": true,    "isEmailRequired": true,    "paymentMethods": [      "card"    ],    "paymentObject": {      "isFixed": true,      "amount": "100.00"    },    "tax": 0,    "isShippable": false,    "isPublished": true  }'

{  "body": {    "_id": "507f1f77bcf86cd799439011",    "linkId": "PP-XXXXXXXXXX",    "merchantId": "MID-XXXX-XXXX",    "pageName": "Q1 Sales Page",    "description": "Payment page for Q1",    "type": "regular",    "currency": "EGP",    "isMobileRequired": true,    "isEmailRequired": true,    "isPublished": true,    "isShippable": false,    "paymentMethods": [      "card"    ],    "paymentObject": {      "isFixed": true,      "amount": 100    },    "tax": 0,    "totalPaidAmount": 0,    "totalPaymentCount": 0,    "totalPendingCount": 0,    "creationDate": "2026-07-30 09:12:44.201000+00:00"  },  "message": "success"}

Creates a payment page. Kashier mints a link identifier (PP-…) for the page, which is what the public URL and the /public reads are keyed on. Set paymentObject.isFixed to collect one fixed amount, or leave it false to let the customer enter the amount.

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 payment page to create. type decides the shape — regular collects a single amount, product lists a catalogue the customer buys from.

pageName*string

The page's name, shown to the customer. Must be unique across your payment pages.

description?string

currency*string

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

Value in

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

type*string

regular for a single-amount page, product for a catalogue page.

Value in

"regular"
"product"

isMobileRequired*boolean

Whether the customer must supply a mobile number.

isEmailRequired*boolean

Whether the customer must supply an email address.

paymentMethods*array<string>

The payment methods offered on the page. Forced to ["card"] when isShippable is true.

paymentObject?

How much the page collects. When isFixed is true the customer pays amount exactly; when it is false the customer types in their own amount.

tax?number

Tax percentage applied to the page total.

isPublished?boolean

Whether the page is live. An unpublished page's link does not render.

isShippable?boolean

Whether the page collects a delivery address and creates a shipping order for each payment.

pickupAddressId?string

Which of your saved pickup addresses fulfilment collects from. Only used when isShippable is true.

pageImage?string

URL of the banner image shown at the top of the page.

extraFields?array<>

additionalFees?array<>

products?array<>

The catalogue, for a product page.

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Create payment page

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`