Search documentation of stripe_elixir

# StripeElixir.Services.DisputeService (stripe_elixir v0.1.0)

Copy Markdown View Source

Dispute

A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate.

Related guide: Disputes and fraud

## Summary

### Functions

close(client, dispute, params \\ %{}, opts \\ [])

Close a dispute

list(client, params \\ %{}, opts \\ [])

List all disputes

retrieve(client, dispute, params \\ %{}, opts \\ [])

Retrieve a dispute

update(client, dispute, params \\ %{}, opts \\ [])

Update a dispute

## Functions

# close(client, dispute, params \\ %{}, opts \\ [])

    @spec close(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Close a dispute

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.

# list(client, params \\ %{}, opts \\ [])

    @spec list(StripeElixir.Client.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

List all disputes

Returns a list of your disputes.

# retrieve(client, dispute, params \\ %{}, opts \\ [])

    @spec retrieve(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Retrieve a dispute

Retrieves the dispute with the given ID.

# update(client, dispute, params \\ %{}, opts \\ [])

    @spec update(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
      {:ok, term()} | {:error, StripeElixir.Error.t()}

Update a dispute

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, 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.