Installment

This service returns information about installment options and card.

Request

Parameters to be sent to the service are as follows:

Input Name Data Type Mandatory Description
price String Yes Total amount for installment plans
binNumber String No First 6 digits of card
locale String No Language settings (default: tr)
conversationId String No Conversation ID to match request and response

Response

Parameters to be returned from the service are as follows:

Output Name Type Description
status String Service response result. (success / failure)
locale String Language settings (default: tr)
systemTime Integer Response system timestamp value
conversationId String If set, conversation ID to match request and response
binNumber(installmentDetails) String First 6 digits of card
price(installmentDetails) String Total amount of basket. Sum of basket items’ amounts must be equal to the total price of basket
cardType(installmentDetails) String Valid values are CREDIT_CARD, DEBIT_CARD, PREPAID_CARD
cardAssociation(installmentDetails) String Valid values are TROY, VISA, MASTER_CARD, AMERICAN_EXPRESS
cardFamilyName(installmentDetails) String Valid values are Bonus, Axess, World, Maximum, Paraf, CardFinans, Advantage
force3ds(installmentDetails) String Force 3D flag. If it returns 1, transaction must be processed with 3D Auth
bankName(installmentDetails) String Name of the issuer bank
bankCode(installmentDetails) Integer Bank code of the issuer bank
installmentPrice(installmentPrices)(installmentDetails) String Amount for per installment
totalPrice(installmentPrices)(installmentDetails) String Installment fee added to total amount
installmentNumber(installmentPrices)(installmentDetails) String Installment number
errorCode String Error code if service response status is failure
errorMessage String Error message if service response status is failure
errorGroup String Error group if service response status is failure

Sample Codes

Sample codes that can be found in iyzico clients:

$request = new \Iyzipay\Request\RetrieveInstallmentInfoRequest();
$request->setLocale(\Iyzipay\Model\Locale::TR);
$request->setConversationId("123456789");
$request->setBinNumber("554960");
$request->setPrice("100");

$installmentInfo = \Iyzipay\Model\InstallmentInfo::retrieve($request, Config::options());
RetrieveInstallmentInfoRequest request = new RetrieveInstallmentInfoRequest();
request.Locale = Locale.TR.ToString();
request.ConversationId = "123456789";
request.BinNumber = "554960";
request.Price = "100";

InstallmentInfo installmentInfo = InstallmentInfo.Retrieve(request, options);
RetrieveInstallmentInfoRequest request = new RetrieveInstallmentInfoRequest();
request.setLocale(Locale.TR.getValue());
request.setConversationId("123456789");
request.setBinNumber("554960");
request.setPrice(new BigDecimal("100"));

InstallmentInfo installmentInfo = InstallmentInfo.retrieve(request, options);
iyzipay.installmentInfo.retrieve({
    locale: Iyzipay.LOCALE.TR,
    conversationId: '123456789',
    binNumber: '554960',
    price: '100'
}, function (err, result) {
    console.log(err, result);
    done();
});
request = {
    locale: 'tr',
    conversationId: '123456789',
    binNumber: '454671',
    price: '1',
}
installment_info = Iyzipay::Model::InstallmentInfo.new.retrieve(request, @options)
request = dict([('locale', 'tr')])
request['conversationId'] = '123456789'
request['binNumber'] = '454671'
request['price'] = '1'

installment_info = iyzipay.InstallmentInfo()
installment_info_response = installment_info.retrieve(request, options)
//Request
    "locale": "tr",
    "conversationId": "123456789",
    "binNumber": "454360",
    "price": "100.0"
//Response
{
    "status": "success",
    "locale": "tr",
    "systemTime": 1470727458044,
    "conversationId": "123456789",
    "installmentDetails": [
        {
            "binNumber": "454360",
            "price": 100,
            "cardType": "CREDIT_CARD",
            "cardAssociation": "VISA",
            "cardFamilyName": "Maximum",
            "force3ds": 0,
            "bankCode": 64,
            "bankName": "İş Bankası",
            "forceCvc": 0,
            "installmentPrices": [
                {
                    "installmentPrice": 100,
                    "totalPrice": 100,
                    "installmentNumber": 1
                },
                {
                    "installmentPrice": 50.68,
                    "totalPrice": 101.36,
                    "installmentNumber": 2
                },
                {
                    "installmentPrice": 33.95,
                    "totalPrice": 101.86,
                    "installmentNumber": 3
                },
                {
                    "installmentPrice": 17.43,
                    "totalPrice": 104.58,
                    "installmentNumber": 6
                },
                {
                    "installmentPrice": 12.19,
                    "totalPrice": 109.67,
                    "installmentNumber": 9
                }
            ]
        }
    ]
}

Questions

If you have questions about this service, get in touch with us and find out how we can help you.