v1

latestOpenAPI 3.0.02026-07-24440173.4 KB

Sessions

Create Session

Creates a session for embedded payment flows (COLLECT_DETAILS or COMPLETE_PAYMENT).

post/v3/sessions

Request body

PaymentMode'COMPLETE_PAYMENT' | 'COLLECT_DETAILS' required

Defines session mode. COLLECT_DETAILS or COMPLETE_PAYMENT

SupportedNetworksstring[]

Specifies the allowed card networks for the session such as: ["visa", "masterCard", "mada", "amex"].

SupportedPaymentMethodsstring[]

Payment methods to show in the embedded view such as: ["card", "knet", "googlepay", "applepay"] If not sent, all payment methods enabled on your account will appear automatically.

SessionExpirystring date-time

The session expiration date. Must be in UTC timezone.

OperationType'AUTHORIZE' | 'PAY' | 'VERIFY'

Defines the type of payment operation.

Language'EN' | 'AR'

Invoice language.

Response

Session created successfully

IsSuccessboolean

Indicates if the request was successful.

Messagestring

Response message associated with the request.

ValidationErrorsobject[]

A model that contains two keys "Name" and "Error". This is used to indicate the validation result for all parameters you have sent in your request. This can have one or more items based on the invalid parameter count.