outboundtransfer

Documentation

Overview

Package outboundtransfer provides the /treasury/outbound_transfers APIs

Index

• func Cancel(id string, params *stripe.TreasuryOutboundTransferCancelParams) (*stripe.TreasuryOutboundTransfer, error)
• func Get(id string, params *stripe.TreasuryOutboundTransferParams) (*stripe.TreasuryOutboundTransfer, error)
• func New(params *stripe.TreasuryOutboundTransferParams) (*stripe.TreasuryOutboundTransfer, error)
• type Client
  • func (c Client) Cancel(id string, params *stripe.TreasuryOutboundTransferCancelParams) (*stripe.TreasuryOutboundTransfer, error)
  • func (c Client) Get(id string, params *stripe.TreasuryOutboundTransferParams) (*stripe.TreasuryOutboundTransfer, error)
  • func (c Client) List(listParams *stripe.TreasuryOutboundTransferListParams) *Iter
  • func (c Client) New(params *stripe.TreasuryOutboundTransferParams) (*stripe.TreasuryOutboundTransfer, error)
• type Iter
  • func List(params *stripe.TreasuryOutboundTransferListParams) *Iter
  • func (i *Iter) TreasuryOutboundTransfer() *stripe.TreasuryOutboundTransfer
  • func (i *Iter) TreasuryOutboundTransferList() *stripe.TreasuryOutboundTransferList

Functions

func Cancel

func Cancel(id string, params *stripe.TreasuryOutboundTransferCancelParams) (*stripe.TreasuryOutboundTransfer, error)

An OutboundTransfer can be canceled if the funds have not yet been paid out.

func Get

func Get(id string, params *stripe.TreasuryOutboundTransferParams) (*stripe.TreasuryOutboundTransfer, error)

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

func New

func New(params *stripe.TreasuryOutboundTransferParams) (*stripe.TreasuryOutboundTransfer, error)

Creates an OutboundTransfer.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /treasury/outbound_transfers APIs.

func (Client) Cancel

func (c Client) Cancel(id string, params *stripe.TreasuryOutboundTransferCancelParams) (*stripe.TreasuryOutboundTransfer, error)

An OutboundTransfer can be canceled if the funds have not yet been paid out.

func (Client) Get

func (c Client) Get(id string, params *stripe.TreasuryOutboundTransferParams) (*stripe.TreasuryOutboundTransfer, error)

Retrieves the details of an existing OutboundTransfer by passing the unique OutboundTransfer ID from either the OutboundTransfer creation request or OutboundTransfer list.

func (Client) List

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

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

func (Client) New

func (c Client) New(params *stripe.TreasuryOutboundTransferParams) (*stripe.TreasuryOutboundTransfer, error)

Creates an OutboundTransfer.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for treasury outbound transfers.

func List

func List(params *stripe.TreasuryOutboundTransferListParams) *Iter

Returns a list of OutboundTransfers sent from the specified FinancialAccount.

func (*Iter) TreasuryOutboundTransfer

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

TreasuryOutboundTransfer returns the treasury outbound transfer which the iterator is currently pointing to.

func (*Iter) TreasuryOutboundTransferList

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

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