2. Edit Repeatedly
Please note that active payment orders counting days will be terminated and a new payment order will be created if RecurringPeriodType and/or Trial information changes during editing. Please pay atten
Edit Recurring Payment
PUT
{{Base Adres}}/api/paywall/recurring
apikeypublic
string
Yes
The Public Key obtained from the merchant panel.
apiclientpublic
string
Yes
The Public Client obtained from the merchant panel.
The parameters that need to be sent to the service are as follows:
SubscriptionMerchantCode
string
Yes
The unique tracking number provided by you for the recurring payment.
It must be the same as the one used during creation
SubscriptionType
int
Yes
Membership type. Currently, only 1 is supported. You can track it from the system data
CurrencyId
int
Yes
Currency
Amount
decimal
Yes
Recurring payment amount. The amount to be deducted from the card each time.
CallbackUrl
string
Yes
The address where payment results will be POSTed. See. Post Body
HasTrial
bool
Yes
Is there a trial period applied to the membership?
TrialDay
int
Yes
The number of days for the trial period applied to the membership. If the payment was created on 02/07 in a monthly period and there is a 10-day trial period, the first payment will be collected on 12/08.
RecurringPeriodType
int
Yes
The type of recurring period for the payment.
FailAttempt
int
Yes
The number of retries in case of payment failure. Max: 5
FailAttemptPendingHour
int
Yes
The time zone Paywall will wait between retries for failed payments. Max: 24
Items:Name
string
Yes
The name of the sale subject to payment.
Items:Amount
decimal
Yes
The amount of the sale subject to payment.
Items The Itmes object is an array, and the amount information of the entered items should be equal to the total amount
Sample to be sent for service JSON and example codes Sample to be sent for service
{
"SubscriptionMerchantCode": "65FSDOMBNA59DA5ASGHD",
"SubscriptionType": 1,
"CurrencyId": 2,
"Amount": 12,
"CallbackUrl": "https://webhook.site/8d70cb8e-fe1b-478b-8ee3-823870549ef2",
"HasTrial": true,
"TrialDay": 1,
"RecurringPeriodType": 4,
"FailAttempt": 1,
"FailAttemptPendingHour": 2,
// If there is no change in the Items parameter, creation will proceed.
// It must be the same as what you sent immediately.
"Items": [
{
"Type": 1,
"Name": "Gold Package",
"Amount": 12
}
]
}
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
No details are returned.
{
"ErrorCode": 0,
"Result": true,
"Message": "",
"Body": null
}
Last updated