This page describe the request parameters that you are required to send through your payment processing page and the response parameters that will be sent back by the PayFORT server. The page describes the request parameters for both Merchant Page and Merchant Page 2 integrations and response for Merchant Page and Merchant Page 2 .
Merchant Page Request Parameters
submission type
HTTPs Form Post Request
List of Request Parameters
service_command(String, mandatory)
| Maximum Length | Possible Value | Description |
|---|---|---|
| 20 | TOKENIZATION | Command for server to understand what type of service it requires to provide. |
access_code(alphanumeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | zx0IPmPy5jp1vAz | The access code generated in the back office. |
merchant_identifier(alphanumeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | CycHZxVj | The ID of the Merchant which can be found in the back office |
merchant_reference(alphanumeric, mandatory)
| Maximum Length | Example | Special character | Description |
|---|---|---|---|
| 40 | XYZ9239-yu898 | - _ . | The Merchant’s unique order number. |
language(String, mandatory)
| Maximum Length | Possible Values | Description |
|---|---|---|
| 2 | en/ar | The checkout page and messages language where en stands for english and ar for arabic. |
signature(alphanumeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 200 | 7cad05f0212ed933c9a5d5dffa31661acf2c827a | A string hashed using the Secure Hash Algorithm. Please refer to section Signature |
token_name(alphanumeric, optional)
| Maximum Length | Example | Special character | Description |
|---|---|---|---|
| 100 | Op9Vmp | . @ - _ | The token received from the Tokenization process. |
return_url(alphanumeric, optional)
| Length | Example | Special character | Description |
|---|---|---|---|
| 400 | http://www.merchant.com | $ ! = ? # & - _ / : . | The URL of the Merchant’s page to be displayed to the customer when the order is processed. |
Merchant Page Response
List of Response Parameters that would be sent back by the PayFORT Server as a JSON format
service_command(String)
| Maximum Length | Possible/Expected Value | Description |
|---|---|---|
| 20 | TOKENIZATION | service command. |
access_code(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | zx0IPmPy5jp1vAz8Kpg7 | access code generated. |
merchant_identifier(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | CycHZxVj | The ID of the Merchant. |
merchant_reference(alphanumeric)
| Maximum Length | Example | Special character | Description |
|---|---|---|---|
| 40 | XYZ9239-yu898 | - _ . | The Merchant’s unique order number. |
language(String)
| Maximum Length | Possible/Expected Values | Description |
|---|---|---|
| 2 | en/ar | The checkout page and messages language where en stands for english and ar for arabic. |
signature(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 200 | 7cad05f0212ed933c9a5d5dffa31661acf2c827a | A string hashed using the Secure Hash Algorithm. Please refer to section Signature |
token_name(alphanumeric)
| Maximum Length | Example | Special character | Description |
|---|---|---|---|
| 100 | Op9Vmp | . @ - _ | The token received from the Tokenization process. |
expiry_date(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 4 | 2105 | The card’s expiry date. |
card_number(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 19 | 2105 | The masked credit card’s number. Only the MEEZA payment option takes 19 digits card number. *AMEX payment option takes 15 digits card number. *Otherwise, they take 16 digits card number. Example: 400555*0001 |
response_message(alphanumeric)
| Maximum Length | Possible/Expected Values | Description |
|---|---|---|
| 150 | Please refer to section messages | Message description of the response code. It returns according to the request language. |
response_code(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 5 | 20064 | Response Code carries the value of PayFORT 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. |
status(numeric)
| Maximum Length | Possible/Expected Value | Description |
|---|---|---|
| 2 | Please refer to section statuses | A two-digit numeric value that indicates the status of the transaction. |
card_bin(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 8 | 478773 | 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. |
return_url(alphanumeric, optional)
| Length | Example | Special character | Description |
|---|---|---|---|
| 400 | http://www.merchant.com | $ ! = ? # & - _ / : . | The URL of the Merchant’s page to be displayed to the customer when the order is processed. |
Merchant Page 2 Request Parameters
submission type
HTTPs Form Post Request
List of Request Parameters
service_command(String, mandatory)
| Maximum Length | Possible Value | Description |
|---|---|---|
| 20 | TOKENIZATION | Command for server to understand what type of service it requires to provide. |
access_code(alphanumeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | zx0IPmPy5jp1vAz | The access code generated in the back office. |
merchant_identifier(alphanumeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | CycHZxVj | The ID of the Merchant which can be found in the back office |
merchant_reference(alphanumeric, mandatory)
| Maximum Length | Example | Special character | Description |
|---|---|---|---|
| 40 | XYZ9239-yu898 | - _ . | The Merchant’s unique order number. |
language(String, mandatory)
| Maximum Length | Possible Values | Description |
|---|---|---|
| 2 | en/ar | The checkout page and messages language where en stands for english and ar for arabic. |
expiry_date(numeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 4 | 2105 | The card’s expiry date. |
card_number(numeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 19 | 4005550000000001 | Only the MEEZA payment option takes 19 digits card number. AMEX payment option takes 15 digits card number. *Otherwise, they take 16 digits card number. |
card_security_code(numeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 4 | 123 | A security code for the card. * Only AMEX accepts card security code of 4 digits. |
signature(alphanumeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 200 | 7cad05f0212ed933c9a5d5dffa31661acf2c827a | A string hashed using the Secure Hash Algorithm. Please refer to section Signature |
token_name(alphanumeric, optional)
| Maximum Length | Example | Special character | Description |
|---|---|---|---|
| 100 | Op9Vmp | . @ - _ | The token received from the Tokenization process. |
card_holder_name(String, optional)
| Maximum Length | Example | Special character | Description |
|---|---|---|---|
| 50 | John Smith | ' - . | The card holder name. |
remember_me(String, optional)
| Maximum Length | Possible/Expected values | Special character | Description |
|---|---|---|---|
| 50 | -YES -NO |
' - . | The card holder name. |
return_url(alphanumeric, optional)
| Length | Example | Special character | Description |
|---|---|---|---|
| 400 | http://www.merchant.com | $ ! = ? # & - _ / : . | The URL of the Merchant’s page to be displayed to the customer when the order is processed. |
Merchant Page 2 Response
List of Response Parameters that would be sent back by the PayFORT Server as a JSON format
service_command(String)
| Maximum Length | Possible/Expected Value | Description |
|---|---|---|
| 20 | TOKENIZATION | service command. |
access_code(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | zx0IPmPy5jp1vAz8Kpg7 | access code generated. |
merchant_identifier(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | CycHZxVj | The ID of the Merchant. |
merchant_reference(alphanumeric)
| Maximum Length | Example | Special character | Description |
|---|---|---|---|
| 40 | XYZ9239-yu898 | - _ . | The Merchant’s unique order number. |
language(String)
| Maximum Length | Possible/Expected Values | Description |
|---|---|---|
| 2 | en/ar | The checkout page and messages language where en stands for english and ar for arabic. |
signature(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 200 | 7cad05f0212ed933c9a5d5dffa31661acf2c827a | A string hashed using the Secure Hash Algorithm. Please refer to section Signature |
token_name(alphanumeric)
| Maximum Length | Example | Special character | Description |
|---|---|---|---|
| 100 | Op9Vmp | . @ - _ | The token received from the Tokenization process. |
expiry_date(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 4 | 2105 | The card’s expiry date. |
card_number(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 19 | 2105 | The masked credit card’s number. Only the MEEZA payment option takes 19 digits card number. *AMEX payment option takes 15 digits card number. *Otherwise, they take 16 digits card number. Example: 400555*0001 |
response_message(alphanumeric)
| Maximum Length | Possible/Expected Values | Description |
|---|---|---|
| 150 | Please refer to section messages | Message description of the response code. It returns according to the request language. |
response_code(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 5 | 20064 | Response Code carries the value of PayFORT 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. |
status(numeric)
| Maximum Length | Possible/Expected Value | Description |
|---|---|---|
| 2 | Please refer to section statuses | A two-digit numeric value that indicates the status of the transaction. |
card_bin(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 8 | 478773 | 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. |
card_holder_name(String)
| Maximum Length | Example | Description |
|---|---|---|
| 50 | John Smith | The card holder name. |
remember_me(String)
| Maximum Length | Possible/Expected values | Description |
|---|---|---|
| 3 | - YES, - NO |
This parameter provides you with an indication to whether to save this token for the user based on the user selection. |
return_url(alphanumeric, optional)
| Length | Example | Special character | Description |
|---|---|---|---|
| 400 | http://www.merchant.com | $ ! = ? # & - _ / : . | The URL of the Merchant’s page to be displayed to the customer when the order is processed. |