NAV Navbar
Logo

Before Starting the Integration section in the API:

Step 1: Access your test account
You have to make sure that you get access to a test account, it’s a full test environment allow you to simulate and process simulation transactions. You can contact support@payfort.com to get your test account.

Step 2: make sure that you are using the correct integration type
Before building the integration, you need to make sure that you are selecting and using the proper parameters in the API calls as per the required integration type.

All the mandatory parameters mentioned in every section in the API documentation.

Step 3: Create the transaction request
Process a valid API request depends on transaction parameters included, you need to check the documentation and read every parameter possible values in order to reduce the errors in processing the transaction.

Step 4: Process the transaction response
After each payment processed, PayFort returns the transaction’s response on the URL configured in your account under Technical Settings channel configuration.

You can find more details in the API documentation section Direct Transaction Feedback.

You need to validate the response parameters returned on this URL by calculating the signature for the response parameters using the SHA Response Phrase configured in your account under Security Settings.

Step 5: Test and Go Live
You can use our testing cards to test your integration and simulate your test cases.

PayFort requires to test your integration before going live to verify the integration and make sure it’s implemented properly.

Installments Redirection

Installments Redirection Service - Request

Include the following parameters in the Purchase - Request Parameters you will send to PayFort:

ATTRIBUTES Description
installments
Alpha
Optional
max: 10
Used to specify the type of the Installments service.
Possible/ expected values: STANDALONE

Installments Redirection Service - Response

The following parameters will be returned in PayFort’s Response in addition to the Purchase - Response Parameters:

ATTRIBUTES Description
installments
Alpha
max: 10
Used to specify the type of the Installments service.
Possible/ expected values: STANDALONE
number_of_installments
Numeric
max: 2
The number of installments the customer has selected in the payment page.
Example: 3

Installments Merchant Page (Iframe)

Installments Merchant page Service - Request

Include the following parameters in the Merchant page - Request Parameters you will send to PayFort:

ATTRIBUTES Description
installments
Alpha
Mandatory
max: 10
Used to specify the type of the Installments service.
Possible/ expected values: STANDALONE
amount
Numeric
Mandatory
Max: 10
The transaction’s amount. *Each currency has predefined allowed decimal points that should be taken into consideration when sending the amount.
Example: 10000
currency
Alpha
Mandatory
Max: 3
The currency of the transaction’s amount in ISO code 3.
Example: USD
customer_country_code
Alpha
Optional
Max: 3
The Customer’s country code. ISO 3 digit country code.
Example: JOR

Installments Merchant page Service - Response

The following parameters will be returned in PayFort’s Response in addition to the Merchant Page - Response Parameters:

ATTRIBUTES Description
installments
Alpha
max: 10
Used to specify the type of the Installments service.
Possible/ expected values: STANDALONE
amount
Numeric
Max: 10
The transaction’s amount.
Example: 10000
currency
Alpha
Max: 3
The currency of the transaction’s amount in ISO code 3.
Example: USD
customer_country_code
Alpha
Max: 3
The Customer’s country code. ISO 3-digit country code.
Example: JOR
number_of_installments
Numeric
Max: 2
The number of installments the customer has selected in payment page.
Example: 3
plan_code
Alphanumeric
Max: 8
A code that refers to the “installments plan” the customer selected from the merchant page.
Example: NNNN89JJ
issuer_code
Alphanumeric
Max: 8
A code that refers to the “card issuer” the customer selected from the merchant page.
Example: 12HP34SE

Installments Purchase Service - Request

Include the following parameters in the Operation - Request Parameters you will send to PayFort:

ATTRIBUTES Description
installments
Alpha
Mandatory
max: 10
Used to specify the type of the Installments service.
Possible/ expected values: YES
plan_code
Alphanumeric
Mandatory
Max: 8
A code that refers to the “installments plan” the customer selected from the merchant page.
Example: NNNN89JJ
issuer_code
Alphanumeric
Mandatory
Max: 8
A code that refers to the “card issuer” the customer selected from the merchant page.
Example: 12HP34SE

Installments Purchase Service - Response

The following parameters will be returned in PayFort’s Response in addition to the Operation - Response Parameters:

