MYmyfatoorah
Payments

Create Payment

Changed on
post/v3/payments

Request

  • Base URL
    https://apitest.myfatoorah.com
  • URL
    https://apitest.myfatoorah.com/v3/payments
  • Auth
    HTTP bearer

Request body

PaymentMethod'CARD' | 'APPLE_PAY' | 'GOOGLE_PAY' | 'KNET'

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.

PaymentExpirystring date-time

The payment expiration date. Must be in UTC timezone.

NotificationOption'EMAIL' | 'SMS' | 'ALL' | 'LINK'

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

OperationType'AUTHORIZE' | 'PAY'

Defines the type of payment operation.

Language'EN' | 'AR'

Invoice language.

IpAddressstring

The customer’s IP address

DisplayPaymentMethodsstring[]

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.

Response

Payment created successfully

IsSuccessstring

"true" or "false" indicating the status of your request.

Messagestring

The message response associated with the request done

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.

Changes

  • 00639fc15f06Revision changes
    • warning

      removed the request property

    • info

      added the new optional request property