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.

Was this section helpful? Yes No

Create a payment method domain

POST / v1 / payment_method_domains

Update a payment method domain

POST / v1 / payment_method_domains /:id

Retrieve a payment method domain

GET / v1 / payment_method_domains /:id

List payment method domains

GET / v1 / payment_method_domains

Validate an existing payment method domain

POST / v1 / payment_method_domains /:id / validate

The PaymentMethodDomain object

Attributes

id string Unique identifier for the object.
domain _ name string The domain name that this payment method domain object represents.
enabled boolean 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

object string, value is "payment_method_domain"
amazon _ pay object
apple _ pay object
created timestamp
google _ pay object
klarna object
link object
livemode boolean
paypal object

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

POST / v1 / payment_method_domains

Creates a payment method domain.

Parameters

domain _ name string Required The domain name that this payment method domain object represents.
enabled boolean 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.

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" }}