3. Recurring Inquiry
Inquire Recurring Payment
GET {{Base Adres}}/api/paywall/recurring/query
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 provided for the recurring payment.
The parameters returned from the service are as follows:
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 fails, this is the specified error message.
Body
object
Details of the recurring payment
The parameters returned from the service (Payment Details) are as follows:
Id
int
The recurring payment identification information.
CurrencyId
int
The recurring payment currency.
SubscriptionType
int
The recurring payment type.
SubscriptionCode
string
The code assigned by Paywall for recurring payments.
SubscriptionMerchantCode
string
The code assigned by us for recurring payments.
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 the payment trial version has been applied or not.
TrialDay
int
The trial period applied to the payment (Days).
RecurringPeriodType
int
The payment period type.
FailAttempt
int
The number of retries 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 name of the customer assigned to the payment.
Customer:Lastname
string
The surname of the customer assigned to the payment.
Customer:Phone
string
The phone number of the customer assigned to the payment.
Customer:Email
string
The email address of the customer assigned to the payment.
Customer:Country
string
The country information of the customer assigned to the payment.
Customer:City
string
The city information of the customer assigned to the payment.
Customer:Address
string
The address information of the customer assigned to the payment.
Customer:IdentityNumber
string
The identification information of the customer assigned to the payment.
Items:Type
int
The type of the sale involved in the payment.
Items:Name
string
The name of the sale involved in the payment.
Items:Amount
decimal
The amount of the sale involved in the payment.
Jobs:RecurringDateTime
DateTime
The date on which the payment task will occur.
Jobs:IsComplete
bool
The completion status of the payment task.
{
"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": "[email protected]",
"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
}
}Last updated