> This is Payabli documentation. For a complete page index, fetch https://docs.payabli.com/llms.txt — append .md to any page URL for lightweight markdown. For section-level indexes, query parameters, and other AI-optimized access methods, see https://docs.payabli.com/ai-agents.md

# Get payment method domain

GET https://api-sandbox.payabli.com/api/PaymentMethodDomain/{domainId}

Get the details for a payment method domain.

Reference: https://docs.payabli.com/developers/api-reference/paymentmethoddomain/paymentmethoddomain-get

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: payabliApi-oas
  version: 1.0.0
paths:
  /PaymentMethodDomain/{domainId}:
    get:
      operationId: get-payment-method-domain
      summary: Get payment method domain details
      description: Get the details for a payment method domain.
      tags:
        - subpackage_paymentMethodDomain
      parameters:
        - name: domainId
          in: path
          description: The payment method domain's ID in Payabli.
          required: true
          schema:
            type: string
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success response that includes a payment method domain's details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentMethodDomainApiResponse'
        '400':
          description: Bad request / invalid data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliErrorBody'
        '401':
          description: Unauthorized request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliErrorBody'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliErrorBody'
        '503':
          description: Database connection error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayabliErrorBody'
servers:
  - url: https://api-sandbox.payabli.com/api
    description: Sandbox
  - url: https://api.payabli.com/api
    description: Production
