API referencePay In endpointsHosted payment pages

Create payment page

Creates a new payment page for a paypoint. Note: this operation doesn’t create a new paypoint, just a payment page for an exisiting paypoint. See How do I create a paypoint? to understand how paypoints are created.

Path parameters

entrystringRequired

The paypoint’s entrypoint identifier. Learn more

Headers

requestTokenstringRequired
idempotencyKeystringOptional

A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key is not generated in Payabli, you must generate it yourself.

Request

This endpoint expects an object.
AdditionalDatamap from strings to optional 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. 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

Response

Success

isSuccessbooleanOptional

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

pageIdentifierstringOptional

Auxiliary validation used internally by payment pages and components.

responseCodeintegerOptional

Code for the response. Learn more in API Response Codes.

responseDatastring or integerOptional

The response data.

responseTextstringOptional

Response text for operation: ‘Success’ or ‘Declined’.

Errors