Add Payment Method Domain

Authorizations

requestToken

string

header

required

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

Body

application/json

applePay

object

Apple Pay configuration information.

domainName

string

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

entityId

integer

The entity's ID in Payabli.

entityType

string

The entity type. Available values:

paypoint
organization
psp (payment service provider).

Response

200 - application/json

Response for the add payment method domain operation.

isSuccess

boolean

pageidentifier

string

responseData

object

Data related to the payment method domain.

responseData.applePay

object

Details about the status of the Apple Pay service.

responseData.cascades

object[]

Data about the domain's cascade status.

responseData.createdAt

string

Timestamp of when record was created, in UTC.

responseData.domainName

string

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

responseData.entityId

integer

The entity's ID in Payabli.

responseData.entityType

string

The entity type. Available values:

paypoint
organization
psp (payment service provider).

responseData.id

string

The payment method domain's ID in Payabli.

responseData.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.`

responseData.ownerEntityType

string

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

paypoint
organization
psp (payment service provider).

responseData.updatedAt

string | null

Timestamp of when record was last updated, in UTC.

responseText

string

API Basics

Pay In Endpoints

Pay Out Endpoints

Pay Ops Endpoints

Object Models

Add Payment Method Domain

Authorizations

Body

Response