exoapi_stripe v0.1.4

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

description: Refund objects allow you to refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.

Related guide: Refunds.

:amount :: :integer

Amount, in %s.

:balance_transaction :: ExOAPI.Stripe.Schemas.BalanceTransaction | :string

Balance transaction that describes the impact on your account balance.

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

ID of the charge that was refunded.

: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.

:description :: :string

An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)

:failure_balance_transaction :: ExOAPI.Stripe.Schemas.BalanceTransaction | :string

If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.

:failure_reason :: :string

If the refund failed, the reason for refund failure if known. Possible values are lost_or_stolen_card, expired_or_canceled_card, or unknown.

:id :: :string

Unique identifier for the object.

: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.

:next_action :: ExOAPI.Stripe.Schemas.RefundNextAction

: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 refunded.

:reason :: :string

Reason for the refund, either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).

:receipt_number :: :string

This is the transaction number that appears on email receipts sent for this refund.

:source_transfer_reversal :: ExOAPI.Stripe.Schemas.TransferReversal | :string

The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details.

:status :: :string

Status of the refund. For credit card refunds, this can be pending, succeeded, or failed. For other types of refunds, it can be pending, succeeded, failed, or canceled. Refer to our refunds documentation for more details.

:transfer_reversal :: ExOAPI.Stripe.Schemas.TransferReversal | :string

If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.

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.Refund{
  amount: integer() | nil,
  balance_transaction: ExOAPI.EctoTypes.AnyOf.t() | nil,
  charge: ExOAPI.EctoTypes.AnyOf.t() | nil,
  created: integer() | nil,
  currency: String.t() | nil,
  description: String.t() | nil,
  failure_balance_transaction: ExOAPI.EctoTypes.AnyOf.t() | nil,
  failure_reason: String.t() | nil,
  id: String.t() | nil,
  metadata: map() | nil,
  next_action: ExOAPI.Stripe.Schemas.RefundNextAction.t() | nil,
  object: :refund | nil,
  payment_intent: ExOAPI.EctoTypes.AnyOf.t() | nil,
  reason:
    (:requested_by_customer
     | :fraudulent
     | :expired_uncaptured_charge
     | :duplicate)
    | nil,
  receipt_number: String.t() | nil,
  source_transfer_reversal: ExOAPI.EctoTypes.AnyOf.t() | nil,
  status: String.t() | nil,
  transfer_reversal: ExOAPI.EctoTypes.AnyOf.t() | nil
}

Link to this section Functions

Link to this function

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

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