7. Installment Inquiry

Installment Inquiry

GET {{Base Address}}/api/paywall/installment

Sending a request to the address provided above should be sufficient. You can use the 'Base Address' as you wish for both the testing environment and the production environment.

Important: To use the installment inquiry service, you need to send the 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' field.

PaymentAPI Address

Parameter	Type	Compulsory	Description
apikeypublic	string	Yes	The Public Key obtained from the merchant panel.
apiclientpublic	string	Yes	The Public Client obtained from the merchant panel.
currencyid	int	Yes	The currency in which the payment is intended to be made. See: Currency
amount	decimal	Yes	The amount associated with the payment.
binnumber	string	No	The first 6 digits of the card for which the payment is intended to be made.
distinctduplicates	bool	Yes	In cases where multiple payment providers are used and if you send this parameter as TRUE, the response object will only contain one row for 2 installments even if it is active in multiple providers.

The response returned from the service:

Parameter	Type	Description
ErrorCode	int	Error code. It returns a value of '0' if the operation is successful.
Result	bool	It returns either true or false. If the operation is successful, it returns 'true'.
Message	string	If the operation is unsuccessful, this is the message related to the error.
Body	object	It returns 'filled' if the installment option is available, and 'empty' otherwise.

💳 For inquiries without a BIN number, you can access the card families within the returned list Card Families You can access them from the page

JSON (with BIN Numbers)

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "CardBank": "T.HALK BANKASI A.Ş.",
        "CardBrand": "Master Card",
        "CardFamily": "Paraf",
        "CardKind": "Ticari Kart",
        "CardType": "Credit",
        "Options": [
            {
                "Installment": 1,
                "Commission": 1.00,
                "Interest": 3.00,
                "RawAmount": 10.1,
                "InterestAmount": 39.80
            }
        ]
    }
}

JSON (without BIN Numbers)

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": [
        {
            "CardFamilyId": 1,
            "CardFamily": "World",
            "Option": [
                {
                    "Installment": 1,
                    "Commission": 0.00,
                    "Interest": 1.00,
                    "RawAmount": 10.1,
                    "InterestAmount": 20.00
                }
            ]
        },
        {
            "CardFamilyId": 8,
            "CardFamily": "Advantage",
            "Option": [
                {
                    "Installment": 2,
                    "Commission": 1.00,
                    "Interest": 0.00,
                    "RawAmount": 10.1,
                    "InterestAmount": 10.1
                },
                {
                    "Installment": 4,
                    "Commission": 1.00,
                    "Interest": 0.00,
                    "RawAmount": 10.1,
                    "InterestAmount": 10.1
                }
            ]
        },
        {
            "CardFamilyId": 5,
            "CardFamily": "Paraf",
            "Option": [
                {
                    "Installment": 3,
                    "Commission": 1.00,
                    "Interest": 0.00,
                    "RawAmount": 10.1,
                    "InterestAmount": 10.1
                },
                {
                    "Installment": 5,
                    "Commission": 1.00,
                    "Interest": 0.00,
                    "RawAmount": 10.1,
                    "InterestAmount": 10.1
                },
                {
                    "Installment": 6,
                    "Commission": 1.00,
                    "Interest": 0.00,
                    "RawAmount": 10.1,
                    "InterestAmount": 10.1
                }
            ]
        }
    ]
}