transfer

Documentation

Overview

Package transfer provides the /transfers APIs

Index

• func Get(id string, params *stripe.TransferParams) (*stripe.Transfer, error)
• func New(params *stripe.TransferParams) (*stripe.Transfer, error)
• func Update(id string, params *stripe.TransferParams) (*stripe.Transfer, error)
• type Client
  • func (c Client) Get(id string, params *stripe.TransferParams) (*stripe.Transfer, error)
  • func (c Client) List(listParams *stripe.TransferListParams) *Iter
  • func (c Client) New(params *stripe.TransferParams) (*stripe.Transfer, error)
  • func (c Client) Update(id string, params *stripe.TransferParams) (*stripe.Transfer, error)
• type Iter
  • func List(params *stripe.TransferListParams) *Iter
  • func (i *Iter) Transfer() *stripe.Transfer
  • func (i *Iter) TransferList() *stripe.TransferList

Functions

func Get

func Get(id string, params *stripe.TransferParams) (*stripe.Transfer, error)

Get returns the details of a transfer.

func New

func New(params *stripe.TransferParams) (*stripe.Transfer, error)

New creates a new transfer.

func Update

func Update(id string, params *stripe.TransferParams) (*stripe.Transfer, error)

Update updates a transfer's properties.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /transfers APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.TransferParams) (*stripe.Transfer, error)

Get returns the details of a transfer.

func (Client) List

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

List returns a list of transfers.

func (Client) New

func (c Client) New(params *stripe.TransferParams) (*stripe.Transfer, error)

New creates a new transfer.

func (Client) Update

func (c Client) Update(id string, params *stripe.TransferParams) (*stripe.Transfer, error)

Update updates a transfer's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for transfers.

func List

func List(params *stripe.TransferListParams) *Iter

List returns a list of transfers.

func (*Iter) Transfer

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

Transfer returns the transfer which the iterator is currently pointing to.

func (*Iter) TransferList

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

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