API referencePay In endpointsHosted payment pages

Get all page details

Loads all of a payment page’s details including pageIdentifier and validationCode. This endpoint requires an application API token.

Path parameters

entrystringRequired

The paypoint’s entrypoint identifier. Learn more

subdomainstringRequired

Payment page identifier. The subdomain value is the last portion of the payment page URL. For example, inhttps://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1, the subdomain is pay-your-fees-1.

Headers

requestTokenstringRequired

Response

Success
AdditionalDatamap from strings to optional maps from strings to any or null

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using custom identifiers, pass those in this object. Example usage:

1{
2  "additionalData": {
3    "key1": "value1",
4    "key2": "value2",
5    "key3": "value3"
6  }
7}
credentialslist of objects or null
Array of credential objects with active services for the page
lastAccessdatetime or null
Timestamp of last access to page structure
pageContentobject or null
Sections of page
pageIdentifierstring or null
Auxiliary validation used internally by payment pages and components.
pageSettingsobject or null
Settings of page
publishedinteger or null

Flag indicating if page is active to accept payments. 0 for false, 1 for true.

receiptContentobject or null
Sections of payment receipt
subdomainstring or null<=50 characters
Page identifier. Must be unique in platform.
totalAmountdouble or null
Total amount to pay in this page
validationCodestring or null
Base64 encoded image of Captcha associated to this page load

Errors