> 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

# List payment method domains

GET https://api-sandbox.payabli.com/api/PaymentMethodDomain/list

Get a list of payment method domains that belong to a PSP, organization, or paypoint.

Reference: https://docs.payabli.com/developers/api-reference/paymentmethoddomain/get-list-of-payment-method-domains

## Servers

- `https://api-sandbox.payabli.com/api` (Sandbox, default)
- `https://api.payabli.com/api` (Production)

## Request

### Query parameters

- `entityId` (long, optional) — Identifier for the organization or paypoint. - For organization, provide the organization ID - For paypoint, provide the paypoint ID
- `entityType` (string, optional) — The type of entity. Valid values: - organization - paypoint - psp
- `fromRecord` (integer, optional, default: 0) — Number of records to skip. Defaults to `0`.
- `limitRecord` (integer, optional, default: 20) — Max number of records for query response. Defaults to `20`.

## Response

### 200

Success

- `records` (list of object, required)
  - `type` (string, required, nullable) — The record type. For payment method domains, this is always `PaymentMethodDomain`.
  - `applePay` (object, required) — Details about the status of the Apple Pay service.
    - `data` (object, optional) — This object is only returned when the domain verification check fails. If a domain has failed validation, this object contains information about the failure.
      - `errorMessage` (string, optional) — Any error message related to Apple Pay's activation status.
      - `metadata` (object, optional) — This metadata appears only when the domain verification check fails. It gives more information about why the check failed.
        - `isFileAvailable` (boolean, optional) — 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` (boolean, optional) — Indicates whether the domain verification file content is valid. If the file is invalid, try downloading it and hosting it again.
        - `redirectDomainName` (string, optional) — The domain name if the domain verification URL returns a redirect.
        - `redirectUrl` (string, optional) — 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` (integer, optional) — The status code returned by the domain verification URL.
    - `isEnabled` (boolean, optional) — When `true`, the service is enabled.
  - `googlePay` (object, required) — Details about the status of the Google Pay service.
    - `data` (object, optional) — This object is only returned when the domain verification check fails. If a domain has failed validation, this object contains information about the failure.
      - `errorMessage` (string, optional) — Any error message related to Google Pay's activation status.
      - `metadata` (object, optional) — This metadata appears only when the domain verification check fails. It gives more information about why the check failed.
        - `statusCode` (integer, optional) — The status code returned by the domain verification URL.
        - `redirectUrl` (string, optional) — 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` (string, optional) — The domain name if the domain verification URL returns a redirect.
    - `isEnabled` (boolean, optional) — When `true`, the service is enabled.
  - `createdAt` (datetime, required) — Timestamp of when record was created, in UTC.
  - `domainName` (string, 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.
  - `entityId` (long, 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.
  - `entityType` (string, required) — The entity type. Available values: - `paypoint` - `organization` - `psp` (payment service provider)
  - `id` (string, required) — The payment method domain's ID in Payabli.
  - `ownerEntityId` (long, 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.
  - `ownerEntityType` (string, required) — The domain's owner's entity type. Available values: - `paypoint` - `organization` - `psp` (payment service provider)
  - `cascades` (list of object, optional) — Data about the domain's cascade status.
    - `createdAt` (datetime, optional) — Timestamp of when record was created, in UTC.
    - `jobErrorMessage` (string, optional) — Error message for a failed cascade process.
    - `jobId` (string, optional) — The cascade process ID.
    - `jobStatus` (enum, optional) — The cascade process status.
      - Allowed values: `in_progress`, `completed`, `failed`
    - `updatedAt` (datetime, optional) — Timestamp of when record was last updated, in UTC.
  - `updatedAt` (datetime, optional) — Timestamp of when record was last updated, in UTC.
- `summary` (object, required)
  - `pageIdentifier` (string, optional) — Auxiliary validation used internally by payment pages and components.
  - `pageSize` (integer, optional) — Number of records on each response page.
  - `totalPages` (integer, optional) — Total number of records in response.
  - `totalRecords` (integer, optional) — Total number of records in response.

## Examples

### PaypointDomains

**Response**

```json
{
  "records": [
    {
      "type": "PaymentMethodDomains",
      "applePay": {
        "isEnabled": true
      },
      "googlePay": {
        "isEnabled": true
      },
      "createdAt": "2025-02-13T18:31:07.023Z",
      "domainName": "payment.example.com",
      "entityId": 1147,
      "entityType": "paypoint",
      "id": "pmd_7b4b3ca0f6b74f02853dfcee5ec090a3",
      "ownerEntityId": 1147,
      "ownerEntityType": "paypoint",
      "updatedAt": "2025-03-18T13:48:39.056Z"
    },
    {
      "type": "PaymentMethodDomains",
      "applePay": {
        "isEnabled": true
      },
      "googlePay": {
        "isEnabled": true
      },
      "createdAt": "2025-02-13T18:04:50.207Z",
      "domainName": "checkout.example.com",
      "entityId": 1147,
      "entityType": "paypoint",
      "id": "pmd_1f799c8ab7dd432dbc2052ce332c101c",
      "ownerEntityId": 1147,
      "ownerEntityType": "paypoint",
      "updatedAt": "2025-02-13T18:04:50.207Z"
    },
    {
      "type": "PaymentMethodDomains",
      "applePay": {
        "isEnabled": true
      },
      "googlePay": {
        "isEnabled": false
      },
      "createdAt": "2026-09-06T03:55:32.213Z",
      "domainName": "pay.example.com",
      "entityId": 1147,
      "entityType": "paypoint",
      "id": "pmd_135ac1be6fab4a97850aadbbba77ce1b",
      "ownerEntityId": 1147,
      "ownerEntityType": "paypoint",
      "updatedAt": "2026-09-06T03:55:47.586Z"
    }
  ],
  "summary": {
    "pageIdentifier": "t.wlbQ4YZ3/JJkaP2/muAxibhlwdVz1Ve89QtI40H9KPhf...",
    "pageSize": 20,
    "totalPages": 1,
    "totalRecords": 17
  }
}
```

**SDK Code**

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

async function main() {
    const client = new PayabliClient();
    await client.paymentMethodDomain.listPaymentMethodDomains({
        entityId: 1147,
        entityType: "paypoint",
    });
}
main();

```

