Retrieve a payment method domain
GET / v1 / payment_method_domains /:id
Retrieves the details of an existing payment method domain.
Parameters
No parameters.
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" }}
List payment method domains
GET / v1 / payment_method_domains
Lists the details of existing payment method domains.
Parameters
- 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 will not appear in Elements or Embedded Checkout
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
Returns a list of payment method domain objects.
Response
{ "object": "list", "url": "/v1/payment_method_domains", "has_more": false, "data": [ { "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" } } ]}
Validate an existing payment method domain
POST / v1 / payment_method_domains /:id / validate
Some payment methods might require additional steps to register a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain. The payment method doesn’t appear in Elements or Embedded Checkout for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required registration steps specific to the payment method, and then validate the payment method domain with this endpoint.
Related guides: Payment method domains.
Parameters
No parameters.
Returns
Returns the updated 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" }}