transfer

Documentation

Overview

Package transfer provides the /transfers APIs

Index

• Constants
• func Cancel(id string, params *stripe.TransferParams) (*stripe.Transfer, error)
• 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) Cancel(id string, params *stripe.TransferParams) (*stripe.Transfer, error)
  • func (c Client) Get(id string, params *stripe.TransferParams) (*stripe.Transfer, error)
  • func (c Client) List(params *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) Meta() *stripe.ListMeta
  • func (i *Iter) Next() (*stripe.Transfer, error)
  • func (i *Iter) Stop() bool

Constants

const (
	Paid     stripe.TransferStatus = "paid"
	Pending  stripe.TransferStatus = "pending"
	Failed   stripe.TransferStatus = "failed"
	Canceled stripe.TransferStatus = "canceled"

	Card stripe.TransferType = "card"
	Bank stripe.TransferType = "bank_account"

	InsufficientFunds    stripe.TransferFailCode = "insufficient_funds"
	AccountClosed        stripe.TransferFailCode = "account_closed"
	NoAccount            stripe.TransferFailCode = "no_account"
	InvalidAccountNumber stripe.TransferFailCode = "invalid_account_number"
	DebitNotAuth         stripe.TransferFailCode = "debit_not_authorized"
	BankOwnerChanged     stripe.TransferFailCode = "bank_ownership_changed"
	AccountFrozen        stripe.TransferFailCode = "account_frozen"
	CouldNotProcess      stripe.TransferFailCode = "could_not_process"
	BankAccountRestrict  stripe.TransferFailCode = "bank_account_restricted"
	InvalidCurrency      stripe.TransferFailCode = "invalid_currency"
)

Functions

func Cancel

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

Cancel cancels a pending transfer. For more details see https://stripe.com/docs/api#cancel_transfer.

func Get

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

Get returns the details of a transfer. For more details see https://stripe.com/docs/api#retrieve_transfer.

func New

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

New POSTs a new transfer. For more details see https://stripe.com/docs/api#create_transfer.

func Update

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

Update updates a transfer's properties. For more details see https://stripe.com/docs/api#update_transfer.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /transfers APIs.

func (Client) Cancel

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

func (Client) Get

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

func (Client) List

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

func (Client) New

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

func (Client) Update

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

type Iter

type Iter struct {
	Iter *stripe.Iter
}

Iter is a iterator for list responses.

func List

func List(params *stripe.TransferListParams) *Iter

List returns a list of transfers. For more details see https://stripe.com/docs/api#list_transfers.

func (*Iter) Meta

func (i *Iter) Meta() *stripe.ListMeta

Meta returns the list metadata.

func (*Iter) Next

func (i *Iter) Next() (*stripe.Transfer, error)

Next returns the next value in the list.

func (*Iter) Stop

func (i *Iter) Stop() bool

Stop returns true if there are no more iterations to be performed.