inboundtransfer

Documentation

Overview

Package inboundtransfer provides the /treasury/inbound_transfers APIs

Index

• func Cancel(id string, params *stripe.TreasuryInboundTransferCancelParams) (*stripe.TreasuryInboundTransfer, error)
• func Get(id string, params *stripe.TreasuryInboundTransferParams) (*stripe.TreasuryInboundTransfer, error)
• func New(params *stripe.TreasuryInboundTransferParams) (*stripe.TreasuryInboundTransfer, error)
• type Client
  • func (c Client) Cancel(id string, params *stripe.TreasuryInboundTransferCancelParams) (*stripe.TreasuryInboundTransfer, error)
  • func (c Client) Get(id string, params *stripe.TreasuryInboundTransferParams) (*stripe.TreasuryInboundTransfer, error)
  • func (c Client) List(listParams *stripe.TreasuryInboundTransferListParams) *Iter
  • func (c Client) New(params *stripe.TreasuryInboundTransferParams) (*stripe.TreasuryInboundTransfer, error)
• type Iter
  • func List(params *stripe.TreasuryInboundTransferListParams) *Iter
  • func (i *Iter) TreasuryInboundTransfer() *stripe.TreasuryInboundTransfer
  • func (i *Iter) TreasuryInboundTransferList() *stripe.TreasuryInboundTransferList

Functions

func Cancel

func Cancel(id string, params *stripe.TreasuryInboundTransferCancelParams) (*stripe.TreasuryInboundTransfer, error)

Cancels an InboundTransfer.

func Get

func Get(id string, params *stripe.TreasuryInboundTransferParams) (*stripe.TreasuryInboundTransfer, error)

Retrieves the details of an existing InboundTransfer.

func New

func New(params *stripe.TreasuryInboundTransferParams) (*stripe.TreasuryInboundTransfer, error)

Creates an InboundTransfer.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /treasury/inbound_transfers APIs.

func (Client) Cancel

func (c Client) Cancel(id string, params *stripe.TreasuryInboundTransferCancelParams) (*stripe.TreasuryInboundTransfer, error)

Cancels an InboundTransfer.

func (Client) Get

func (c Client) Get(id string, params *stripe.TreasuryInboundTransferParams) (*stripe.TreasuryInboundTransfer, error)

Retrieves the details of an existing InboundTransfer.

func (Client) List

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

Returns a list of InboundTransfers sent from the specified FinancialAccount.

func (Client) New

func (c Client) New(params *stripe.TreasuryInboundTransferParams) (*stripe.TreasuryInboundTransfer, error)

Creates an InboundTransfer.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for treasury inbound transfers.

func List

func List(params *stripe.TreasuryInboundTransferListParams) *Iter

Returns a list of InboundTransfers sent from the specified FinancialAccount.

func (*Iter) TreasuryInboundTransfer

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

TreasuryInboundTransfer returns the treasury inbound transfer which the iterator is currently pointing to.

func (*Iter) TreasuryInboundTransferList

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

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