ATTRIBUTES Description
installments
Alpha
max: 10
Used to specify the type of the Installments service.
Possible/ expected values: YES
plan_code
Alphanumeric
Max: 8
A code that refers to the “installments plan” the customer selected from the merchant page.
Example: NNNN89JJ
issuer_code
Alphanumeric
Max: 8
A code that refers to the “card issuer” the customer selected from the merchant page.
Example: 12HP34SE
number_of_installments
Numeric
Max: 2
The number of installments the customer has selected in payment page.
Example: 3

Installments Hosted Checkout

Get Installments Plans API

This service allows you to know the installment plan details and issuers configured in your account for the installment service.

Get Installments Plans API URLs

Test Environment URL:

https://sbpaymentservices.payfort.com/FortAPI/paymentApi

Production Environment URL:

https://paymentservices.payfort.com/FortAPI/paymentApi

Parameters Submission Type

REST POST request using JSON.

Get Installments Plans API - Request

Include the following parameters in the Request you will send to PayFort:

ATTRIBUTES Description
query_command
Alpha
Mandatory
max: 50
Query operations command.
Possible/ expected values: GET_INSTALLMENTS_PLANS
Special characters: _
access_code
Alphanumeric
Mandatory
max: 20
Access code.
Example: zx0IPmPy5jp1vAz
merchant_identifier
Alphanumeric
Mandatory
max: 20
The ID of the Merchant.
Example: CycHZxVj
signature
Alphanumeric
Mandatory
max: 200
A string hashed using the Secure Hash Algorithm. (Please refer to section Signature for more details).
Example: 7cad05f0212ed933c9a5d5dffa31661acf2c827a
amount
Numeric
Optional
max: 10
The transaction’s amount.*Each currency has predefined allowed decimal points that should be taken into consideration when sending the amount.
Example: 10000
currency
Alpha
Optional
max: 3
The currency of the transaction’s amount in ISO code 3.
Example: USD
language
Alpha
Optional
max: 2
The checkout page and messages language.
Possible/ expected values: en / ar
issuer_code
Alphanumeric
Optional
max: 8
A code that refers to the “card issuer” the customer selected from the merchant page.
Example: 12HP34SE

Get Installments Plans API - Response

The following parameters will be returned in PayFort’s Response:

ATTRIBUTES Description
query_command
Alpha
max: 50
Query operations command.
Possible/ expected values: GET_INSTALLMENTS_PLANS
access_code
Alphanumeric
max: 20
Access code.
Example: zx0IPmPy5jp1vAz
merchant_identifier
Alphanumeric
max: 20
The ID of the Merchant.
Example: CycHZxVj
signature
Alphanumeric
max: 200
A string hashed using the Secure Hash Algorithm. (Please refer to section Signature for more details).
Example: 7cad05f0212ed933c9a5d5dffa31661acf2c827a
amount
Numeric
max: 10
The transaction’s amount.
Example: 10000
currency
Alpha
max: 3
The currency of the transaction’s amount in ISO code 3.
Example: USD
language
Alpha
max: 2
The checkout page and messages language.
Possible/ expected values: en / ar
issuer_code
Alphanumeric
max: 8
A code that refers to the “card issuer” the customer selected from the merchant page.
Example: 12HP34SE
response_message
Alphanumeric
max: 150
Message description of the response code. It returns according to the request language.
Example: Insufficient Funds
response_code
Numeric
Max: 5
Response Code carries the value of our system’s response. *The code consists of five digits, the first 2 digits represent the response status, and the last 3 digits represent the response messages.
Example: 20064
status
Numeric
max: 2
A two-digit numeric value that indicates the status of the transaction
Possible/ expected values: (Please refer to section statuses).
installment_detail
List
max: -
This parameter is a parent parameter for other parameters that contain the details of installment.
Possible/ expected values: (Please refer to section issuer_detail).

issuer_detail

This parameter is a sub parameter of the “installment_detail” parameter, the table below shows the children parameters of the “issuer_detail”:

