creditreversal

Documentation

Overview

Package creditreversal provides the /treasury/credit_reversals APIs

Index

• func Get(id string, params *stripe.TreasuryCreditReversalParams) (*stripe.TreasuryCreditReversal, error)
• func New(params *stripe.TreasuryCreditReversalParams) (*stripe.TreasuryCreditReversal, error)
• type Client
  • func (c Client) Get(id string, params *stripe.TreasuryCreditReversalParams) (*stripe.TreasuryCreditReversal, error)
  • func (c Client) List(listParams *stripe.TreasuryCreditReversalListParams) *Iter
  • func (c Client) New(params *stripe.TreasuryCreditReversalParams) (*stripe.TreasuryCreditReversal, error)
• type Iter
  • func List(params *stripe.TreasuryCreditReversalListParams) *Iter
  • func (i *Iter) TreasuryCreditReversal() *stripe.TreasuryCreditReversal
  • func (i *Iter) TreasuryCreditReversalList() *stripe.TreasuryCreditReversalList

Functions

func Get

func Get(id string, params *stripe.TreasuryCreditReversalParams) (*stripe.TreasuryCreditReversal, error)

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

func New

func New(params *stripe.TreasuryCreditReversalParams) (*stripe.TreasuryCreditReversal, error)

Reverses a ReceivedCredit and creates a CreditReversal object.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /treasury/credit_reversals APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.TreasuryCreditReversalParams) (*stripe.TreasuryCreditReversal, error)

Retrieves the details of an existing CreditReversal by passing the unique CreditReversal ID from either the CreditReversal creation request or CreditReversal list

func (Client) List

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

Returns a list of CreditReversals.

func (Client) New

func (c Client) New(params *stripe.TreasuryCreditReversalParams) (*stripe.TreasuryCreditReversal, error)

Reverses a ReceivedCredit and creates a CreditReversal object.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for treasury credit reversals.

func List

func List(params *stripe.TreasuryCreditReversalListParams) *Iter

Returns a list of CreditReversals.

func (*Iter) TreasuryCreditReversal

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

TreasuryCreditReversal returns the treasury credit reversal which the iterator is currently pointing to.

func (*Iter) TreasuryCreditReversalList

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

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