Create Session

post

https://apitest.myfatoorah.com/v3/sessions

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

PaymentMode

string

enum

required

Defaults to COMPLETE_PAYMENT

Defines session mode. COLLECT_DETAILS or COMPLETE_PAYMENT

Allowed:

Order

object

required

Order information related to the payment..

SupportedNetworks

array of strings

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

SupportedNetworks

SaveCardOptions

object

Controls card tokenization behavior.

SupportedPaymentMethods

array of strings

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.

SupportedPaymentMethods

SessionExpiry

date-time

The session expiration date. Must be in UTC timezone.

ThreeDS

object

Enables or disables 3D Secure authentication.

OperationType

string

enum

Defines the type of payment operation.

Allowed:

Suppliers

array of objects

Required only if Multi-Vendor feature is enabled.

Suppliers

Customer

object

Customer information that will be returned back to you in webhook events.

IntegrationUrls

object

URLs for redirecting and receiving payment status notifications.

Language

string

enum

Invoice language.

Allowed:

MetaData

object

Custom fields stored with the transaction and returned in the webhook.

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Session created successfully