stripity_stripe

stripity_stripe v2.7.0 Stripe.Issuing.Dispute View Source

Work with Stripe Issuing dispute objects.

You can:

  • Create a dispute
  • Retrieve a dispute
  • Update a dispute
  • List all disputes

Stripe API reference: https://stripe.com/docs/api/issuing/disputes

Link to this section Summary

Types

evidence()
evidence_detail()
t()

Functions

create(params, opts \\ [])

Create a dispute.

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

List all disputes.

retrieve(id, opts \\ [])

Retrieve a dispute.

update(id, params, opts \\ [])

Update a dispute.

Link to this section Types

Link to this type

evidence() View Source 
evidence() :: %{
  fraudulent: evidence_detail() | nil,
  other: evidence_detail() | nil
}

Link to this type

evidence_detail() View Source 
evidence_detail() :: %{
  dispute_explanation: String.t(),
  uncategorized_file: String.t()
}

Link to this type

t() View Source 
t() :: %Stripe.Issuing.Dispute{
  amount: integer(),
  created: Stripe.timestamp(),
  currency: String.t() | nil,
  disputed_transaction: Stripe.id() | Stripe.Issuing.Transaction.t(),
  evidence: evidence(),
  id: Stripe.id(),
  livemode: boolean(),
  metadata: Stripe.Types.metadata(),
  object: String.t(),
  reason: atom() | String.t(),
  status: String.t()
}

Link to this section Functions

Link to this function

create(params, opts \\ []) View Source 
create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params:
       %{
         :disputed_transaction => Stripe.id() | Stripe.Issuing.Transaction.t(),
         :reason => :other | :fradulent,
         optional(:amount) => non_neg_integer(),
         optional(:evidence) => evidence(),
         optional(:metadata) => Stripe.Types.metadata()
       }
       | %{}

Create a dispute.

Link to this function

list(params \\ %{}, opts \\ []) View Source 
list(params, Stripe.options()) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params:
       %{
         optional(:created) => String.t() | Stripe.date_query(),
         optional(:disputed_transaction) =>
           Stripe.Issuing.Transaction.t() | Stripe.id(),
         optional(:ending_before) => t() | Stripe.id(),
         optional(:limit) => 1..100,
         optional(:starting_after) => t() | Stripe.id()
       }
       | %{}

List all disputes.

Link to this function

retrieve(id, opts \\ []) View Source 
retrieve(Stripe.id() | t(), Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}

Retrieve a dispute.

Link to this function

update(id, params, opts \\ []) View Source 
update(Stripe.id() | t(), params, Stripe.options()) ::
  {:ok, t()} | {:error, Stripe.Error.t()}
when params: %{optional(:metadata) => Stripe.Types.metadata()} | %{}

Update a dispute.

Keyboard Shortcuts
×
c
Toggle sidebar
n
Toggle night mode
/ or s
Focus search bar
?
Bring up this help dialog