exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.Dispute (exoapi_stripe v0.1.4)

description: A dispute occurs when a customer questions your charge with their card issuer. When this happens, you're given the opportunity to respond to the dispute with evidence that shows that the charge is legitimate. You can find more information about the dispute process in our Disputes and Fraud documentation.

Related guide: Disputes and Fraud.

:amount :: :integer

Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).

::balance_transactions :: ExOAPI.Stripe.Schemas.BalanceTransaction

:charge :: ExOAPI.Stripe.Schemas.Charge | :string

ID of the charge that was disputed.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:currency :: :string

Three-letter ISO currency code, in lowercase. Must be a supported currency.

:evidence :: ExOAPI.Stripe.Schemas.DisputeEvidence

:evidence_details :: ExOAPI.Stripe.Schemas.DisputeEvidenceDetails

:id :: :string

Unique identifier for the object.

:is_charge_refundable :: :boolean

If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute.

:livemode :: :boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

:metadata :: :map

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:payment_intent :: ExOAPI.Stripe.Schemas.PaymentIntent | :string

ID of the PaymentIntent that was disputed.

:reason :: :string

Reason given by cardholder for dispute. Possible values are bank_cannot_process, check_returned, credit_not_processed, customer_initiated, debit_not_authorized, duplicate, fraudulent, general, incorrect_account_details, insufficient_funds, product_not_received, product_unacceptable, subscription_canceled, or unrecognized. Read more about dispute reasons.

:status :: :string

Current status of dispute. Possible values are warning_needs_response, warning_under_review, warning_closed, needs_response, under_review, charge_refunded, won, or lost.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.Dispute{
  amount: integer() | nil,
  balance_transactions: [ExOAPI.Stripe.Schemas.BalanceTransaction.t()],
  charge: ExOAPI.EctoTypes.AnyOf.t() | nil,
  created: integer() | nil,
  currency: String.t() | nil,
  evidence: ExOAPI.Stripe.Schemas.DisputeEvidence.t() | nil,
  evidence_details: ExOAPI.Stripe.Schemas.DisputeEvidenceDetails.t() | nil,
  id: String.t() | nil,
  is_charge_refundable: boolean() | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  object: :dispute | nil,
  payment_intent: ExOAPI.EctoTypes.AnyOf.t() | nil,
  reason: String.t() | nil,
  status:
    (:won
     | :warning_under_review
     | :warning_needs_response
     | :warning_closed
     | :under_review
     | :needs_response
     | :lost
     | :charge_refunded)
    | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()