# 2. Payment Inquiry

## Shared Payment Page Query

<mark style="color:blue;">`GET`</mark> `{{BaseAddress}}/api/paywall/checkout/inquiry`

{% hint style="info" %}
**Important**: In order to use the payment initiation service, you need to send the '**apikeypublic**' and '**apiclientpublic**' parameters in the 'Header' field.

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

**The header information that needs to be sent to the service is as follows:**

<details>

<summary><strong>Parameters and descriptions</strong></summary>

<table><thead><tr><th width="202">Parameter</th><th width="92">Type</th><th width="146">Compulsory </th><th width="403">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>id</td><td>int</td><td>Yes</td><td>The identifier (Id) information of the shared payment page. It is returned at the time of creation.</td></tr></tbody></table>

</details>

**The response returned from the service:**

<details>

<summary><strong>Parameter descriptions</strong></summary>

<table><thead><tr><th width="240">Parameter</th><th width="120.33333333333331">Type </th><th>Description</th></tr></thead><tbody><tr><td>Id</td><td>int</td><td>The identifier (Id) information of the shared payment page.</td></tr><tr><td>Guid</td><td>Guid</td><td>The unique code of the shared payment page.</td></tr><tr><td>UniqueCode</td><td>string</td><td>It is provided by your side at the time of creation.</td></tr><tr><td>LanguageId</td><td>int</td><td>It is the language identifier provided at the time of creation of the shared payment page.</td></tr><tr><td>CurrencyId</td><td>int</td><td>Currency identifier</td></tr><tr><td>CurrencyName</td><td>string</td><td>The name of the currency.</td></tr><tr><td>Amount</td><td>decimal</td><td>The amount</td></tr><tr><td>Installment</td><td>int</td><td>Installment information</td></tr><tr><td>InstallmentSupport</td><td>bool</td><td>Installment support</td></tr><tr><td>InstallmentDynamic</td><td>bool</td><td>Dynamic installment support</td></tr><tr><td>ShowProduct</td><td>bool</td><td>Are the products displayed on the screen?</td></tr><tr><td>ReceiverInfoSupport</td><td>bool</td><td>Should recipient information be collected on the screen?</td></tr><tr><td>ReceiverAddressSupport</td><td>bool</td><td>Should recipient address information be collected on the screen?</td></tr><tr><td>SuccessBackUrl</td><td>string</td><td>The screen to be redirected to in case of success</td></tr><tr><td>CardWallSupport</td><td>bool</td><td>Is there card storage support?</td></tr><tr><td>CardWallExpirationMin</td><td>int</td><td>The minute that card storage is supported. It is supported for a certain period for security reasons.</td></tr><tr><td>ExpiryTime</td><td>DateTime</td><td>The expiration date of the shared payment page.</td></tr><tr><td>AnyPayment</td><td>bool</td><td>Has any payment been made on the shared payment page?</td></tr><tr><td>SuccessPayment</td><td>bool</td><td>Are there any successful payments?</td></tr></tbody></table>

</details>

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

```json
{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Id": 1320,
        "Guid": "399173a2-5b0b-49e5--9bf2e3e661b7",
        "UniqueCode": "A1S2D3F4G5H6J7J7H6G5F4D3S2A1",
        "LanguageId": 1,
        "CurrencyId": 1,
        "CurrencyName": "TRY",
        "Amount": 25.00,
        "InstallmentSupport": true,
        "InstallmentDynamic": true,
        "ShowProduct": true,
        "ReceiverInfoSupport": false,
        "ReceiverAddressSupport": false,
        "SuccessBackUrl": "https://paywall.one/95d9cb18-b6ab-403b-a86a-da0ace185706",
        "FailBackUrl": "https://paywall.one/95d9cb18-b6ab-403b-a86a-da0ace185706",
        "CardWallSupport": true,
        "CardWallExpirationMin": 15,
        "ExpiryTime": "2024-02-06T18:38:03.482921",
        "AnyPayment": true,
        "SuccessPayment": true
    }
}
```

{% 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/checkout-page-service/2.-payment-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.