payout

Documentation

Overview

Package payout provides the /payouts APIs

Index

• Constants
• func Cancel(id string, params *stripe.PayoutParams) (*stripe.Payout, error)
• func Get(id string, params *stripe.PayoutParams) (*stripe.Payout, error)
• func New(params *stripe.PayoutParams) (*stripe.Payout, error)
• func Update(id string, params *stripe.PayoutParams) (*stripe.Payout, error)
• type Client
  • func (c Client) Cancel(id string, params *stripe.PayoutParams) (*stripe.Payout, error)
  • func (c Client) Get(id string, params *stripe.PayoutParams) (*stripe.Payout, error)
  • func (c Client) List(params *stripe.PayoutListParams) *Iter
  • func (c Client) New(params *stripe.PayoutParams) (*stripe.Payout, error)
  • func (c Client) Update(id string, params *stripe.PayoutParams) (*stripe.Payout, error)
• type Iter
  • func List(params *stripe.PayoutListParams) *Iter
  • func (i *Iter) Payout() *stripe.Payout

Constants

const (
	Canceled stripe.PayoutStatus = "canceled"
	Failed   stripe.PayoutStatus = "failed"
	Paid     stripe.PayoutStatus = "paid"
	Pending  stripe.PayoutStatus = "pending"
	Transit  stripe.PayoutStatus = "in_transit"

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

	SourceAlipay  stripe.PayoutSourceType = "alipay_account"
	SourceBank    stripe.PayoutSourceType = "bank_account"
	SourceBitcoin stripe.PayoutSourceType = "bitcoin_receiver"
	SourceCard    stripe.PayoutSourceType = "card"

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

Functions

func Cancel

func Cancel(id string, params *stripe.PayoutParams) (*stripe.Payout, error)

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

func Get

func Get(id string, params *stripe.PayoutParams) (*stripe.Payout, error)

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

func New

func New(params *stripe.PayoutParams) (*stripe.Payout, error)

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

func Update

func Update(id string, params *stripe.PayoutParams) (*stripe.Payout, error)

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

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /payouts APIs.

func (Client) Cancel

func (c Client) Cancel(id string, params *stripe.PayoutParams) (*stripe.Payout, error)

func (Client) Get

func (c Client) Get(id string, params *stripe.PayoutParams) (*stripe.Payout, error)

func (Client) List

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

func (Client) New

func (c Client) New(params *stripe.PayoutParams) (*stripe.Payout, error)

func (Client) Update

func (c Client) Update(id string, params *stripe.PayoutParams) (*stripe.Payout, error)

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for lists of Payouts. The embedded Iter carries methods with it; see its documentation for details.

func List

func List(params *stripe.PayoutListParams) *Iter

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

func (*Iter) Payout

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

Payout returns the most recent Payout visited by a call to Next.