ATTRIBUTES Description
issuer_code
Alphanumeric
max: 8
A code that refers to the “card issuer” the customer selected from the merchant page.
Example: 12HP34SE
issuer_name_ar
Alphanumeric
max: 50
The issuer name in Arabic.
Example: Issuer2عربي
issuer_name_en
Alphanumeric
max: 50
The issuer name in English.
Example: Issuer2
terms_and_condition_ar
Alphanumeric
max: 200
The Arabic terms and condition URL.
Example: http://www.gmail.com
terms_and_condition_en
Alphanumeric
max: 200
The English terms and condition URL.
Example: http://www.yahoo.com
country_code
Alpha
max: 3
The country’s code in ISO 3-digits.
Example: JOR
issuer_logo_ar
Alphanumeric
max: 350
The issuer logo for the Arabic version.
Example: https://payfort-fort-images-lt.s3.amazonaws.com/frontend/files/logos/issuer/logo_en_164.jpg
issuer_logo_en
Alphanumeric
max: 350
The issuer logo for the English version.
Example: https://payfort-fort-images-lt.s3.amazonaws.com/frontend/files/logos/issuer/logo_en_164.jpg
banking_system
Alpha
max: 11
The type of institutions that provide financial services.
Possible/ expected values:
-Non Islamic
-Islamic
formula
Alphanumeric
max: 100
The equation of calculating the installment value.
Example: (amount +(amount *effective rate/100))/period
Please check the note below the table for more details.
plan_detail
List
max: -
This parameter contain all the plans for this issuer.
Possible/ expected values: (Please refer to section plan_detail).
bins
List
max: -
List of 6 digits of the card number related to this issuer.
Possible/ expected values: (Please refer to section bins).
confirmation_message_ar
Alphanumeric
max: 500
This parameter shows to the customer the confirmation message that the merchant configure on his back-office in Arabic.
disclaimer_message_ar
Alphanumeric
max: 500
This parameter shows to the customer the disclaimer message that the merchant configure on his back-office in Arabic.
processing_fees_message_ar
Alphanumeric
max: 500
This parameter shows to the customer the processing fee message that the merchant configure on his back-office in Arabic.
confirmation_message_en
Alphanumeric
max: 500
This parameter shows the customer to the confirmation message that the merchant configure on his back-office in English.
confirmation_message_en
Alphanumeric
max: 500
This parameter shows the customer to the confirmation message that the merchant configure on his back-office in English.
disclaimer_message_en
Alphanumeric
max: 500
This parameter shows to the customer the disclaimer message that the merchant configure on his back-office in English.
processing_fees_message_en
Alphanumeric
max: 500
This parameter shows to the customer the processing fee message that the merchant configure on his back-office in English.

plan_detail Parameter

This parameter is a sub parameter of the “issuer_detail” parameter, the table below shows the children parameters of the “plan_detail”:

ATTRIBUTES Description
plan_code
Alphanumeric
max: 8
A code that refers to the “installments plan”.
Example: NNNN89JJ
currency_code
Alpha
max: 3
The currency of the transaction’s amount in ISO code 3.
Example: USD
number_of_installment
Numeric
max: 2
The number of installments.
Example: 3
fees_type
Alpha
max: 10
The type of the fee.
Possible/ expected values:
-Fixed
-Percentage
*Please refer to the formulas section to know the difference.
fees_amount
Numeric
max: 10
The amount of the fee.
Example: 11
processing_fees_type
Alpha
max: 10
The type of the processing fee.
Possible/ expected values:
-Fixed
-Percentage
*Please refer to the formulas section to know the difference.
processing_fees_amount
Numeric
max: 10
The amount of the processing fee.
Example: 11
rate_type
Numeric
max: 15
The type of the rate.
Possible/ expected values:
-Reducing Balance
-Flat
plan_merchant_type
Alpha
max: 11
The type of agreement between the plan and Merchant.
Possible/ expected values:
-Partner
-Non Partner
plan_type
Alpha
max: 12
The type of the installments plan.
Possible/ expected values:
-Local
-Cross-Border
fee_display_value
Numeric
max:
The display value that represent the fees amount.
Example: 11.0
minimum_amount
Numeric
max: 10
The minimum range of the accepted amount for this plan.
Example: 11
maximum_amount
Numeric
max: 10
The maximum range of the accepted amount for this plan.
Example: 110000000
amountPerMonth
Numeric
max: 10
The payable amount per month.
Example: 3.00

bins

This parameter is a sub parameter of the “issuer_detail” parameter, the table below shows the children parameters of the “bins”:

ATTRIBUTES Description
bin
Numeric
max: 6
The first 6 digits of the card number.
Example: 478773
currency_code
Alpha
max: 3
The currency of the transaction’s amount in ISO code 3.
Example: JOR
currency_code
Alpha
max: 3
The currency of the transaction’s amount in ISO code 3.
Example: USD
card_brand_code
Alpha
max: 16
The type of the credit card.
Possible/ expected values:
-VISA
-Master Card
-American Express

Get Installments Plans API formulas

