Stripe.Resources.CustomerCashBalanceTransaction (tiger_stripe v0.3.0)

Copy Markdown View Source

CustomerCashBalanceTransaction

Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer.

Summary

Types

applied_to_payment()
funded()
funded_bank_transfer()
funded_bank_transfer_eu_bank_transfer()
funded_bank_transfer_gb_bank_transfer()
funded_bank_transfer_jp_bank_transfer()
funded_bank_transfer_us_bank_transfer()
t()

Functions

expandable_fields()
object_name()

Types

applied_to_payment()

@type applied_to_payment() :: %{
  optional(:payment_intent) =>
    String.t() | Stripe.Resources.PaymentIntent.t() | nil,
  optional(String.t()) => term()
}

funded()

@type funded() :: %{
  optional(:bank_transfer) => funded_bank_transfer() | nil,
  optional(String.t()) => term()
}
  • bank_transfer

funded_bank_transfer()

@type funded_bank_transfer() :: %{
  optional(:eu_bank_transfer) => funded_bank_transfer_eu_bank_transfer() | nil,
  optional(:gb_bank_transfer) => funded_bank_transfer_gb_bank_transfer() | nil,
  optional(:jp_bank_transfer) => funded_bank_transfer_jp_bank_transfer() | nil,
  optional(:reference) => String.t() | nil,
  optional(:type) => String.t() | nil,
  optional(:us_bank_transfer) => funded_bank_transfer_us_bank_transfer() | nil,
  optional(String.t()) => term()
}
  • eu_bank_transfer
  • gb_bank_transfer
  • jp_bank_transfer
  • reference - The user-supplied reference field on the bank transfer. Max length: 5000. Nullable.
  • type - The funding method type used to fund the customer balance. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer. Possible values: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, us_bank_transfer.
  • us_bank_transfer

funded_bank_transfer_eu_bank_transfer()

@type funded_bank_transfer_eu_bank_transfer() :: %{
  optional(:bic) => String.t() | nil,
  optional(:iban_last4) => String.t() | nil,
  optional(:sender_name) => String.t() | nil,
  optional(String.t()) => term()
}
  • bic - The BIC of the bank of the sender of the funding. Max length: 5000. Nullable.
  • iban_last4 - The last 4 digits of the IBAN of the sender of the funding. Max length: 5000. Nullable.
  • sender_name - The full name of the sender, as supplied by the sending bank. Max length: 5000. Nullable.

funded_bank_transfer_gb_bank_transfer()

@type funded_bank_transfer_gb_bank_transfer() :: %{
  optional(:account_number_last4) => String.t() | nil,
  optional(:sender_name) => String.t() | nil,
  optional(:sort_code) => String.t() | nil,
  optional(String.t()) => term()
}
  • account_number_last4 - The last 4 digits of the account number of the sender of the funding. Max length: 5000. Nullable.
  • sender_name - The full name of the sender, as supplied by the sending bank. Max length: 5000. Nullable.
  • sort_code - The sort code of the bank of the sender of the funding Max length: 5000. Nullable.

funded_bank_transfer_jp_bank_transfer()

@type funded_bank_transfer_jp_bank_transfer() :: %{
  optional(:sender_bank) => String.t() | nil,
  optional(:sender_branch) => String.t() | nil,
  optional(:sender_name) => String.t() | nil,
  optional(String.t()) => term()
}
  • sender_bank - The name of the bank of the sender of the funding. Max length: 5000. Nullable.
  • sender_branch - The name of the bank branch of the sender of the funding. Max length: 5000. Nullable.
  • sender_name - The full name of the sender, as supplied by the sending bank. Max length: 5000. Nullable.

funded_bank_transfer_us_bank_transfer()

@type funded_bank_transfer_us_bank_transfer() :: %{
  optional(:network) => String.t() | nil,
  optional(:sender_name) => String.t() | nil,
  optional(String.t()) => term()
}
  • network - The banking network used for this funding. Possible values: ach, domestic_wire_us, swift.
  • sender_name - The full name of the sender, as supplied by the sending bank. Max length: 5000. Nullable.

t()

@type t() :: %Stripe.Resources.CustomerCashBalanceTransaction{
  adjusted_for_overdraft: Stripe.Resources.AdjustedForOverdraft.t() | nil,
  applied_to_payment: applied_to_payment() | nil,
  created: integer(),
  currency: String.t(),
  customer: String.t() | Stripe.Resources.Customer.t(),
  customer_account: String.t(),
  ending_balance: integer(),
  funded: funded() | nil,
  id: String.t(),
  livemode: boolean(),
  net_amount: integer(),
  object: String.t(),
  refunded_from_payment: Stripe.Resources.RefundedFromPayment.t() | nil,
  transferred_to_balance: Stripe.Resources.TransferredToBalance.t() | nil,
  type: String.t(),
  unapplied_from_payment: Stripe.Resources.UnappliedFromPayment.t() | nil
}
  • adjusted_for_overdraft - Expandable.
  • applied_to_payment - Expandable.
  • created - Time at which the object was created. Measured in seconds since the Unix epoch. Format: Unix timestamp.
  • currency - Three-letter ISO currency code, in lowercase. Must be a supported currency. Max length: 5000.
  • customer - The customer whose available cash balance changed as a result of this transaction. Expandable.
  • customer_account - The ID of an Account representing a customer whose available cash balance changed as a result of this transaction. Max length: 5000. Nullable.
  • ending_balance - The total available cash balance for the specified currency after this transaction was applied. Represented in the smallest currency unit.
  • funded - Expandable.
  • id - Unique identifier for the object. Max length: 5000.
  • livemode - Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • net_amount - The amount by which the cash balance changed, represented in the smallest currency unit. A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance.
  • object - String representing the object's type. Objects of the same type share the same value. Possible values: customer_cash_balance_transaction.
  • refunded_from_payment - Expandable.
  • transferred_to_balance - Expandable.
  • type - The type of the cash balance transaction. New types may be added in future. See Customer Balance to learn more about these types. Possible values: adjusted_for_overdraft, applied_to_payment, funded, funding_reversed, refunded_from_payment, return_canceled, return_initiated, transferred_to_balance, unapplied_from_payment.
  • unapplied_from_payment - Expandable.

Functions

expandable_fields()

object_name()