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)

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can't cancel automatic Stripe payouts.

func Get

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

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

func New

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

To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://stripe.com/docs/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error.

If your API key is in test mode, money won't actually be sent, though every other action occurs as if you're in live mode.

If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://stripe.com/docs/api#balance_object) details available and pending amounts by source type.

func Reverse

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

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

func Update

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

Updates the specified payout by setting the values of the parameters you pass. We don't change parameters that you don't provide. This request only accepts the metadata as arguments.

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)

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can't cancel automatic Stripe payouts.

func (Client) Get

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

Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.

func (Client) List

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

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

func (Client) New

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

To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://stripe.com/docs/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error.

If your API key is in test mode, money won't actually be sent, though every other action occurs as if you're in live mode.

If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://stripe.com/docs/api#balance_object) details available and pending amounts by source type.

func (Client) Reverse

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

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

func (Client) Update

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

Updates the specified payout by setting the values of the parameters you pass. We don't change parameters that you don't provide. This request only accepts the metadata as arguments.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for payouts.

func List

func List(params *stripe.PayoutListParams) *Iter

Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.

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.