Create Session

post

https://api.ksamerchant.geidea.net/payment-intent/api/v2/direct/session

Body Params

amount

float

required

Defaults to 1850

The total amount value of the payment. This parameter is required, and the format is a double - a number with 2 digits after the decimal point. For example 19.99

currency

string

required

Defaults to SAR

The currency of the payment. This is a 3-digit alphabetic code, following the ISO 4217 currency code standard. For example: SAR

timestamp

string

Defaults to 2/21/2024 5:16:48 AM

The timestamp of the moment at which the create session request has been initiated.

merchantReferenceId

string

Defaults to 10

The unique identifier for the session given added by the merchant. Must be a valid UUID

signature

string

required

Defaults to tF04+uS/SE+z4Bx6JxtO7UAd/srkX9KK7pM3Ertp2iM=

A parameter to ensure the security and authenticity of API communications. It involves generating a signature using the contents of the API request and secret keys, which is then sent along with the request.

paymentIntentId

string

If you have previously generated a payment intent, you can use this parameter to link your order to the payment intent. This will process a payment for the specified payment intent.

paymentOperation

string

enum

Defaults to Pay

The type of payment operation to be performed. This is an optional parameter - if not submitted, the Geidea gateway will process a 'Pay' operation by default.

Allowed:

cardOnFile

boolean

Indicates whether to store the payment method for future use. If you pass 'true' in this field, Geidea will save the card and will return a tokenId in the callback after the order. This tokenId can be used later to process a payment for the same customer using the saved payment method.

metadata

object

Object that contain parameter to pass additional custom data

appearance

object

This object allows you to modify the appearance of the Geidea Checkout payment widget.

language

string

enum

Defaults to en

The language to be used on the checkout page.

Allowed:

callbackUrl

string

Defaults to https://www.callbackurl.com

The URL where the payment gateway should send the callback after the transaction is completed. It must have a valid SSL certificate and start with 'https://'

subscriptionId

string

The subscription Id for which the payment is initiated. Must be a valid GUID. Subscription ID (generated from the create subscription API) can be passed in the request to capture the card on file details during the first transaction and later Geidea will auto-debit the customers as per the set frequency and interval based on securely stored token.

returnUrl

string

Defaults to https://www.geidea.net

A URL that can be used to redirect to a different page after the transaction has been completed

customer

object

Customer object that specifies all details of the customer

cofAgreement

object

Agreement object to specify the details of the agreement between the merchant & a customer for a specific transaction

initiatedBy

string

enum

Defaults to Internet

A value indicating whether the request is started from Customer(Internet) or Merchant.

Allowed:

tokenid

string

Tokenid that can be passed to create session for a CIT token payment or MIT unscheduled payment

platform

object

Details of the platform used to run the payment page

paymentOptions

array of objects

A list of available of option to make available on the payment page

paymentOptions

order

object

The object indicating details of the order

Headers

deviceBrand

string

For instance Apple

deviceModel

string

For instance 14 Pro

deviceType

string

For instance iPhone

language

string

For instance en or ar

sdkVersion

string

For instance 1.0.0

OSVersion

string

For instance 18.0

Responses

200200

400400