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)

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

func New

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

To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://stripe.com/docs/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.

func Update

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

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request accepts only metadata as an argument.

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)

Retrieves the details of an existing transfer. Supply the unique transfer ID from either a transfer creation request or the transfer list, and Stripe will return the corresponding transfer information.

func (Client) List

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

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

func (Client) New

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

To send funds from your Stripe account to a connected account, you create a new transfer object. Your [Stripe balance](https://stripe.com/docs/api#balance) must be able to cover the transfer amount, or you'll receive an “Insufficient Funds” error.

func (Client) Update

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

Updates the specified transfer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request accepts only metadata as an argument.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for transfers.

func List

func List(params *stripe.TransferListParams) *Iter

Returns a list of existing transfers sent to connected accounts. The transfers are returned in sorted order, with the most recently created transfers appearing first.

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.