stripe-ruby/lib/stripe/services/payment_method_domain_service.rb
stripe-openapi[bot] 91626d37e8
Support for APIs in the new API version 2025-03-31.basil (#1543)
* Update generated code for v1559

* Update generated code for v1566

* Update generated code for v1572

* Update generated code for v1618

* Update generated code for v1635

---------

Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
Co-authored-by: prathmesh-stripe <165320323+prathmesh-stripe@users.noreply.github.com>
Co-authored-by: helenye-stripe <111009531+helenye-stripe@users.noreply.github.com>
2025-03-31 11:09:09 -07:00

67 lines
2.4 KiB
Ruby

# File generated from our OpenAPI spec
# frozen_string_literal: true
module Stripe
class PaymentMethodDomainService < StripeService
# Creates a payment method domain.
def create(params = {}, opts = {})
request(
method: :post,
path: "/v1/payment_method_domains",
params: params,
opts: opts,
base_address: :api
)
end
# Lists the details of existing payment method domains.
def list(params = {}, opts = {})
request(
method: :get,
path: "/v1/payment_method_domains",
params: params,
opts: opts,
base_address: :api
)
end
# Retrieves the details of an existing payment method domain.
def retrieve(payment_method_domain, params = {}, opts = {})
request(
method: :get,
path: format("/v1/payment_method_domains/%<payment_method_domain>s", { payment_method_domain: CGI.escape(payment_method_domain) }),
params: params,
opts: opts,
base_address: :api
)
end
# Updates an existing payment method domain.
def update(payment_method_domain, params = {}, opts = {})
request(
method: :post,
path: format("/v1/payment_method_domains/%<payment_method_domain>s", { payment_method_domain: CGI.escape(payment_method_domain) }),
params: params,
opts: opts,
base_address: :api
)
end
# 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](https://stripe.com/docs/payments/payment-methods/pmd-registration).
def validate(payment_method_domain, params = {}, opts = {})
request(
method: :post,
path: format("/v1/payment_method_domains/%<payment_method_domain>s/validate", { payment_method_domain: CGI.escape(payment_method_domain) }),
params: params,
opts: opts,
base_address: :api
)
end
end
end