Payment pages

Create payment page

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.

post/v2/paymentPage

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/paymentPage
  • Auth: API key in header Authorization

Request body

pageNamestring required

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

descriptionstring
currency'EGP' | 'USD' | 'GBP' | 'EUR' required

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

type'regular' | 'product' required

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

isMobileRequiredboolean required

Whether the customer must supply a mobile number.

isEmailRequiredboolean required

Whether the customer must supply an email address.

paymentMethodsstring[] required

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

taxnumber

Tax percentage applied to the page total.

isPublishedboolean

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

isShippableboolean

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

pickupAddressIdstring

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

pageImagestring

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

Response

The created payment page, including the linkId its public URL is built from.

messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.