Lists the details of existing payment method domains.
", + "operationId": "GetPaymentMethodDomains", + "parameters": [ + { + "description": "The domain name that this payment method domain object represents.", + "in": "query", + "name": "domain_name", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements", + "in": "query", + "name": "enabled", + "required": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "description": "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.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "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.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/payment_method_domain" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "pattern": "^/v1/payment_method_domains", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "PaymentMethodDomainResourcePaymentMethodDomainList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Creates a payment method domain.
", + "operationId": "PostPaymentMethodDomains", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "domain_name": { + "description": "The domain name that this payment method domain object represents.", + "maxLength": 5000, + "type": "string" + }, + "enabled": { + "description": "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.", + "type": "boolean" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "domain_name" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_method_domain" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/payment_method_domains/{payment_method_domain}": { + "get": { + "description": "Retrieves the details of an existing payment method domain.
", + "operationId": "GetPaymentMethodDomainsPaymentMethodDomain", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "in": "path", + "name": "payment_method_domain", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_method_domain" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Updates an existing payment method domain.
", + "operationId": "PostPaymentMethodDomainsPaymentMethodDomain", + "parameters": [ + { + "in": "path", + "name": "payment_method_domain", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "enabled": { + "description": "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.", + "type": "boolean" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_method_domain" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/payment_method_domains/{payment_method_domain}/validate": { + "post": { + "description": "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.\nThe payment method doesn’t appear in Elements for this domain until it is active.
\n\nTo 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.
\n\nRelated guides: Payment method domains.
", + "operationId": "PostPaymentMethodDomainsPaymentMethodDomainValidate", + "parameters": [ + { + "in": "path", + "name": "payment_method_domain", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_method_domain" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/payment_methods": { "get": { "description": "Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.
", diff --git a/openapi/spec3.beta.sdk.yaml b/openapi/spec3.beta.sdk.yaml index 1ca6a016..aded696c 100644 --- a/openapi/spec3.beta.sdk.yaml +++ b/openapi/spec3.beta.sdk.yaml @@ -31260,6 +31260,153 @@ components: x-stripeResource: class_name: Zip in_package: '' + payment_method_domain: + description: >- + 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 guides: [Payment method + domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + properties: + apple_pay: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + domain_name: + description: The domain name that this payment method domain object represents. + maxLength: 5000 + type: string + enabled: + description: >- + 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. + type: boolean + google_pay: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + link: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - payment_method_domain + type: string + paypal: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status + required: + - apple_pay + - created + - domain_name + - enabled + - google_pay + - id + - link + - livemode + - object + - paypal + title: PaymentMethodDomainResourcePaymentMethodDomain + type: object + x-expandableFields: + - apple_pay + - google_pay + - link + - paypal + x-resourceId: payment_method_domain + x-stripeOperations: + - method_name: retrieve + method_on: service + method_type: retrieve + operation: get + path: '/v1/payment_method_domains/{payment_method_domain}' + - method_name: list + method_on: service + method_type: list + operation: get + path: /v1/payment_method_domains + - method_name: create + method_on: service + method_type: create + operation: post + path: /v1/payment_method_domains + - method_name: update + method_on: service + method_type: update + operation: post + path: '/v1/payment_method_domains/{payment_method_domain}' + - method_name: validate + method_on: service + method_type: custom + operation: post + path: '/v1/payment_method_domains/{payment_method_domain}/validate' + x-stripeResource: + class_name: PaymentMethodDomain + has_collection_class: true + in_package: '' + payment_method_domain_resource_payment_method_status: + description: >- + Indicates the status of a specific payment method on a payment method + domain. + properties: + status: + description: The status of the payment method on the domain. + enum: + - active + - inactive + type: string + status_details: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status_details + required: + - status + title: PaymentMethodDomainResourcePaymentMethodStatus + type: object + x-expandableFields: + - status_details + x-stripeResource: + class_name: PaymentMethodDomainPaymentMethodStatus + in_package: '' + payment_method_domain_resource_payment_method_status_details: + description: >- + Contains additional details about the status of a payment method for a + specific payment method domain. + properties: + error_message: + description: >- + The error message associated with the status of the payment method + on the domain. + maxLength: 5000 + type: string + required: + - error_message + title: PaymentMethodDomainResourcePaymentMethodStatusDetails + type: object + x-expandableFields: [] + x-stripeResource: + class_name: PaymentMethodDomainPaymentMethodStatusDetails + in_package: '' payment_method_eps: description: '' properties: @@ -113553,6 +113700,327 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + /v1/payment_method_domains: + get: + description:Lists the details of existing payment method domains.
+ operationId: GetPaymentMethodDomains + parameters: + - description: The domain name that this payment method domain object represents. + in: query + name: domain_name + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + Whether this payment method domain is enabled. If the domain is not + enabled, payment methods will not appear in Elements + in: query + name: enabled + required: false + schema: + type: boolean + style: form + - description: >- + 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. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: >- + 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/payment_method_domain' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/payment_method_domains + type: string + required: + - data + - has_more + - object + - url + title: PaymentMethodDomainResourcePaymentMethodDomainList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description:Creates a payment method domain.
+ operationId: PostPaymentMethodDomains + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + domain_name: + description: >- + The domain name that this payment method domain object + represents. + maxLength: 5000 + type: string + enabled: + description: >- + 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. + type: boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + required: + - domain_name + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_method_domain' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/payment_method_domains/{payment_method_domain}': + get: + description:Retrieves the details of an existing payment method domain.
+ operationId: GetPaymentMethodDomainsPaymentMethodDomain + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: payment_method_domain + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_method_domain' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description:Updates an existing payment method domain.
+ operationId: PostPaymentMethodDomainsPaymentMethodDomain + parameters: + - in: path + name: payment_method_domain + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + enabled: + description: >- + 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. + type: boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_method_domain' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/payment_method_domains/{payment_method_domain}/validate': + post: + description: >- +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.
+ operationId: PostPaymentMethodDomainsPaymentMethodDomainValidate + parameters: + - in: path + name: payment_method_domain + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_method_domain' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. /v1/payment_methods: get: description: >- diff --git a/openapi/spec3.json b/openapi/spec3.json index 7f5fb6e0..93dadba3 100644 --- a/openapi/spec3.json +++ b/openapi/spec3.json @@ -25209,6 +25209,114 @@ "type": "object", "x-expandableFields": [] }, + "payment_method_domain": { + "description": "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).", + "properties": { + "apple_pay": { + "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" + }, + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "domain_name": { + "description": "The domain name that this payment method domain object represents.", + "maxLength": 5000, + "type": "string" + }, + "enabled": { + "description": "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.", + "type": "boolean" + }, + "google_pay": { + "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "link": { + "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "payment_method_domain" + ], + "type": "string" + }, + "paypal": { + "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" + } + }, + "required": [ + "apple_pay", + "created", + "domain_name", + "enabled", + "google_pay", + "id", + "link", + "livemode", + "object", + "paypal" + ], + "title": "PaymentMethodDomainResourcePaymentMethodDomain", + "type": "object", + "x-expandableFields": [ + "apple_pay", + "google_pay", + "link", + "paypal" + ], + "x-resourceId": "payment_method_domain" + }, + "payment_method_domain_resource_payment_method_status": { + "description": "Indicates the status of a specific payment method on a payment method domain.", + "properties": { + "status": { + "description": "The status of the payment method on the domain.", + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "status_details": { + "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status_details" + } + }, + "required": [ + "status" + ], + "title": "PaymentMethodDomainResourcePaymentMethodStatus", + "type": "object", + "x-expandableFields": [ + "status_details" + ] + }, + "payment_method_domain_resource_payment_method_status_details": { + "description": "Contains additional details about the status of a payment method for a specific payment method domain.", + "properties": { + "error_message": { + "description": "The error message associated with the status of the payment method on the domain.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "error_message" + ], + "title": "PaymentMethodDomainResourcePaymentMethodStatusDetails", + "type": "object", + "x-expandableFields": [] + }, "payment_method_eps": { "description": "", "properties": { @@ -95570,6 +95678,422 @@ } } }, + "/v1/payment_method_domains": { + "get": { + "description": "Lists the details of existing payment method domains.
", + "operationId": "GetPaymentMethodDomains", + "parameters": [ + { + "description": "The domain name that this payment method domain object represents.", + "in": "query", + "name": "domain_name", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements", + "in": "query", + "name": "enabled", + "required": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "description": "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.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "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.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/payment_method_domain" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "pattern": "^/v1/payment_method_domains", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "PaymentMethodDomainResourcePaymentMethodDomainList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Creates a payment method domain.
", + "operationId": "PostPaymentMethodDomains", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "domain_name": { + "description": "The domain name that this payment method domain object represents.", + "maxLength": 5000, + "type": "string" + }, + "enabled": { + "description": "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.", + "type": "boolean" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "domain_name" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_method_domain" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/payment_method_domains/{payment_method_domain}": { + "get": { + "description": "Retrieves the details of an existing payment method domain.
", + "operationId": "GetPaymentMethodDomainsPaymentMethodDomain", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "in": "path", + "name": "payment_method_domain", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_method_domain" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Updates an existing payment method domain.
", + "operationId": "PostPaymentMethodDomainsPaymentMethodDomain", + "parameters": [ + { + "in": "path", + "name": "payment_method_domain", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "enabled": { + "description": "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.", + "type": "boolean" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_method_domain" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/payment_method_domains/{payment_method_domain}/validate": { + "post": { + "description": "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.\nThe payment method doesn’t appear in Elements for this domain until it is active.
\n\nTo 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.
\n\nRelated guides: Payment method domains.
", + "operationId": "PostPaymentMethodDomainsPaymentMethodDomainValidate", + "parameters": [ + { + "in": "path", + "name": "payment_method_domain", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_method_domain" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/payment_methods": { "get": { "description": "Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.
", diff --git a/openapi/spec3.sdk.json b/openapi/spec3.sdk.json index 5f7c4b58..b630b17f 100644 --- a/openapi/spec3.sdk.json +++ b/openapi/spec3.sdk.json @@ -30171,6 +30171,164 @@ "in_package": "" } }, + "payment_method_domain": { + "description": "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).", + "properties": { + "apple_pay": { + "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" + }, + "created": { + "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", + "format": "unix-time", + "type": "integer" + }, + "domain_name": { + "description": "The domain name that this payment method domain object represents.", + "maxLength": 5000, + "type": "string" + }, + "enabled": { + "description": "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.", + "type": "boolean" + }, + "google_pay": { + "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" + }, + "id": { + "description": "Unique identifier for the object.", + "maxLength": 5000, + "type": "string" + }, + "link": { + "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" + }, + "livemode": { + "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value.", + "enum": [ + "payment_method_domain" + ], + "type": "string" + }, + "paypal": { + "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status" + } + }, + "required": [ + "apple_pay", + "created", + "domain_name", + "enabled", + "google_pay", + "id", + "link", + "livemode", + "object", + "paypal" + ], + "title": "PaymentMethodDomainResourcePaymentMethodDomain", + "type": "object", + "x-expandableFields": [ + "apple_pay", + "google_pay", + "link", + "paypal" + ], + "x-resourceId": "payment_method_domain", + "x-stripeOperations": [ + { + "method_name": "retrieve", + "method_on": "service", + "method_type": "retrieve", + "operation": "get", + "path": "/v1/payment_method_domains/{payment_method_domain}" + }, + { + "method_name": "list", + "method_on": "service", + "method_type": "list", + "operation": "get", + "path": "/v1/payment_method_domains" + }, + { + "method_name": "create", + "method_on": "service", + "method_type": "create", + "operation": "post", + "path": "/v1/payment_method_domains" + }, + { + "method_name": "update", + "method_on": "service", + "method_type": "update", + "operation": "post", + "path": "/v1/payment_method_domains/{payment_method_domain}" + }, + { + "method_name": "validate", + "method_on": "service", + "method_type": "custom", + "operation": "post", + "path": "/v1/payment_method_domains/{payment_method_domain}/validate" + } + ], + "x-stripeResource": { + "class_name": "PaymentMethodDomain", + "has_collection_class": true, + "in_package": "" + } + }, + "payment_method_domain_resource_payment_method_status": { + "description": "Indicates the status of a specific payment method on a payment method domain.", + "properties": { + "status": { + "description": "The status of the payment method on the domain.", + "enum": [ + "active", + "inactive" + ], + "type": "string" + }, + "status_details": { + "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status_details" + } + }, + "required": [ + "status" + ], + "title": "PaymentMethodDomainResourcePaymentMethodStatus", + "type": "object", + "x-expandableFields": [ + "status_details" + ], + "x-stripeResource": { + "class_name": "PaymentMethodDomainPaymentMethodStatus", + "in_package": "" + } + }, + "payment_method_domain_resource_payment_method_status_details": { + "description": "Contains additional details about the status of a payment method for a specific payment method domain.", + "properties": { + "error_message": { + "description": "The error message associated with the status of the payment method on the domain.", + "maxLength": 5000, + "type": "string" + } + }, + "required": [ + "error_message" + ], + "title": "PaymentMethodDomainResourcePaymentMethodStatusDetails", + "type": "object", + "x-expandableFields": [], + "x-stripeResource": { + "class_name": "PaymentMethodDomainPaymentMethodStatusDetails", + "in_package": "" + } + }, "payment_method_eps": { "description": "", "properties": { @@ -98680,6 +98838,422 @@ } } }, + "/v1/payment_method_domains": { + "get": { + "description": "Lists the details of existing payment method domains.
", + "operationId": "GetPaymentMethodDomains", + "parameters": [ + { + "description": "The domain name that this payment method domain object represents.", + "in": "query", + "name": "domain_name", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements", + "in": "query", + "name": "enabled", + "required": false, + "schema": { + "type": "boolean" + }, + "style": "form" + }, + { + "description": "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.", + "in": "query", + "name": "ending_before", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + }, + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.", + "in": "query", + "name": "limit", + "required": false, + "schema": { + "type": "integer" + }, + "style": "form" + }, + { + "description": "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.", + "in": "query", + "name": "starting_after", + "required": false, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "form" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "description": "", + "properties": { + "data": { + "items": { + "$ref": "#/components/schemas/payment_method_domain" + }, + "type": "array" + }, + "has_more": { + "description": "True if this list has another page of items after this one that can be fetched.", + "type": "boolean" + }, + "object": { + "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.", + "enum": [ + "list" + ], + "type": "string" + }, + "url": { + "description": "The URL where this list can be accessed.", + "maxLength": 5000, + "pattern": "^/v1/payment_method_domains", + "type": "string" + } + }, + "required": [ + "data", + "has_more", + "object", + "url" + ], + "title": "PaymentMethodDomainResourcePaymentMethodDomainList", + "type": "object", + "x-expandableFields": [ + "data" + ] + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Creates a payment method domain.
", + "operationId": "PostPaymentMethodDomains", + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "domain_name": { + "description": "The domain name that this payment method domain object represents.", + "maxLength": 5000, + "type": "string" + }, + "enabled": { + "description": "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.", + "type": "boolean" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "domain_name" + ], + "type": "object" + } + } + }, + "required": true + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_method_domain" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/payment_method_domains/{payment_method_domain}": { + "get": { + "description": "Retrieves the details of an existing payment method domain.
", + "operationId": "GetPaymentMethodDomainsPaymentMethodDomain", + "parameters": [ + { + "description": "Specifies which fields in the response should be expanded.", + "explode": true, + "in": "query", + "name": "expand", + "required": false, + "schema": { + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + }, + "style": "deepObject" + }, + { + "in": "path", + "name": "payment_method_domain", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": {}, + "schema": { + "additionalProperties": false, + "properties": {}, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_method_domain" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + }, + "post": { + "description": "Updates an existing payment method domain.
", + "operationId": "PostPaymentMethodDomainsPaymentMethodDomain", + "parameters": [ + { + "in": "path", + "name": "payment_method_domain", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "enabled": { + "description": "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.", + "type": "boolean" + }, + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_method_domain" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, + "/v1/payment_method_domains/{payment_method_domain}/validate": { + "post": { + "description": "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.\nThe payment method doesn’t appear in Elements for this domain until it is active.
\n\nTo 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.
\n\nRelated guides: Payment method domains.
", + "operationId": "PostPaymentMethodDomainsPaymentMethodDomainValidate", + "parameters": [ + { + "in": "path", + "name": "payment_method_domain", + "required": true, + "schema": { + "maxLength": 5000, + "type": "string" + }, + "style": "simple" + } + ], + "requestBody": { + "content": { + "application/x-www-form-urlencoded": { + "encoding": { + "expand": { + "explode": true, + "style": "deepObject" + } + }, + "schema": { + "additionalProperties": false, + "properties": { + "expand": { + "description": "Specifies which fields in the response should be expanded.", + "items": { + "maxLength": 5000, + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + } + }, + "required": false + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/payment_method_domain" + } + } + }, + "description": "Successful response." + }, + "default": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error" + } + } + }, + "description": "Error response." + } + } + } + }, "/v1/payment_methods": { "get": { "description": "Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.
", diff --git a/openapi/spec3.sdk.yaml b/openapi/spec3.sdk.yaml index 0cd0e7ab..6d166674 100644 --- a/openapi/spec3.sdk.yaml +++ b/openapi/spec3.sdk.yaml @@ -27674,6 +27674,153 @@ components: x-stripeResource: class_name: Zip in_package: '' + payment_method_domain: + description: >- + 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 guides: [Payment method + domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + properties: + apple_pay: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + domain_name: + description: The domain name that this payment method domain object represents. + maxLength: 5000 + type: string + enabled: + description: >- + 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. + type: boolean + google_pay: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + link: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - payment_method_domain + type: string + paypal: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status + required: + - apple_pay + - created + - domain_name + - enabled + - google_pay + - id + - link + - livemode + - object + - paypal + title: PaymentMethodDomainResourcePaymentMethodDomain + type: object + x-expandableFields: + - apple_pay + - google_pay + - link + - paypal + x-resourceId: payment_method_domain + x-stripeOperations: + - method_name: retrieve + method_on: service + method_type: retrieve + operation: get + path: '/v1/payment_method_domains/{payment_method_domain}' + - method_name: list + method_on: service + method_type: list + operation: get + path: /v1/payment_method_domains + - method_name: create + method_on: service + method_type: create + operation: post + path: /v1/payment_method_domains + - method_name: update + method_on: service + method_type: update + operation: post + path: '/v1/payment_method_domains/{payment_method_domain}' + - method_name: validate + method_on: service + method_type: custom + operation: post + path: '/v1/payment_method_domains/{payment_method_domain}/validate' + x-stripeResource: + class_name: PaymentMethodDomain + has_collection_class: true + in_package: '' + payment_method_domain_resource_payment_method_status: + description: >- + Indicates the status of a specific payment method on a payment method + domain. + properties: + status: + description: The status of the payment method on the domain. + enum: + - active + - inactive + type: string + status_details: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status_details + required: + - status + title: PaymentMethodDomainResourcePaymentMethodStatus + type: object + x-expandableFields: + - status_details + x-stripeResource: + class_name: PaymentMethodDomainPaymentMethodStatus + in_package: '' + payment_method_domain_resource_payment_method_status_details: + description: >- + Contains additional details about the status of a payment method for a + specific payment method domain. + properties: + error_message: + description: >- + The error message associated with the status of the payment method + on the domain. + maxLength: 5000 + type: string + required: + - error_message + title: PaymentMethodDomainResourcePaymentMethodStatusDetails + type: object + x-expandableFields: [] + x-stripeResource: + class_name: PaymentMethodDomainPaymentMethodStatusDetails + in_package: '' payment_method_eps: description: '' properties: @@ -93596,6 +93743,327 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + /v1/payment_method_domains: + get: + description:Lists the details of existing payment method domains.
+ operationId: GetPaymentMethodDomains + parameters: + - description: The domain name that this payment method domain object represents. + in: query + name: domain_name + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + Whether this payment method domain is enabled. If the domain is not + enabled, payment methods will not appear in Elements + in: query + name: enabled + required: false + schema: + type: boolean + style: form + - description: >- + 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. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: >- + 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/payment_method_domain' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/payment_method_domains + type: string + required: + - data + - has_more + - object + - url + title: PaymentMethodDomainResourcePaymentMethodDomainList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description:Creates a payment method domain.
+ operationId: PostPaymentMethodDomains + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + domain_name: + description: >- + The domain name that this payment method domain object + represents. + maxLength: 5000 + type: string + enabled: + description: >- + 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. + type: boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + required: + - domain_name + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_method_domain' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/payment_method_domains/{payment_method_domain}': + get: + description:Retrieves the details of an existing payment method domain.
+ operationId: GetPaymentMethodDomainsPaymentMethodDomain + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: payment_method_domain + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_method_domain' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description:Updates an existing payment method domain.
+ operationId: PostPaymentMethodDomainsPaymentMethodDomain + parameters: + - in: path + name: payment_method_domain + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + enabled: + description: >- + 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. + type: boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_method_domain' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/payment_method_domains/{payment_method_domain}/validate': + post: + description: >- +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.
+ operationId: PostPaymentMethodDomainsPaymentMethodDomainValidate + parameters: + - in: path + name: payment_method_domain + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_method_domain' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. /v1/payment_methods: get: description: >- diff --git a/openapi/spec3.yaml b/openapi/spec3.yaml index 69916bf3..71461893 100644 --- a/openapi/spec3.yaml +++ b/openapi/spec3.yaml @@ -23616,6 +23616,117 @@ components: title: payment_method_details_zip type: object x-expandableFields: [] + payment_method_domain: + description: >- + 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 guides: [Payment method + domains](https://stripe.com/docs/payments/payment-methods/pmd-registration). + properties: + apple_pay: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + domain_name: + description: The domain name that this payment method domain object represents. + maxLength: 5000 + type: string + enabled: + description: >- + 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. + type: boolean + google_pay: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + link: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - payment_method_domain + type: string + paypal: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status + required: + - apple_pay + - created + - domain_name + - enabled + - google_pay + - id + - link + - livemode + - object + - paypal + title: PaymentMethodDomainResourcePaymentMethodDomain + type: object + x-expandableFields: + - apple_pay + - google_pay + - link + - paypal + x-resourceId: payment_method_domain + payment_method_domain_resource_payment_method_status: + description: >- + Indicates the status of a specific payment method on a payment method + domain. + properties: + status: + description: The status of the payment method on the domain. + enum: + - active + - inactive + type: string + status_details: + $ref: >- + #/components/schemas/payment_method_domain_resource_payment_method_status_details + required: + - status + title: PaymentMethodDomainResourcePaymentMethodStatus + type: object + x-expandableFields: + - status_details + payment_method_domain_resource_payment_method_status_details: + description: >- + Contains additional details about the status of a payment method for a + specific payment method domain. + properties: + error_message: + description: >- + The error message associated with the status of the payment method + on the domain. + maxLength: 5000 + type: string + required: + - error_message + title: PaymentMethodDomainResourcePaymentMethodStatusDetails + type: object + x-expandableFields: [] payment_method_eps: description: '' properties: @@ -82111,6 +82222,327 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + /v1/payment_method_domains: + get: + description:Lists the details of existing payment method domains.
+ operationId: GetPaymentMethodDomains + parameters: + - description: The domain name that this payment method domain object represents. + in: query + name: domain_name + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + Whether this payment method domain is enabled. If the domain is not + enabled, payment methods will not appear in Elements + in: query + name: enabled + required: false + schema: + type: boolean + style: form + - description: >- + 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. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: >- + 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/payment_method_domain' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/payment_method_domains + type: string + required: + - data + - has_more + - object + - url + title: PaymentMethodDomainResourcePaymentMethodDomainList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description:Creates a payment method domain.
+ operationId: PostPaymentMethodDomains + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + domain_name: + description: >- + The domain name that this payment method domain object + represents. + maxLength: 5000 + type: string + enabled: + description: >- + 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. + type: boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + required: + - domain_name + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_method_domain' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/payment_method_domains/{payment_method_domain}': + get: + description:Retrieves the details of an existing payment method domain.
+ operationId: GetPaymentMethodDomainsPaymentMethodDomain + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: payment_method_domain + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_method_domain' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description:Updates an existing payment method domain.
+ operationId: PostPaymentMethodDomainsPaymentMethodDomain + parameters: + - in: path + name: payment_method_domain + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + enabled: + description: >- + 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. + type: boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_method_domain' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/payment_method_domains/{payment_method_domain}/validate': + post: + description: >- +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.
+ operationId: PostPaymentMethodDomainsPaymentMethodDomainValidate + parameters: + - in: path + name: payment_method_domain + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/payment_method_domain' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. /v1/payment_methods: get: description: >-