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.
Returns
Returns a payment method domain 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" }}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.
Returns
Returns the updated payment method domain object.
{ "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.
{ "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
Lists the details of existing payment method domains.
Parameters
- 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 will not appear in Elements
More parameters
- ending_
beforestring - limitinteger
- starting_
afterstring
Returns
Returns a list of payment method domain objects.
{ "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
Some payment methods such as Apple Pay require additional steps to verify 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 for this domain until it is active.
To activate a payment method on an existing payment method domain, complete the required validation 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.
{ "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" }}