hostedPaymentPages

Get all payment page details

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

get/Paypoint/load/{entry}/{subdomain}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Paypoint/load/{entry}/{subdomain}
  • Auth: HTTP bearer

Path parameters

entrystring required

The paypoint's entrypoint identifier. Learn more

subdomainstring required

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

Response

Success

AdditionalDataAdditionalData

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. Max length for a value is 100 characters. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}
LastAccessstring date-time

Timestamp of last access to page structure

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

publishedinteger

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

Subdomainstring

Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.

totalAmountnumber double

Total amount to pay in this page

validationCodestring

Base64 encoded image of CAPTCHA associated to this page load

Changes

No recorded changes to this operation across all 1 revision of this API.