Create a payment session

Create a payment session for the embedded form. Pass the returned session_Id to the KNET, card or Apple Pay widget on your page.

paymentGatewayCodePayment method
KnetKNET
CCCSSAVisa and Mastercard
ApplePayApple Pay

Guide: Embedded Payment.

Errors

errorKeyCause
PaymentMethodRequiredpaymentGatewayCode is missing
ReferenceNumberRequiredref_Number is missing
AmountRequiredamount is missing or 0
InvoiceAmountMustEqualsToTotalItemsAmountamount is not the total of the items
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Payment method: Knet, CCCSSA (cards) or ApplePay.

string
required

Your order or reference number. Use it to match the invoice to your order.

number
required

Amount in KWD, up to 3 decimal places.

string
required

Currency code. Use KWD.

string
required

The customer's name.

string

The customer's mobile number, digits only.

string

The customer's email address.

string

Payment page language: en or ar.

Responses

isValid: validation errors also return HTTP 200 with isValid: false.

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json