Sign in

v1

latestOpenAPI 3.1.02026-07-263436159.3 KB

Create Paywall

Use this call to create a new paywall for your customers according to their country of residence and preferred payment methods.

post/paywalls

Headers

Ocp-Apim-Subscription-Keystring required

The subscription key has a length of 32 characters and will be provided within the API keys. <strong style="color:red;">Required only for new integrations from July 24th onwards.</strong>

Request body

amountstring required

<strong style="color:red;">Required for all countries</strong></br>The amount of the transaction. The last two digits will be parsed as decimals (e.g. for 32.00$ write 3200)

currencystring required

<strong style="color:red;">Required for all countries</strong></br>The currency code of the currency used for the transaction.

descriptionstring

A short description of the order.

trackingIdstring

Optional external tracking reference for the transaction.

notificationUrlstring

The URL used to send notifications when a transaction is created and changes status.

returnUrlstring

The URL used to redirect the user after the transaction flow is completed.

paymentChannelTypeCodestring

The channel through which the customer will pay the transaction. Use this parameter to filter the payment methods displayed on the paywall. You can check all possible values <a href="https://payretailers.readme.io/reference/paywall-parameters#paymentchanneltypecode">here</a>

languagestring

The language that will be displayed on the payment method's checkout page. Click <a href="https://payretailers.readme.io/reference/transaction-parameters#language">here</a> to see the possible values.

testModeboolean

Used to make the difference between real transactions and test transactions. Check the Test Mode page for more details.

Response

200

uidstring
trackingIdstring
amountinteger
currencystring
descriptionstring
createdAtstring
returnUrlstring
notificationUrlstring
{"stackTrail":"paths:/paywalls:post:responses:200:content:application/json:schema:properties:shopName","oasType":"schema","type":"unknown"}
languagestring
totalAmountinteger
{"stackTrail":"paths:/paywalls:post:responses:200:content:application/json:schema:properties:expirationDate","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/paywalls:post:responses:200:content:application/json:schema:properties:transactionID","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/paywalls:post:responses:200:content:application/json:schema:properties:currencySymbol","oasType":"schema","type":"unknown"}
apiPaymentShopDomainUrlstring
{"stackTrail":"paths:/paywalls:post:responses:200:content:application/json:schema:properties:whitelabel","oasType":"schema","type":"unknown"}
isLocalCurrencyboolean
isConvertedToLocalCurrencyboolean
{"stackTrail":"paths:/paywalls:post:responses:200:content:application/json:schema:properties:convertedAmountLocalCurrency","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/paywalls:post:responses:200:content:application/json:schema:properties:localCurrencySymbol","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/paywalls:post:responses:200:content:application/json:schema:properties:localCurrency","oasType":"schema","type":"unknown"}
testModeboolean
showModalboolean

Example response

{
  "uid": "c32dc84f-070f-4ddb-8a3d-33756c93135c",
  "trackingId": "10010000A100027",
  "amount": 10000,
  "currency": "MXN",
  "description": "Payment Test",
  "createdAt": "2023-01-13T13:35:41.4520468Z",
  "returnUrl": "https://payment-form.payretailers.com/return",
  "notificationUrl": "https://payment-form.payretailers.com/notification",
  "language": "ES",
  "totalAmount": 100,
  "apiPaymentShopDomainUrl": "https://api.gateway.payretailers.com/",
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "test@payretailers.com",
    "country": "MX",
    "city": "Ciudad de México",
    "zip": "06010",
    "address": "República de Perú 177",
    "phone": "5299999999999",
    "ip": "150.125.18.159"
  },
  "form": {
    "action": "https://pr1az1pro1paywall1web.z13.web.core.windows.net/?p=c32dc84f-070f-4ddb-8a3d-33756c93135c",
    "method": "GET"
  },
  "testMode": true
}
All 34 operations