Packages

Complete Stripe SDK for Elixir with parity to the official Ruby SDK. V1+V2 coverage (193 services, 320 resource structs, 525 documented params). Per-event modules, Finch HTTP/2, RustyJSON, automatic retries, OAuth, webhooks, telemetry, per-client config, streaming pagination.

Current section

Files

Jump to
tiger_stripe lib stripe params issuing dispute_create_params.ex
Raw

lib/stripe/params/issuing/dispute_create_params.ex

# File generated from our OpenAPI spec
defmodule Stripe.Params.Issuing.DisputeCreateParams do
@moduledoc "Parameters for dispute create."
@typedoc """
* `amount` - The dispute amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If not set, defaults to the full transaction amount.
* `evidence` - Evidence provided for the dispute.
* `expand` - Specifies which fields in the response should be expanded.
* `metadata` - Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
* `transaction` - The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`. Max length: 5000.
* `treasury` - Params for disputes related to Treasury FinancialAccounts
"""
@type t :: %__MODULE__{
amount: integer() | nil,
evidence: map() | nil,
expand: [String.t()] | nil,
metadata: map() | nil,
transaction: String.t() | nil,
treasury: map() | nil
}
defstruct [:amount, :evidence, :expand, :metadata, :transaction, :treasury]
defmodule Evidence do
@moduledoc "Nested parameters."
@typedoc """
* `canceled` - Evidence provided when `reason` is 'canceled'.
* `duplicate` - Evidence provided when `reason` is 'duplicate'.
* `fraudulent` - Evidence provided when `reason` is 'fraudulent'.
* `merchandise_not_as_described` - Evidence provided when `reason` is 'merchandise_not_as_described'.
* `no_valid_authorization` - Evidence provided when `reason` is 'no_valid_authorization'.
* `not_received` - Evidence provided when `reason` is 'not_received'.
* `other` - Evidence provided when `reason` is 'other'.
* `reason` - The reason for filing the dispute. The evidence should be submitted in the field of the same name. Possible values: `canceled`, `duplicate`, `fraudulent`, `merchandise_not_as_described`, `no_valid_authorization`, `not_received`, `other`, `service_not_as_described`.
* `service_not_as_described` - Evidence provided when `reason` is 'service_not_as_described'.
"""
@type t :: %__MODULE__{
canceled: map() | nil,
duplicate: map() | nil,
fraudulent: map() | nil,
merchandise_not_as_described: map() | nil,
no_valid_authorization: map() | nil,
not_received: map() | nil,
other: map() | nil,
reason: String.t() | nil,
service_not_as_described: map() | nil
}
defstruct [
:canceled,
:duplicate,
:fraudulent,
:merchandise_not_as_described,
:no_valid_authorization,
:not_received,
:other,
:reason,
:service_not_as_described
]
end
defmodule Treasury do
@moduledoc "Nested parameters."
@typedoc """
* `received_debit` - The ID of the ReceivedDebit to initiate an Issuings dispute for. Max length: 5000.
"""
@type t :: %__MODULE__{
received_debit: String.t() | nil
}
defstruct [:received_debit]
end
end