Search documentation of stripe_elixir

# StripeElixir.Services.PaymentMethodDomainService (stripe_elixir v0.1.0)

Copy Markdown View Source

PaymentMethodDomainResourcePaymentMethodDomain

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 guide: Payment method domains.

## Summary

### Functions

create(client, params \\ %{}, opts \\ [])

Create a payment method domain

list(client, params \\ %{}, opts \\ [])

List payment method domains

retrieve(client, payment_method_domain, params \\ %{}, opts \\ [])

Retrieve a payment method domain

update(client, payment_method_domain, params \\ %{}, opts \\ [])

Update a payment method domain

validate(client, payment_method_domain, params \\ %{}, opts \\ [])

Validate an existing payment method domain

## Functions

# create(client, params \\ %{}, opts \\ [])

    @spec create(StripeElixir.Client.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Create a payment method domain

Creates a payment method domain.

# list(client, params \\ %{}, opts \\ [])

    @spec list(StripeElixir.Client.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

List payment method domains

Lists the details of existing payment method domains.

# retrieve(client, payment_method_domain, params \\ %{}, opts \\ [])

    @spec retrieve(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Retrieve a payment method domain

Retrieves the details of an existing payment method domain.

# update(client, payment_method_domain, params \\ %{}, opts \\ [])

    @spec update(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Update a payment method domain

Updates an existing payment method domain.

# validate(client, payment_method_domain, params \\ %{}, opts \\ [])

    @spec validate(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

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.