POST {{Base Adres}}/api/paywall/recurring
Important: In order to use the payment service, you need to send the 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' field. PaymentAPI Address
The parameters that need to be sent to the service are as follows:
Sample to be sent to the service JSON and sample codes is as follows
The parameters returned from the service are as follows:
Last updated
| Parameter | Type | Required | Description |
|---|---|---|---|
| Parameter | Type | Required | Description |
|---|---|---|---|
| parameter | type | Description |
|---|---|---|
apikeypublic
string
Yes
The Public Key obtained from the merchant panel.
apiclientpublic
string
Yes
The Public Client obtained from the merchant panel.
Card:UniqueCode
string
Yes
The UniqueCode information for the hidden card where payments will be collected is returned from PayWall as a response during card registration and listing.
SubscriptionType
int
Yes
Membership type. Currently, only 1 is supported.
See: Recurring Payment
SubscriptionMerchantCode
string
Yes
The unique reference number provided by you for recurring payments
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 trial period applied to the membership is 10 days. If the payment was generated on 02/07 in a monthly cycle, the first payment will be collected on 12/08.
PaymentAtCreation
bool
Yes
If you send the parameter as TRUE, the initial payment with the relevant information is collected before creating the membership. Upon successful collection, membership is created with the respective card details. If FALSE is sent, the membership is created, and a payment order is generated along with the selected period. However, the initial payment is not collected when creating the membership. Note: In the case of providing trial days, even if this parameter is sent as TRUE, the first payment will be collected today + after the trial days.
FirstPaymentDate
DateTime
No
You can set the initial payment date on your side. If the parameter is sent as '2024-04-04', the respective payment will be taken on April 4, 2024, and will continue with the period you have defined for the subsequent payments.
Note: In the case of a trial application, additional days are added to the initial payment date, and the payment is made accordingly. If you specify '2024-04-04' and there is a 10-day trial, the first payment will be collected on April 14, 2024.
RecurringPeriodType
int
Yes
Payment recurrence period type
See: Recurring Payment
FailAttempt
int
Yes
Number of retry attempts in case of payment failure. Max: 5
FailAttemptPendingHour
int
Yes
Time interval PayWall will wait between failed payment retries.
Max: 24
Customer:Name
string
Yes
User/customer name in your payment system
Customer:Lastname
string
Yes
User/customer last name in your payment system
Customer:Phone
string
Yes
The customer's phone number in your payment system.
Customer:Email
string
Yes
The user/customer email address in your payment system
Customer:Country
string
Yes
The user/customer country information in your payment system.
Customer:City
string
Yes
The user/customer city information in your payment system.
Customer:Address
string
Yes
The user/customer address information in your payment system.
Customer:IdentityNumber
string
Yes
The user/customer identification information in your payment system.
Items:Type
int
Yes
The type of the transaction subject to payment See: Recurring Payment
Items:Name
string
Yes
The name of the sale that is the subject of the payment.
Items:Amount
decimal
Yes
The amount of the sale subject to payment.
The 'Items' obect is an array, and the 'Amount' information of the entered items should sum up to totl amount
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
No details are returned.
