Installments


Installments helps your customer to pay for any product or services at your site in easy equitable monthly installments (EMI). If your customers don't have enough cash for payment of products or services offered by your site, then PayFORT in partnership with several banks and credit cards facilitates installment services for your customer requirements. However, you will be paid the full amount immediately.

PayFORT is offering the services at present in UAE Egypt KSA only.


Supported Schemes


List of Banks enrolled for installment services

  1. Emirates NBD
  2. ADCB Mashreq
  3. Dubai First CBD
  4. Mawarid Finance NCB
  5. SABB Bank AlJazira
  6. Saudi Hollandi bank Riyadh
  7. bank CIB Barclays

How it works?

Placeholder: Provide Integration flow/process flow diagram.

Despite the involvement of multiple parties (merchant, bank and customer), the installment process is simple and can be implemented in seconds.

  1. At Checkout customer selects his bank, installment plans and enters his credit card details to complete the purchase.

  2. Customer is not required to call his bank to convert the transaction into Installments. PayFORT will work with banks to convert the transaction into installments.

  3. Customer then receives an sms or an email from the bank confirming the conversion of the transaction into EMI.

Installments Redirection


Now most of the transactions can be converted into Installments so in this section all the transactions of Redirections can be converted into Installments.

Installments Redirection Service - Request

You have to include the following parameters in the Purchase - Request Parameters which you will send to PayFort:

ATTRIBUTES Description
installments Alpha Optional max: 10 Used to specify the type of the Installments service. Possible/ expected values: STANDALONE

Placeholder: Please provide sample code for Installments Redirection service - requirements


Installments Redirection Service - Response

Placeholder : Provide sample JSON response

The following parameters will be returned in PayFort’s JSON Response in addition to the Purchase - Response Parameters:

ATTRIBUTES Description
installments Alpha max: 10 Used to specify the type of the Installments service. Possible/ expected values: STANDALONE
number_of_installments Numeric max: 2 The number of installments the customer has selected in the payment page. Example: 3

Installments Merchant Page (Iframe)


If you are integrating Merchant Page (iFrame feature) then you can easily redesign your merchant page to easily send installment request from the merchant page itself as shown in this section.

Installments Merchant page Service - Request


Placeholder: Provide sample code for request

Include the following parameters in the Merchant page - Request Parameters you will send to PayFort:

ATTRIBUTES Description
installments Alpha Mandatory max: 10 Used to specify the type of the Installments service. Possible/ expected values: STANDALONE
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. Example: USD
customer_country_code Alpha Optional Max: 3 The Customer’s country code. ISO 3 digit country code. Example: JOR
  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.

Installments Merchant page Service - Response

Placeholder: Please provide sample JSON response.

The following parameters will be returned in PayFort’s Response in addition to the Merchant Page - Response Parameters

ATTRIBUTES Description
installments Alpha max: 10 Used to specify the type of the Installments service. Possible/ expected values: STANDALONE
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. Example: USD
customer_country_code Alpha Max: 3 The Customer’s country code. ISO 3-digit country code. Example: JOR
number_of_installments Numeric Max: 2 The number of installments the customer has selected in payment page. Example: 3
plan_code Alphanumeric Max: 8 A code that refers to the “installments plan” the customer selected from the merchant page. Example: NNNN89JJ
issuer_code Alphanumeric Max: 8 A code that refers to the “card issuer” the customer selected from the merchant page. Example: 12HP34SE
  Every parameter the Merchant sends in the Request should be received by the Merchant in the Response -even the optional ones

Installments Purchase Service - Request

Placeholder: Sample code for merchant page operations request

For transactions being carried out under operations you have to Include the following parameters in the Operation - Request Parameters while sending to PayFort:

ATTRIBUTES Description
installments Alpha Mandatory max: 10 Used to specify the type of the Installments service. Possible/ expected values: YES
plan_code Alphanumeric Mandatory Max: 8 A code that refers to the “installments plan” the customer selected from the merchant page. Example: NNNN89JJ
issuer_code Alphanumeric Mandatory Max: 8 A code that refers to the “card issuer” the customer selected from the merchant page. Example: 12HP34SE

Installments Purchase Service - Response


Placeholder: Provide sample JSON response sent from the PayFORT server.

