class

Stripe::TreasuryReceivedDebit

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

ReceivedDebits represent funds pulled from a FinancialAccount. These are not initiated from the FinancialAccount.

Constants

ERROR_MESSAGE_FOR_FAILURE_CODE = "invalid value for \"failure_code\", must be one of [account_closed, account_frozen, insufficient_funds, other]."
ERROR_MESSAGE_FOR_NETWORK = "invalid value for \"network\", must be one of [ach, card, stripe]."
ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [treasury.received_debit]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [failed, succeeded]."
MAX_LENGTH_FOR_DESCRIPTION = 5000
MAX_LENGTH_FOR_FINANCIAL_ACCOUNT = 5000
MAX_LENGTH_FOR_HOSTED_REGULATORY_RECEIPT_URL = 5000
MAX_LENGTH_FOR_ID = 5000
VALID_VALUES_FOR_FAILURE_CODE = String.static_array("account_closed", "account_frozen", "insufficient_funds", "other")
VALID_VALUES_FOR_NETWORK = String.static_array("ach", "card", "stripe")
VALID_VALUES_FOR_OBJECT = String.static_array("treasury.received_debit")
VALID_VALUES_FOR_STATUS = String.static_array("failed", "succeeded")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : Int64 | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, description : String | Nil = nil, failure_code : String | Nil = nil, financial_account : String | Nil = nil, hosted_regulatory_receipt_url : String | Nil = nil, id : String | Nil = nil, linked_flows : Stripe::TreasuryReceivedDebitsResourceLinkedFlows | Nil = nil, livemode : Bool | Nil = nil, network : String | Nil = nil, object : String | Nil = nil, reversal_details : Stripe::TreasuryReceivedDebitReversalDetails | Nil = nil, status : String | Nil = nil, transaction : Stripe::TreasuryCreditReversalTransaction | Nil = nil, initiating_payment_method_details : Stripe::TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

amount

Amount (in cents) transferred.

Source
amount=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] amount Object to be assigned

Source
created

Time at which the object was created. Measured in seconds since the Unix epoch.

Source
created=(new_value : Int64 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned

Source
currency

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Source
currency=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned

Source
description

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

Source
description=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned

Source
failure_code

Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen.

Source
failure_code=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] failure_code Object to be assigned

Source
financial_account

The FinancialAccount that funds were pulled from.

Source
financial_account=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] financial_account Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

hosted_regulatory_receipt_url

A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

Source
hosted_regulatory_receipt_url=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] hosted_regulatory_receipt_url Object to be assigned

Source
id

Unique identifier for the object.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
initiating_payment_method_details
Source
initiating_payment_method_details=(new_value : Stripe::TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] initiating_payment_method_details Object to be assigned

Source
linked_flows
Source
linked_flows=(new_value : Stripe::TreasuryReceivedDebitsResourceLinkedFlows | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] linked_flows Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
livemode

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Source
livemode=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned

Source
network

The network used for the ReceivedDebit.

Source
network=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] network Object to be assigned

Source
object

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

Source
object=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned

Source
reversal_details
Source
reversal_details=(new_value : Stripe::TreasuryReceivedDebitReversalDetails | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] reversal_details Object to be assigned

Source
status

Status of the ReceivedDebit. ReceivedDebits are created with a status of either succeeded (approved) or failed (declined). The failure reason can be found under the failure_code.

Source
status=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

Source
transaction
Source
transaction=(new_value : Stripe::TreasuryCreditReversalTransaction | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] transaction Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source