Stripe.Resources.Treasury.ReceivedCredit (tiger_stripe v0.3.0)

Copy Markdown View Source

TreasuryReceivedCreditsResourceReceivedCredit

ReceivedCredits represent funds sent to a FinancialAccount (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.

Summary

Types

initiating_payment_method_details()
linked_flows()
linked_flows_source_flow_details()
reversal_details()
t()

Functions

expandable_fields()
object_name()

Types

initiating_payment_method_details()

@type initiating_payment_method_details() :: %{
  optional(:balance) => String.t() | nil,
  optional(:billing_details) => Stripe.Resources.BillingDetails.t() | nil,
  optional(:financial_account) => Stripe.Resources.FinancialAccount.t() | nil,
  optional(:issuing_card) => String.t() | nil,
  optional(:type) => String.t() | nil,
  optional(:us_bank_account) => Stripe.Resources.UsBankAccount.t() | nil,
  optional(String.t()) => term()
}
  • balance - Set when type is balance. Possible values: payments.
  • billing_details
  • financial_account
  • issuing_card - Set when type is issuing_card. This is an Issuing Card ID. Max length: 5000.
  • type - Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount. Possible values: balance, financial_account, issuing_card, stripe, us_bank_account.
  • us_bank_account

linked_flows()

@type linked_flows() :: %{
  optional(:credit_reversal) => String.t() | nil,
  optional(:issuing_authorization) => String.t() | nil,
  optional(:issuing_transaction) => String.t() | nil,
  optional(:source_flow) => String.t() | nil,
  optional(:source_flow_details) => linked_flows_source_flow_details() | nil,
  optional(:source_flow_type) => String.t() | nil,
  optional(String.t()) => term()
}
  • credit_reversal - The CreditReversal created as a result of this ReceivedCredit being reversed. Max length: 5000. Nullable.
  • issuing_authorization - Set if the ReceivedCredit was created due to an Issuing Authorization object. Max length: 5000. Nullable.
  • issuing_transaction - Set if the ReceivedCredit is also viewable as an Issuing transaction object. Max length: 5000. Nullable.
  • source_flow - ID of the source flow. Set if network is stripe and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals. Max length: 5000. Nullable.
  • source_flow_details - The expandable object of the source flow. Nullable.
  • source_flow_type - The type of flow that originated the ReceivedCredit (for example, outbound_payment). Max length: 5000. Nullable.

linked_flows_source_flow_details()

@type linked_flows_source_flow_details() :: %{
  optional(:credit_reversal) =>
    Stripe.Resources.Treasury.CreditReversal.t() | nil,
  optional(:outbound_payment) =>
    Stripe.Resources.Treasury.OutboundPayment.t() | nil,
  optional(:outbound_transfer) =>
    Stripe.Resources.Treasury.OutboundTransfer.t() | nil,
  optional(:payout) => Stripe.Resources.Payout.t() | nil,
  optional(:type) => String.t() | nil,
  optional(String.t()) => term()
}
  • credit_reversal
  • outbound_payment
  • outbound_transfer
  • payout
  • type - The type of the source flow that originated the ReceivedCredit. Possible values: credit_reversal, other, outbound_payment, outbound_transfer, payout.

reversal_details()

@type reversal_details() :: %{
  optional(:deadline) => integer() | nil,
  optional(:restricted_reason) => String.t() | nil,
  optional(String.t()) => term()
}
  • deadline - Time before which a ReceivedCredit can be reversed. Format: Unix timestamp. Nullable.
  • restricted_reason - Set if a ReceivedCredit cannot be reversed. Possible values: already_reversed, deadline_passed, network_restricted, other, source_flow_restricted. Nullable.

t()

@type t() :: %Stripe.Resources.Treasury.ReceivedCredit{
  amount: integer(),
  created: integer(),
  currency: String.t(),
  description: String.t(),
  failure_code: String.t(),
  financial_account: String.t(),
  hosted_regulatory_receipt_url: String.t(),
  id: String.t(),
  initiating_payment_method_details: initiating_payment_method_details(),
  linked_flows: linked_flows(),
  livemode: boolean(),
  network: String.t(),
  object: String.t(),
  reversal_details: reversal_details(),
  status: String.t(),
  transaction: String.t() | Stripe.Resources.Treasury.Transaction.t()
}
  • amount - Amount (in cents) transferred.
  • 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. Format: ISO 4217 currency code.
  • description - An arbitrary string attached to the object. Often useful for displaying to users. Max length: 5000.
  • failure_code - Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen. Possible values: account_closed, account_frozen, international_transaction, other. Nullable.
  • financial_account - The FinancialAccount that received the funds. Max length: 5000. Nullable.
  • hosted_regulatory_receipt_url - A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses. Max length: 5000. Nullable.
  • id - Unique identifier for the object. Max length: 5000.
  • initiating_payment_method_details - Expandable.
  • linked_flows - Expandable.
  • livemode - Has the value true if the object exists in live mode or the value false if the object exists in test mode.
  • network - The rails used to send the funds. Possible values: ach, card, stripe, us_domestic_wire.
  • object - String representing the object's type. Objects of the same type share the same value. Possible values: treasury.received_credit.
  • reversal_details - Details describing when a ReceivedCredit may be reversed. Nullable. Expandable.
  • status - Status of the ReceivedCredit. ReceivedCredits are created either succeeded (approved) or failed (declined). If a ReceivedCredit is declined, the failure reason can be found in the failure_code field. Possible values: failed, succeeded.
  • transaction - The Transaction associated with this object. Nullable. Expandable.

Functions

expandable_fields()

object_name()