components:
  schemas:
    ApplePayMetadata:
      type: object
      properties:
        isFileAvailable:
          type: boolean
          description: |
            When `true`, indicates whether the domain verification file is
            available at the expected path. When `false`, Payabli was unable to
            find the file at the expected path. If the file is missing, make
            sure it's hosted at the correct path:
            `/.well-known/apple-developer-merchantid-domain-association`.
        isFileContentValid:
          type: boolean
          description: |
            Indicates whether the domain verification file content is valid. If
            the file is invalid, try downloading it and hosting it again.
        redirectDomainName:
          type: string
          description: The domain name if the domain verification URL returns a redirect.
        redirectUrl:
          type: string
          description: |
            If the domain verification URL is redirected, this is the URL it's
            redirected to. For example, `www.partner.com` could redirect to
            `www.partners-new-home-page.com`. In this case, you should add
            `www.partners-new-home-page.com` as a domain instead of
            `www.partner.com`.
        statusCode:
          type: integer
          description: The status code returned by the domain verification URL.
      description: |
        This metadata appears only when the domain verification check fails. It
        gives more information about why the check failed.
      title: ApplePayMetadata
    ApplePayStatusData:
      type: object
      properties:
        errorMessage:
          type: string
          description: Any error message related to Apple Pay's activation status.
        metadata:
          $ref: '#/components/schemas/ApplePayMetadata'
      description: Details about the Apple Pay service status.
      title: ApplePayStatusData
    IsEnabled:
      type: boolean
      description: When `true`, the service is enabled.
      title: IsEnabled
    ApplePayData:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ApplePayStatusData'
          description: |
            This object is only returned when the domain verification check
            fails. If a domain has failed validation, this object contains
            information about the failure.
        isEnabled:
          $ref: '#/components/schemas/IsEnabled'
      description: Details about the status of the Apple Pay service.
      title: ApplePayData
    GooglePayMetadata:
      type: object
      properties:
        statusCode:
          type: integer
          description: The status code returned by the domain verification URL.
        redirectUrl:
          type: string
          description: |
            If the domain verification URL is redirected, this is the URL it's
            redirected to. For example, `www.partner.com` could redirect to
            `www.partners-new-home-page.com`. In this case, you should add
            `www.partners-new-home-page.com` as a domain instead of
            `www.partner.com`.
        redirectDomainName:
          type: string
          description: The domain name if the domain verification URL returns a redirect.
      description: |
        This metadata appears only when the domain verification check fails. It
        gives more information about why the check failed.
      title: GooglePayMetadata
    GooglePayStatusData:
      type: object
      properties:
        errorMessage:
          type: string
          description: Any error message related to Google Pay's activation status.
        metadata:
          $ref: '#/components/schemas/GooglePayMetadata'
      description: Details about the Google Pay service status.
      title: GooglePayStatusData
    GooglePayData:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/GooglePayStatusData'
          description: |
            This object is only returned when the domain verification check
            fails. If a domain has failed validation, this object contains
            information about the failure.
        isEnabled:
          $ref: '#/components/schemas/IsEnabled'
      description: Details about the status of the Google Pay service.
      title: GooglePayData
    CreatedAt:
      type: string
      format: date-time
      description: Timestamp of when record was created, in UTC.
      title: CreatedAt
    JobId:
      type: string
      description: The cascade process ID.
      title: JobId
    JobStatus:
      type: string
      enum:
        - in_progress
        - completed
        - failed
      description: The cascade process status.
      title: JobStatus
    LastModified:
      type: string
      format: date-time
      description: Timestamp of when record was last updated, in UTC.
      title: LastModified
    CascadeJobDetails:
      type: object
      properties:
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        jobErrorMessage:
          type: string
          description: Error message for a failed cascade process.
        jobId:
          $ref: '#/components/schemas/JobId'
        jobStatus:
          $ref: '#/components/schemas/JobStatus'
        updatedAt:
          $ref: '#/components/schemas/LastModified'
      description: Details about the cascade process.
      title: CascadeJobDetails
    DomainName:
      type: string
      description: >
        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.
      title: DomainName
    EntityId:
      type: integer
      format: int64
      description: |
        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.
      title: EntityId
    EntityType:
      type: string
      description: |
        The entity type. Available values:

        - `paypoint`
        - `organization`
        - `psp` (payment service provider)
      title: EntityType
    PaymentMethodDomainId:
      type: string
      description: The payment method domain's ID in Payabli.
      title: PaymentMethodDomainId
    OwnerEntityId:
      type: integer
      format: int64
      description: >
        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.
      title: OwnerEntityId
    OwnerEntityType:
      type: string
      description: |
        The domain's owner's entity type. Available values:

        - `paypoint`
        - `organization`
        - `psp` (payment service provider)
      title: OwnerEntityType
    PaymentMethodDomainApiResponse:
      type: object
      properties:
        type:
          type:
            - string
            - 'null'
          description: >-
            The record type. For payment method domains, this is always
            `PaymentMethodDomain`.
        applePay:
          $ref: '#/components/schemas/ApplePayData'
        googlePay:
          $ref: '#/components/schemas/GooglePayData'
        cascades:
          type: array
          items:
            $ref: '#/components/schemas/CascadeJobDetails'
          description: Data about the domain's cascade status.
        createdAt:
          $ref: '#/components/schemas/CreatedAt'
        domainName:
          $ref: '#/components/schemas/DomainName'
        entityId:
          $ref: '#/components/schemas/EntityId'
        entityType:
          $ref: '#/components/schemas/EntityType'
        id:
          $ref: '#/components/schemas/PaymentMethodDomainId'
        ownerEntityId:
          $ref: '#/components/schemas/OwnerEntityId'
        ownerEntityType:
          $ref: '#/components/schemas/OwnerEntityType'
        updatedAt:
          $ref: '#/components/schemas/LastModified'
      required:
        - type
        - applePay
        - googlePay
        - createdAt
        - domainName
        - entityId
        - entityType
        - id
        - ownerEntityId
        - ownerEntityType
      description: Data related to the payment method domain.
      title: PaymentMethodDomainApiResponse
    PayabliErrorBodyResponseData:
      type: object
      properties:
        explanation:
          type: string
          description: Human-readable explanation of what happened.
        todoAction:
          type: string
          description: Suggested resolution.
      description: Object with detailed error context.
      title: PayabliErrorBodyResponseData
    PayabliErrorBody:
      type: object
      properties:
        isSuccess:
          type: boolean
          description: Always `false` for error responses.
        responseCode:
          type: integer
          description: |
            Code for the response. Learn more in
            [API Response Codes](/developers/api-reference/api-responses).
        responseText:
          type: string
          description: Error text describing what went wrong.
        responseData:
          $ref: '#/components/schemas/PayabliErrorBodyResponseData'
          description: Object with detailed error context.
      required:
        - isSuccess
        - responseText
      description: |
        Shape returned by every Payabli API error response. The `responseData`
        object carries human-readable error context.
      title: PayabliErrorBody
  securitySchemes:
    APIKeyAuth:
      type: apiKey
      in: header
      name: requestToken

