3. Query Recurring

Query Recurring Payment

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

Important: To be able to use the payment service, you need to send the 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' section. PaymentAPI Address

Parameter	Type	Mandatory	Description
apikeypublic	string	Yes	The Public Key obtained from the merchant panel
apiclientpublic	string	Yes	The Public Client obtained from the merchant panel
subscriptionmerchantcode	string	Yes	The unique tracking number you provided for the recurring payment

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. If the operation is successful, it returns 'true'
Message	string	If the operation is in error, this is the specified error message
Body	nesne	The details of the recurring payment

The parameters returned from the service (Payment Details) are as follows:

Parameter	Type	Description
Id	int	Recurring payment identification information
CurrencyId	int	Recurring payment currency
SubscriptionType	int	Recurring payment type
SubscriptionCode	string	The code assigned to the recurring payment by PayWall.
SubscriptionMerchantCode	string	he code assigned to the recurring payment by your side
Amount	decimal	The amount of the recurring payment
CallbackUrl	string	The address where the payment result is POSTed after payment transactions See. Post Body
HasTrial	bool	Whether a trial version is applied to the payment
TrialDay	int	Trial period applied to the payment (Days)
RecurringPeriodType	int	Payment period type
FailAttempt	int	How many times it will be attempted in case of payment failure
FailAttemptPendingHour	int	The time interval to wait between each unsuccessful attempt in case of payment failure
Card:CardCount	int	The number of registered cards assigned to the payment
Customer:Name	string	The customer name assigned to the payment
Customer:Lastname	string	The customer last name assigned to the payment
Customer:Phone	string	The customer phone number assigned to the payment
Customer:Email	string	The customer email address assigned to the payment.
Customer:Country	string	The customer country information assigned to the payment
Customer:City	string	The customer city information assigned to the payment
Customer:Address	string	The customer address information assigned to the payment
Customer:IdentityNumber	string	The customer identification information assigned to the payment
Items:Type	int	The type of the sale subject to payment
Items:Name	string	The name of the sale subject to payment
Items:Amount	decimal	The amount of the sale subject to payment
Jobs:RecurringDateTime	DateTime	The date on which the payment-related task will occur
Jobs:IsComplete	bool	The completion status of the payment-related task

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Id": 22,
        "CurrencyId": 1,
        "SubscriptionType": 1,
        "SubscriptionCode": "c6035cb4-85b0-43b7-b104-9295ce66a246",
        "SubscriptionMerchantCode": "test2merchantcode",
        "Amount": 110.00,
        "CallbackUrl": "https://webhook.site/8d70cb8e-fe1b-478b-8ee3-823870549ef2",
        "HasTrial": false,
        "TrialDay": 0,
        "RecurringPeriodType": 4,
        "FailAttempt": 3,
        "FailAttemptPendingHour": 1,
        "Card": {
            "CardCount": 1
        },
        "Customer": {
            "Name": "Jogni",
            "Lastname": "Kivi",
            "Phone": "5554433212",
            "Email": "[e-mail]",
            "Country": "Turkey",
            "City": "Istanbul",
            "Address": "Heaven",
            "IdentityNumber": "11111111110"
        },
        "Items": [
            {
                "Type": 1,
                "Name": "Gold Package",
                "Amount": 110.00
            }
        ],
        "Jobs": [
            {
                "RecurringDateTime": "2023-08-22T18:00:00",
                "IsComplete": false
            }
        ],
        "InsertDateTime": "2023-07-22T18:16:37.865576",
        "IsActive": true
    }
}