GET
/
Paypoint
/
{entry}
/
{subdomain}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/Paypoint/{entry}/{subdomain} \
  --header 'requestToken: <api-key>'
{
  "subdomain": "mypage-1",
  "lastAccess": "2022-06-30 15:01:00",
  "totalAmount": 123,
  "pageContent": {
    "name": "<string>",
    "entry": "<string>",
    "subdomain": "mypage-1",
    "logo": {
      "enabled": true,
      "order": 1
    },
    "page": {
      "enabled": true,
      "order": 1,
      "header": "<string>",
      "description": "<string>"
    },
    "invoices": {
      "enabled": true,
      "order": 1,
      "invoiceLink": {
        "enabled": true,
        "order": 1,
        "label": "<string>"
      },
      "viewInvoiceDetails": {
        "enabled": true,
        "order": 1,
        "label": "<string>"
      }
    },
    "payor": {
      "enabled": true,
      "order": 1,
      "header": "<string>",
      "fields": [
        {
          "name": "<string>",
          "label": "<string>",
          "validation": "<string>",
          "value": "<string>",
          "required": true,
          "display": true,
          "fixed": true,
          "identifier": true,
          "order": 1,
          "width": 4
        }
      ]
    },
    "paymentMethods": {
      "enabled": true,
      "order": 1,
      "header": "<string>",
      "allMethodsChecked": true,
      "methods": {
        "visa": true,
        "mastercard": true,
        "discover": false,
        "amex": true,
        "eCheck": false,
        "applePay": true
      },
      "settings": {
        "applePay": {
          "buttonStyle": "black",
          "buttonType": "pay",
          "language": "en-US"
        }
      }
    },
    "notes": {
      "enabled": true,
      "order": 1,
      "header": "<string>",
      "placeholder": "<string>",
      "value": "<string>"
    },
    "messageBeforePaying": {
      "enabled": true,
      "order": 1,
      "label": "<string>"
    },
    "paymentButton": {
      "enabled": true,
      "order": 1,
      "label": "<string>"
    },
    "review": {
      "enabled": true,
      "order": 1,
      "header": "<string>"
    },
    "contactUs": {
      "enabled": true,
      "order": 1,
      "header": "<string>",
      "emailLabel": "<string>",
      "phoneLabel": "<string>",
      "paymentIcons": true
    },
    "autopay": {
      "enabled": true,
      "order": 1,
      "header": "<string>",
      "finish": {
        "untilCancelled": true,
        "calendar": true
      },
      "frequency": {
        "one-time": true,
        "weekly": true,
        "every2Weeks": true,
        "every6Months": true,
        "monthly": true,
        "every3Months": true,
        "annually": true
      },
      "startDate": "1, 5-10",
      "frequencySelected": "<string>"
    },
    "amount": {
      "enabled": true,
      "order": 1,
      "categories": [
        {
          "name": "<string>",
          "type": "<string>",
          "label": "<string>",
          "value": "<string>",
          "description": "<string>",
          "order": 1,
          "quantity": 123,
          "showDescription": true,
          "optionalPay": true
        }
      ]
    }
  },
  "receiptContent": {
    "logo": {
      "enabled": true,
      "order": 1
    },
    "page": {
      "enabled": true,
      "order": 1,
      "header": "<string>",
      "description": "<string>"
    },
    "amount": {
      "enabled": true,
      "order": 1
    },
    "details": {
      "enabled": true,
      "order": 1
    },
    "paymentInformation": {
      "enabled": true,
      "order": 1
    },
    "messageBeforeButton": {
      "enabled": true,
      "order": 1,
      "label": "<string>"
    },
    "paymentButton": {
      "enabled": true,
      "order": 1,
      "label": "<string>"
    },
    "contactUs": {
      "enabled": true,
      "order": 1
    },
    "settings": {
      "enabled": true,
      "order": 1,
      "sendAuto": true,
      "sendManual": false,
      "fields": [
        {
          "name": "<string>",
          "display": true,
          "Fixed": true
        }
      ]
    }
  },
  "pageSettings": {
    "color": "<string>",
    "customCssUrl": "<string>",
    "language": "<string>",
    "redirectAfterApproveUrl": "<string>",
    "redirectAfterApprove": true,
    "pageLogo": {
      "ftype": "pdf",
      "filename": "my-doc.pdf",
      "furl": "https://mysite.com/my-doc.pdf",
      "fContent": "TXkgdGVzdCBmaWxlHJ==..."
    },
    "paymentButton": {
      "label": "<string>",
      "size": "sm"
    }
  },
  "AdditionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  },
  "published": 0,
  "credentials": [
    {
      "service": "<string>",
      "mode": 123,
      "minticket": 123,
      "maxticket": 123,
      "cfeeFix": 123,
      "cfeeFloat": 123,
      "cfeeMin": 123,
      "cfeeMax": 123,
      "accountId": "<string>",
      "referenceId": 123
    }
  ],
  "pageIdentifier": "null",
  "validationCode": "<string>"
}

Authorizations

​
requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

​
subdomain
string
required

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.

Example:

"pay-your-fees-1"

​
entry
string
required

The paypoint's entrypoint identifier. Learn more

Example:

"8cfec329267"

Response

200 - application/json
Success
​
subdomain
string | null

Page identifier. Must be unique in platform.

Maximum length: 50
Example:

"mypage-1"

​
lastAccess
string | null

Timestamp of last access to page structure

Example:

"2022-06-30 15:01:00"

​
totalAmount
number | null

Total amount to pay in this page

​
pageContent
object

Sections of page

​
receiptContent
object

Sections of payment receipt

​
pageSettings
object

Settings of page

​
AdditionalData
object

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}
Example:
{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}
​
published
enum<integer>

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

Available options:
0,
1
​
credentials
object[] | null

Array of credential objects with active services for the page

​
pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

​
validationCode
string | null

Base64 encoded image of Captcha associated to this page load

Was this page helpful?