Create Session - Subscription

post/payment-intent/api/v2/direct/session-subscription

Request

  • Base URL
    https://api.ksamerchant.geidea.net
  • URL
    https://api.ksamerchant.geidea.net/payment-intent/api/v2/direct/session-subscription
  • Auth
    HTTP basic

Request body

amountnumber float required

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

currencystring required

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

timestampstring

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

merchantReferenceIdstring

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

signaturestring required

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.

subscriptionIdstring required

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.

paymentIntentIdstring

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'Pay' | 'PreAuthorize' | 'AuthorizeCapture'

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.

cardOnFileboolean

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.

language'en' | 'ar'

The language to be used on the checkout page.

callbackUrlstring

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://'

Changes

No recorded changes to this operation across all 2 revisions of this API.