# 3. Recurring Inquiry

## Inquire Recurring Payment

<mark style="color:blue;">`GET`</mark> `{{Base Adres}}/api/paywall/recurring/query`

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

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

<table><thead><tr><th width="266">Parameter</th><th width="79">Type</th><th width="133">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>subscriptionmerchantcode</td><td>string </td><td>Yes</td><td>The unique tracking number provided for the recurring payment.</td></tr></tbody></table>

**The parameters returned from the service are as follows:**

<table><thead><tr><th width="189">Parameter</th><th width="100.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>ErrorCode</td><td>int</td><td>Error code. Returns '0' if the operation is successful.</td></tr><tr><td>Result</td><td>bool</td><td>It returns a True or False value. If the operation is successful, it returns 'true'.</td></tr><tr><td>Message</td><td>string</td><td>If the operation fails, this is the specified error message.</td></tr><tr><td>Body</td><td>object</td><td>Details of the recurring payment</td></tr></tbody></table>

**The parameters returned from the service (Payment Details) are as follows:**

<table><thead><tr><th width="274">Parameter</th><th width="114.33333333333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>Id</td><td>int</td><td>The recurring payment identification information.</td></tr><tr><td>CurrencyId</td><td>int</td><td>The recurring payment currency.</td></tr><tr><td>SubscriptionType</td><td>int</td><td>The recurring payment type.</td></tr><tr><td>SubscriptionCode</td><td>string</td><td>The code assigned by Paywall for recurring payments.</td></tr><tr><td>SubscriptionMerchantCode</td><td>string</td><td>The code assigned by us for recurring payments.</td></tr><tr><td>Amount</td><td>decimal</td><td>The amount of the recurring payment.</td></tr><tr><td>CallbackUrl</td><td>string</td><td>The address where the payment result is POSTed after payment transactions.<br><br>See. <a href="broken-reference"><strong>Post Body</strong></a></td></tr><tr><td>HasTrial</td><td>bool</td><td>Whether the payment trial version has been applied or not.</td></tr><tr><td>TrialDay</td><td>int</td><td>The trial period applied to the payment (Days).</td></tr><tr><td>RecurringPeriodType</td><td>int</td><td>The payment period type.</td></tr><tr><td>FailAttempt</td><td>int</td><td>The number of retries in case of payment failure.</td></tr><tr><td>FailAttemptPendingHour</td><td>int</td><td>The time interval to wait between each unsuccessful attempt in case of payment failure.</td></tr><tr><td><strong>Card</strong>:CardCount</td><td>int</td><td>The number of registered cards assigned to the payment.</td></tr><tr><td><strong>Customer</strong>:Name</td><td>string</td><td>The name of the customer assigned to the payment.</td></tr><tr><td><strong>Customer</strong>:Lastname</td><td>string</td><td>The surname of the customer assigned to the payment.</td></tr><tr><td><strong>Customer</strong>:Phone</td><td>string</td><td>The phone number of the customer assigned to the payment.</td></tr><tr><td><strong>Customer</strong>:Email</td><td>string</td><td>The email address of the customer assigned to the payment.</td></tr><tr><td><strong>Customer</strong>:Country</td><td>string</td><td>The country information of the customer assigned to the payment.</td></tr><tr><td><strong>Customer</strong>:City</td><td>string</td><td>The city information of the customer assigned to the payment.</td></tr><tr><td><strong>Customer</strong>:Address</td><td>string</td><td>The address information of the customer assigned to the payment.</td></tr><tr><td><strong>Customer</strong>:IdentityNumber</td><td>string</td><td>The identification information of the customer assigned to the payment.</td></tr><tr><td><strong>Items</strong>:Type</td><td>int</td><td>The type of the sale involved in the payment.</td></tr><tr><td><strong>Items</strong>:Name</td><td>string</td><td>The name of the sale involved in the payment.</td></tr><tr><td><strong>Items</strong>:Amount</td><td>decimal</td><td>The amount of the sale involved in the payment.</td></tr><tr><td><strong>Jobs</strong>:RecurringDateTime</td><td>DateTime</td><td>The date on which the payment task will occur.</td></tr><tr><td><strong>Jobs</strong>:IsComplete</td><td>bool</td><td>The completion status of the payment task.</td></tr></tbody></table>

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

```json
{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Id": 22,
        "CurrencyId": 1,
        "SubscriptionType": 1,
        "SubscriptionCode": "c6035cb4-85b0-43b7-b104-9295ce66a246",
        "SubscriptionMerchantCode": "test2merchantcode",
        "Amount": 110.00,
        "CallbackUrl": "https://webhook.site/8d70cb8e-fe1b-478b-8ee3-823870549ef2",
        "HasTrial": false,
        "TrialDay": 0,
        "RecurringPeriodType": 4,
        "FailAttempt": 3,
        "FailAttemptPendingHour": 1,
        "Card": {
            "CardCount": 1
        },
        "Customer": {
            "Name": "Jogni",
            "Lastname": "Kivi",
            "Phone": "5554433212",
            "Email": "kivijogni@paywall.one",
            "Country": "Turkey",
            "City": "Istanbul",
            "Address": "Heaven",
            "IdentityNumber": "11111111110"
        },
        "Items": [
            {
                "Type": 1,
                "Name": "Gold Package",
                "Amount": 110.00
            }
        ],
        "Jobs": [
            {
                "RecurringDateTime": "2023-08-22T18:00:00",
                "IsComplete": false
            }
        ],
        "InsertDateTime": "2023-07-22T18:16:37.865576",
        "IsActive": true
    }
}
```

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