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.
Bill Presentment
This service allows the Merchant to generate a unique bill numbers for Customer’s orders using the FORT API. The Merchant displays or sends the unique bill number to the Customer. The Customer presents the unique bill number to PayFort’s payment partners to pay for his order.
Bill Presentment 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.
Bill Presentment - 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: BILL_PRESENTMENT 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 |
| merchant_reference Alphanumeric Mandatory max: 40 |
The Merchant’s unique order number. Example: XYZ2939-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. Possible/ expected values: EGP |
| language Alpha Mandatory max: 2 |
The checkout page and messages language. Possible/ expected values: en / ar |
| request_expiry_date Alphanumeric Mandatory max: 25 |
The date when the bill expires.*The merchant will hold the item till the expiry date. If the customer didn’t pay, the holding will be canceled. Example: 2017-12-20T15:36:55+03:00 Special characters: - + : |
| payment_partner Alpha Mandatory max: 5 |
A financial corporation that generate bills to the customer. Possible/ expected values: FAWRY |
| signature Alphanumeric Mandatory max: 200 |
A string hashed using the Secure Hash Algorithm. (Please refer to section Signature for more details). Example: 7cad05f0212ed933c9a5d5dffa31661acf2c827a |
| customer_name Alpha Optional Max: 40 |
The customer’s name. Example: John Smith Special characters: _ \ / - . ' Space |
| customer_email Alphanumeric Optional Max: 254 |
The customer’s email. Example: customer@domain.com Special characters: _ - . @ + |
Bill Presentment - Response
The following parameters will be returned in PayFort’s Response:
| ATTRIBUTES | Description |
|---|---|
| service_command Alpha max: 20 |
Command. Possible/ expected values: BILL_PRESENTMENT |
| access_code Alphanumeric max: 20 |
Access code. Possible/ expected 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: XYZ2939-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. Possible/ expected values: EGP |
| language Alpha max: 2 |
The checkout page and messages language. Possible/ expected values: en / ar |
| bill_number Numeric max: 14 |
A unique number generated by PayFort to pay bills. Example: 14823285500005 |
| request_expiry_date Alphanumeric max: 25 |
The date when the bill expires.*The merchant will hold the item till the expiry date. If the customer didn’t pay, the holding will be canceled. Example: 2017-12-20T15:36:55+03:00 |
| payment_partner Alpha max: 5 |
A financial corporation that generate bills to the customer. Possible/ expected values: FAWRY |
| signature Alphanumeric max: 200 |
A string hashed using the Secure Hash Algorithm. (Please refer to section Signature for more details). Example: 7cad05f0212ed933c9a5d5dffa31661acf2c827a |
| customer_name Alpha Max: 40 |
The customer’s name. Example: John Smith |
| customer_email Alphanumeric Max: 254 |
The customer’s email. Example: customer1@domain.com |
| 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: 46000 |
| status Numeric Max: 2 |
A two-digit numeric value that indicates the status of the transaction. Possible/ expected values: (Please refer to section statuses). |
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.