paymentMethodDomain

Get payment method domain details

Get the details for a payment method domain.

get/PaymentMethodDomain/{domainId}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/PaymentMethodDomain/{domainId}
  • Auth: HTTP bearer

Path parameters

domainIdstring required

The payment method domain's ID in Payabli.

Response

Success response that includes a payment method domain's details.

typestring nullable required

The record type. For payment method domains, this is always PaymentMethodDomain.

createdAtstring date-time required

Timestamp of when record was created, in UTC.

domainNamestring required

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.

entityIdinteger required

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.

entityTypestring required

The entity type. Available values:

  • paypoint
  • organization
  • psp (payment service provider)
idstring required

The payment method domain's ID in Payabli.

ownerEntityIdinteger required

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.

ownerEntityTypestring required

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

  • paypoint
  • organization
  • psp (payment service provider)
updatedAtstring date-time

Timestamp of when record was last updated, in UTC.

Changes

No recorded changes to this operation across all 1 revision of this API.