The monthly installments amount that are displayed on PayFort payment pages are calculated based on the below formulas:

Percentage Fees: Installments interest rate in percent (%) charged to the customer by the bank.

Fixed Fees: Installments fees in fixed amount charged to the customer by the bank.

Get Installments Plans API - Response Sample

The following is sample of a response of an Get Installments Plans API request:

Merchant Page 2.0 Tokenization

Merchant Page 2.0 Tokenization URLs

Test Environment URL:

https://sbcheckout.payfort.com/FortAPI/paymentPage

Production Environment URL:

https://checkout.payfort.com/FortAPI/paymentPage

Parameters Submission Type

HTTPs Form Post Request

Merchant Page 2.0 Tokenization - Request

Include the following parameters in the Request you will send to PayFort:

ATTRIBUTES Description
service_command
Alpha
Mandatory
max: 20
Command.
Possible/ expected values: TOKENIZATION
access_code
Alphanumeric
Mandatory
Max: 20
Access code.
Example: zx0IPmPy5jp1vAz
merchant_identifier
Alphanumeric
Mandatory
Max: 20
The ID of the Merchant.
Example: CycHZxVj
merchant_reference
Alphanumeric
Mandatory
Max: 40
The Merchant’s unique order number.
Example: XYZ9239-yu898
Special characters: - _ .
language
Alpha
Mandatory
Max: 2
The checkout page and messages language.
Possible/ expected values: en/ ar
expiry_date
Numeric
Mandatory
Max: 4
The card’s expiry date.
Example: 2105
card_number
Numeric
Mandatory
Max: 16
The clear credit card’s number.
Example: 4005550000000001
card_security_code
Numeric
Mandatory
Max: 4
A security code for the card. * Only AMEX accepts card security code of 4 digits.
Example: 123
signature
Alphanumeric
Mandatory
Max: 200
A string hashed using the Secure Hash Algorithm. (Please refer to section Signature for more details).
*Please don’t include the following parameters in calculating the signature of Merchant Page 2.0 tokenization request: card_security_code, card number, expiry_date, card_holder_name, remember_me.
Example: 7cad05f0212ed933c9a5d5dffa31661acf2c827a
token_name
Alphanumeric
Optional
Max: 100
The token received from the Tokenization process.
Example: Op9Vmp
Special characters: . @ - _
card_holder_name
Alpha
Optional
Max: 50
The card holder name.
Example: John Smith
Special characters: . - ’
remember_me
Alpha
Optional
Max: 3
This parameter provides you with an indication to whether to save this token for the user based on the user selection.
Possible/ expected values: - YES - NO
return_url
Alphanumeric
Optional
Max: 400
The URL of the Merchant’s page to be displayed to the customer when the order is processed.
Example: http://www.merchant.com
Special characters: $ ! = ? # & - _ / : .

Merchant Page 2.0 Tokenization - Response

The following parameters will be returned in PayFort’s Response:

ATTRIBUTES Description
service_command
Alpha
Max: 20
Command.
Possible/ expected values: TOKENIZATION
access_code
Alphanumeric
Max: 20
Access code.
Example: zx0IPmPy5jp1vAz8Kpg7
merchant_identifier
Alphanumeric
Max: 20
The ID of the Merchant.
Example: CycHZxVj
merchant_reference
Alphanumeric
Max: 40
The Merchant’s unique order number.
Example: XYZ9239-yu898
language
Alpha
Max: 2
The checkout page and messages language.
Possible/ expected values: en/ ar
expiry_date
Numeric
Max: 4
The card’s expiry date.
Example: 2105
card_number
Numeric
Max: 19
The masked credit card’s number.
AMEX payment option takes 15 digits card number.
*Otherwise, they take 16 digits card number.
Example: 400555
*****0001
signature
Alphanumeric
Max: 200
A string hashed using the Secure Hash Algorithm. Please refer to section Signature
Example: 7cad05f0212ed933c9a5d5dffa31661acf2c827a
token_name
Alphanumeric
max: 100
The Token received from the Tokenization process.
Example: COp9Vmp
response_message
Alphanumeric
Max: 150
Message description of the response code. It returns according to the request language.
Possible/ expected values: Please refer to section messages
response_code
Numeric
Max: 5
Response Code carries the value of our system’s response. *The code consists of five digits, the first 2 digits represent the response status, and the last 3 digits represent the response messages.
Example: 20064
status
Numeric
Max: 2
A two-digit numeric value that indicates the status of the transaction.
Possible/ expected values: (Please refer to section statuses).
card_bin
Numeric
Max: 8
The first 6 digits of the card number.*If the card number for MEEZA was of length 19 then the card bin will be the first 8 digits.
Example: 478773
card_holder_name
Alpha
Max: 50
The card holder name.
Example: John Smith
remember_me
Alpha
Max: 3
This parameter provides you with an indication to whether to save this token for the user based on the user selection.
Possible/ expected values: - YES - NO
return_url
Alphanumeric
Max: 400
The URL of the Merchant’s page to be displayed to the customer when the order is processed.
Example: http://www.merchant.com

