exoapi_stripe v0.1.4

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

description: A Transfer object is created when you move funds between Stripe accounts as part of Connect.

Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a Payout object, with corresponding payout endpoints. For more information, read about the transfer/payout split.

Related guide: Creating Separate Charges and Transfers.

:amount :: :integer

Amount in %s to be transferred.

:amount_reversed :: :integer

Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).

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

Balance transaction that describes the impact of this transfer on your account balance.

:created :: :integer

Time that this record of the transfer was first created.

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

:destination :: ExOAPI.Stripe.Schemas.Account | :string

ID of the Stripe account the transfer was sent to.

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

If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer.

:id :: :string

Unique identifier for the object.

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

::data :: ExOAPI.Stripe.Schemas.TransferReversal

:has_more :: :boolean

True if this list has another page of items after this one that can be fetched.

:object :: :string

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

:url :: :string

The URL where this list can be accessed.

:reversed :: :boolean

Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.

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

ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance.

:source_type :: :string

The source balance this transfer came from. One of card, fpx, or bank_account.

:transfer_group :: :string

A string that identifies this transaction as part of a group. See the Connect documentation for details.

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.Transfer{
  amount: integer() | nil,
  amount_reversed: integer() | nil,
  balance_transaction: ExOAPI.EctoTypes.AnyOf.t() | nil,
  created: integer() | nil,
  currency: String.t() | nil,
  description: String.t() | nil,
  destination: ExOAPI.EctoTypes.AnyOf.t() | nil,
  destination_payment: ExOAPI.EctoTypes.AnyOf.t() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  object: :transfer | nil,
  reversals: map() | nil,
  reversed: boolean() | nil,
  source_transaction: ExOAPI.EctoTypes.AnyOf.t() | nil,
  source_type: String.t() | nil,
  transfer_group: String.t() | nil
}

Link to this section Functions

Link to this function

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

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