Get all page details

curl https://api-sandbox.payabli.com/api/Paypoint/load/8cfec329267/pay-your-fees-1 \
     -H "requestToken: <apiKey>"

{
  "AdditionalData": {
    "key1": {
      "key": "value"
    },
    "key2": {
      "key": "value"
    },
    "key3": {
      "key": "value"
    }
  },
  "credentials": [
    {
      "accountId": "accountId",
      "cfeeFix": 1.1,
      "cfeeFloat": 1.1,
      "cfeeMax": 1.1,
      "cfeeMin": 1.1,
      "maxticket": 1.1,
      "minticket": 1.1,
      "mode": 1,
      "referenceId": 1000000,
      "service": "service"
    }
  ],
  "lastAccess": "2022-06-30T15:01:00Z",
  "pageContent": {
    "amount": {
      "categories": [
        {}
      ],
      "enabled": true,
      "order": 1
    },
    "autopay": {
      "enabled": true,
      "frequencySelected": "frequencySelected",
      "header": "header",
      "order": 1,
      "startDate": "1, 5-10"
    },
    "contactUs": {
      "emailLabel": "emailLabel",
      "enabled": true,
      "header": "header",
      "order": 1,
      "paymentIcons": true,
      "phoneLabel": "phoneLabel"
    },
    "entry": "entry",
    "invoices": {
      "enabled": true,
      "invoiceLink": {
        "enabled": true
      },
      "order": 1,
      "viewInvoiceDetails": {
        "enabled": true
      }
    },
    "logo": {
      "enabled": true,
      "order": 1
    },
    "messageBeforePaying": {
      "enabled": true,
      "label": "label",
      "order": 1
    },
    "name": "name",
    "notes": {
      "enabled": true,
      "header": "header",
      "order": 1,
      "placeholder": "placeholder",
      "value": "value"
    },
    "page": {
      "description": "description",
      "enabled": true,
      "header": "header",
      "order": 1
    },
    "paymentButton": {
      "enabled": true,
      "label": "label",
      "order": 1
    },
    "paymentMethods": {
      "allMethodsChecked": true,
      "enabled": true,
      "header": "header",
      "methods": {
        "amex": true,
        "applePay": true,
        "discover": false,
        "eCheck": false,
        "mastercard": true,
        "visa": true
      },
      "order": 1
    },
    "payor": {
      "enabled": true,
      "fields": [
        {}
      ],
      "header": "header",
      "order": 1
    },
    "review": {
      "enabled": true,
      "header": "header",
      "order": 1
    },
    "subdomain": "mypage-1"
  },
  "pageIdentifier": "null",
  "pageSettings": {
    "color": "color",
    "customCssUrl": "customCssUrl",
    "language": "language",
    "pageLogo": {
      "fContent": "TXkgdGVzdCBmaWxlHJ==...",
      "filename": "my-doc.pdf",
      "ftype": "pdf",
      "furl": "https://mysite.com/my-doc.pdf"
    },
    "paymentButton": {
      "label": "label",
      "size": "sm"
    },
    "redirectAfterApprove": true,
    "redirectAfterApproveUrl": "redirectAfterApproveUrl"
  },
  "published": 1,
  "receiptContent": {
    "amount": {
      "enabled": true,
      "order": 1
    },
    "contactUs": {
      "enabled": true,
      "order": 1
    },
    "details": {
      "enabled": true,
      "order": 1
    },
    "logo": {
      "enabled": true,
      "order": 1
    },
    "messageBeforeButton": {
      "enabled": true,
      "label": "label",
      "order": 1
    },
    "page": {
      "description": "description",
      "enabled": true,
      "header": "header",
      "order": 1
    },
    "paymentButton": {
      "enabled": true,
      "label": "label",
      "order": 1
    },
    "paymentInformation": {
      "enabled": true,
      "order": 1
    },
    "settings": {
      "enabled": true,
      "fields": [
        {}
      ],
      "order": 1,
      "sendAuto": true,
      "sendManual": true
    }
  },
  "subdomain": "mypage-1",
  "totalAmount": 1.1,
  "validationCode": "validationCode"
}

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

Authentication

requestTokenstring

API Key authentication via header

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.

Response

Success

AdditionalDatamap from strings to optional maps from strings to any

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

Array of credential objects with active services for the page

lastAccessdatetime

Timestamp of last access to page structure

pageContentobject

Sections of page

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

pageSettingsobject

Settings of page

publishedinteger

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

receiptContentobject

Sections of payment receipt

subdomainstring<=50 characters

Page identifier. Must be unique in platform.

totalAmountdouble

Total amount to pay in this page

validationCodestring

Base64 encoded image of Captcha associated to this page load

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error