reversal

Documentation

Overview

Package reversal provides the /transfers/{id}/reversals APIs

Index

• func Get(id string, params *stripe.ReversalParams) (*stripe.Reversal, error)
• func New(params *stripe.ReversalParams) (*stripe.Reversal, error)
• func Update(id string, params *stripe.ReversalParams) (*stripe.Reversal, error)
• type Client
  • func (c Client) Get(id string, params *stripe.ReversalParams) (*stripe.Reversal, error)
  • func (c Client) List(listParams *stripe.ReversalListParams) *Iter
  • func (c Client) New(params *stripe.ReversalParams) (*stripe.Reversal, error)
  • func (c Client) Update(id string, params *stripe.ReversalParams) (*stripe.Reversal, error)
• type Iter
  • func List(params *stripe.ReversalListParams) *Iter
  • func (i *Iter) Reversal() *stripe.Reversal
  • func (i *Iter) ReversalList() *stripe.ReversalList

Functions

func Get

func Get(id string, params *stripe.ReversalParams) (*stripe.Reversal, error)

Get returns the details of a reversal.

func New

func New(params *stripe.ReversalParams) (*stripe.Reversal, error)

New creates a new reversal.

func Update

func Update(id string, params *stripe.ReversalParams) (*stripe.Reversal, error)

Update updates a reversal's properties.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /transfers/{id}/reversals APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.ReversalParams) (*stripe.Reversal, error)

Get returns the details of a reversal.

func (Client) List

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

List returns a list of reversals.

func (Client) New

func (c Client) New(params *stripe.ReversalParams) (*stripe.Reversal, error)

New creates a new reversal.

func (Client) Update

func (c Client) Update(id string, params *stripe.ReversalParams) (*stripe.Reversal, error)

Update updates a reversal's properties.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for reversals.

func List

func List(params *stripe.ReversalListParams) *Iter

List returns a list of reversals.

func (*Iter) Reversal

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

Reversal returns the reversal which the iterator is currently pointing to.

func (*Iter) ReversalList

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

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