recipient

Documentation

Overview

Package recipient provides the /recipients APIs

Index

• Constants
• func Del(id string) error
• func Get(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
• func New(params *stripe.RecipientParams) (*stripe.Recipient, error)
• func Update(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
• type Client
  • func (c Client) Del(id string) error
  • func (c Client) Get(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
  • func (c Client) List(params *stripe.RecipientListParams) *Iter
  • func (c Client) New(params *stripe.RecipientParams) (*stripe.Recipient, error)
  • func (c Client) Update(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)
• type Iter
  • func List(params *stripe.RecipientListParams) *Iter
  • func (i *Iter) Meta() *stripe.ListMeta
  • func (i *Iter) Next() (*stripe.Recipient, error)
  • func (i *Iter) Stop() bool

Constants

const (
	Individual stripe.RecipientType = "individual"
	Corp       stripe.RecipientType = "corporation"

	NewAccount       stripe.BankAccountStatus = "new"
	VerifiedAccount  stripe.BankAccountStatus = "verified"
	ValidatedAccount stripe.BankAccountStatus = "validated"
	ErroredAccount   stripe.BankAccountStatus = "errored"
)

Functions

func Del

func Del(id string) error

Del removes a recipient. For more details see https://stripe.com/docs/api#delete_recipient.

func Get

func Get(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

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

func New

func New(params *stripe.RecipientParams) (*stripe.Recipient, error)

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

func Update

func Update(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

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

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /recipients APIs.

func (Client) Del

func (c Client) Del(id string) error

func (Client) Get

func (c Client) Get(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

func (Client) List

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

func (Client) New

func (c Client) New(params *stripe.RecipientParams) (*stripe.Recipient, error)

func (Client) Update

func (c Client) Update(id string, params *stripe.RecipientParams) (*stripe.Recipient, error)

type Iter

type Iter struct {
	Iter *stripe.Iter
}

Iter is a iterator for list responses.

func List

func List(params *stripe.RecipientListParams) *Iter

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

func (*Iter) Meta

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

Meta returns the list metadata.

func (*Iter) Next

func (i *Iter) Next() (*stripe.Recipient, 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.