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 paymentMethodDomain API

The paymentMethodDomain API from Payabli — 5 operation(s) for paymentmethoddomain.

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

The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 5 paths, and defines 37 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.

7 operations 5 paths 37 schemas 1 DELETE2 GET1 PATCH3 POST

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 paymentMethodDomain 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 7

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

paymentMethodDomain 7
POST
/PaymentMethodDomain
Add a payment method domain
AddPaymentMethodDomain 1 param body → 200400401500503
POST
/PaymentMethodDomain/{domainId}/cascade
Cascade a payment method domain to the child entities
CascadePaymentMethodDomain 2 params → 200400401500503
POST
/PaymentMethodDomain/{domainId}/verify
Verify a payment method domain
VerifyPaymentMethodDomain 2 params → 200
GET
/PaymentMethodDomain/{domainId}
Get payment method domain details
GetPaymentMethodDomain 2 params → 200400401500503
PATCH
/PaymentMethodDomain/{domainId}
Update payment method domain configuration
UpdatePaymentMethodDomain 2 params body → 200400401500503
DELETE
/PaymentMethodDomain/{domainId}
Delete a payment method domain
DeletePaymentMethodDomain 2 params → 200400401500503
GET
/PaymentMethodDomain/list
List payment method domains for an entity
ListPaymentMethodDomains 5 params → 200400401500503

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are PaymentMethodDomainApiResponse (12 properties), AddPaymentMethodDomainRequest (5 properties), CascadeJobDetails (5 properties), ApplePayMetadata (5 properties). Each schema is shown below with its type and property counts.

DeletePaymentMethodDomainResponse
object
4 properties 4 required
AddPaymentMethodDomainRequestGooglePay
object
Google Pay configuration information.
1 property
EntityId
integer
The entity's ID in Payabli. If the entity is a paypoint, this is the paypoint ID. If the entity is an organization, this is the organization ID.
UpdatePaymentMethodDomainRequest
object
2 properties
GooglePayMetadata
object
This metadata appears only when the domain verification check fails. It gives more information about why the check failed.
3 properties
AddPaymentMethodDomainApiResponse
object
Response for the add payment method domain operation.
4 properties 4 required
ListPaymentMethodDomainsResponse
object
2 properties 2 required
JobStatus
string
The cascade process status.
AddPaymentMethodDomainRequest
object
5 properties
ApplePayMetadata
object
This metadata appears only when the domain verification check fails. It gives more information about why the check failed.
5 properties
EntityType
string
The entity type. Available values: - paypoint - organization - psp (payment service provider)
IsEnabled
boolean
When true, the service is enabled.
JobId
string
The cascade process ID.
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
ResponseText
string
Response text for operation: 'Success' or 'Declined'.
PaymentMethodDomainApiResponse
object
Data related to the payment method domain.
12 properties 10 required
ApplePayData
object
Details about the status of the Apple Pay service.
2 properties
AddPaymentMethodDomainRequestApplePay
object
Apple Pay configuration information.
1 property
QuerySummaryNoAmt
object
4 properties
UpdatePaymentMethodDomainRequestWallet
object
1 property
OwnerEntityType
string
The domain's owner's entity type. Available values: - paypoint - organization - psp (payment service provider)
GooglePayStatusData
object
Details about the Google Pay service status.
2 properties
ApplePayStatusData
object
Details about the Apple Pay service status.
2 properties
Totalrecords
integer
Total number of records in response.
Responsedatanonobject
The response data.
LastModified
string
Timestamp of when record was last updated, in UTC.
OwnerEntityId
integer
The domain's owning entity's ID in Payabli. This value might be different than the entityId, depending on whether the domain is cascaded and whether it's inher…
IsSuccess
boolean
Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.
PageIdentifier
string
Auxiliary validation used internally by payment pages and components.
Pagesize
integer
Number of records on each response page.
DomainName
string
The domain. For example: subdomain.domain.com or domain.com. Must be public. Can't be localhost, hidden by a VPN, or protected by a password.
GooglePayData
object
Details about the status of the Google Pay service.
2 properties
CreatedAt
string
Timestamp of when record was created, in UTC.
CascadeJobDetails
object
Details about the cascade process.
5 properties
PaymentMethodDomainGeneralResponse
object
4 properties 1 required
PaymentMethodDomainId
string
The payment method domain's ID in Payabli.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

payabli-paymentmethoddomain-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 hostedPaymentPages API
Payabli Import API
Payabli Invoice API
Where this information came from

This is an independent, third-party profile of Payabli paymentMethodDomain 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.