exoapi_stripe v0.1.4

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

description: Stripe Connect platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platform's balance and subtract from the destination account's balance.

Reversing a transfer that was made for a destination charge is allowed only up to the amount of the charge. It is possible to reverse a transfer_group transfer only if the destination account has enough balance to cover the reversal.

Related guide: Reversing Transfers.

:amount :: :integer

Amount, in %s.

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

Balance transaction that describes the impact on your account balance.

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

:destination_payment_refund :: ExOAPI.Stripe.Schemas.Refund | :string

Linked payment refund for the transfer reversal.

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

:object :: :string

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

:source_refund :: ExOAPI.Stripe.Schemas.Refund | :string

ID of the refund responsible for the transfer reversal.

:transfer :: ExOAPI.Stripe.Schemas.Transfer | :string

ID of the transfer that was reversed.

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.TransferReversal{
  amount: integer() | nil,
  balance_transaction: ExOAPI.EctoTypes.AnyOf.t() | nil,
  created: integer() | nil,
  currency: String.t() | nil,
  destination_payment_refund: ExOAPI.EctoTypes.AnyOf.t() | nil,
  id: String.t() | nil,
  metadata: map() | nil,
  object: :transfer_reversal | nil,
  source_refund: ExOAPI.EctoTypes.AnyOf.t() | nil,
  transfer: 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()