Retrieve Payment Method Domain

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const paymentMethodDomain = await client.paymentMethodDomains.retrieve('id');

console.log(paymentMethodDomain.id);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/payment_method_domains/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/payment_method_domains/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/payment_method_domains/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "created_at": "2026-01-01T12:00:00.000Z",
  "hostname": "checkout.shinetime.example",
  "id": "pmd_xxxxxxxxxxxxxx",
  "provider": "apple",
  "status": "verified",
  "updated_at": "2026-01-01T12:00:00.000Z"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

GET

payment_method_domains

{id}

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const paymentMethodDomain = await client.paymentMethodDomains.retrieve('id');

console.log(paymentMethodDomain.id);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/payment_method_domains/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/payment_method_domains/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/payment_method_domains/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "created_at": "2026-01-01T12:00:00.000Z",
  "hostname": "checkout.shinetime.example",
  "id": "pmd_xxxxxxxxxxxxxx",
  "provider": "apple",
  "status": "verified",
  "updated_at": "2026-01-01T12:00:00.000Z"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-08-21"

Path Parameters

string

required

The unique identifier of the payment method domain, prefixed pmd_.

Response

payment method domain retrieved

account_id

string | null

required

ID of the account the domain is registered for, prefixed biz_.

Example:

"biz_xxxxxxxxxxxxxx"

created_at

string

required

When the domain was created, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

hostname

string

required

Hostname the checkout is served from (e.g. checkout.example.com).

Example:

"checkout.shinetime.example"

string

required

Payment method domain ID, prefixed pmd_.

Example:

"pmd_xxxxxxxxxxxxxx"

provider

enum<string>

required

Wallet provider the domain is registered with.

Available options:

apple

Example:

"apple"

status

enum<string>

required

Verification status. pending means the provider could not fetch the domain-association file yet; only verified domains show wallet payment methods at checkout.

Available options:

pending,

verified

Example:

"verified"

updated_at

string

required

When the domain was last updated, as an ISO 8601 timestamp.

Example:

"2026-01-01T12:00:00.000Z"

⌘I

Introduction

Reference

Webhooks & events

Core Resources

Notifications

Money

Commerce

Partners

Workforce

Tracking

Ads

Media

Identity

Developer

Retrieve Payment Method Domain

Authorizations

Headers

Path Parameters

Response