Stripe.Dispute (stripity_stripe v2.17.2) View Source
Work with Stripe disputes.
You can:
- Retrieve a dispute
- Update a dispute
- Close a dispute
- List disputes
Stripe API reference: https://stripe.com/docs/api/disputes
Link to this section Summary
Link to this section Types
Specs
dispute_evidence() :: %{ access_activity_log: String.t() | nil, billing_address: String.t() | nil, cancellation_policy: Stripe.id() | Stripe.FileUpload.t() | nil, cancellation_policy_disclosure: String.t() | nil, cancellation_rebuttal: String.t() | nil, customer_communication: Stripe.id() | Stripe.FileUpload.t() | nil, customer_email_address: String.t() | nil, customer_name: String.t() | nil, customer_purchase_ip: String.t() | nil, customer_signature: Stripe.id() | Stripe.FileUpload.t() | nil, duplicate_charge_documentation: Stripe.id() | Stripe.FileUpload.t() | nil, duplicate_charge_explanation: String.t() | nil, duplicate_charge_id: Stripe.id() | nil, product_description: String.t() | nil, receipt: Stripe.id() | Stripe.FileUpload.t() | nil, refund_policy: Stripe.id() | Stripe.FileUpload.t() | nil, refund_policy_disclosure: String.t() | nil, refund_refusal_explanation: String.t() | nil, service_date: String.t() | nil, service_documentation: Stripe.id() | Stripe.FileUpload.t() | nil, shipping_address: String.t() | nil, shipping_carrier: String.t() | nil, shipping_date: String.t() | nil, shipping_documentation: Stripe.id() | Stripe.FileUpload.t() | nil, shipping_tracking_number: Stripe.id() | Stripe.FileUpload.t() | nil, uncategorized_file: Stripe.id() | Stripe.FileUpload.t() | nil, uncategorized_text: String.t() | nil }
Specs
dispute_evidence_details() :: %{ due_by: Stripe.timestamp() | nil, has_evidence: boolean(), past_due: boolean(), submission_count: integer() }
Specs
dispute_reason() :: String.t()
Specs
dispute_status() :: String.t()
Specs
t() :: %Stripe.Dispute{ amount: integer(), balance_transactions: [Stripe.BalanceTransaction.t()], charge: Stripe.id() | Stripe.Charge.t(), created: Stripe.timestamp(), currency: String.t(), evidence: dispute_evidence(), evidence_details: dispute_evidence_details(), id: Stripe.id(), is_charge_refundable: boolean(), livemode: boolean(), metadata: %{optional(String.t()) => String.t()}, object: String.t(), payment_intent: Stripe.id() | Stripe.PaymentIntent.t() | nil, reason: dispute_reason(), status: dispute_status() }
Link to this section Functions
Specs
close(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Close a dispute.
Specs
list(params, Stripe.options()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()} when params: %{ optional(:created) => String.t() | Stripe.date_query(), optional(:ending_before) => t() | Stripe.id(), optional(:limit) => 1..100, optional(:starting_after) => t() | Stripe.id() } | %{}
List all disputes.
Specs
retrieve(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieve a dispute.
Specs
update(Stripe.id() | t(), params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{ optional(:evidence) => dispute_evidence(), optional(:metadata) => Stripe.Types.metadata(), optional(:submit) => boolean() } | %{}
Update a dispute.