List Payment Method Domains

Authorizations

requestToken

string

header

required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Query Parameters

entityId

integer

Identifier for the organization or paypoint.

Set this to organization and use the org ID in entityID to get details for the organization.
Set this paypoint and use the paypoint's entryname in `entityId`` to get details for the paypoint.

entityType

string

The type of entity. Valid values:

organization
paypoint Set this to organization and use the org ID in entityID to get details for the organization. Set this paypoint and use the paypoint's entryname in `entityId`` to get details for the paypoint.

limitRecord

integer

default:

Max number of records for query response. Defaults to 20.

fromRecord

integer

default:

Number of records to skip. Defaults to 0.

Response

200 - application/json

records

object[]

records.applePay

object

Details about the status of the Apple Pay service.

records.cascades

object[]

Data about the domain's cascade status.

records.createdAt

string

Timestamp of when record was created, in UTC.

records.domainName

string

The domain. For example: subdomain.domain.com or domain.com

records.entityId

integer

The entity's ID in Payabli.

records.entityType

string

The entity type. Available values:

paypoint
organization
psp (payment service provider).

records.id

string

The payment method domain's ID in Payabli.

records.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 inherited.`

records.ownerEntityType

string

The domain's owner's entity type. Available values:

paypoint
organization
psp (payment service provider).

records.updatedAt

string | null

Timestamp of when record was last updated, in UTC.

summary

object

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

List Payment Method Domains

Authorizations

Query Parameters

Response