Recurring Transactions Request Parameters
| ATTRIBUTES | Possible/Expected Values or examples | Description |
|---|---|---|
| command( Alpha Mandatory max: 20) | PURCHASE | command |
| access_code( Alphanumeric Mandatory max: 20) | zx0IPmPy5jp1vAz | Access code |
| merchant_identifier( Alphanumeric Mandatory max: 20) | CycHZxVj | The ID of the Merchant. |
| merchant_reference( Alphanumeric Mandatory max: 40) | XYZ9239-yu898 | The Merchant’s unique order number. Special characters: - _ . |
| amount( Numeric Mandatory max: 10) | 10000 | The transaction’s amount. *Each currency has predefined allowed decimal points that should be taken into consideration when sending the amount. |
| currency(Alpha Mandatory max: 3) | AED | The currency of the transaction’s amount in ISO code 3. |
| language( Alpha Mandatory max: 2) | en / ar | The checkout page and messages language. |
| customer_email(Alphanumeric Mandatory max: 254) | customer@domain.com | The customer’s email. Special characters: _ - . @ + |
| eci (Alpha Mandatory max: 16) | RECURRING | Ecommerce indicator. |
| token_name( Alphanumeric Mandatory max: 100) | Op9Vmp | The Token received from the Tokenization process. Special characters: _ - . @ |
| signature( Alphanumeric Mandatory max: 200) | 7cad05f0212ed933c9a5d5dffa31661acf2c827a | A string hashed using the Secure Hash Algorithm. (Please refer to section Signature for more details). |
| payment_option( Alpha Optional Max: 10) | -MASTERCARD - VISA - AMEX | Payment option. Possible/ expected values: - MASTERCARD - VISA - AMEX |
| order_description( Alphanumeric Optional max: 150) | iPhone 6-S | It holds the description of the order. Special characters: '/ . _ - # : $ Space |
| customer_name( Alpha Optional max: 40) | John Smith | The customer’s name. Special characters: _ \ / - . 'Space |
| merchant_extra( Alphanumeric Optional Max: 999) | JohnSmith | Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. Special characters: . ; / _ - , '@ |
| merchant_extra1( Alphanumeric Optional Max: 250) | JohnSmith | Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. Special characters: . ; / _ - , '@ |
| merchant_extra2( Alphanumeric Optional Max: 250) | JohnSmith | Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. Special characters: . ; / _ - , '@ |
| merchant_extra3( Alphanumeric Optional Max: 250) | JohnSmith | Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. Special characters: . ; / _ - , '@ |
| merchant_extra4( Alphanumeric Optional Max: 250) | JohnSmith | Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. Special characters: . ; / _ - , '@ |
| merchant_extra5( Alphanumeric Optional Max: 250) | JohnSmith | Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. Special characters: . ; / _ - , '@ |
| phone_number( Alphanumeric Optional max: 19) | 00962797219966 | The customer’s phone number. Special characters: + - ( ) Space |
| settlement_reference( Alphanumeric Optional max: 34) | XYZ9239-yu898 | 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. Special characters: - _ . |
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.
Recurring Transaction Response
| ATTRIBUTES | Possible/Expected values or Example | Description |
|---|---|---|
| command( Alpha max: 20) | PURCHASE | command. |
| access_code( Alphanumeric max: 20) | zx0IPmPy5jp1vAz | Access code. |
| merchant_identifier( Alphanumeric max: 20) | CycHZxVj | The ID of the Merchant. |
| merchant_reference( Alphanumeric max: 40) | XYZ9239-yu898 | The Merchant’s unique order number. |
| amount( Numeric max: 10) | 10000 | The transaction’s amount. |
| currency( Alpha max: 3) | AED | The currency of the transaction’s amount in ISO code 3. |
| language( Alpha max: 2) | en / ar | The checkout page and messages language. |
| customer_email( Alphanumeric max: 254) | customer@domain.com | The customer’s email. |
| eci (Alpha max: 16) | RECURRING | Ecommerce indicator. |
| token_name( Alphanumeric max: 100) | Op9Vmp | The Token received from the Tokenization process. |
| signature( Alphanumeric max: 200) | 7cad05f0212ed933c9a5d5dffa31661acf2c827a | A string hashed using the Secure Hash Algorithm. (Please refer to section Signature for more details). |
| fort_id( Numeric max: 20) | 149295435400084008 | The order’s unique reference returned by our system. |
| payment_option Alpha Max: 10 | - MASTERCARD - VISA - AMEX |
Payment option. |
| order_description( Alphanumeric max: 150) | iPhone 6-S | It holds the description of the order. |
| customer_name( Alpha max: 40) | John Smith | The customer’s name. |
| merchant_extra( Alphanumeric Max: 999) | JohnSmith | Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
| merchant_extra1( Alphanumeric Max: 250) | JohnSmith | Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
| merchant_extra2( Alphanumeric Max: 250) | JohnSmith | Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
| merchant_extra3( Alphanumeric Max: 250) | JohnSmith | Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
| merchant_extra4( Alphanumeric Max: 250) | JohnSmith | Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
| merchant_extra5( Alphanumeric Max: 250) | JohnSmith | Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
| expiry_date( Numeric Max: 4) | 2015 | The card’s expiry date. Example: 2105 |
| card_number( Numeric Max: 16) | 400555**0001 | The clear credit card’s number. |
| authorization_code( Alphanumeric max: 100) | P1000000000000372136 | The authorization code returned from the 3rd party. |
| response_message( Alphanumeric max: 150) | Please refer to section messages | Message description of the response code. It returns according to the request language. Possible/ expected values: |
| response_code( Numeric Max: 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 max: 2) | Please refer to section statuses | A two-digit numeric value that indicates the status of the transaction |
| phone_number( Alphanumeric max: 19) | 00962797219966 | The customer’s phone number. |
| settlement_reference( Alphanumeric max: 34) | XYZ9239-yu898 | 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. |
Every parameter the Merchant sends in the Request should be received by the Merchant in the Response -even the optional ones