# 7. Installment Inquiry

## Installment Inquiry

<mark style="color:blue;">`GET`</mark> `{{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.

{% hint style="info" %}
**Important**: To use the installment inquiry service, you need to send the '**apikeypublic**' and '**apiclientpublic**' parameters in the 'Header' field.<br>

[<mark style="color:green;">**PaymentAPI**</mark> ](/payment-orchestration-integration-document/environment.md)[<mark style="color:green;">**Address**</mark>](/payment-orchestration-integration-document/environment.md)
{% endhint %}

<table><thead><tr><th width="192">Parameter</th><th width="102">Type</th><th width="142">Compulsory</th><th>Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>The Public Key obtained from the merchant panel.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>The Public Client obtained from the merchant panel.</td></tr><tr><td>currencyid</td><td>int</td><td>Yes</td><td><p>The currency in which the payment is intended to be made.</p><p><br>See:  <a href="/pages/bahfUMz1dqpN1ZCnpVtM">Currency</a></p></td></tr><tr><td>amount</td><td>decimal</td><td>Yes</td><td>The amount associated with the payment.</td></tr><tr><td>binnumber</td><td>string</td><td>No</td><td>The first 6 digits of the card for which the payment is intended to be made.</td></tr><tr><td>distinctduplicates</td><td>bool</td><td>Yes</td><td>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.</td></tr><tr><td>endoftheday</td><td>int</td><td>No</td><td>You can use this to list installments of payment providers (that are connected) with a specific settlement day.<br><br><a href="/pages/kxGo6DLcmpIZVkMm7OC8">Valor Days</a></td></tr><tr><td>posid</td><td>int</td><td>No</td><td>You can use this parameter if you want to list the installments of a specific virtual POS connection.</td></tr></tbody></table>

**The response returned from the service:**

<table><thead><tr><th width="156">Parameter</th><th width="91.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>ErrorCode</td><td>int</td><td>Error code. It returns a value of '0' if the operation is successful.</td></tr><tr><td>Result</td><td>bool</td><td>It returns either true or false. If the operation is successful, it returns 'true'.</td></tr><tr><td>Message</td><td>string</td><td>If the operation is unsuccessful, this is the message related to the error.</td></tr><tr><td>Body</td><td>object</td><td>It returns 'filled' if the installment option is available, and 'empty' otherwise.</td></tr></tbody></table>

**💳 The BIN number is the first 6 digits on the card.**

{% tabs %}
{% tab title="JSON" %}
{% code overflow="wrap" lineNumbers="true" %}

```json5
{
    "ErrorCodeType": 1,
    "ErrorMessage": null,
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "CardBank": "ANADOLUBANK A.Ş.",
        "CardBrand": "Master Card",
        "CardFamily": null,
        "CardKind": "Bireysel Kart",
        "CardType": "Debit",
        "Options": [
            {
                "PaymentGatewayId": 4149,
                "PaymentGatewayName": "payjumptestt",
                "Installment": 1,
                "Commission": 2.00,
                "Interest": 2.00,
                "RawAmount": 30.0,
                "InterestAmount": 30.60
            }
        ]
    }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.paywall.one/payment-orchestration-integration-document/payment-service/7.-installment-inquiry.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.