TR EN


Extra Installments



- To offer extra installments in checkout, You need to know the available extra installments list in Payfull.
- Available extra installment depends on the selected installment/bank id/gateway/total/currency of the current payment.


Request parameters
merchant: required
merchant name which you created in your Payfull account.

type: required
transaction type should be Get.

get_param: required
The name of the parameter you like to get, so it should be ExtraInstallmentsList.

language: required
Response message language can be en / tr

client_ip: required
The client IP who uses the application which sends the request to the API.

exchange_rate: optional
If you would like to know about currency exchange rate in Payfull, set this parameter to 1.
In this case the response will be only the conversion rate which help you if you are not using Turkish Lira (TRY).

currency: optional
If you set exchange_rate to 1, then this parameter is required, currency can be USD/EUR/GBP

hash: required
Generated hash code on the caller side

To generate the hash code please follow the steps below:
  • - arrange the parameters alphabetically from A to Z
  • - Create a parameters string which has the length for each parameters with its value side by side
  • - Create the sha256 hash code from the parameters string and pass the merchant password as Shared secret key
  • - Add the hash code to the request parameters


Extra Installments for specific payment



You can know the available extra installments for specific payment easily by the following request.


Request parameters
merchant: required
merchant name which you created in your Payfull account.

type: required
transaction type should be Get.

get_param: required
The name of the parameter you like to get, so it should be ExtraInstallments.

language: required
Response message language can be en / tr

client_ip: required
The client IP who uses the application which sends the request to the API.

total: required
Payment total.

currency: required
Payment currency, currency can be TRY/USD/EUR/GBP

bank_id: required
Payment bank id depends on the payment installment because each installment has bank id and gateway.

gateway: required
Payment gateway depends on the payment selected installment because each installment has bank id and gateway.

installments: required
Payment selected installment.

hash: required
Generated hash code on the caller side

To generate the hash code please follow the steps below:
  • - arrange the parameters alphabetically from A to Z
  • - Create a parameters string which has the length for each parameters with its value side by side
  • - Create the sha256 hash code from the parameters string and pass the merchant password as Shared secret key
  • - Add the hash code to the request parameters


Sample request


merchant: merchant name
type: Get
get_param: ExtraInstallmentsList
language: tr
client_ip: 192.168.1.1
hash: 14339MjuG01015018



Sample Response


{
"status":1,
"ErrorMSG":"",
"ErrorCode":"00",
"data":
{
  "campaigns"
    [{
    "campaign_name":"Campaign A",
    "campaign_code":"2",
    "campaign_id":"4",
    "currency":TRY,
    "bank_id":"YapiKredi"
    "gateway":"10001"
    "base_installments":"2"
    "extra_installments":"4"
    "min_amount":"0"
    "status":"1"
    },
    {
    "campaign_name":"Campaign B",
    "campaign_code":"3",
    "campaign_id":"5",
    "currency":TRY,
    "bank_id":"YapiKredi"
    "gateway":"10001"
    "base_installments":"2"
    "extra_installments":"5"
    "min_amount":"0"
    "status":"1"
    }]
}
}


PHP Example