Stripe.Resources.Balance (tiger_stripe v0.3.0)

Copy Markdown View Source

Balance

This is an object representing your Stripe balance. You can retrieve it to see the balance currently on your Stripe account.

The top-level available and pending comprise your "payments balance."

Related guide: Balances and settlement time, Understanding Connect account balances

Summary

Types

available()
available_source_types()
connect_reserved()
connect_reserved_source_types()
instant_available()
instant_available_net_available()
instant_available_net_available_source_types()
instant_available_source_types()
issuing()
issuing_available()
issuing_available_source_types()
pending()
pending_source_types()
refund_and_dispute_prefunding()
refund_and_dispute_prefunding_available()
refund_and_dispute_prefunding_available_source_types()
refund_and_dispute_prefunding_pending()
refund_and_dispute_prefunding_pending_source_types()
t()

Functions

expandable_fields()
object_name()

Types

available()

@type available() :: %{
  optional(:amount) => integer() | nil,
  optional(:currency) => String.t() | nil,
  optional(:source_types) => available_source_types() | nil,
  optional(String.t()) => term()
}

available_source_types()

@type available_source_types() :: %{
  optional(:bank_account) => integer() | nil,
  optional(:card) => integer() | nil,
  optional(:fpx) => integer() | nil,
  optional(String.t()) => term()
}

connect_reserved()

@type connect_reserved() :: %{
  optional(:amount) => integer() | nil,
  optional(:currency) => String.t() | nil,
  optional(:source_types) => connect_reserved_source_types() | nil,
  optional(String.t()) => term()
}

connect_reserved_source_types()

@type connect_reserved_source_types() :: %{
  optional(:bank_account) => integer() | nil,
  optional(:card) => integer() | nil,
  optional(:fpx) => integer() | nil,
  optional(String.t()) => term()
}

instant_available()

@type instant_available() :: %{
  optional(:amount) => integer() | nil,
  optional(:currency) => String.t() | nil,
  optional(:net_available) => [instant_available_net_available()] | nil,
  optional(:source_types) => instant_available_source_types() | nil,
  optional(String.t()) => term()
}
  • amount - Balance amount.
  • currency - Three-letter ISO currency code, in lowercase. Must be a supported currency. Format: ISO 4217 currency code.
  • net_available - Breakdown of balance by destination.
  • source_types

instant_available_net_available()

@type instant_available_net_available() :: %{
  optional(:amount) => integer() | nil,
  optional(:destination) => String.t() | nil,
  optional(:source_types) =>
    instant_available_net_available_source_types() | nil,
  optional(String.t()) => term()
}
  • amount - Net balance amount, subtracting fees from platform-set pricing.
  • destination - ID of the external account for this net balance (not expandable). Max length: 5000.
  • source_types

instant_available_net_available_source_types()

@type instant_available_net_available_source_types() :: %{
  optional(:bank_account) => integer() | nil,
  optional(:card) => integer() | nil,
  optional(:fpx) => integer() | nil,
  optional(String.t()) => term()
}

instant_available_source_types()

@type instant_available_source_types() :: %{
  optional(:bank_account) => integer() | nil,
  optional(:card) => integer() | nil,
  optional(:fpx) => integer() | nil,
  optional(String.t()) => term()
}

issuing()

@type issuing() :: %{
  optional(:available) => [issuing_available()] | nil,
  optional(String.t()) => term()
}
  • available - Funds that are available for use.

issuing_available()

@type issuing_available() :: %{
  optional(:amount) => integer() | nil,
  optional(:currency) => String.t() | nil,
  optional(:source_types) => issuing_available_source_types() | nil,
  optional(String.t()) => term()
}

issuing_available_source_types()

@type issuing_available_source_types() :: %{
  optional(:bank_account) => integer() | nil,
  optional(:card) => integer() | nil,
  optional(:fpx) => integer() | nil,
  optional(String.t()) => term()
}

pending()

@type pending() :: %{
  optional(:amount) => integer() | nil,
  optional(:currency) => String.t() | nil,
  optional(:source_types) => pending_source_types() | nil,
  optional(String.t()) => term()
}

pending_source_types()

@type pending_source_types() :: %{
  optional(:bank_account) => integer() | nil,
  optional(:card) => integer() | nil,
  optional(:fpx) => integer() | nil,
  optional(String.t()) => term()
}

refund_and_dispute_prefunding()

@type refund_and_dispute_prefunding() :: %{
  optional(:available) => [refund_and_dispute_prefunding_available()] | nil,
  optional(:pending) => [refund_and_dispute_prefunding_pending()] | nil,
  optional(String.t()) => term()
}
  • available - Funds that are available for use.
  • pending - Funds that are pending

refund_and_dispute_prefunding_available()

@type refund_and_dispute_prefunding_available() :: %{
  optional(:amount) => integer() | nil,
  optional(:currency) => String.t() | nil,
  optional(:source_types) =>
    refund_and_dispute_prefunding_available_source_types() | nil,
  optional(String.t()) => term()
}

refund_and_dispute_prefunding_available_source_types()

@type refund_and_dispute_prefunding_available_source_types() :: %{
  optional(:bank_account) => integer() | nil,
  optional(:card) => integer() | nil,
  optional(:fpx) => integer() | nil,
  optional(String.t()) => term()
}

refund_and_dispute_prefunding_pending()

@type refund_and_dispute_prefunding_pending() :: %{
  optional(:amount) => integer() | nil,
  optional(:currency) => String.t() | nil,
  optional(:source_types) =>
    refund_and_dispute_prefunding_pending_source_types() | nil,
  optional(String.t()) => term()
}

refund_and_dispute_prefunding_pending_source_types()

@type refund_and_dispute_prefunding_pending_source_types() :: %{
  optional(:bank_account) => integer() | nil,
  optional(:card) => integer() | nil,
  optional(:fpx) => integer() | nil,
  optional(String.t()) => term()
}

t()

@type t() :: %Stripe.Resources.Balance{
  available: [available()],
  connect_reserved: [connect_reserved()] | nil,
  instant_available: [instant_available()] | nil,
  issuing: issuing() | nil,
  livemode: boolean(),
  object: String.t(),
  pending: [pending()],
  refund_and_dispute_prefunding: refund_and_dispute_prefunding() | nil
}
  • available - Available funds that you can transfer or pay out automatically by Stripe or explicitly through the Transfers API or Payouts API. You can find the available balance for each currency and payment type in the source_types property. Expandable.
  • connect_reserved - Funds held due to negative balances on connected accounts where account.controller.requirement_collection is application, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the source_types property. Expandable.
  • instant_available - Funds that you can pay out using Instant Payouts. Expandable.
  • issuing - Expandable.
  • livemode - Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • object - String representing the object's type. Objects of the same type share the same value. Possible values: balance.
  • pending - Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the source_types property. Expandable.
  • refund_and_dispute_prefunding - Expandable.

Functions

expandable_fields()

object_name()