setupintent

Documentation

Overview

Package setupintent provides the /setup_intents APIs

Index

• func Cancel(id string, params *stripe.SetupIntentCancelParams) (*stripe.SetupIntent, error)
• func Confirm(id string, params *stripe.SetupIntentConfirmParams) (*stripe.SetupIntent, error)
• func Get(id string, params *stripe.SetupIntentParams) (*stripe.SetupIntent, error)
• func New(params *stripe.SetupIntentParams) (*stripe.SetupIntent, error)
• func Update(id string, params *stripe.SetupIntentParams) (*stripe.SetupIntent, error)
• func VerifyMicrodeposits(id string, params *stripe.SetupIntentVerifyMicrodepositsParams) (*stripe.SetupIntent, error)
• type Client
  • func (c Client) Cancel(id string, params *stripe.SetupIntentCancelParams) (*stripe.SetupIntent, error)
  • func (c Client) Confirm(id string, params *stripe.SetupIntentConfirmParams) (*stripe.SetupIntent, error)
  • func (c Client) Get(id string, params *stripe.SetupIntentParams) (*stripe.SetupIntent, error)
  • func (c Client) List(listParams *stripe.SetupIntentListParams) *Iter
  • func (c Client) New(params *stripe.SetupIntentParams) (*stripe.SetupIntent, error)
  • func (c Client) Update(id string, params *stripe.SetupIntentParams) (*stripe.SetupIntent, error)
  • func (c Client) VerifyMicrodeposits(id string, params *stripe.SetupIntentVerifyMicrodepositsParams) (*stripe.SetupIntent, error)
• type Iter
  • func List(params *stripe.SetupIntentListParams) *Iter
  • func (i *Iter) SetupIntent() *stripe.SetupIntent
  • func (i *Iter) SetupIntentList() *stripe.SetupIntentList

Functions

func Cancel

func Cancel(id string, params *stripe.SetupIntentCancelParams) (*stripe.SetupIntent, error)

Cancel is the method for the `POST /v1/setup_intents/{intent}/cancel` API.

func Confirm

func Confirm(id string, params *stripe.SetupIntentConfirmParams) (*stripe.SetupIntent, error)

Confirm is the method for the `POST /v1/setup_intents/{intent}/confirm` API.

func Get

func Get(id string, params *stripe.SetupIntentParams) (*stripe.SetupIntent, error)

Get returns the details of a setup intent.

func New

func New(params *stripe.SetupIntentParams) (*stripe.SetupIntent, error)

New creates a new setup intent.

func Update

func Update(id string, params *stripe.SetupIntentParams) (*stripe.SetupIntent, error)

Update updates a setup intent's properties.

func VerifyMicrodeposits

func VerifyMicrodeposits(id string, params *stripe.SetupIntentVerifyMicrodepositsParams) (*stripe.SetupIntent, error)

VerifyMicrodeposits is the method for the `POST /v1/setup_intents/{intent}/verify_microdeposits` API.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /setup_intents APIs.

func (Client) Cancel

func (c Client) Cancel(id string, params *stripe.SetupIntentCancelParams) (*stripe.SetupIntent, error)

Cancel is the method for the `POST /v1/setup_intents/{intent}/cancel` API.

func (Client) Confirm

func (c Client) Confirm(id string, params *stripe.SetupIntentConfirmParams) (*stripe.SetupIntent, error)

Confirm is the method for the `POST /v1/setup_intents/{intent}/confirm` API.

func (Client) Get

func (c Client) Get(id string, params *stripe.SetupIntentParams) (*stripe.SetupIntent, error)

Get returns the details of a setup intent.

func (Client) List

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

List returns a list of setup intents.

func (Client) New

func (c Client) New(params *stripe.SetupIntentParams) (*stripe.SetupIntent, error)

New creates a new setup intent.

func (Client) Update

func (c Client) Update(id string, params *stripe.SetupIntentParams) (*stripe.SetupIntent, error)

Update updates a setup intent's properties.

func (Client) VerifyMicrodeposits

func (c Client) VerifyMicrodeposits(id string, params *stripe.SetupIntentVerifyMicrodepositsParams) (*stripe.SetupIntent, error)

VerifyMicrodeposits is the method for the `POST /v1/setup_intents/{intent}/verify_microdeposits` API.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for setup intents.

func List

func List(params *stripe.SetupIntentListParams) *Iter

List returns a list of setup intents.

func (*Iter) SetupIntent

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

SetupIntent returns the setup intent which the iterator is currently pointing to.

func (*Iter) SetupIntentList

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

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