# 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

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: List payment method domains for an entity
  version: endpoint_paymentMethodDomain.ListPaymentMethodDomains
paths:
  /PaymentMethodDomain/list:
    get:
      operationId: list-payment-method-domains
      summary: List payment method domains for an entity
      description: >-
        Get a list of payment method domains that belong to a PSP, organization,
        or paypoint.
      tags:
        - - subpackage_paymentMethodDomain
      parameters:
        - name: entityId
          in: query
          description: >-
            Identifier for the organization or paypoint. 

            - For organization, provide the organization ID - For paypoint,
            provide the paypoint ID
          required: false
          schema:
            type: integer
            format: int64
        - name: entityType
          in: query
          description: |-
            The type of entity. Valid values: 
              - organization
              - paypoint
              - psp
          required: false
          schema:
            type: string
        - name: fromRecord
          in: query
          description: Number of records to skip. Defaults to `0`.
          required: false
          schema:
            type: integer
            default: 0
        - name: limitRecord
          in: query
          description: Max number of records for query response. Defaults to `20`.
          required: false
          schema:
            type: integer
            default: 20
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/type_paymentMethodDomain:ListPaymentMethodDomainsResponse
        '400':
          description: Bad request/ invalid data
          content: {}
        '401':
          description: Unauthorized request.
          content: {}
        '500':
          description: Internal API Error
          content: {}
        '503':
          description: Database connection error
          content: {}
components:
  schemas:
    type_: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 return by the domain verification URL.
    type_:ApplePayStatusData:
      type: object
      properties:
        errorMessage:
          type: string
          description: Any error message related to Apple Pay's activation status.
        metadata:
          $ref: '#/components/schemas/type_:ApplePayMetadata'
    type_:IsEnabled:
      type: boolean
    type_:ApplePayData:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_: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/type_:IsEnabled'
          description: When `true`, Apple Pay is enabled.
    type_:GooglePayMetadata:
      type: object
      properties:
        statusCode:
          type: integer
          description: The status code return 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.
    type_:GooglePayStatusData:
      type: object
      properties:
        errorMessage:
          type: string
          description: Any error message related to Google Pay's activation status.
        metadata:
          $ref: '#/components/schemas/type_:GooglePayMetadata'
    type_:GooglePayData:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/type_: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/type_:IsEnabled'
          description: When `true`, Google Pay is enabled.
    type_:CreatedAt:
      type: string
      format: date-time
    type_:JobId:
      type: string
    type_:JobStatus:
      type: string
    type_:LastModified:
      type: string
      format: date-time
    type_:CascadeJobDetails:
      type: object
      properties:
        createdAt:
          $ref: '#/components/schemas/type_:CreatedAt'
        jobErrorMessage:
          type: string
          description: Error message for a failed cascade process.
        jobId:
          $ref: '#/components/schemas/type_:JobId'
        jobStatus:
          $ref: '#/components/schemas/type_:JobStatus'
        updatedAt:
          $ref: '#/components/schemas/type_:LastModified'
    type_:DomainName:
      type: string
    type_:EntityId:
      type: integer
      format: int64
    type_:EntityType:
      type: string
    type_:PaymentMethodDomainId:
      type: string
    type_:OwnerEntityId:
      type: integer
      format: int64
    type_:OwnerEntityType:
      type: string
    type_:PaymentMethodDomainApiResponse:
      type: object
      properties:
        type:
          type:
            - string
            - 'null'
          description: >-
            The record type. For payment method domains, this is always
            `PaymentMethodDomain`.
        applePay:
          $ref: '#/components/schemas/type_:ApplePayData'
        googlePay:
          $ref: '#/components/schemas/type_:GooglePayData'
        cascades:
          type: array
          items:
            $ref: '#/components/schemas/type_:CascadeJobDetails'
          description: Data about the domain's cascade status.
        createdAt:
          $ref: '#/components/schemas/type_:CreatedAt'
        domainName:
          $ref: '#/components/schemas/type_:DomainName'
        entityId:
          $ref: '#/components/schemas/type_:EntityId'
        entityType:
          $ref: '#/components/schemas/type_:EntityType'
        id:
          $ref: '#/components/schemas/type_:PaymentMethodDomainId'
        ownerEntityId:
          $ref: '#/components/schemas/type_:OwnerEntityId'
        ownerEntityType:
          $ref: '#/components/schemas/type_:OwnerEntityType'
        updatedAt:
          $ref: '#/components/schemas/type_:LastModified'
      required:
        - type
        - applePay
        - googlePay
        - createdAt
        - domainName
        - entityId
        - entityType
        - id
        - ownerEntityId
        - ownerEntityType
        - updatedAt
    type_:PageIdentifier:
      type: string
    type_:Pagesize:
      type: integer
    type_:Totalrecords:
      type: integer
    type_:QuerySummaryNoAmt:
      type: object
      properties:
        pageIdentifier:
          $ref: '#/components/schemas/type_:PageIdentifier'
        pageSize:
          $ref: '#/components/schemas/type_:Pagesize'
        totalPages:
          $ref: '#/components/schemas/type_:Totalrecords'
        totalRecords:
          $ref: '#/components/schemas/type_:Totalrecords'
    type_paymentMethodDomain:ListPaymentMethodDomainsResponse:
      type: object
      properties:
        records:
          type: array
          items:
            $ref: '#/components/schemas/type_:PaymentMethodDomainApiResponse'
        summary:
          $ref: '#/components/schemas/type_:QuerySummaryNoAmt'
      required:
        - records
        - summary

```

## SDK Code Examples

```python PaypointDomains
from payabli import payabli

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

```

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

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

```

```go PaypointDomains
import (
	context "context"
	option "github.com/payabli/sdk-go/option"
	sdkgo "github.com/payabli/sdk-go"
	sdkgoclient "github.com/payabli/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.PaymentMethodDomain.ListPaymentMethodDomains(
	context.TODO(),
	&sdkgo.ListPaymentMethodDomainsRequest{
		EntityId: sdkgo.Int64(
			1147,
		),
		EntityType: sdkgo.String(
			"paypoint",
		),
	},
)

```

```csharp PaypointDomains
using PayabliApi;

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

```

```ruby PaypointDomains
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/PaymentMethodDomain/list?entityId=1147&entityType=paypoint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java PaypointDomains
HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/PaymentMethodDomain/list?entityId=1147&entityType=paypoint")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php PaypointDomains
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/PaymentMethodDomain/list?entityId=1147&entityType=paypoint', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```swift PaypointDomains
import Foundation

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

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

```python OrgDomains
from payabli import payabli

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

```

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

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

```

```go OrgDomains
import (
	context "context"
	option "github.com/payabli/sdk-go/option"
	sdkgo "github.com/payabli/sdk-go"
	sdkgoclient "github.com/payabli/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.PaymentMethodDomain.ListPaymentMethodDomains(
	context.TODO(),
	&sdkgo.ListPaymentMethodDomainsRequest{
		EntityId: sdkgo.Int64(
			1147,
		),
		EntityType: sdkgo.String(
			"paypoint",
		),
	},
)

```

```csharp OrgDomains
using PayabliApi;

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

```

```ruby OrgDomains
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/PaymentMethodDomain/list?entityId=39&entityType=organization")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java OrgDomains
HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/PaymentMethodDomain/list?entityId=39&entityType=organization")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php OrgDomains
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/PaymentMethodDomain/list?entityId=39&entityType=organization', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```swift OrgDomains
import Foundation

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

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