1. List

List your products and content within the scope of recurring payments.

Recurring Payment Product/Content Pool List

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

Important: To use the Product/Content 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

itemtype

int

No

Content type

itemname

string

No

Content name

amount

decimal

No

Content amount

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.

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "TotalRecord": 10,
        "Data": [
            {
                "Id": 19,
                "Type": 2,
                "Name": "test1",
                "Amount": 150.00,
                "LastChangesDateTime": "0001-01-01T00:00:00",
                "ActiveUsedSubscription": 6
            },
            {
                "Id": 12,
                "Type": 1,
                "Name": "test2",
                "Amount": 23.00,
                "LastChangesDateTime": "2023-12-18T14:27:45.1340498",
                "ActiveUsedSubscription": 13
            },
            {
                "Id": 11,
                "Type": 1,
                "Name": "test3",
                "Amount": 1.00,
                "LastChangesDateTime": "0001-01-01T00:00:00",
                "ActiveUsedSubscription": 0
            },
            {
                "Id": 10,
                "Type": 1,
                "Name": "test4",
                "Amount": 121.00,
                "LastChangesDateTime": "0001-01-01T00:00:00",
                "ActiveUsedSubscription": 0
            },
            {
                "Id": 9,
                "Type": 3,
                "Name": "test5",
                "Amount": 10.00,
                "LastChangesDateTime": "0001-01-01T00:00:00",
                "ActiveUsedSubscription": 0
            }
        ]
    }
}

Last updated