Maintenance Operations Parameters
Capture Payment Request Parameters
command(String, mandatory)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 20 | CAPTURE | A command for payFORT server to understand. |
access_code(alphanumeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | zx0IPmPy5jp1vAz8Kpg7 | Merchant access code that can be found in the backoffice |
merchant_identifier(alphanumeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | CycHZxVj | Merchant ID that can be found in the backoffice |
merchant_reference(alphanumeric, mandatory)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 40 | XYZ9239-yu898 | - _ . | The Merchant’s unique order number. |
fort_id(numeric, optional)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | 149295435400084008 | The order’s unique reference returned by our system. |
amount(numeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 10 | 10000 | The transaction’s amount. *Each currency has predefined allowed decimal points that should be taken into consideration when sending the amount check the note after this table. |
currency(String, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 3 | AED | The currency of the transaction’s amount in ISO code 3. |
language(String, mandatory)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 2 | en/ar | The checkout page and messages language where en is 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 |
order_description(Alphanumeric, optional)
| Maximum Length | Example | Description | |
|---|---|---|---|
| 150 | iPhone 6-S | '/ . _ - # : $ Space |
It holds the description of the order. |
Before sending the amount value of any transaction, you have to multiply the value with the currency decimal code according to ISO code 3.
For example: If the amount value was 500 AED; according to ISO code 3, you should multiply the value with 100 (2 decimal points); so it will be sent in the request as 50000.
Another example: If the amount value was 100 JOD; according to ISO code 3, you should multiply the value with 1000 (3 decimal points); so it will be sent in the request as 100000.
You can send “merchant_reference” and/ or “fort_id” in the CAPTURE request.
Capture Payment Response
command(String)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 20 | CAPTURE | A command for payFORT server to understand. |
access_code(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | zx0IPmPy5jp1vAz8Kpg7 | Merchant access code that can be found in the backoffice |
merchant_identifier(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | CycHZxVj | Merchant ID that can be found in the backoffice |
merchant_reference(alphanumeric)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 40 | XYZ9239-yu898 | - _ . | The Merchant’s unique order number. |
amount(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 10 | 10000 | The transaction’s amount. |
currency(String)
| Maximum Length | Example | Description |
|---|---|---|
| 3 | AED | The currency of the transaction’s amount in ISO code 3. |
language(String)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 2 | en/ar | The checkout page and messages language where en is 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 |
order_description(Alphanumeric)
| Maximum Length | Example | Description | |
|---|---|---|---|
| 150 | iPhone 6-S | '/ . _ - # : $ Space |
It holds the description of the order. |
fort_id(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | 149295435400084008 | The order’s unique reference returned by our system. |
response_message(alphanumeric)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 150 | Please refer to section messages | The 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 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. |
status(numeric)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 2 | Please refer to section statuses | A two-digit numeric value that indicates the status of the transaction. |
Every parameter the Merchant sends in the Request should be received by the Merchant in the Response -even the optional ones.
Please refer to section Transactions Response Codes for more details about operation’s statuses
Void Payment Request Parameters
command(String, mandatory)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 20 | VOID_AUTHORIZATION | A command for payFORT server to understand. |
fort_id(numeric, optional)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | 149295435400084008 | The order’s unique reference returned by our system. |
access_code(alphanumeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | zx0IPmPy5jp1vAz8Kpg7 | Merchant access code that can be found in the backoffice |
merchant_identifier(alphanumeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | CycHZxVj | Merchant ID that can be found in the backoffice |
merchant_reference(alphanumeric, mandatory)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 40 | XYZ9239-yu898 | - _ . | The Merchant’s unique order number. |
amount(numeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 10 | 10000 | The transaction’s amount. *Each currency has predefined allowed decimal points that should be taken into consideration when sending the amount check the note after this table. |
currency(String, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 3 | AED | The currency of the transaction’s amount in ISO code 3. |
language(String, mandatory)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 2 | en/ar | The checkout page and messages language where en is 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 |
order_description(Alphanumeric, optional)
| Maximum Length | Example | Description | |
|---|---|---|---|
| 150 | iPhone 6-S | '/ . _ - # : $ Space |
It holds the description of the order. |
You can send “merchant_reference” and/ or “fort_id” in the VOID_AUTHORIZATION request.
Void Payment Response
command(String)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 20 | VOID_AUTHORIZATION | A command for payFORT server to understand. |
access_code(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | zx0IPmPy5jp1vAz8Kpg7 | Merchant access code that can be found in the backoffice |
merchant_identifier(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | CycHZxVj | Merchant ID that can be found in the backoffice |
merchant_reference(alphanumeric)
| Maximum Length | Example | Special Characters | 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 is 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 |
order_description(Alphanumeric)
| Maximum Length | Example | Description | |
|---|---|---|---|
| 150 | iPhone 6-S | '/ . _ - # : $ Space |
It holds the description of the order. |
fort_id(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | 149295435400084008 | The order’s unique reference returned by our system. |
response_message(alphanumeric)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 150 | Please refer to section messages | The 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 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. |
status(numeric)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 2 | Please refer to section statuses | A two-digit numeric value that indicates the status of the transaction. |
Every parameter the Merchant sends in the Request should be received by the Merchant in the Response -even the optional ones.
Please refer to section Transactions Response Codes for more details about operation’s statuses
Refund Payment Request Parameters
command(String, mandatory)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 20 | REFUND | A command for payFORT server to understand. |
access_code(alphanumeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | zx0IPmPy5jp1vAz8Kpg7 | Merchant access code that can be found in the backoffice |
merchant_identifier(alphanumeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | CycHZxVj | Merchant ID that can be found in the backoffice |
merchant_reference(alphanumeric, mandatory)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 40 | XYZ9239-yu898 | - _ . | The Merchant’s unique order number. |
fort_id(numeric, optional)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | 149295435400084008 | The order’s unique reference returned by our system. |
amount(numeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 10 | 10000 | The transaction’s amount. *Each currency has predefined allowed decimal points that should be taken into consideration when sending the amount check the note after this table. |
currency(String, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 3 | AED | The currency of the transaction’s amount in ISO code 3. |
language(String, mandatory)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 2 | en/ar | The checkout page and messages language where en is 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 |
order_description(Alphanumeric, optional)
| Maximum Length | Example | Description | |
|---|---|---|---|
| 150 | iPhone 6-S | '/ . _ - # : $ Space |
It holds the description of the order. |
maintenance_reference(alphanumeric, optional)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 200 | customer123 | - _ . | The Refund’s unique order number. * You will be able to retry on the refund request using the same maintenance reference if the refund transaction was declined. |
Before sending the amount value of any transaction, you have to multiply the value with the currency decimal code according to ISO code 3.
For example: If the amount value was 500 AED; according to ISO code 3, you should multiply the value with 100 (2 decimal points); so it will be sent in the request as 50000.
Another example: If the amount value was 100 JOD; according to ISO code 3, you should multiply the value with 1000 (3 decimal points); so it will be sent in the request as 100000.
You can send “merchant_reference” and/ or “fort_id” in the REFUND request.
Refund Payment Response
command(String)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 20 | AUTHORIZATION, PURCHASE | A command for payFORT server to understand. |
access_code(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | zx0IPmPy5jp1vAz8Kpg7 | Merchant access code that can be found in the backoffice |
merchant_identifier(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | CycHZxVj | Merchant ID that can be found in the backoffice |
merchant_reference(alphanumeric)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 40 | XYZ9239-yu898 | - _ . | The Merchant’s unique order number. |
amount(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 10 | 10000 | The transaction’s amount. |
currency(String)
| Maximum Length | Example | Description |
|---|---|---|
| 3 | AED | The currency of the transaction’s amount in ISO code 3. |
language(String)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 2 | en/ar | The checkout page and messages language where en is 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 |
order_description(Alphanumeric)
| Maximum Length | Example | Description | |
|---|---|---|---|
| 150 | iPhone 6-S | '/ . _ - # : $ Space |
It holds the description of the order. |
maintenance_reference(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 200 | customer123 | The Refund’s unique order number. * You will be able to retry on the refund request using the same maintenance reference if the refund transaction was declined. |
fort_id(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | 149295435400084008 | The order’s unique reference returned by our system. |
response_message(alphanumeric)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 150 | Please refer to section messages | The 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 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. |
status(numeric)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 2 | Please refer to section statuses | A two-digit numeric value that indicates the status of the transaction. |
Every parameter the Merchant sends in the Request should be received by the Merchant in the Response -even the optional ones.
Please refer to section Transactions Response Codes for more details about operation’s statuses