iOS SDK Operations
command(String, mandatory)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 20 | AUTHORIZATION, PURCHASE | A command for payFORT server to understand. |
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 |
customer_email(alphanumeric, mandatory)
| Maximum Length | Example | Special characters | Description |
|---|---|---|---|
| 254 | customer1@domain.com | _ - . @ + | The customer’s email. |
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 characters | Description |
|---|---|---|---|
| 100 | Op9Vmp | . @ - _ | The Token received from the Tokenization process. |
sdk_token(alphanumeric, mandatory)
| Maximum Length | Example | Description |
|---|---|---|
| 100 | Dwp78q3 | An SDK Token to enable using the FORT Mobile SDK. |
payment_option(String, optional)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 10 | - MASTERCARD - VISA - AMEX - SADAD (for Purchase operations only) - NAPS (for Purchase operations only) - KNET(for Purchase operations only) - MADA (for Purchase operations and eci Ecommerce only) Click here to download MADA Branding Document - MEEZA (for Purchase operations and ECOMMERCE eci only) |
Payment option. |
eci(String, optional)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 16 | -ECOMMERCE - MOTO |
E-commerce indicator. *MOTO and E-commerce indicator clickable in VISA, MASTERCARD and AMEX. |
order_description(Alphanumeric, optional)
| Maximum Length | Example | Description | |
|---|---|---|---|
| 150 | iPhone 6-S | '/ . _ - # : $ Space |
It holds the description of the order. |
customer_ip(Alphanumeric, optional)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 45 | IPv4 → 192.178.1.10 IPv6 → 2001:0db8:3042:0002:5a55:caff:fef6:bdbf |
. : | It holds the customer’s IP address. *We support IPv4 and IPv6 as shown in the example. |
customer_name(String, optional)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 40 | John Smith | _ \ / - . 'Space |
The customer’s name. |
merchant_extra(alphanumeric, optional)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 999 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
merchant_extra1(alphanumeric, optional)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 250 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
merchant_extra2(alphanumeric, optional)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 250 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
merchant_extra3(alphanumeric, optional)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 250 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
merchant_extra4(alphanumeric, optional)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 250 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
merchant_extra5(alphanumeric, optional)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 250 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
merchant_extra5(alphanumeric, optional)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 250 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
remember_me(alpha, optional)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 2 | -YES -No |
This parameter provides you with an indication to whether to save this token for the user based on the user selection. |
phone_number(numeric, optional)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 19 | 00962797219966 | + - ( ) Space | The customer’s phone number. |
settlement_reference(alphanumeric, optional)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 34 | 00962797219966 | - _ . | 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. |
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.
SDK Operations response
command(String)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 20 | AUTHORIZATION, PURCHASE | A command for payFORT server to understand. |
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. *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)
| Maximum Length | Example | Description |
|---|---|---|
| 3 | AED | The currency of the transaction’s amount in ISO code 3. |
customer_email(alphanumeric)
| Maximum Length | Example | Special characters | Description |
|---|---|---|---|
| 254 | customer1@domain.com | _ - . @ + | The customer’s email. |
fort_id(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 20 | 149295435400084008 | The order’s unique reference returned by our system. |
sdk_token(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 100 | Dwp78q3 | An SDK Token to enable using the FORT Mobile SDK. |
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 characters | Description |
|---|---|---|---|
| 100 | Op9Vmp | . @ - _ | The Token received from the Tokenization process. |
payment_option(String)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 10 | - MASTERCARD - VISA - AMEX - SADAD (for Purchase operations only) - NAPS (for Purchase operations only) - KNET(for Purchase operations only) - MADA (for Purchase operations and eci Ecommerce only) Click here to download MADA Branding Document - MEEZA (for Purchase operations and ECOMMERCE eci only) |
Payment option. |
eci(String)
| Maximum Length | Possible/ expected values | Description |
|---|---|---|
| 16 | -ECOMMERCE - MOTO |
E-commerce indicator. *MOTO and E-commerce indicator clickable in VISA, MASTERCARD and AMEX. |
authorization_code(alphanumeric)
| Maximum Length | Example | Description |
|---|---|---|
| 100 | P1000000000000372136 | The authorization code returned from the 3rd party. |
order_description(Alphanumeric)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 150 | iPhone 6-S | '/ . _ - # : $ Space |
It holds the description of the order. |
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. |
customer_ip(Alphanumeric)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 45 | IPv4 → 192.178.1.10 IPv6 → 2001:0db8:3042:0002:5a55:caff:fef6:bdbf |
. : | It holds the customer’s IP address. *We support IPv4 and IPv6 as shown in the example. |
customer_name(String)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 40 | John Smith | _ \ / - . 'Space |
The customer’s name. |
expiry_date(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 4 | 2105 | The card’s expiry date. |
card_number(numeric)
| Maximum Length | Example | Description |
|---|---|---|
| 16 | 400555*0001 | 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. |
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. |
merchant_extra(alphanumeric)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 999 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
merchant_extra1(alphanumeric)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 250 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
merchant_extra2(alphanumeric)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 250 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
merchant_extra3(alphanumeric)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 250 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
merchant_extra4(alphanumeric)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 250 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
merchant_extra5(alphanumeric)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 250 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
merchant_extra5(alphanumeric)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 250 | John Smith | . ; / _ - , '@ |
Extra data sent by merchant. Will be received and sent back as received. Will not be displayed in any report. |
phone_number(numeric)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 19 | 00962797219966 | + - ( ) Space | The customer’s phone number. |
settlement_reference(alphanumeric)
| Maximum Length | Example | Special Characters | Description |
|---|---|---|---|
| 34 | 00962797219966 | - _ . | 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. |
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.