topup

Documentation

Overview

Package topup provides the /topups APIs

Index

• func Cancel(id string, params *stripe.TopupParams) (*stripe.Topup, error)
• func Get(id string, params *stripe.TopupParams) (*stripe.Topup, error)
• func New(params *stripe.TopupParams) (*stripe.Topup, error)
• func Update(id string, params *stripe.TopupParams) (*stripe.Topup, error)
• type Client
  • func (c Client) Cancel(id string, params *stripe.TopupParams) (*stripe.Topup, error)
  • func (c Client) Get(id string, params *stripe.TopupParams) (*stripe.Topup, error)
  • func (c Client) List(listParams *stripe.TopupListParams) *Iter
  • func (c Client) New(params *stripe.TopupParams) (*stripe.Topup, error)
  • func (c Client) Update(id string, params *stripe.TopupParams) (*stripe.Topup, error)
• type Iter
  • func List(params *stripe.TopupListParams) *Iter
  • func (i *Iter) Topup() *stripe.Topup
  • func (i *Iter) TopupList() *stripe.TopupList

Functions

func Cancel

func Cancel(id string, params *stripe.TopupParams) (*stripe.Topup, error)

Cancels a top-up. Only pending top-ups can be canceled.

func Get

func Get(id string, params *stripe.TopupParams) (*stripe.Topup, error)

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

func New

func New(params *stripe.TopupParams) (*stripe.Topup, error)

Top up the balance of an account

func Update

func Update(id string, params *stripe.TopupParams) (*stripe.Topup, error)

Updates the metadata of a top-up. Other top-up details are not editable by design.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /topups APIs.

func (Client) Cancel

func (c Client) Cancel(id string, params *stripe.TopupParams) (*stripe.Topup, error)

Cancels a top-up. Only pending top-ups can be canceled.

func (Client) Get

func (c Client) Get(id string, params *stripe.TopupParams) (*stripe.Topup, error)

Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.

func (Client) List

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

Returns a list of top-ups.

func (Client) New

func (c Client) New(params *stripe.TopupParams) (*stripe.Topup, error)

Top up the balance of an account

func (Client) Update

func (c Client) Update(id string, params *stripe.TopupParams) (*stripe.Topup, error)

Updates the metadata of a top-up. Other top-up details are not editable by design.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for topups.

func List

func List(params *stripe.TopupListParams) *Iter

Returns a list of top-ups.

func (*Iter) Topup

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

Topup returns the topup which the iterator is currently pointing to.

func (*Iter) TopupList

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

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