v1

latestOpenAPI 3.1.02026-07-263436159.3 KB

Get Paywall by UID

Use this call to retrieve the details of a Paywall previously created with the POST Paywall method.

get/paywalls/{PaywallUid}

Path parameters

PaywallUidstring required

The UID of the paywall returned by the POST Create Paywall method.

Headers

Ocp-Apim-Subscription-Keystring required

The subscription key has a length of 32 characters and will be provided within the API keys. Will be available for new integrations from July 24th onwards.

Response

200

uidstring

trackingIdstring

amountinteger

currencystring

descriptionstring

createdAtstring

returnUrlstring

cancelUrlstring

notificationUrlstring

{"stackTrail":"paths:/paywalls/{PaywallUid}:get:responses:200:content:application/json:schema:properties:shopName","oasType":"schema","type":"unknown"}

languagestring

totalAmountinteger

expirationDatestring

{"stackTrail":"paths:/paywalls/{PaywallUid}:get:responses:200:content:application/json:schema:properties:transactionID","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/paywalls/{PaywallUid}:get:responses:200:content:application/json:schema:properties:whitelabel","oasType":"schema","type":"unknown"}

showModalboolean

Example response

{
  "uid": "bb893933-1bf5-4678-a8dc-8875ae078743",
  "trackingId": "tracking 1544655",
  "amount": 50000,
  "currency": "USD",
  "description": "test payment",
  "createdAt": "2022-05-25T09:25:43.3785145Z",
  "returnUrl": "https://payretailers.com",
  "cancelUrl": "https://payretailers.com",
  "notificationUrl": "https://payment-form.payretailers.com",
  "language": "EN",
  "totalAmount": 500,
  "expirationDate": "2022-05-27T09:25:43.3781256Z",
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "personalId": "1234567",
    "country": "BR",
    "city": "Buenos Aires",
    "zip": "1234556",
    "address": "100 street 25",
    "phone": "5545454545",
    "ip": "181.166.176.12"
  },
  "form": {
    "action": "https://api.gateway.payretailers.com/v2/public/paywalls/landing/xxxxxxxx",
    "method": "GET"
  },
  "showModal": true
}