7. Query Recurring Payment

You can query your payments reported with successful results to your CallbackUrl address using this service. You can use the PaymentId and SubscriptionId parameters provided within the callback.

Query Recurring Payment

GET {{Base Adres}}/api/paywall/recurring/query/payment

Important: In order to use the Query Recurring Payment service, you need to send 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' field.

PaymentAPI Address

Parameter
Type
Compulsory
Description

apikeypublic

string

Yes

The Public Key obtained from the merchant panel.

apiclientpublic

string

Yes

The Public Client obtained from the merchant panel.

subscriptionid

int

Yes

Sent by Paywall during membership creation and successful callbacks.

paymentid

int

Yes

The identifier of the payment in Paywall for the recurring payment made within the scope of the membership. It is conveyed within the callback, and you can confirm the payment from this service with the conveyed identifier.

The parameters returned from the service are as follows:

Parameter
Type
Description

ErrorCode

int

Error code. If the transaction is successful, it returns '0'.

Result

bool

It returns either true or false. If the transaction is successful, it returns 'true'.

Message

string

If the transaction is unsuccessful, this is the specified error message.

Body

object

No details returned.

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "SubscriptionId": 2445347,
        "SubscriptionStatusType": 0,
        "PaymentSuccess": true,
        "SubscriptionMerchantCode": "OSKANR4664SDDH",
        "Payment": {
            "Id": 1680435,
            "CardOwnerName": "Emir Selim Tütüncü",
            "CardNumber": "453144******2283",
            "CurrencyId": 1,
            "InstallmentId": 1,
            "Amount": 110.00,
            "Activities": [
                {
                    "PaymentActivityId": 3313320,
                    "PaymentStatusId": 4,
                    "PaymentStatus": "Başarılı",
                    "PaymentActivityTypeId": 1,
                    "PaymentActivityType": "Satış"
                },
                {
                    "PaymentActivityId": 3313319,
                    "PaymentStatusId": 2,
                    "PaymentStatus": "Başladı",
                    "PaymentActivityTypeId": 1,
                    "PaymentActivityType": "Satış"
                },
                {
                    "PaymentActivityId": 3313318,
                    "PaymentStatusId": 8,
                    "PaymentStatus": "Ara İşlem",
                    "PaymentActivityTypeId": 1,
                    "PaymentActivityType": "Satış"
                },
                {
                    "PaymentActivityId": 3313317,
                    "PaymentStatusId": 6,
                    "PaymentStatus": "PayJump",
                    "PaymentActivityTypeId": 1,
                    "PaymentActivityType": "Satış"
                },
                {
                    "PaymentActivityId": 3313316,
                    "PaymentStatusId": 5,
                    "PaymentStatus": "Başarısız",
                    "PaymentActivityTypeId": 1,
                    "PaymentActivityType": "Satış"
                },
                {
                    "PaymentActivityId": 3313315,
                    "PaymentStatusId": 2,
                    "PaymentStatus": "Başladı",
                    "PaymentActivityTypeId": 1,
                    "PaymentActivityType": "Satış"
                },
                {
                    "PaymentActivityId": 3313314,
                    "PaymentStatusId": 1,
                    "PaymentStatus": "Oluşturuldu",
                    "PaymentActivityTypeId": 1,
                    "PaymentActivityType": "Satış"
                }
            ]
        }
    }
}

Last updated