1. List

List your customers within the scope of recurring payments.

Recurring Payment Customer Pool List

GET {{Base Adres}}/api/paywall/recurring/customer/pool

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

PaymentAPI Address

Parameter	Type	Compulsory	Description
apikeypublic	string	Yes	Public Key obtained from the member merchant panel.
apiclientpublic	string	Yes	Public Client obtained from the member merchant panel.
start	int	Yes	The starting point for listing.
length	int	Yes	The length of the list.
sortvalue	string	Yes	This is sorting data, which accepts 'asc' and 'desc' values.
sortcolumn	string	Yes	It only accepts the 'Id' value.
datefrom	DateTime	No	Start date. Format: yyyy-MM-dd
dateto	DateTime	No	End date. Format: yyyy-MM-dd
name	string	No	Customer name
lastname	string	No	Customer surname
phone	string	No	Customer phone number
email	string	No	Customer email
country	string	No	Customer country
city	string	No	Customer city
address	string	No	Customer address
identity	string	No	Customer identity

The parameters returned from the service are as follows:

Parameter	Type	Description
ErrorCode	int	Error code. Returns '0' if the operation is successful.
Result	bool	It returns a true or false value. Returns 'true' if the operation is successful.
Message	string	If the operation fails, this is the message specified for the error.
Body	object	It returns card details.

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "TotalRecord": 350,
        "Data": [
            {
                "Id": 357,
                "CustomerName": "test1",
                "CustomerLastname": "test1",
                "CustomerPhone": "55500000001",
                "CustomerEmail": "[email protected]",
                "CustomerCountry": "",
                "CustomerCity": "",
                "CustomerAddress": "",
                "CustomerIdentity": "",
                "LastChangesDateTime": "0001-01-01T00:00:00",
                "ActiveUsedSubscription": 1
            },
            {
                "Id": 354,
                "CustomerName": "test2",
                "CustomerLastname": "test2",
                "CustomerPhone": "55500000002",
                "CustomerEmail": "[email protected]",
                "CustomerCountry": "",
                "CustomerCity": "",
                "CustomerAddress": "",
                "CustomerIdentity": "",
                "LastChangesDateTime": "0001-01-01T00:00:00",
                "ActiveUsedSubscription": 1
            },
            {
                "Id": 353,
                "CustomerName": "test3",
                "CustomerLastname": "test3",
                "CustomerPhone": "55500000003",
                "CustomerEmail": "[email protected]",
                "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": "[email protected]",
                "CustomerCountry": "",
                "CustomerCity": "",
                "CustomerAddress": "",
                "CustomerIdentity": "",
                "LastChangesDateTime": "0001-01-01T00:00:00",
                "ActiveUsedSubscription": 1
            },
            {
                "Id": 351,
                "CustomerName": "test5",
                "CustomerLastname": "test5",
                "CustomerPhone": "55500000005",
                "CustomerEmail": "[email protected]",
                "CustomerCountry": "",
                "CustomerCity": "",
                "CustomerAddress": "",
                "CustomerIdentity": "",
                "LastChangesDateTime": "0001-01-01T00:00:00",
                "ActiveUsedSubscription": 1
            }
        ]
    }
}