```python PaypointDomains
from payabli import payabli

client = payabli()

client.payment_method_domain.list_payment_method_domains(
    entity_id=1147,
    entity_type="paypoint",
)

```

```java PaypointDomains
package com.example.usage;

import io.github.payabli.api.PayabliApiClient;
import io.github.payabli.api.resources.paymentmethoddomain.requests.ListPaymentMethodDomainsRequest;

public class Example {
    public static void main(String[] args) {
        PayabliApiClient client = PayabliApiClient
            .builder()
            .build();

        client.paymentMethodDomain().listPaymentMethodDomains(
            ListPaymentMethodDomainsRequest
                .builder()
                .entityId(1147L)
                .entityType("paypoint")
                .build()
        );
    }
}
```

```ruby PaypointDomains
require "payabli"

client = Payabli::Client.new

client.payment_method_domain.list_payment_method_domains(
  entity_id: 1147,
  entity_type: "paypoint"
)

```

```csharp PaypointDomains
using PayabliApi;
using System.Threading.Tasks;

namespace Usage;

public class Example
{
    public async Task Do() {
        var client = new PayabliApiClient();

        await client.PaymentMethodDomain.ListPaymentMethodDomainsAsync(
            new ListPaymentMethodDomainsRequest {
                EntityId = 1147L,
                EntityType = "paypoint"
            }
        );
    }

}

```

```go PaypointDomains
package example

import (
    context "context"

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

func do() {
    client := client.NewClient()
    request := &payabli.ListPaymentMethodDomainsRequest{
        EntityId: payabli.Int64(
            int64(1147),
        ),
        EntityType: payabli.String(
            "paypoint",
        ),
    }
    client.PaymentMethodDomain.ListPaymentMethodDomains(
        context.TODO(),
        request,
    )
}

```

