GET
/
PaymentMethodDomain
/
{domainId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/PaymentMethodDomain/{domainId} \
  --header 'requestToken: <api-key>'
{
  "entityId": 109,
  "entityType": "paypoint",
  "domainName": "subdomain.domain.com",
  "applePay": {
    "isEnabled": true,
    "data": {
      "errorMessage": "null",
      "metadata": {
        "isFileAvailable": true,
        "isFileContentValid": true,
        "statusCode": 123,
        "redirectUrl": "<string>",
        "redirectDomainName": "<string>"
      }
    }
  },
  "ownerEntityId": 109,
  "ownerEntityType": "organization",
  "cascades": [
    {
      "jobId": "445865",
      "jobStatus": "completed",
      "jobErrorMessage": "<string>",
      "createdAt": "2022-07-01 15:00:01",
      "updatedAt": "2022-07-01 15:00:01"
    }
  ],
  "createdAt": "2022-07-01 15:00:01",
  "updatedAt": "2022-07-01 15:00:01",
  "id": "pmd_12AB"
}

Authorizations

​
requestToken
string
header
required

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

Path Parameters

​
domainId
string
required

The payment method domain's ID in Payabli.

Example:

"pmd_12AB"

Response

200
application/json
Success response that includes a payment method domain's details.

Data related to the payment method domain.

​
entityId
integer

The entity's ID in Payabli.

Example:

109

​
entityType
string

The entity type. Available values:

  • paypoint
  • organization
  • psp (payment service provider).
Example:

"paypoint"

​
domainName
string

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

Example:

"subdomain.domain.com"

​
applePay
object

Details about the status of the Apple Pay service.

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

Example:

109

​
ownerEntityType
string

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

  • paypoint
  • organization
  • psp (payment service provider).
Example:

"organization"

​
cascades
object[]

Data about the domain's cascade status.

Details about the cascade process.

​
createdAt
string

Timestamp of when record was created, in UTC.

Example:

"2022-07-01 15:00:01"

​
updatedAt
string | null

Timestamp of when record was last updated, in UTC.

Example:

"2022-07-01 15:00:01"

​
id
string

The payment method domain's ID in Payabli.

Example:

"pmd_12AB"

Was this page helpful?