dispute

Documentation

Overview

Package dispute provides the /disputes APIs

Index

• func Close(id string, params *stripe.DisputeParams) (*stripe.Dispute, error)
• func Get(id string, params *stripe.DisputeParams) (*stripe.Dispute, error)
• func Update(id string, params *stripe.DisputeParams) (*stripe.Dispute, error)
• type Client
  • func (c Client) Close(id string, params *stripe.DisputeParams) (*stripe.Dispute, error)
  • func (c Client) Get(id string, params *stripe.DisputeParams) (*stripe.Dispute, error)
  • func (c Client) List(listParams *stripe.DisputeListParams) *Iter
  • func (c Client) Update(id string, params *stripe.DisputeParams) (*stripe.Dispute, error)
• type Iter
  • func List(params *stripe.DisputeListParams) *Iter
  • func (i *Iter) Dispute() *stripe.Dispute
  • func (i *Iter) DisputeList() *stripe.DisputeList

Functions

func Close

func Close(id string, params *stripe.DisputeParams) (*stripe.Dispute, error)

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

func Get

func Get(id string, params *stripe.DisputeParams) (*stripe.Dispute, error)

Retrieves the dispute with the given ID.

func Update

func Update(id string, params *stripe.DisputeParams) (*stripe.Dispute, error)

When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically.

Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://stripe.com/docs/disputes/categories).

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /disputes APIs.

func (Client) Close

func (c Client) Close(id string, params *stripe.DisputeParams) (*stripe.Dispute, error)

Closing the dispute for a charge indicates that you do not have any evidence to submit and are essentially dismissing the dispute, acknowledging it as lost.

The status of the dispute will change from needs_response to lost. Closing a dispute is irreversible.

func (Client) Get

func (c Client) Get(id string, params *stripe.DisputeParams) (*stripe.Dispute, error)

Retrieves the dispute with the given ID.

func (Client) List

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

Returns a list of your disputes.

func (Client) Update

func (c Client) Update(id string, params *stripe.DisputeParams) (*stripe.Dispute, error)

When you get a dispute, contacting your customer is always the best first step. If that doesn't work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your [dashboard](https://dashboard.stripe.com/disputes), but if you prefer, you can use the API to submit evidence programmatically.

Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our [guide to dispute types](https://stripe.com/docs/disputes/categories).

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for disputes.

func List

func List(params *stripe.DisputeListParams) *Iter

Returns a list of your disputes.

func (*Iter) Dispute

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

Dispute returns the dispute which the iterator is currently pointing to.

func (*Iter) DisputeList

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

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