Paywall Integration

The paywall is a web page developed by Payretailers that enables users to select their preferred payment method, provide any necessary additional information, and proceed to checkout. It offers an all-in-one solution that manages the entire transaction flow through a single API call.

The paywall is the quickest way to integrate our payment solution. By using this API, a web page is generated displaying all available payment methods, filtered based on the parameters you define. Our API will respond with your Paywall's URL so you can redirected the customer to this page, where they can select their preferred payment method, input any required information, and proceed to checkout. The paywall is responsive, meaning it adjusts seamlessly to all devices and screen sizes.

Advantages	Limitations
- Simple: Transactions are processed with just one API call. - Comprehensive: Manages the entire checkout process. - Up-to-date: Your configured Payment Methods are automatically updated in the Paywall	- Limited customisation: Few modification options available.

To get started and learn to create your paywall please navigate to Create Paywall

Paywall Customisation

While the paywall has limited customisation options, you can request adjustments to the following elements:

The main colour
The logo
The background image

Please submit the required details to our technical support team, considering the specifications below:

Recommended sizes:

Logo: 140 x 64 px

Background image: 1500 x 500 px

Recommended formats: PNG, JPEG, JPG.

Paywall flow

The flow of the paywall is as follows:

Submit a POST Paywall request to the endpoint indicated here. Upon successful submission, a new paywall is generated based on the parameters of your request.
Retrieve the URL of the paywall from the API response.
Redirect the user to the paywall.
The user then selects their preferred payment method and provides any missing information before confirming the transaction.
If successful, a pending transaction will be created, and the customer will be redirected to the selected payment method’s checkout page. If there are any issues, an error message will appear either on the paywall or on the payment method’s checkout page, indicating the nature of the issue.
Once the checkout process is completed, the customer will be redirected to the URL specified in the returnUrl if applicable. Please note that not all payment methods automatically redirect users. The transaction will then follow the standard transaction process and be handled by our system.

This flowchart illustrates the paywall flow information given above.