The following parameters will be returned in PayFort’s Response in addition to the Operation - Response Parameters:

ATTRIBUTES Description
installments Alpha max: 10 Used to specify the type of the Installments service. Possible/ expected values: YES
plan_code Alphanumeric Max: 8 A code that refers to the “installments plan” the customer selected from the merchant page. Example: NNNN89JJ
issuer_code Alphanumeric Max: 8 A code that refers to the “card issuer” the customer selected from the merchant page. Example: 12HP34SE
number_of_installments Numeric Max: 2 The number of installments the customer has selected in payment page. Example: 3
  Every parameter the Merchant sends in the Request should be received by the Merchant in the Response -even the optional ones

Installments Hosted Checkout


Get Installments Plans API

By using Hosted Checkout you will be able to fetch various installment plan details for your various products and services as well as various issuers configured in your account for the installment service. You can use the following endpoints to setup hosted checkout service.

Endpoints

Sandbox

POST https://sbpaymentservices.payfort.com/FortAPI/paymentApi

Live

POST https://paymentservices.payfort.com/FortAPI/paymentApi

Parameters Submission Type

REST POST request using JSON.


Get Installments Plans API - Request

Placeholder: Provide the sample code for the request

Include the following parameters in the Request you will send to PayFort:

For input parameters please visit the section Get Installments Plans API - Request under the link

  Please note that you can’t send these parameters (amount/ currency) separately; you should send them together or not sending them at all.

  If you send the amount and the currency in get plans API, you will receive AmountPerMonth parameter calculated from our side, and no need to use the formulas returned to complete the amount calculations.

Get Installments Plans API - Response

Placeholder: Provide sample JSON response

The following parameters will be returned in PayFort’s Response:

For more details on the parameters please visit the section Get Installments Plans API - Response in the link

  Every parameter the Merchant sends in the Request should be received by the Merchant in the Response -even the optional ones


Issuer Detail

You can use the following attributes to know the details of the installment services issuers.

Placeholder: Provide sample code for issuer details

This parameter is a sub parameter of the installment_detail parameter, please refer the section Issuer Detail in the link for the children parameters of the issuer_detail

  What does each of the formula parameters mean: (amount +(amount *effective rate/100))/period Amount: The transaction amount. Effective rate: The fee_amount retrieved in the response inside the next plan_detail section Period: number_of_installment retrieved in the response inside the next plan_detail section


Plan Details

If you want to fetch details of various installment plans you can use the attributes in this section and send in your request to the PayFORT server.

Placeholder: provide sample code for plan details.

This parameter is a sub parameter of the issuer_detail parameter, please refer the section Plan Detail in the link for the children parameters of the plan_detail:


Bins Details

This section will help you to capture the details of the credit card that customer will use for availing the installment service. You have to use the attributes in your request to fetch the details of the credit card.

Placeholder: provide sample code for bins details.

This parameter is a sub parameter of the issuer_detail parameter, please refer the section Bin Detail in the link for the children parameters of the bins:


Get Installments Plans API formulas

This section helps you to calculate the installment formula that would be displayed to your customers when they checkout. Following are the key formulas applicable for calculating the installments.

(amount + fees) / months


Get Installments Plans API - Response

Response Sample

The following is sample of a response of an Get Installments Plans API request:

