7. Query Recurring Payment

You can query your payments that have been reported as successful to your URL address using this service. You can use the PaymentId and SubscriptionId parameters transmitted within the callback.

Inquire Recurring Payment

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

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

PaymentAPI Address

ParameterTypeMandatoryDescription

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

Membership creation and successful callback notifications are sent by PayWall.

paymentid

int

Yes

The identification information of the payment in PayWall related to the recurring payment made within the scope of the membership. It is transmitted within the callback, and you can use the transmitted identity to confirm the payment through this service.

The parameters returned from the service are as follows:

ParameterTypeDescription

ErrorCode

int

Error code. It returns '0' if the operation is successful.

Result

bool

Returns a 'true' or 'false' value. If the operation is successful, it returns 'true'.

Message

string

If the operation is erroneous, this message is specific to the error.

Body

object

Details are not 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