Search documentation of stripe_elixir

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

Copy Markdown View Source

IssuingDispute

As a card issuer, you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.

Related guide: Issuing disputes

## Summary

### Functions

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

Create a dispute

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

List all disputes

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

Retrieve a dispute

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

Submit a dispute

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

Update a dispute

## Functions

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

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

Create a dispute

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 for more details about evidence requirements.

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

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

List all disputes

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.

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

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

Retrieve a dispute

Retrieves an Issuing `Dispute` object.

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

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

Submit a dispute

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.

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

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

Update a dispute

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.