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

Important: In order to use this service, you need to send the 'apikeypublic' and 'apiclientpublic' parameters in the 'Header' field. PaymentAPI Address

Parameters that should be sent to the service are as follows:

Required header parameters

Parameter	Type	Compulsory	Description
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.

Request body parameters

Parameter	Type	Compulsory	Description
UniqueCode	string	Yes	The tracking/order/cart code of the payment on your side
Amount	decimal	Yes	Product/Service Amount
LanguageId	int	No	You can change the language settings of the shared payment page according to your user segment. See: Launguage Options
CurrencyId	int	Yes	Currency https://paywall.gitbook.io/tr/sistem-verileri/para-birimleri
CallbackSupport	bool	Yes	Successful payment results are sent to an address via POST as a callback
CallbackAddress	string	No	The address where successful payment results will be sent
InstallmentSupport	bool	Yes	Should installment options be displayed on the screen?
InstallmentDynamic	bool	No	Installment options can be listed using your active installments among active providers. This listing is based on the card family entered by the user
SuccessBackUrl	string	Yes	The page to redirect after a successful payment
FailBackUrl	string	Yes	The page to redirect after a failed payment
Force3D	bool	Yes	Should the user be forced to use “Secure Payment” on the shared payment page?
ShowProduct	bool	Yes	Should the products subject to payment be listed on the shared payment page?
ExpireDateTime	datetime	No	The lifetime of the shared payment page. It can be defined by you; if not specified, it defaults to 10 minutes
Products	List<Products>	Yes	Product information subject to payment (displayed on the shared payment page if permitted)
Customer	Customer	Yes	Customer information subject to payment (not displayed on the shared payment page; used in reporting)
CardWallSupport	bool	No	Can be used to enable saved card support on the shared payment page
CardWallRelationalId1	string	No	The first unique identifier to associate the card
CardWallRelationalId2	string	No	The second unique identifier to associate the card (all fields must be sent during listing)
CardWallRelationalId3	string	No	The third unique identifier to associate the card (all fields must be sent during listing)
PayWatchSupport	bool	No	Should payments be monitored with PayWatch? (Only those in “Started” status)
PayWatchMin	short	Yes (Conditional)	After how many minutes should PayWatch process the payment? Minimum: 5 | Maksimum: 20
PayWatchCallbackAddress	string	No	If provided, a callback will be sent to the specified address after any change detected by PayWatch in the payment
MasterpassSupport	bool	No	To enable Masterpass support on the shared payment page, you must send the relevant parameter as true Note: In addition to sending this parameter as true, you must also activate the Masterpass plugin on the Virtual POS providers page in the Paywall panel
UseMasterpassAlternative	bool	No	If you want to use Virtual POS providers connected in the Paywall panel (excluding Masterpass) for transactions that are not registered in Masterpass, entered manually, or not intended to be saved by the user in Masterpass, this parameter must be sent as true
RouteGroupKey	string	Yes/No	If payments are to be received via RouteGroup, the RouteGroup key information must be provided with this parameter
SupportCampaign	bool	No	To list campaigns related to the card used on the shared payment page, the relevant parameter must be sent as true Note: To perform campaign queries, at least one of the connected Virtual POS providers in the Paywall panel must be marked as a Campaign POS
SupportReward *Comming Soon	bool	No	To enable the use of reward points for the relevant card information on the shared payment page, the parameter must be sent as true
ProviderBased	bool	Yes	“true” is returned when the payment must be processed through a specific virtual POS provider; in this case, the target provider is selected using the ProviderKey.
ProviderKey	string	Yes/No	Required when ProviderBased = true i: The key value of the provider defined in the panel. IfProviderBased = false , this is typically left blank.
ProviderCondition	object	No	Additional conditions for provider selection. For example, the InstallmentReceiverAddressSupport parameter can be used to define conditions for a specific number of installments; if not used, it can be set to null.
ReceiverAddressSupport	bool	Yes	Determines whether the recipient address fields are displayed on the shared payment page.
ReceiverInfoSupport	bool	Yes	Determines whether the fields for recipient information are displayed on the shared payment page.
RegionId	short	No	The region ID if region selection is to be used. If not provided, the default behavior is used.
InterestConfirmationPopup	bool	Yes	Determines whether to display a confirmation window regarding the commission/interest to the user.
SkipInterest	bool	Yes	If true, skip behavior is triggered in the interest/commission flow under certain conditions; the specific condition can be specified using the SkipInterestCondition.
SkipInterestCondition	object	No	Used in conjunction with SkipInterest The Installment parameter (byte, nullable): Specifies which installment option the skip applies to; set to null if not used.

