How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Payabli hostedPaymentPages API

The hostedPaymentPages API from Payabli — 3 operation(s) for hostedpaymentpages.

Payabli hostedPaymentPages API is one of 33 APIs that Payabli publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Hosted Payment Pages. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 49 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api-sandbox.payabli.com/api, https://api.payabli.com/api.

3 operations 3 paths 49 schemas 1 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.payabli.com/api
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Payabli hostedPaymentPages API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the header as requestToken (APIKeyAuth).

  • BearerAuth — OAuth2 Bearer access token from the client-credentials flow. See [OAuth authentication](/developers/oauth-authentication).
  • APIKeyAuth — Long-lived API token sent in the requestToken header. See [API token authentication](/developers/api-tokens).

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

hostedPaymentPages 3
POST
/Paypoint/{entry}
Create payment page
newPage 3 params body → 200400401500503
PUT
/Paypoint/{entry}/{subdomain}
Update a payment page
savePage 3 params body → 200400401500503
GET
/Paypoint/load/{entry}/{subdomain}
Get all payment page details
loadPage 3 params → 200400401500503

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are PageContent (15 properties), PayabliCredentials (13 properties), PayabliPages (11 properties), PayorFields (10 properties). Each schema is shown below with its type and property counts.

MethodsList
object
10 properties
SettingElement
object
5 properties
PayabliApiResponse00Responsedatanonobject
object
6 properties 1 required
MethodElementSettingsApplePayButtonType
string
The text on Apple Pay button. See [Apple Pay Button Type](/developers/developer-guides/hosted-payment-page-apple-payparam-applepay-button-type) for more inform…
ContactElement
object
6 properties
ReceiptContent
object
Object containing receipt body configuration
9 properties
AccountId
string
Custom identifier for payment connector.
MethodElementSettingsApplePayButtonStyle
string
The Apple Pay button style. See [Apple Pay Button Style](/developers/developer-guides/hosted-payment-page-apple-payparam-applepay-button-style) for more inform…
PageContent
object
15 properties
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. If you are using [custom identifiers](…
Subdomain
string
Refers to the payment page identifier. If provided, then the transaction is linked to the payment page.
PageElement
object
4 properties
PayorFields
object
10 properties
PayabliErrorBody
object
Shape returned by every Payabli API error response. The responseData object carries human-readable error context.
4 properties 2 required
PayabliErrorBodyResponseData
object
Object with detailed error context.
2 properties
GreaterValueAllowed
boolean
When true, the customer can pay an amount greater than the invoice or bill amount.
PayCategory
object
9 properties
Enabled
boolean
Toggles whether the section or element is enabled.
PageSetting
object
7 properties
FrequencyList
object
7 properties
NoteElement
object
5 properties
DisplayProperty
object
3 properties
MethodElementSettingsApplePayLanguage
string
The Apple Pay button locale. See [Apple Pay Button Language](/developers/developer-guides/hosted-payment-page-apple-payparam-applepay-language) for more inform…
FileContentFtype
string
The MIME type of the file (if content is provided).
MethodElementSettings
object
Settings for wallet payment methods.
1 property
PayorElement
object
4 properties
AmountElement
object
3 properties
Element
object
2 properties
Responsedatanonobject
The response data.
ButtonElementSize
string
Specify the size of the custom payment button.
LabelElement
object
3 properties
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
ButtonElement
object
2 properties 1 required
AllowOverride
boolean
Whether the configured service fee can be overridden at the transaction level.
AbsorbDifference
boolean
Whether the paypoint absorbs the difference between the configured service fee and the actual fee charged to the customer.
IdempotencyKey
string
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. Th…
InvoiceElement
object
4 properties
Responsecode
integer
Code for the response. Learn more in [API Response Codes](/developers/api-reference/api-responses).
AutoElement
object
7 properties
FileContent
object
Contains details about a file. Max upload size is 30 MB.
4 properties
HeaderElement
object
3 properties
Order
integer
Order of element or section in container.
PayabliCredentials
object
13 properties
Finishtype
object
2 properties
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
PayabliPages
object
11 properties
MethodElementSettingsApplePay
object
3 properties
MethodElement
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

payabli-hostedpaymentpages-api-openapi.yml Raw ↑

Other APIs Payabli publishes across the network.

Payabli Bill API
Payabli Boarding API
Payabli chargeBacks API
Payabli checkCapture API
Payabli Cloud API
Payabli Customer API
Payabli Export API
Payabli Funding API
Payabli ghostCard API
Payabli Import API
Payabli Invoice API
Payabli lineItem API
Where this information came from

This is an independent, third-party profile of Payabli hostedPaymentPages API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.