Here you will find information about specific parameters of the POST Create Paywall request and their values.
Required Fields
Some fields in the request are made mandatory by some payment methods in order to process the payment successfully. If any required information is missing when generating the paywall the user will be able to add it themselves on the fourth step of the paywall flow.
This is made to maximise the chances of successful transaction. However, including all required fields when generating the request to ensure an optimal conversion rate. As such we advise you to add this information from your user's account details to avoid having to re-enter it during checkout.
PaymentChannelTypeCode
The PaymentChannelTypeCode is an optional parameter that can be used to filter the payment methods displayed on the paywall per channel. There are four possible values:
CASH, ONLINE, CREDITCARD,WALLET .
Those values can be combined as needed with a + sign to display the relevant payment method on the paywall as shown here :"paymentChannelTypeCode":"CASH+ONLINE" .
If you do not include this parameter in your POST paywall request, or pass a value of null, your paywall will display all available payment options for the requested country and currency.
Important note: If the value passed for
paymentChannelTypeCodeis incorrect the paywall will be blank.
Transaction creation error
It is possible to find cases where the paywall creation is successful but the transaction creation is not, which will result in an error on the paywall or on the payment method's checkout page. Those errors are often due to one of the values that was included in the POST Paywall request. In those cases you can check the Transaction Error Messages page to know what went wrong with the transaction creation.
Important note: paywalls can only be used once! A paywall is considered used when the user clicks on one of the payment methods available on the page. If the customer closes the checkout page before completing the process or if for any reason the payment is not completed, the paywall will have to be created again.
Country
"Country" is a required field for all Paywalls, find below the list of supported Country Codes:
| Parameter | Values |
|---|---|
| Country | AR BR CL CO CR EC MX PA PE BF CM CI GH KE RW SN TZ UG NG ZA |