Paywall Response

If successful, the response returns a paywall ID under the parameter uid as well as information about the paywall. This paywall ID can be used as parameter of the GET Paywall request to retrieve the paywall information at any time.

The object form contains the URL of the paywall. You must redirect your users to this URL after sending the request for them to go through with the transaction. After that, everything is handled directly on the paywall and the payment method's checkout page.

The transaction ID will be generated after the customer finishes filling the paywall form and is redirected to the checkout page of the payment method. This event will generate a new PENDING transaction and trigger a callback sent to the request’s notificationUrl with the transaction ID. Your users will be redirected to the returnUrl after finishing on the checkout page.

Paywall Response Fields

Here is the list of all fields of the response with their associated description.

Field	Description
`uid`	The ID of the paywall created.
`trackingId`	The tracking ID used in the request. If omitted, the value will be `null`.
`amount`	The amount of the transaction.
`currency`	The currency of the shop used.
`description`	The description used in the request. If omitted, the value will be `null`.
`createdAt`	The timestamp of the creation date of the paywall.
`returnUrl`	The return Url used in the request. If omitted, the value will be `null`.
`notificationUrl`	The notification Url sent in the request. If omitted, the value will be `null`.
`shopName`	The name of the shop used to create the request.
`language`	The language that will be displayed on the paywall and the payment method checkout page.
`totalAmount`	The amount converted from integer to float.
`expirationDate`	The expiration date of the paywall.
`transactionId`	The ID of the transaction generated with the paywall.
`CurrencySymbol`	The symbol of the currency of the transaction.
`apiPaymentShopDomainUrl`	The base endpoint of the API.
`customer`	The object containing the customer information. Any unrequired field left out of the request will have a value of `null`.
`form`	The object that contains the URL of the paywall that must be used to redirect the user.
`whitelabel`	An object that contains information related to the aspect of the paywall. If the paywall was not customised, every parameter inside of this object will have a value of `null`.
`isLocalCurrency`	Depreciated. Will always have a value of `false`.
`isConvertedToLocalCurrency`	Depreciated. Will always have a value of `false`.
`convertedAmountLocalCurrency`	Depreciated. Will always have a value of `null`.
`localCurrencySymbol`	Depreciated. Will always have a value of `null`.
`localCurrency`	Depreciated. Will always have a value of `null`.
`testMode`	Boolean that differentiates real paywalls from test paywalls.
`showModal`	Depreciated. Will always have a value of `false`.