```

## Examples



**Response**

```json
{
  "type": "PaymentMethodDomains",
  "applePay": {
    "data": null,
    "isEnabled": true
  },
  "googlePay": {
    "data": null,
    "isEnabled": true
  },
  "createdAt": "2025-03-15T10:24:36.207Z",
  "domainName": "checkout.example.com",
  "entityId": 78,
  "entityType": "organization",
  "id": "pmd_b8237fa45c964d8a9ef27160cd42b8c5",
  "ownerEntityId": 78,
  "ownerEntityType": "organization",
  "cascades": [
    {
      "createdAt": "2025-04-25T15:37:28.685Z",
      "jobId": "1245697",
      "jobStatus": "completed",
      "updatedAt": "2025-04-25T15:37:33.228Z"
    }
  ],
  "updatedAt": "2025-04-25T15:38:46.804Z"
}
```

**SDK Code**

```typescript
import { PayabliClient } from "@payabli/sdk-node";

async function main() {
    const client = new PayabliClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.paymentMethodDomain.getPaymentMethodDomain("pmd_b8237fa45c964d8a9ef27160cd42b8c5");
}
main();

```

```python
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY_HERE",
)

client.payment_method_domain.get_payment_method_domain(
    domain_id="pmd_b8237fa45c964d8a9ef27160cd42b8c5",
)

```

```java
package com.example.usage;

import io.github.payabli.api.PayabliPayabliApiOasClient;

public class Example {
    public static void main(String[] args) {
        PayabliPayabliApiOasClient client = PayabliPayabliApiOasClient
            .builder()
            .apiKey("YOUR_API_KEY_HERE")
            .build();

        client.paymentMethodDomain().getPaymentMethodDomain("pmd_b8237fa45c964d8a9ef27160cd42b8c5");
    }
}
```

```ruby
require "payabli"

client = Payabli::Client.new(api_key: "YOUR_API_KEY_HERE")

client.payment_method_domain.get_payment_method_domain(domain_id: "pmd_b8237fa45c964d8a9ef27160cd42b8c5")

```

```csharp
using PayabliPayabliApiOas;
using System.Threading.Tasks;

namespace Usage;

public class Example
{
    public async Task Do() {
        var client = new PayabliPayabliApiOasClient(
            apiKey: "YOUR_API_KEY_HERE"
        );

        await client.PaymentMethodDomain.GetPaymentMethodDomainAsync(
            "pmd_b8237fa45c964d8a9ef27160cd42b8c5"
        );
    }

}

```

```go
package example

import (
    context "context"

    client "github.com/payabli/sdk-go/client"
    option "github.com/payabli/sdk-go/option"
)

func do() {
    client := client.NewClient(
        option.WithApiKey(
            "YOUR_API_KEY_HERE",
        ),
    )
    client.PaymentMethodDomain.GetPaymentMethodDomain(
        context.TODO(),
        "pmd_b8237fa45c964d8a9ef27160cd42b8c5",
    )
}

```

```php
<?php

namespace Example;

use Payabli\PayabliClient;

$client = new PayabliClient(
    apiKey: 'YOUR_API_KEY_HERE',
);
$client->paymentMethodDomain->getPaymentMethodDomain(
    'pmd_b8237fa45c964d8a9ef27160cd42b8c5',
);

```

```swift
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/PaymentMethodDomain/pmd_b8237fa45c964d8a9ef27160cd42b8c5")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```