Merchant Page 2.0 Operations

Merchant Page 2.0 Operations URLs

Test Environment URL:

https://sbpaymentservices.payfort.com/FortAPI/paymentApi

Production Environment URL:

https://paymentservices.payfort.com/FortAPI/paymentApi

Parameters Submission Type

REST POST request using JSON.

Merchant Page 2.0 Operations - Request

Include the following parameters in the Request you will send to PayFort:

ATTRIBUTES Description
command
Alpha
Mandatory
max: 20
Command.
Possible/ expected values: PURCHASE
access_code
Alphanumeric
Mandatory
Max: 20
Access code.
Example: zx0IPmPy5jp1vAz
merchant_identifier
Alphanumeric
Mandatory
Max: 20
The ID of the Merchant.
Example: CycHZxVj
merchant_reference
Alphanumeric
Mandatory
Max: 40
The Merchant’s unique order number.
Example: XYZ9239-yu898
Special characters: - _ .
amount
Numeric
Mandatory
Max: 10
The transaction’s amount. *Each currency has predefined allowed decimal points that should be taken into consideration when sending the amount.
Example: 10000
currency
Alpha
Mandatory
Max: 3
The currency of the transaction’s amount in ISO code 3.
Example: AED
language
Alpha
Mandatory
Max: 2
The checkout page and messages language.
Possible/ expected values: en/ ar
customer_email
Alphanumeric
Mandatory
Max: 254
The customer’s email.
Example: customer@domain.com
Special characters: _ - . @ +
token_name
Alphanumeric
Mandatory
Max: 100
The Token received from the Tokenization process.
Example: Op9Vmp
Special characters: _ - . @
installments
Alpha
Mandatory
Max: 10
Used to specify the type of the Installments service.
Possible/ expected values: HOSTED
issuer_code
Alphanumeric
Mandatory
Max: 8
A code that refers to the “card issuer” the customer selected from the merchant page.
Example: 12HP34SE
plan_code
Alphanumeric
Mandatory
Max: 8
A code that refers to the “installments plan” the customer selected from the merchant page.
Example: NNNN89JJ
customer_ip
Alphanumeric
Mandatory
max: 45
It holds the customer’s IP address. *It’s Mandatory, if the fraud service is active. *We support IPv4 and IPv6 as shown in the example below.
Example:
IPv4 → 192.178.1.10
IPv6 → 2001:0db8:3042:0002:5a55:caff:fef6:bdbf
Special characters: . :
signature
Alphanumeric
Mandatory
Max: 200
A string hashed using the Secure Hash Algorithm. (Please refer to section Signature for more details).
Example: 7cad05f0212ed933c9a5d5dffa31661acf2c827a
payment_option
Alpha
Optional
Max: 10
Payment option.
Possible/ expected values:
- MASTERCARD
- VISA
- AMEX
eci
Alpha
Optional
Max: 16
Ecommerce indicator.
Possible/ expected values:
ECOMMERCE
order_description
Alphanumeric
Optional
Max: 150
It holds the description of the order.
Example: iPhone 6-S
Special characters: ' / . _ - # : $ Space
card_security_code
Numeric
Optional
Max: 4
A security code for the card. * Only AMEX accepts card security code of 4 digits.
Example: 123
customer_name
Alpha
Optional
Max: 40
The customer’s name.
Example: John Smith
Special characters: _ \ / - . ' Space
merchant_extra
Alphanumeric
Optional
Max: 999
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report.
Example: JohnSmith
Special characters: . ; / _ - , ' @
merchant_extra1
Alphanumeric
Optional
Max: 250
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report.
Example: JohnSmith
Special characters: . ; / _ - , ' @
merchant_extra2
Alphanumeric
Optional
Max: 250
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report.
Example: JohnSmith
Special characters: . ; / _ - , ' @
merchant_extra3
Alphanumeric
Optional
Max: 250
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report.
Example: JohnSmith
Special characters: . ; / _ - , ' @
merchant_extra4
Alphanumeric
Optional
Max: 250
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report.
Example: JohnSmith
Special characters: . ; / _ - , ' @
merchant_extra5
Alphanumeric
Optional
Max: 250
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report.
Example: JohnSmith
Special characters: . ; / _ - , ' @
remember_me
Alpha
Optional
Max: 3
This parameter provides you with an indication to whether to save this token for the user based on the user selection. *The Tokenization service MUST be activated in order to be able to send “remember_me” parameter.
Possible/ expected values: -YES -NO
phone_number
Alphanumeric
Optional
max: 19
The customer’s phone number.
Example: 00962797219966
Special characters: + - ( ) Space
settlement_reference
Alphanumeric
Optional
max: 34
The Merchant submits this value to the FORT. The value is then passed to the Acquiring bank and displayed to the merchant in the Acquirer settlement file.
Example: XYZ9239-yu898
Special characters: - _ .
return_url
Alphanumeric
Optional
Max: 400
The URL of the Merchant’s page to be displayed to the customer when the order is processed.
Example: http://www.merchant.com
Special characters: $ ! = ? # & - _ / : .

