exoapi_stripe v0.1.4

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

description: To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID.

Related guide: Topping Up your Platform Account.

:amount :: :integer

Amount transferred.

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

ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.

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

:expected_availability_date :: :integer

Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.

:failure_code :: :string

Error code explaining reason for top-up failure if available (see the errors section for a list of codes).

:failure_message :: :string

Message to user further explaining reason for top-up 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.

:object :: :string

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

:source :: ExOAPI.Stripe.Schemas.Source

:statement_descriptor :: :string

Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.

:status :: :string

The status of the top-up is either canceled, failed, pending, reversed, or succeeded.

:transfer_group :: :string

A string that identifies this top-up as part of a group.

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.Topup{
  amount: integer() | nil,
  balance_transaction: ExOAPI.EctoTypes.AnyOf.t() | nil,
  created: integer() | nil,
  currency: String.t() | nil,
  description: String.t() | nil,
  expected_availability_date: integer() | nil,
  failure_code: String.t() | nil,
  failure_message: String.t() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  metadata: map() | nil,
  object: :topup | nil,
  source: ExOAPI.Stripe.Schemas.Source.t() | nil,
  statement_descriptor: String.t() | nil,
  status: (:succeeded | :reversed | :pending | :failed | :canceled) | 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()