Products parameter above

Parameter	Type	Compulsory	Description
ProductId	string	Yes	ID of your product on your system
ProductImage	string	No	URL of your product image
ProductName	string	Yes	Your product name
ProductCategory	string	Yes	Category of your product
ProductDescription	string	Yes	Description of your product
ProductAmount	decimal	Yes	The amount of your product
MemberId	int	No	It is mandatory for the Marketplace model. It must be filled with the MemberId information of the sub-merchant in the Paywall system.
MemberEarningCalculated	bool	No	In the marketplace scope, if you have calculated the sub-merchant's entitlement, you should send this parameter as true.
MemberEarning	decimal	No	In the marketplace scope, if you have calculated the sub-merchant's entitlement, you should send this parameter with the entitlement value to Paywall.
MemberCustomCommission	bool	No	In the marketplace scope, this is the parameter used if you want to specify a commission for the sub-merchant for this particular sale.
MemberCommission	decimal	No	In the marketplace scope, this is the parameter where the commission value is sent if you want to specify a commission for the sub-merchant for this particular sale.

Customer parameter above

Parameter	Type	Compulsory	Description
FullName	string	Yes	Customer name/surname
Phone	string	Yes	Customer phone number
Email	string	Yes	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
CustomerId	string	Yes/No	You must fill this field with the payer user's ID in your system. Note: Required for Masterpass

An example JSON to be sent to the service is as follows:

JSON

{
    "UniqueCode": "{{$guid}}",
    "Amount": 10.0,
    "CurrencyId": 1,
    "LanguageId": 1,
    "CallbackSupport": true,
    "PayWatchSupport": true,
    "CallbackAddress": "https://yourwebservice.com/callback",
    "PayWatchMin": 5,
    "PayWatchCallbackAddress": "https://yourwebservice.com/callback/paywatch",
    "SuccessBackUrl": "https://yourwebservice.com/callback/success",
    "FailBackUrl": "https://yourwebservice.com/callback/unsuccessful",
    "Force3D": false,
    "InstallmentSupport": true,
    "InstallmentDynamic": true,
    "CardWallSupport": false,
    "CardWallRelationalId1": "user-id",
    "CardWallRelationalId2": null,
    "CardWallRelationalId3": null,
    "ShowProduct": true,
    "ReceiverInfoSupport": false,
    "ReceiverAddressSupport": false,
    "RegionId": null,
    "ProviderBased": false,
    "ProviderKey": "",
    "ProviderCondition": {
      "Installment": null
    },
    "InterestConfirmationPopup": true,
    "SkipInterest": false,
    "SkipInterestCondition": null,
    "Customer": {
        "FullName":"{{$randomFirstName}}",
        "Phone":"905123456789", // Must for Masterpass
        "Email":"{{$randomEmail}}",
        "Country":"{{$randomCountry}}",
        "City":"{{$randomCity}}",
        "Address":"{{$randomStreetAddress}}",
        "IdentityNumber":"2523123412",
        "TaxNumber":"456345456",
        "CustomerId": "72845" // Must for Masterpass (Payer's userid in your system)
    },
    "Products": [
      {
       "MemberId": 12345,
       "MemberEarningCalculated": true,
       "MemberEarning": 96.39,
       "MemberCustomCommission": true,
       "MemberCommission": 2.61,
       "ProductId": "1",
       "ProductImage": "https://yourwebsite.com/photoimage",
       "ProductName": "1",
       "ProductCategory": "1",
       "ProductDescription": null,
       "ProductAmount": 10
      }
    ],
    "ExpireDateTime": null,
    "RouteGroupKey": "route-999",
    "MasterpassSupport": true, // If payment page will support Masterpass
    "UseMasterpassAlternative": true, // If payment page will support altervative providers than Masterpass
    "SupportCampaign": true,
    "SupportReward": false // Soon
  }

The parameters returned from the service are as follows:

Parameter Descriptions

Parameter	Type	Description
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

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Id": 13284456,
        "Guid": "a2319b22-b442-4b9d-bc87-b800be680761",
        "UniqueCode": "OAEASG54455565256792",
        "Amount": 25.0,
        "Link": "https://dev-checkout.itspaywall.com/checkout/?CheckoutId=a2319b22-b442-4b9d-bc87-b800be680761"
    }
}