payout

Documentation

Overview

Package payout provides the /payouts APIs

Index

• 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 Reverse(id string, params *stripe.PayoutReverseParams) (*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(listParams *stripe.PayoutListParams) *Iter
  • func (c Client) New(params *stripe.PayoutParams) (*stripe.Payout, error)
  • func (c Client) Reverse(id string, params *stripe.PayoutReverseParams) (*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
  • func (i *Iter) PayoutList() *stripe.PayoutList

Functions

func Cancel

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

Cancel is the method for the `POST /v1/payouts/{payout}/cancel` API.

func Get

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

Get returns the details of a payout.

func New

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

New creates a new payout.

func Reverse

func Reverse(id string, params *stripe.PayoutReverseParams) (*stripe.Payout, error)

Reverse is the method for the `POST /v1/payouts/{payout}/reverse` API.

func Update

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

Update updates a payout's properties.

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)

Cancel is the method for the `POST /v1/payouts/{payout}/cancel` API.

func (Client) Get

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

Get returns the details of a payout.

func (Client) List

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

List returns a list of payouts.

func (Client) New

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

New creates a new payout.

func (Client) Reverse

func (c Client) Reverse(id string, params *stripe.PayoutReverseParams) (*stripe.Payout, error)

Reverse is the method for the `POST /v1/payouts/{payout}/reverse` API.

func (Client) Update

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

Update updates a payout's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for payouts.

func List

func List(params *stripe.PayoutListParams) *Iter

List returns a list of payouts.

func (*Iter) Payout

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

Payout returns the payout which the iterator is currently pointing to.

func (*Iter) PayoutList

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

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