paymentmethoddomain

Documentation

Overview

Package paymentmethoddomain provides the /payment_method_domains APIs

Index

• func Get(id string, params *stripe.PaymentMethodDomainParams) (*stripe.PaymentMethodDomain, error)
• func New(params *stripe.PaymentMethodDomainParams) (*stripe.PaymentMethodDomain, error)
• func Update(id string, params *stripe.PaymentMethodDomainParams) (*stripe.PaymentMethodDomain, error)
• func Validate(id string, params *stripe.PaymentMethodDomainValidateParams) (*stripe.PaymentMethodDomain, error)
• type Client
  • func (c Client) Get(id string, params *stripe.PaymentMethodDomainParams) (*stripe.PaymentMethodDomain, error)
  • func (c Client) List(listParams *stripe.PaymentMethodDomainListParams) *Iter
  • func (c Client) New(params *stripe.PaymentMethodDomainParams) (*stripe.PaymentMethodDomain, error)
  • func (c Client) Update(id string, params *stripe.PaymentMethodDomainParams) (*stripe.PaymentMethodDomain, error)
  • func (c Client) Validate(id string, params *stripe.PaymentMethodDomainValidateParams) (*stripe.PaymentMethodDomain, error)
• type Iter
  • func List(params *stripe.PaymentMethodDomainListParams) *Iter
  • func (i *Iter) PaymentMethodDomain() *stripe.PaymentMethodDomain
  • func (i *Iter) PaymentMethodDomainList() *stripe.PaymentMethodDomainList

Functions

func Get

func Get(id string, params *stripe.PaymentMethodDomainParams) (*stripe.PaymentMethodDomain, error)

Retrieves the details of an existing payment method domain.

func New

func New(params *stripe.PaymentMethodDomainParams) (*stripe.PaymentMethodDomain, error)

Creates a payment method domain.

func Update

func Update(id string, params *stripe.PaymentMethodDomainParams) (*stripe.PaymentMethodDomain, error)

Updates an existing payment method domain.

func Validate

func Validate(id string, params *stripe.PaymentMethodDomainValidateParams) (*stripe.PaymentMethodDomain, error)

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](https://stripe.com/docs/payments/payment-methods/pmd-registration).

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /payment_method_domains APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.PaymentMethodDomainParams) (*stripe.PaymentMethodDomain, error)

Retrieves the details of an existing payment method domain.

func (Client) List

func (c Client) List(listParams *stripe.PaymentMethodDomainListParams) *Iter

Lists the details of existing payment method domains.

func (Client) New

func (c Client) New(params *stripe.PaymentMethodDomainParams) (*stripe.PaymentMethodDomain, error)

Creates a payment method domain.

func (Client) Update

func (c Client) Update(id string, params *stripe.PaymentMethodDomainParams) (*stripe.PaymentMethodDomain, error)

Updates an existing payment method domain.

func (Client) Validate

func (c Client) Validate(id string, params *stripe.PaymentMethodDomainValidateParams) (*stripe.PaymentMethodDomain, error)

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](https://stripe.com/docs/payments/payment-methods/pmd-registration).

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for payment method domains.

func List

func List(params *stripe.PaymentMethodDomainListParams) *Iter

Lists the details of existing payment method domains.

func (*Iter) PaymentMethodDomain

func (i *Iter) PaymentMethodDomain() *stripe.PaymentMethodDomain

PaymentMethodDomain returns the payment method domain which the iterator is currently pointing to.

func (*Iter) PaymentMethodDomainList

func (i *Iter) PaymentMethodDomainList() *stripe.PaymentMethodDomainList

PaymentMethodDomainList returns the current list object which the iterator is currently using. List objects will change as new API calls are made to continue pagination.