# 1. List

## Recurring Payment Customer Pool List

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

{% hint style="info" %}
**Important:** To use the Customer Pool Listing 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="162">Parameter</th><th width="122">Type</th><th width="139">Compulsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>Public Key obtained from the member merchant panel.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>Public Client obtained from the member merchant panel.</td></tr><tr><td>start</td><td>int</td><td>Yes</td><td>The starting point for listing.</td></tr><tr><td>length</td><td>int</td><td>Yes</td><td>The length of the list.</td></tr><tr><td>sortvalue</td><td>string</td><td>Yes</td><td>This is sorting data, which accepts 'asc' and 'desc' values.</td></tr><tr><td>sortcolumn</td><td>string</td><td>Yes</td><td>It only accepts the 'Id' value.</td></tr><tr><td>datefrom</td><td>DateTime</td><td>No</td><td>Start date. Format: yyyy-MM-dd</td></tr><tr><td>dateto</td><td>DateTime</td><td>No</td><td>End date. Format: yyyy-MM-dd</td></tr><tr><td>name</td><td>string</td><td>No</td><td>Customer name</td></tr><tr><td>lastname</td><td>string</td><td>No</td><td>Customer surname</td></tr><tr><td>phone</td><td>string</td><td>No</td><td>Customer phone number</td></tr><tr><td>email</td><td>string</td><td>No</td><td>Customer email</td></tr><tr><td>country</td><td>string</td><td>No</td><td>Customer country</td></tr><tr><td>city</td><td>string</td><td>No</td><td>Customer city</td></tr><tr><td>address</td><td>string</td><td>No</td><td>Customer address</td></tr><tr><td>identity</td><td>string</td><td>No</td><td>Customer identity</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. Returns 'true' if the operation is successful.</td></tr><tr><td>Message</td><td>string</td><td>If the operation fails, this is the message specified for the error.</td></tr><tr><td>Body</td><td>object</td><td>It returns card details.</td></tr></tbody></table>

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

```json
{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "TotalRecord": 350,
        "Data": [
            {
                "Id": 357,
                "CustomerName": "test1",
                "CustomerLastname": "test1",
                "CustomerPhone": "55500000001",
                "CustomerEmail": "test@gmail.com",
                "CustomerCountry": "",
                "CustomerCity": "",
                "CustomerAddress": "",
                "CustomerIdentity": "",
                "LastChangesDateTime": "0001-01-01T00:00:00",
                "ActiveUsedSubscription": 1
            },
            {
                "Id": 354,
                "CustomerName": "test2",
                "CustomerLastname": "test2",
                "CustomerPhone": "55500000002",
                "CustomerEmail": "tes2t@gmail.com",
                "CustomerCountry": "",
                "CustomerCity": "",
                "CustomerAddress": "",
                "CustomerIdentity": "",
                "LastChangesDateTime": "0001-01-01T00:00:00",
                "ActiveUsedSubscription": 1
            },
            {
                "Id": 353,
                "CustomerName": "test3",
                "CustomerLastname": "test3",
                "CustomerPhone": "55500000003",
                "CustomerEmail": "test3@gmail.com",
                "CustomerCountry": "Turkiye",
                "CustomerCity": "İstanbul",
                "CustomerAddress": "maltepe",
                "CustomerIdentity": "11111111110",
                "LastChangesDateTime": "0001-01-01T00:00:00",
                "ActiveUsedSubscription": 42
            },
            {
                "Id": 352,
                "CustomerName": "test4",
                "CustomerLastname": "test4",
                "CustomerPhone": "55500000004",
                "CustomerEmail": "test4@gmail.com",
                "CustomerCountry": "",
                "CustomerCity": "",
                "CustomerAddress": "",
                "CustomerIdentity": "",
                "LastChangesDateTime": "0001-01-01T00:00:00",
                "ActiveUsedSubscription": 1
            },
            {
                "Id": 351,
                "CustomerName": "test5",
                "CustomerLastname": "test5",
                "CustomerPhone": "55500000005",
                "CustomerEmail": "test5@gmail.com",
                "CustomerCountry": "",
                "CustomerCity": "",
                "CustomerAddress": "",
                "CustomerIdentity": "",
                "LastChangesDateTime": "0001-01-01T00:00:00",
                "ActiveUsedSubscription": 1
            }
        ]
    }
}
```

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