dispute

Documentation

Overview

Package dispute provides the /issuing/disputes APIs

Index

• func Get(id string, params *stripe.IssuingDisputeParams) (*stripe.IssuingDispute, error)
• func New(params *stripe.IssuingDisputeParams) (*stripe.IssuingDispute, error)
• func Submit(id string, params *stripe.IssuingDisputeSubmitParams) (*stripe.IssuingDispute, error)
• func Update(id string, params *stripe.IssuingDisputeParams) (*stripe.IssuingDispute, error)
• type Client
  • func (c Client) Get(id string, params *stripe.IssuingDisputeParams) (*stripe.IssuingDispute, error)
  • func (c Client) List(listParams *stripe.IssuingDisputeListParams) *Iter
  • func (c Client) New(params *stripe.IssuingDisputeParams) (*stripe.IssuingDispute, error)
  • func (c Client) Submit(id string, params *stripe.IssuingDisputeSubmitParams) (*stripe.IssuingDispute, error)
  • func (c Client) Update(id string, params *stripe.IssuingDisputeParams) (*stripe.IssuingDispute, error)
• type Iter
  • func List(params *stripe.IssuingDisputeListParams) *Iter
  • func (i *Iter) IssuingDispute() *stripe.IssuingDispute
  • func (i *Iter) IssuingDisputeList() *stripe.IssuingDisputeList

Functions

func Get

func Get(id string, params *stripe.IssuingDisputeParams) (*stripe.IssuingDispute, error)

Retrieves an Issuing Dispute object.

func New

func New(params *stripe.IssuingDisputeParams) (*stripe.IssuingDispute, error)

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements.

func Submit

func Submit(id string, params *stripe.IssuingDisputeSubmitParams) (*stripe.IssuingDispute, error)

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence).

func Update

func Update(id string, params *stripe.IssuingDisputeParams) (*stripe.IssuingDispute, error)

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /issuing/disputes APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.IssuingDisputeParams) (*stripe.IssuingDispute, error)

Retrieves an Issuing Dispute object.

func (Client) List

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

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

func (Client) New

func (c Client) New(params *stripe.IssuingDisputeParams) (*stripe.IssuingDispute, error)

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence) for more details about evidence requirements.

func (Client) Submit

func (c Client) Submit(id string, params *stripe.IssuingDisputeSubmitParams) (*stripe.IssuingDispute, error)

Submits an Issuing Dispute to the card network. Stripe validates that all evidence fields required for the dispute's reason are present. For more details, see [Dispute reasons and evidence](https://stripe.com/docs/issuing/purchases/disputes#dispute-reasons-and-evidence).

func (Client) Update

func (c Client) Update(id string, params *stripe.IssuingDisputeParams) (*stripe.IssuingDispute, error)

Updates the specified Issuing Dispute object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence object can be unset by passing in an empty string.

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for issuing disputes.

func List

func List(params *stripe.IssuingDisputeListParams) *Iter

Returns a list of Issuing Dispute objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

func (*Iter) IssuingDispute

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

IssuingDispute returns the issuing dispute which the iterator is currently pointing to.

func (*Iter) IssuingDisputeList

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

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