Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Payment Method Domains 

A payment method domain represents a web domain that you have registered with Stripe. Stripe Elements use registered payment method domains to control where certain payment methods are shown.

Related guide: Payment method domains.

Endpoints

The PaymentMethodDomain object 

Attributes

  • idstring

    Unique identifier for the object.

  • domain_namestring

    The domain name that this payment method domain object represents.

  • enabledboolean

    Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements.

More attributes

  • objectstring

  • amazon_paymap

  • apple_paymap

  • createdtimestamp

  • google_paymap

  • klarnamap

  • linkmap

  • livemodeboolean

  • paypalmap

The PaymentMethodDomain object
{
  "id": "pmd_1Nnrer2eZvKYlo2Cips79tWl",
  "object": "payment_method_domain",
  "apple_pay": {
    "status": "active"
  },
  "created": 1694129445,
  "domain_name": "example.com",
  "enabled": true,
  "google_pay": {
    "status": "active"
  },
  "link": {
    "status": "active"
  },
  "livemode": false,
  "paypal": {
    "status": "active"
  }
}

Create a payment method domain 

Creates a payment method domain.

Parameters

  • domain_namestringRequired

    The domain name that this payment method domain object represents.

  • enabledboolean

    Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.

Returns

Returns a payment method domain object.

POST /v1/payment_method_domains
stripe.Key = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2"
params := &stripe.PaymentMethodDomainParams{DomainName: stripe.String("example.com")}
result, err := paymentmethoddomain.New(params)
Response
{
  "id": "pmd_1Nnrer2eZvKYlo2Cips79tWl",
  "object": "payment_method_domain",
  "apple_pay": {
    "status": "active"
  },
  "created": 1694129445,
  "domain_name": "example.com",
  "enabled": true,
  "google_pay": {
    "status": "active"
  },
  "link": {
    "status": "active"
  },
  "livemode": false,
  "paypal": {
    "status": "active"
  }
}

Update a payment method domain 

Updates an existing payment method domain.

Parameters

  • enabledboolean

    Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout.

Returns

Returns the updated payment method domain object.

POST /v1/payment_method_domains/:id
stripe.Key = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2"
params := &stripe.PaymentMethodDomainParams{Enabled: stripe.Bool(false)}
result, err := paymentmethoddomain.Update("pmd_1Nnrer2eZvKYlo2Cips79tWl", params)
Response
{
  "id": "pmd_1Nnrer2eZvKYlo2Cips79tWl",
  "object": "payment_method_domain",
  "apple_pay": {
    "status": "active"
  },
  "created": 1694129445,
  "domain_name": "example.com",
  "enabled": false,
  "google_pay": {
    "status": "active"
  },
  "link": {
    "status": "active"
  },
  "livemode": false,
  "paypal": {
    "status": "active"
  }
}

Retrieve a payment method domain 

Retrieves the details of an existing payment method domain.

Parameters

No parameters.

Returns

Returns a payment method domain object.

GET /v1/payment_method_domains/:id
stripe.Key = "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2"
params := &stripe.PaymentMethodDomainParams{}
result, err := paymentmethoddomain.Get("pmd_1Nnrer2eZvKYlo2Cips79tWl", params)
Response
{
  "id": "pmd_1Nnrer2eZvKYlo2Cips79tWl",
  "object": "payment_method_domain",
  "apple_pay": {
    "status": "active"
  },
  "created": 1694129445,
  "domain_name": "example.com",
  "enabled": true,
  "google_pay": {
    "status": "active"
  },
  "link": {
    "status": "active"
  },
  "livemode": false,
  "paypal": {
    "status": "active"
  }
}