Test mode. Use your secret key on your server; live processing is currently disabled.
Operations and schemas are based on the pinned Stripe OpenAPI specification (MIT). Nested object definitions and enums are available in the complete specification.
GET /v1/payment_method_domains
List payment method domains
Lists the details of existing payment method domains.
Request parameters
| Parameter | Location | Type | Description |
|---|
domain_name | query | string | The domain name that this payment method domain object represents. |
enabled | query | boolean | Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements or Embedded Checkout |
ending_before | query | string | A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. |
expand | query | array of string | Specifies which fields in the response should be expanded. |
limit | query | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
starting_after | query | string | A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|
data required | array of payment_method_domain | |
has_more required | boolean | True if this list has another page of items after this one that can be fetched. |
object required | string | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. |
url required | string | The URL where this list can be accessed. |
HTTP default: Error response.
| Field | Type | Description |
|---|
error required | api_errors | |
POST /v1/payment_method_domains
Create a payment method domain
Creates a payment method domain.
Request parameters
| Field | Type | Description |
|---|
domain_name required | 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 or Embedded Checkout. |
expand | array of string | Specifies which fields in the response should be expanded. |
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|
amazon_pay required | payment_method_domain_resource_payment_method_status | |
apple_pay required | payment_method_domain_resource_payment_method_status | |
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
domain_name required | string | The domain name that this payment method domain object represents. |
enabled required | 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. |
google_pay required | payment_method_domain_resource_payment_method_status | |
id required | string | Unique identifier for the object. |
klarna required | payment_method_domain_resource_payment_method_status | |
link required | payment_method_domain_resource_payment_method_status | |
livemode required | boolean | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object required | string | String representing the object's type. Objects of the same type share the same value. |
paypal required | payment_method_domain_resource_payment_method_status | |
HTTP default: Error response.
| Field | Type | Description |
|---|
error required | api_errors | |
GET /v1/payment_method_domains/{payment_method_domain}
Retrieve a payment method domain
Retrieves the details of an existing payment method domain.
Request parameters
| Parameter | Location | Type | Description |
|---|
expand | query | array of string | Specifies which fields in the response should be expanded. |
payment_method_domain | path | string | |
object. See the OpenAPI specification for the complete schema.
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|
amazon_pay required | payment_method_domain_resource_payment_method_status | |
apple_pay required | payment_method_domain_resource_payment_method_status | |
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
domain_name required | string | The domain name that this payment method domain object represents. |
enabled required | 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. |
google_pay required | payment_method_domain_resource_payment_method_status | |
id required | string | Unique identifier for the object. |
klarna required | payment_method_domain_resource_payment_method_status | |
link required | payment_method_domain_resource_payment_method_status | |
livemode required | boolean | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object required | string | String representing the object's type. Objects of the same type share the same value. |
paypal required | payment_method_domain_resource_payment_method_status | |
HTTP default: Error response.
| Field | Type | Description |
|---|
error required | api_errors | |
POST /v1/payment_method_domains/{payment_method_domain}
Update a payment method domain
Updates an existing payment method domain.
Request parameters
| Parameter | Location | Type | Description |
|---|
payment_method_domain | path | string | |
| Field | Type | Description |
|---|
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. |
expand | array of string | Specifies which fields in the response should be expanded. |
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|
amazon_pay required | payment_method_domain_resource_payment_method_status | |
apple_pay required | payment_method_domain_resource_payment_method_status | |
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
domain_name required | string | The domain name that this payment method domain object represents. |
enabled required | 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. |
google_pay required | payment_method_domain_resource_payment_method_status | |
id required | string | Unique identifier for the object. |
klarna required | payment_method_domain_resource_payment_method_status | |
link required | payment_method_domain_resource_payment_method_status | |
livemode required | boolean | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object required | string | String representing the object's type. Objects of the same type share the same value. |
paypal required | payment_method_domain_resource_payment_method_status | |
HTTP default: Error response.
| Field | Type | Description |
|---|
error required | api_errors | |
POST /v1/payment_method_domains/{payment_method_domain}/validate
Validate an existing payment method domain
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.
Request parameters
| Parameter | Location | Type | Description |
|---|
payment_method_domain | path | string | |
| Field | Type | Description |
|---|
expand | array of string | Specifies which fields in the response should be expanded. |
Responses
HTTP 200: Successful response.
| Field | Type | Description |
|---|
amazon_pay required | payment_method_domain_resource_payment_method_status | |
apple_pay required | payment_method_domain_resource_payment_method_status | |
created required | integer | Time at which the object was created. Measured in seconds since the Unix epoch. |
domain_name required | string | The domain name that this payment method domain object represents. |
enabled required | 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. |
google_pay required | payment_method_domain_resource_payment_method_status | |
id required | string | Unique identifier for the object. |
klarna required | payment_method_domain_resource_payment_method_status | |
link required | payment_method_domain_resource_payment_method_status | |
livemode required | boolean | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
object required | string | String representing the object's type. Objects of the same type share the same value. |
paypal required | payment_method_domain_resource_payment_method_status | |
HTTP default: Error response.
| Field | Type | Description |
|---|
error required | api_errors | |