dispute

Documentation

Overview

Package dispute provides the dispute-related APIs

Index

• Constants
• func Close(id string) (*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) (*stripe.Dispute, error)
  • func (c Client) Get(id string, params *stripe.DisputeParams) (*stripe.Dispute, error)
  • func (c Client) List(params *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

Constants

const (
	Duplicate    stripe.DisputeReason = "duplicate"
	Fraudulent   stripe.DisputeReason = "fraudulent"
	SubCanceled  stripe.DisputeReason = "subscription_canceled"
	Unacceptable stripe.DisputeReason = "product_unacceptable"
	NotReceived  stripe.DisputeReason = "product_not_received"
	Unrecognized stripe.DisputeReason = "unrecognized"
	Credit       stripe.DisputeReason = "credit_not_processed"
	General      stripe.DisputeReason = "general"

	Won             stripe.DisputeStatus = "won"
	Lost            stripe.DisputeStatus = "lost"
	Response        stripe.DisputeStatus = "needs_response"
	Review          stripe.DisputeStatus = "under_review"
	WarningResponse stripe.DisputeStatus = "warning_needs_response"
	WarningReview   stripe.DisputeStatus = "warning_under_review"
	ChargeRefunded  stripe.DisputeStatus = "charge_refunded"
	WarningClosed   stripe.DisputeStatus = "warning_closed"
)

Functions

func Close

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

Close dismisses a dispute in the customer's favor. For more details see https://stripe.com/docs/api#close_dispute.

func Get

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

Get returns the details of a dispute. For more details see https://stripe.com/docs/api#retrieve_dispute.

func Update

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

Update updates a dispute. For more details see https://stripe.com/docs/api#update_dispute.

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke dispute-related APIs.

func (Client) Close

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

func (Client) Get

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

func (Client) List

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

func (Client) Update

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

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for lists of Disputes. The embedded Iter carries methods with it; see its documentation for details.

func List

func List(params *stripe.DisputeListParams) *Iter

List returns a list of disputes. For more details see https://stripe.com/docs/api#list_disputes.

func (*Iter) Dispute

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

Dispute returns the most recent Dispute visited by a call to Next.