```php PaypointDomains
<?php

namespace Example;

use Payabli\PayabliClient;
use Payabli\PaymentMethodDomain\Requests\ListPaymentMethodDomainsRequest;

$client = new PayabliClient();
$client->paymentMethodDomain->listPaymentMethodDomains(
    new ListPaymentMethodDomainsRequest([
        'entityId' => 1147,
        'entityType' => 'paypoint',
    ]),
);

```

```swift PaypointDomains
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/PaymentMethodDomain/list?entityId=1147&entityType=paypoint")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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()
```

### OrgDomains

**Response**

```json
{
  "records": [
    {
      "type": "PaymentMethodDomains",
      "applePay": {
        "isEnabled": true
      },
      "googlePay": {
        "isEnabled": false
      },
      "createdAt": "2026-09-27T01:20:17.486Z",
      "domainName": "checkout.example.com",
      "entityId": 39,
      "entityType": "organization",
      "id": "pmd_1bed085c821e432fa71ae0817c571dd6",
      "ownerEntityId": 39,
      "ownerEntityType": "organization",
      "updatedAt": "2025-03-26T23:55:36.876Z"
    },
    {
      "type": "PaymentMethodDomains",
      "applePay": {
        "isEnabled": true
      },
      "googlePay": {
        "isEnabled": false
      },
      "createdAt": "2026-08-23T03:42:06.673Z",
      "domainName": "checkout.example.com",
      "entityId": 39,
      "entityType": "organization",
      "id": "pmd_dab1e3d2a3774216920bdc2afd62c307",
      "ownerEntityId": 39,
      "ownerEntityType": "organization",
      "updatedAt": "2025-03-26T23:56:15.708Z"
    }
  ],
  "summary": {
    "pageIdentifier": "pageIdentifier",
    "pageSize": 20,
    "totalPages": 1,
    "totalRecords": 2
  }
}
```

**SDK Code**

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

async function main() {
    const client = new PayabliClient();
    await client.paymentMethodDomain.listPaymentMethodDomains({
        entityId: 39,
        entityType: "organization",
    });
}
main();

```

```python OrgDomains
from payabli import payabli

client = payabli()

client.payment_method_domain.list_payment_method_domains(
    entity_id=39,
    entity_type="organization",
)

```

```java OrgDomains
package com.example.usage;

import io.github.payabli.api.PayabliApiClient;
import io.github.payabli.api.resources.paymentmethoddomain.requests.ListPaymentMethodDomainsRequest;

public class Example {
    public static void main(String[] args) {
        PayabliApiClient client = PayabliApiClient
            .builder()
            .build();

        client.paymentMethodDomain().listPaymentMethodDomains(
            ListPaymentMethodDomainsRequest
                .builder()
                .entityId(39L)
                .entityType("organization")
                .build()
        );
    }
}
```

```ruby OrgDomains
require "payabli"

client = Payabli::Client.new

client.payment_method_domain.list_payment_method_domains(
  entity_id: 39,
  entity_type: "organization"
)

```

```csharp OrgDomains
using PayabliApi;
using System.Threading.Tasks;

namespace Usage;

public class Example
{
    public async Task Do() {
        var client = new PayabliApiClient();

        await client.PaymentMethodDomain.ListPaymentMethodDomainsAsync(
            new ListPaymentMethodDomainsRequest {
                EntityId = 39L,
                EntityType = "organization"
            }
        );
    }

}

```

```go OrgDomains
package example

import (
    context "context"

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

func do() {
    client := client.NewClient()
    request := &payabli.ListPaymentMethodDomainsRequest{
        EntityId: payabli.Int64(
            int64(39),
        ),
        EntityType: payabli.String(
            "organization",
        ),
    }
    client.PaymentMethodDomain.ListPaymentMethodDomains(
        context.TODO(),
        request,
    )
}

```

```php OrgDomains
<?php

namespace Example;

use Payabli\PayabliClient;
use Payabli\PaymentMethodDomain\Requests\ListPaymentMethodDomainsRequest;

$client = new PayabliClient();
$client->paymentMethodDomain->listPaymentMethodDomains(
    new ListPaymentMethodDomainsRequest([
        'entityId' => 39,
        'entityType' => 'organization',
    ]),
);

```

```swift OrgDomains
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/PaymentMethodDomain/list?entityId=39&entityType=organization")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

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()
```