hostedPaymentPages

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.

post/Paypoint/{entry}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Paypoint/{entry}
  • Auth: HTTP bearer

Path parameters

entrystring required

The paypoint's entrypoint identifier. Learn more

Headers

idempotencyKeystring

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. The key persists for 2 minutes. After 2 minutes, you can reuse the key if needed.

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 body

AdditionalDataAdditionalData

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:

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}
LastAccessstring date-time

Timestamp of last access to page structure

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

publishedinteger

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

Subdomainstring

Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.

totalAmountnumber double

Total amount to pay in this page

validationCodestring

Base64 encoded image of CAPTCHA associated to this page load

Response

Success

responseCodeinteger

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

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

roomIdinteger

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

isSuccessboolean

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

responseTextstring required

Response text for operation: 'Success' or 'Declined'.

Changes

No recorded changes to this operation across all 1 revision of this API.