{
“response_code”: “62000”,
“response_message”: “Success”,
“signature”: “9b02960d319318256efbc17cf57dbc1f7e7fd046e20e49215d0bed32a065c3ae”,
“merchant_identifier”: “bxgOIxIz”,
“access_code”: “Ru8n1ciSJXWm8WFHLKsR”,
“query_command”: “GET_INSTALLMENTS_PLANS”,
“issuer_code”: “fHkigRtu”,
“installment_detail”: {
  “issuer_detail”: [
  {
     “issuer_code”: “fHkigRtu”,
    “issuer_name_ar”: “بنك الامارات دبي الوطني”,
    “issuer_name_en”: “Emirates NBD Egypt”,
    “terms_and_condition_ar”: “http://www.emiratesnbd.com.eg/egypt-en/index.cfm/retail-banking/cards/special-offers/”,
    “terms_and_condition_en”: “http://www.emiratesnbd.com.eg/egypt-en/index.cfm/retail-banking/cards/special-offers/”,
    “country_code”: “EGY”,
    “issuer_logo_ar”: “https://stgstatic.payfort.com/frontend/files/logos/issuer/logo_ar_7.jpeg”,
     “issuer_logo_en”: “https://stgstatic.payfort.com/frontend/files/logos/issuer/logo_en_7.jpg”,
    “banking_system”: “Non Islamic”,
    “formula”: “((amount + ((amount * (effective rate/100)) * period))) / period”,
  “plan_details”: [
  {
    “plan_code”: “zAS4XyG2”,
    “currency_code”: “USD”,
    “number_of_installment”: 33,
    “fees_type”: “Percentage”,
    “fees_amount”: 300,
     “processing_fees_type”: null,
    “processing_fees_amount”: null,
    “rate_type”: “Flat”,
    “plan_merchant_type”: “Non Partner”,
    “plan_type”: “Cross-Border”,
    “fee_display_value”: 400,
    “minimum_amount”: 300,
    “maximum_amount”: 33333300,
    “amountPerMonth”: “3.00”
    }
    ],
“bins”: [
{
  “bin”: “427838”,
  “country_code”: “EGY”,
  “currency_code”: “EGP”,
  “card_brand_code”: “VISA”
},
{
  “bin”: “522025”,
  “country_code”: “EGY”,
  “currency_code”: “EGP”,
  “card_brand_code”: “Master Card”
},
{
  “bin”: “543173”,
  “country_code”: “EGY”,
  “currency_code”: “EGP”,
  “card_brand_code”: “Master Card”
},
],
  “confirmation_message_ar”: null,
  “disclaimer_message_ar”: null,
  “processing_fees_message_ar”: null,
  “confirmation_message_en”: null,
  “disclaimer_message_en”: null,
  “processing_fees_message_en”: null
}
]
},
“status”: “62”
}

Merchant Page 2.0 Operations


Endpoints

Sandbox

POST https://sbpaymentservices.payfort.com/FortAPI/paymentApi

Live

POST https://paymentservices.payfort.com/FortAPI/paymentApi

Parameters Submission Type

REST POST request using JSON.


Installment Service For Merchant Page 2.0 Operations - Request

You can use the endpoints to integrate and send request for Merchant Page 2.0 operations.

Placeholder: Provide sample code for merchant page 2.0 operations for installment service.

Please visit the section Installment Service for Merchant Page 2.0 Operations - Request under the link for input parameters to be sent in the request.

Remember - 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.


Installment Service For Merchant Page 2.0 Operations - Response


Placeholder: Provide sample JSON response for merchant page 2.0 operations for installments.

For more details on response parameters please visit the section Installment Service for merchant page 2.0 operations- response in the link

Remember - Every parameter the Merchant sends in the Request should be received by the Merchant in the Response -even the optional ones-.


Installments Hosted for Trusted Channel


If you are a trusted channel partner or already a PCI compliant partner you can use the attributes provided in this section to integrate your installment service. For more details on the trusted channel partners please visit this link


Installments Hosted for Trusted – Request

Placeholder: Please provide sample code for trusted channel partner request for installment.

  First, you need to send a [Get Instalments Plans API](https://docs.payfort.com/docs/api/build/index.html?shell#get-installments-plans-api) request; to get the instalments details. Include the [input parameters](installmentsparameters.md) under the section Installments Hosted for Trusted - Request in addition to the [Trusted Channel – Request](trustedchannelparameters.md) Parameters you will send to PayFort:

Installments Hosted for Trusted – Response


Placeholder : Provide sample JSON response for Hosted for trusted channel

For details on parameters of the response visit the section Installments Hosted for Trusted- Response in the link


Installments Merchant Page - Style Sheet


This is a list with all customizable CSS classes for Installments Merchant Page. You can use these css classes to style and design your installments merchant page.

  - You can always create multiple theme files that will enable you to switch freely and easily between them when necessary.
- “Theme” files can be uploaded from the back-office using the Payment Page template screen.

Go to Full API


Check out our full API by visiting this link

Need further help?


Thanks for using PayFort.com. If you need any help or support, then message our support team at support@payfort.com.