1. Generate
The common payment page creation flow is the preferred method when you do not want to receive card information through your site/app.
Generate Common Page Payment
POST {{Base Adres}}/api/paywall/checkout/generate
apikeypublic
string
Yes
The Public Key you have obtained from the merchant panel.
apiclientpublic
string
Yes
Public Client that you have obtained from the merchant panel.
Parameters that should be sent to the service are as follows:
UniqueCode
string
Yes
Tracking/order/cart code on your side of the Payment
Amount
decimal
Yes
Total amount
CallbackSupport
bool
Yes
Successful payment results are POST as callback to an address
CallbackAddress
string
No
Address to send callback on successful payment results
InstallmentSupport
bool
Yes
Do you support payment installments?
SuccessBackUrl
string
Yes
URL address to be sent if the operation is successful
FailBackUrl
string
Yes
URL address to be sent if the operation is fail
Force3D
bool
Yes
Force user to "Secure Checkout" on common checkout page?
ShowProduct
bool
Yes
Should the products subject to payment be listed on the common payment page?
ExpireDateTime
datetime
No
The lifetime of the common payment page. It can also be determined by you, if not determined, it is determined as 10 minutes.
Products
List<Product>
No
Product information subject to payment (Listed on common checkout page if allowed)
Customer
No
Customer information subject to payment (It is not displayed on the common payment page. It is used in reporting)
CardWallSupport
bool
No
You can use it to enable support for registered cards on the common payment page.
CardWallRelationalId1
string
No
The unique information required for associating the card.
CardWallRelationalId2
string
No
The second unique information required for associating the card (all information must be sent during listing).
CardWallRelationalId3
String
No
The third unique information required for associating the card (all information must be sent during listing).
Products parameter above:
ProductId
string
No
ID of your product on your system
ProductImage
string
No
URL of your product image
ProductName
string
No
Your product name
ProductCategory
string
No
Category of your product
ProductDescription
string
No
Description of your product
ProductAmount
decimal
No
The amount of your product
Customer parameter above:
FullName
string
No
Customer name/surname
Phone
string
No
Customer phone number
string
No
Customer e-mail
Country
string
No
Country
City
string
No
City
Address
decimal
No
Full address
IdentityNumber
string
No
Individual Customer
TaxNumber
string
No
Corporate Customer
An example JSON to be sent to the service is as follows:
{
"UniqueCode": "AFDKJAS343AGNGF43",
"Amount": 21,
"CurrencyId": 1,
"CallbackSupport": false,
"CallbackAddress": "",
"InstallmentSupport": true,
"SuccessBackUrl": "https://paywall.one/?success",
"FailBackUrl": "https://paywall.one/?unsuccess",
"Force3D": true,
"ShowProduct": true,
"Customer":{
"FullName":"Enes Selman Tütüncü",
"Phone":"5554443322",
"Email":"[email protected]",
"Country":"Türkiye",
"City":"İstanbul",
"Address":"Beyoğlu Taksim",
"IdentityNumber":"11111111111",
"TaxNumber":""
},
"Products": [
{
"ProductId": "1",
"ProductImage": "https://f-asc-l.mncdn.com/webfiles/banners/638109384852337077-4-4lu-768x768px.jpg?v=1675342011",
"ProductName": "Test Product",
"ProductCategory": "Category",
"ProductDescription": "Description",
"ProductAmount": 10.5
},
{
"ProductId": "1",
"ProductImage": "https://f-asc-l.mncdn.com/webfiles/banners/638109384852337077-4-4lu-768x768px.jpg?v=1675342011",
"ProductName": "Test Product",
"ProductCategory": "Category",
"ProductDescription": "Description",
"ProductAmount": 10.5
}
],
"CardWallSupport": false,
"CardWallRelationalId1": "",
"CardWallRelationalId2": "",
"CardWallRelationalId3": "",
"ExpireDateTime": null
}The parameters returned from the service are as follows:
ErrorCode
int
Error code. If the operation is successful, it returns '0'.
Result
bool
Returns True or False. Transaction successful request returns 'true'
Message
string
If the operation is wrong, this is the message about the error, it provides language support according to the local parameter.
Body
string
Returns the payment link under the link parameter
An example JSON:
{
"ErrorCode": 0,
"Result": true,
"Message": "",
"Body": {
"Link": "https://dev-checkout.itspaywall.com/checkout/?CheckoutId=c8ab6dba-f31b-4ee8-9947-52358e9ab5ad"
}
}Last updated