transferreversal

Documentation

Overview

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

Index

• func Get(id string, params *stripe.TransferReversalParams) (*stripe.TransferReversal, error)
• func New(params *stripe.TransferReversalParams) (*stripe.TransferReversal, error)
• func Update(id string, params *stripe.TransferReversalParams) (*stripe.TransferReversal, error)
• type Client
  • func (c Client) Get(id string, params *stripe.TransferReversalParams) (*stripe.TransferReversal, error)
  • func (c Client) List(listParams *stripe.TransferReversalListParams) *Iter
  • func (c Client) New(params *stripe.TransferReversalParams) (*stripe.TransferReversal, error)
  • func (c Client) Update(id string, params *stripe.TransferReversalParams) (*stripe.TransferReversal, error)
• type Iter
  • func List(params *stripe.TransferReversalListParams) *Iter
  • func (i *Iter) TransferReversal() *stripe.TransferReversal
  • func (i *Iter) TransferReversalList() *stripe.TransferReversalList

Functions

func Get

func Get(id string, params *stripe.TransferReversalParams) (*stripe.TransferReversal, error)

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

func New

func New(params *stripe.TransferReversalParams) (*stripe.TransferReversal, error)

When you create a new reversal, you must specify a transfer to create it on.

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

Once entirely reversed, a transfer can't be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

func Update

func Update(id string, params *stripe.TransferReversalParams) (*stripe.TransferReversal, error)

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request only accepts metadata and description as arguments.

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.TransferReversalParams) (*stripe.TransferReversal, error)

By default, you can see the 10 most recent reversals stored directly on the transfer object, but you can also retrieve details about a specific reversal stored on the transfer.

func (Client) List

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

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

func (Client) New

func (c Client) New(params *stripe.TransferReversalParams) (*stripe.TransferReversal, error)

When you create a new reversal, you must specify a transfer to create it on.

When reversing transfers, you can optionally reverse part of the transfer. You can do so as many times as you wish until the entire transfer has been reversed.

Once entirely reversed, a transfer can't be reversed again. This method will return an error when called on an already-reversed transfer, or when trying to reverse more money than is left on a transfer.

func (Client) Update

func (c Client) Update(id string, params *stripe.TransferReversalParams) (*stripe.TransferReversal, error)

Updates the specified reversal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

This request only accepts metadata and description as arguments.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for transfer reversals.

func List

func List(params *stripe.TransferReversalListParams) *Iter

You can see a list of the reversals belonging to a specific transfer. Note that the 10 most recent reversals are always available by default on the transfer object. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional reversals.

func (*Iter) TransferReversal

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

TransferReversal returns the transfer reversal which the iterator is currently pointing to.

func (*Iter) TransferReversalList

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

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