View Source Stripe.PaymentMethodDomain (stripity_stripe v3.3.1)

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(params \\ %{}, opts \\ [])

Creates a payment method domain.

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

Lists the details of existing payment method domains.

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

Retrieves the details of an existing payment method domain.

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

Updates an existing payment method domain.

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

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.

Types

t()

@type t() :: %Stripe.PaymentMethodDomain{
  amazon_pay: term(),
  apple_pay: term(),
  created: integer(),
  domain_name: binary(),
  enabled: boolean(),
  google_pay: term(),
  id: binary(),
  klarna: term(),
  link: term(),
  livemode: boolean(),
  object: binary(),
  paypal: term()
}

The payment_method_domain type.

amazon_pay
apple_pay
created Time at which the object was created. Measured in seconds since the Unix epoch.
domain_name The domain name that this payment method domain object represents.
enabled 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
id Unique identifier for the object.
klarna
link
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
object String representing the object's type. Objects of the same type share the same value.
paypal

Functions

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

@spec create(
  params :: %{
    optional(:domain_name) => binary(),
    optional(:enabled) => boolean(),
    optional(:expand) => [binary()]
  },
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Creates a payment method domain.

Details

Method: post
Path: /v1/payment_method_domains

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

@spec list(
  params :: %{
    optional(:domain_name) => binary(),
    optional(:enabled) => boolean(),
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary()
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Lists the details of existing payment method domains.

Details

Method: get
Path: /v1/payment_method_domains

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

@spec retrieve(
  payment_method_domain :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves the details of an existing payment method domain.

Details

Method: get
Path: /v1/payment_method_domains/{payment_method_domain}

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

@spec update(
  payment_method_domain :: binary(),
  params :: %{optional(:enabled) => boolean(), optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Updates an existing payment method domain.

Details

Method: post
Path: /v1/payment_method_domains/{payment_method_domain}

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

@spec validate(
  payment_method_domain :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

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.

#### Details * Method: `post` * Path: `/v1/payment_method_domains/{payment_method_domain}/validate`