APIPay 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 existing paypoint. Paypoints are created by the Payabli team when a boarding application is approved.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

entrystringRequired

The paypoint’s entrypoint identifier. Learn more

Headers

idempotencyKeystringOptional

Optional but recommended A unique ID that you can include to prevent duplicating objects or transactions in the case that a request is sent more than once. This key isn’t generated in Payabli, you must generate it yourself. This key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

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](/developers/developer-guides/entities-customers), pass those in this object. Max length for a value is 100 characters. Example usage: ```json { "additionalData": { "key1": "value1", "key2": "value2", "key3": "value3" } } ```
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
responseTextstring

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

responseCodeinteger or null

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

pageIdentifierstring or null
Auxiliary validation used internally by payment pages and components.
roomIdlong or null

Describes the room ID. Only in use on Boarding endpoints, returns 0 when not applicable.

isSuccessboolean or null

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

responseDatastring or integer or null
The response data.

Errors