Merchant Page 2.0 Operations - Response

The following parameters will be returned in PayFort’s Response:

ATTRIBUTES Description
command
Alpha
max: 20
Command.
Possible/ expected values: PURCHASE
access_code
Alphanumeric
Max: 20
The ID of the Merchant.
Example: zx0IPmPy5jp1vAz
merchant_identifier
Alphanumeric
Max: 20
The ID of the Merchant.
Example: CycHZxVj
merchant_reference
Alphanumeric
Max: 40
The Merchant’s unique order number.
Example: XYZ9239-yu898
amount
Numeric
Max: 10
The transaction’s amount.
Example: 10000
currency
Alpha
Max: 3
The currency of the transaction’s amount in ISO code 3.
Example: AED
language
Alpha
Max: 2
The checkout page and messages language.
Possible/ expected values: en/ ar
customer_email
Alphanumeric
Max: 254
The customer’s email.
Example: customer1@domain.com
token_name
Alphanumeric
max: 100
The Token received from the Tokenization process.
Example: COp9Vmp
installments
Alpha
Max: 10
Used to specify the type of the Installments service.
Possible/ expected values: HOSTED
issuer_code
Alphanumeric
Max: 8
A code that refers to the “card issuer” the customer selected from the merchant page.
Example: 12HP34SE
plan_code
Alphanumeric
Max: 8
A code that refers to the “installments plan” the customer selected from the merchant page.
Example: NNNN89JJ
customer_ip
Alphanumeric
max: 45
It holds the customer’s IP address. *We support IPv4 and IPv6 as shown in the example below.
Example:
IPv4 → 192.178.1.10
IPv6 → 2001:0db8:3042:0002:5a55:caff:fef6:bdbf
signature
Alphanumeric
Max: 200
A string hashed using the Secure Hash Algorithm. Please refer to section Signature
Example: d7c185c475ac0e3
fort_id
Numeric
Max: 20
The order’s unique reference returned by our system.
Example: 149295435400084008
payment_option
Alpha
Max: 10
Payment option.
Possible/ expected values:
- MASTERCARD
- VISA
- AMEX
eci
Alpha
Max: 16
Ecommerce indicator.
Possible/ expected values:
ECOMMERCE
order_description
Alphanumeric
Max: 150
It holds the description of the order.
Example: iPhone 6-S
authorization_code
Alphanumeric
Max: 100
The authorization code returned from the 3rd party.
Example: P1000000000000372136
response_message
Alphanumeric
Max: 150
Message description of the response code. It returns according to the request language.
Possible/ expected values: Please refer to section messages
response_code
Numeric
Max: 5
Response Code carries the value of our system’s response. *The code consists of five digits, the first 2 digits represent the response status, and the last 3 digits represent the response messages.
Example: 20064
customer_name
Alpha
Max: 40
The customer’s name.
Example: John Smith
merchant_extra
Alphanumeric
Max: 999
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report.
Example: JohnSmith
merchant_extra1
Alphanumeric
Max: 250
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report.
Example: JohnSmith
merchant_extra2
Alphanumeric
Max: 250
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report.
Example: JohnSmith
merchant_extra3
Alphanumeric
Max: 250
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report.
Example: JohnSmith
merchant_extra4
Alphanumeric
Max: 250
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report.
Example: JohnSmith
merchant_extra5
Alphanumeric
Max: 250
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report.
Example: JohnSmith
expiry_date
Numeric
Max: 4
The card’s expiry date.
Example: 2105
card_number
Numeric
Max: 19
The masked credit card’s number.
AMEX payment option takes 15 digits card number.
*Otherwise, they take 16 digits card number.
Example: 400555
*****0001
status
Numeric
Max: 2
A two-digit numeric value that indicates the status of the transaction.
Possible/ expected values: Please refer to section statuses
card_holder_name
Alpha
Max: 50
The card holder name.
Example: John Smith
3ds_url
Alphanumeric
Max: 300
The URL where the Merchant redirects a customer whose card is 3-D Secure for authentication.
Example: http://www.3dsecure.com
remember_me
Alpha
Max: 3
This parameter provides you with an indication to whether to save this token for the user based on the user selection.
Possible/ expected values: - YES - NO
phone_number
Alphanumeric
max: 19
The customer’s phone number.
Example: 00962797219966
settlement_reference
Alphanumeric
max: 34
The Merchant submits this value to the FORT. The value is then passed to the Acquiring bank and displayed to the merchant in the Acquirer settlement file.
Example: XYZ9239-yu898

