Get payment page

GET

/Paypoint/:entry/:subdomain

GET

/api/Paypoint/:entry/:subdomain

$ curl https://api-sandbox.payabli.com/api/Paypoint/8cfec329267/pay-your-fees-1

1 {
2   "AdditionalData": {
3     "key1": {
4       "key": "value"
5     },
6     "key2": {
7       "key": "value"
8     },
9     "key3": {
10       "key": "value"
11     }
12   },
13   "Credentials": [
14     {
15       "accountId": "accountId",
16       "cfeeFix": 1.1,
17       "cfeeFloat": 1.1,
18       "cfeeMax": 1.1,
19       "cfeeMin": 1.1,
20       "maxticket": 1.1,
21       "minticket": 1.1,
22       "mode": 1,
23       "referenceId": 1000000,
24       "service": "service",
25       "greaterValueAllowed": true,
26       "absorbDifference": false,
27       "allowOverride": false
28     }
29   ],
30   "LastAccess": "2022-06-30T15:01:00Z",
31   "PageContent": {
32     "amount": {
33       "categories": [
34         {}
35       ],
36       "enabled": true,
37       "order": 1
38     },
39     "autopay": {
40       "enabled": true,
41       "frequencySelected": "frequencySelected",
42       "header": "header",
43       "order": 1,
44       "startDate": "1, 5-10"
45     },
46     "contactUs": {
47       "emailLabel": "emailLabel",
48       "enabled": true,
49       "header": "header",
50       "order": 1,
51       "paymentIcons": true,
52       "phoneLabel": "phoneLabel"
53     },
54     "entry": "8cfec329267",
55     "invoices": {
56       "enabled": true,
57       "invoiceLink": {
58         "enabled": true
59       },
60       "order": 1,
61       "viewInvoiceDetails": {
62         "enabled": true
63       }
64     },
65     "logo": {
66       "enabled": true,
67       "order": 1
68     },
69     "messageBeforePaying": {
70       "enabled": true,
71       "label": "label",
72       "order": 1
73     },
74     "name": "name",
75     "notes": {
76       "enabled": true,
77       "header": "header",
78       "order": 1,
79       "placeholder": "placeholder",
80       "value": "value"
81     },
82     "page": {
83       "description": "description",
84       "enabled": true,
85       "header": "header",
86       "order": 1
87     },
88     "paymentButton": {
89       "enabled": true,
90       "label": "label",
91       "order": 1
92     },
93     "paymentMethods": {
94       "allMethodsChecked": true,
95       "enabled": true,
96       "header": "header",
97       "methods": {
98         "amex": true,
99         "applePay": true,
100         "discover": false,
101         "eCheck": false,
102         "mastercard": true,
103         "visa": true
104       },
105       "order": 1,
106       "showSaveMethod": true
107     },
108     "payor": {
109       "enabled": true,
110       "fields": [
111         {}
112       ],
113       "header": "header",
114       "order": 1
115     },
116     "review": {
117       "enabled": true,
118       "header": "header",
119       "order": 1
120     },
121     "subdomain": "mypage-1"
122   },
123   "pageIdentifier": "null",
124   "PageSettings": {
125     "color": "color",
126     "customCssUrl": "customCssUrl",
127     "language": "language",
128     "pageLogo": {
129       "fContent": "TXkgdGVzdCBmaWxlHJ==...",
130       "filename": "my-doc.pdf",
131       "ftype": "pdf",
132       "furl": "https://mysite.com/my-doc.pdf"
133     },
134     "paymentButton": {
135       "label": "label",
136       "size": "sm"
137     },
138     "redirectAfterApprove": true,
139     "redirectAfterApproveUrl": "redirectAfterApproveUrl"
140   },
141   "published": 1,
142   "ReceiptContent": {
143     "amount": {
144       "enabled": true,
145       "order": 1
146     },
147     "contactUs": {
148       "enabled": true,
149       "order": 1
150     },
151     "details": {
152       "enabled": true,
153       "order": 1
154     },
155     "logo": {
156       "enabled": true,
157       "order": 1
158     },
159     "messageBeforeButton": {
160       "enabled": true,
161       "label": "label",
162       "order": 1
163     },
164     "page": {
165       "description": "description",
166       "enabled": true,
167       "header": "header",
168       "order": 1
169     },
170     "paymentButton": {
171       "enabled": true,
172       "label": "label",
173       "order": 1
174     },
175     "paymentInformation": {
176       "enabled": true,
177       "order": 1
178     },
179     "settings": {
180       "enabled": true,
181       "fields": [
182         {}
183       ],
184       "order": 1,
185       "sendAuto": true,
186       "sendManual": true
187     }
188   },
189   "Subdomain": "mypage-1",
190   "totalAmount": 1.1,
191   "validationCode": "validationCode"
192 }

Gets the details for a single payment page for a paypoint.

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, in https://paypages-sandbox.payabli.com/513823dc10/pay-your-fees-1, the subdomain is pay-your-fees-1.

Response

Success

AdditionalDatamap from strings to maps from strings to anyOptional

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:

1 {
2   "additionalData": {
3     "key1": "value1",
4     "key2": "value2",
5     "key3": "value3"
6   }
7 }

Credentialslist of objectsOptional

Array of credential objects with active services for the page

LastAccessdatetimeOptional

Timestamp of last access to page structure

PageContentobjectOptional

Sections of page

pageIdentifierstringOptional

Auxiliary validation used internally by payment pages and components.

PageSettingsobjectOptional

Settings of page

publishedintegerOptional

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

ReceiptContentobjectOptional

Sections of payment receipt

SubdomainstringOptional<=50 characters

Page identifier. Must be unique in platform.

totalAmountdoubleOptional

Total amount to pay in this page

validationCodestringOptional

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