exoapi_stripe v0.1.4

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

description: A Payout object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, as well as list all payouts. Payouts are made on varying schedules, depending on your country and industry.

Related guide: Receiving Payouts.

:amount :: :integer

Amount (in %s) to be transferred to your bank account or debit card.

:arrival_date :: :integer

Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.

:automatic :: :boolean

Returns true if the payout was created by an automated payout schedule, and false if it was requested manually.

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

ID of the balance transaction that describes the impact of this payout 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.

:description :: :string

An arbitrary string attached to the object. Often useful for displaying to users.

:destination :: ExOAPI.Stripe.Schemas.DeletedCard | ExOAPI.Stripe.Schemas.DeletedBankAccount | ExOAPI.Stripe.Schemas.Card | ExOAPI.Stripe.Schemas.BankAccount | :string

ID of the bank account or card the payout was sent to.

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

If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.

:failure_code :: :string

Error code explaining reason for payout failure if available. See Types of payout failures for a list of failure codes.

:failure_message :: :string

Message to user further explaining reason for payout failure if available.

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

:method :: :string

The method used to send this payout, which can be standard or instant. instant is only supported for payouts to debit cards. (See Instant payouts for marketplaces for more information.)

:object :: :string

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

:original_payout :: ExOAPI.Stripe.Schemas.Payout | :string

If the payout reverses another, this is the ID of the original payout.

:reversed_by :: ExOAPI.Stripe.Schemas.Payout | :string

If the payout was reversed, this is the ID of the payout that reverses this payout.

:source_type :: :string

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

:statement_descriptor :: :string

Extra information about a payout to be displayed on the user's bank statement.

:status :: :string

Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it is submitted to the bank, when it becomes in_transit. The status then changes to paid if the transaction goes through, or to failed or canceled (within 5 business days). Some failed payouts may initially show as paid but then change to failed.

:type :: :string

Can be bank_account or card.

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.Payout{
  amount: integer() | nil,
  arrival_date: integer() | nil,
  automatic: boolean() | 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,
  failure_balance_transaction: ExOAPI.EctoTypes.AnyOf.t() | nil,
  failure_code: String.t() | nil,
  failure_message: String.t() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  method: String.t() | nil,
  object: :payout | nil,
  original_payout: ExOAPI.EctoTypes.AnyOf.t() | nil,
  reversed_by: ExOAPI.EctoTypes.AnyOf.t() | nil,
  source_type: String.t() | nil,
  statement_descriptor: String.t() | nil,
  status: String.t() | nil,
  type: (:card | :bank_account) | nil
}

Link to this section Functions

Link to this function

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

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