Installments Hosted for Trusted Channel

Installments Hosted for Trusted – Request

Include the following parameters in the Trusted Channel – Request Parameters you will send to PayFort:

ATTRIBUTES Description
installments
Alpha
Mandatory
Max: 10
Used to specify the type of the Installments service.
Possible/ expected values: HOSTED
issuer_code
Alphanumeric
Mandatory
Max: 8
A code that refers to the “card issuer” the customer selected from the merchant page.
Example: 12HP34SE
plan_code
Alphanumeric
Mandatory
Max: 8
A code that refers to the “installments plan” the customer selected from the merchant page.
Example: NNNN89JJ

Installments Hosted for Trusted – Response

The following parameters will be returned in PayFort’s Response in addition to Trusted Channel – Response parameters:

ATTRIBUTES Description
installments
Alpha
Max: 10
Used to specify the type of the Installments service.
Possible/ expected values: HOSTED
issuer_code
Alphanumeric
Max: 8
A code that refers to the “card issuer” the customer selected from the merchant page.
Example: 12HP34SE
plan_code
Alphanumeric
Max: 8
A code that refers to the “installments plan” the customer selected from the merchant page.
Example: NNNN89JJ

FORT Transaction Feedback

Overview

The FORT transaction Feedback system provides Merchants with two types of configurable notifications:
1. Direct Transaction Feedback, PayFort will send Merchants HTTPs notifications that inform Merchants of the transaction’s final status whenever a transaction is processed.
2. Notification Transaction Feedback, PayFort will send Merchants HTTPs notifications that inform Merchants of the transaction’s final status whenever a transaction status is updated.

Registering Transaction Feedback URLs

1. Log in to your back-office account.
2. Select the active channel under Integration Settings > Technical Settings.
3. Enter your Direct Transaction Feedback URL and Notification Transaction Feedback URL.
4. Click “Save Changes” button.

Transaction Feedback submission

The FORT will send Transaction Feedback data as form POST Parameters to the Merchant’s Transaction Feedback URLs.
However if you want to change the submission type to JSON or XML, you can contact us on integration@payfort.com.
This configuration can be enabled by internal PayFort team only
The specifics of the data will differ based upon the financial operation that has been processed.
Please refer to the FORT integration guide for more details.

Responding to FORT Transaction Feedback

Beyond whatever your Transaction Feedback URL does with the data received, it must also return a 2xx (like 200 , 201 , etc…) or 302 HTTP status code to tell the FORT that the notification was received. If your URL does not return 2xx or 302, the FORT will continue to retry the notification until it’s properly acknowledged.
In case the FORT does not receive 200 or 302 HTTP status code it will attempt to send the notification for 10 times with 10 seconds in between.
This configuration is editable as well, if you want to change the grace period or the time interval between the retries please contact us on integration@payfort.com.

Installments Merchant Page - Style Sheet

This is a list with all customizable CSS classes Installments Merchant Page: