Create Payment

post

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
API Base URL
To identify the correct API Base URL for your environment, please refer to this table.

Body Params

PaymentMethod

string

enum

Defaults to CARD

Specify the payment method you want to use, or omit this parameter to create a payment page that displays all enabled methods. This is required for redirection cases.

Allowed:

Order

object

required

Order information related to the payment..

SourceOfFund

object

Contains the payment source details (Tokenized card, direct card details, or Session Id)

PaymentExpiry

date-time

The payment expiration date. Must be in UTC timezone.

SaveCardOptions

object

Used to tokenize card details when using direct integration.

ThreeDS

object

3D Secure authentication details for the direct card transaction.

NotificationOption

string

enum

Defines how the customer receives invoice notifications.
Note: Email or mobile becomes mandatory based on the selected option.

Allowed:

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:

IpAddress

string

The customer’s IP address

MetaData

object

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

DisplayPaymentMethods

array of strings

Array of payment methods to be displayed on the invoice page.
such as: ["card", "knet", "googlepay", "applepay"]
If this parameter is not sent, and the PaymentMethod field is also not provided, all payment methods enabled on your account will be displayed automatically.

DisplayPaymentMethods

NetworkTransactionId

string

Can be used when paying with network tokens.

Response

Language

Credentials

Bearer

Loading…

Response

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

application/json

API Base URL

201Payment created successfully