class

Stripe::TreasuryInboundTransfer

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

Use InboundTransfers to add funds to your FinancialAccount via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit. Related guide: Moving money with Treasury using InboundTransfer objects

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [treasury.inbound_transfer]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [canceled, failed, processing, 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
MAX_LENGTH_FOR_ORIGIN_PAYMENT_METHOD = 5000
MAX_LENGTH_FOR_STATEMENT_DESCRIPTOR = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("treasury.inbound_transfer")
VALID_VALUES_FOR_STATUS = String.static_array("canceled", "failed", "processing", "succeeded")

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, amount : Int64 | Nil = nil, cancelable : Bool | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, description : String | Nil = nil, failure_details : Stripe::TreasuryInboundTransferFailureDetails | Nil = nil, financial_account : String | Nil = nil, hosted_regulatory_receipt_url : String | Nil = nil, id : String | Nil = nil, linked_flows : Stripe::TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, origin_payment_method : String | Nil = nil, origin_payment_method_details : Stripe::TreasuryInboundTransferOriginPaymentMethodDetails | Nil = nil, returned : Bool | Nil = nil, statement_descriptor : String | Nil = nil, status : String | Nil = nil, status_transitions : Stripe::TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions | Nil = nil, transaction : Stripe::TreasuryCreditReversalTransaction | 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
cancelable

Returns true if the InboundTransfer is able to be canceled.

Source
cancelable=(new_value : Bool | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] cancelable 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_details
Source
failure_details=(new_value : Stripe::TreasuryInboundTransferFailureDetails | Nil)

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

Source
financial_account

The FinancialAccount that received the funds.

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
linked_flows
Source
linked_flows=(new_value : Stripe::TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows | 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
metadata
Source
metadata=(new_value : Hash(String, String) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] metadata 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
origin_payment_method

The origin payment method to be debited for an InboundTransfer.

Source
origin_payment_method=(new_value : String | Nil)

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

Source
origin_payment_method_details
Source
origin_payment_method_details=(new_value : Stripe::TreasuryInboundTransferOriginPaymentMethodDetails | Nil)

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

Source
returned

Returns true if the funds for an InboundTransfer were returned after the InboundTransfer went to the succeeded state.

Source
returned=(new_value : Bool | Nil)

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

Source
statement_descriptor

Statement descriptor shown when funds are debited from the source. Not all payment networks support statement_descriptor.

Source
statement_descriptor=(new_value : String | Nil)

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

Source
status

Status of the InboundTransfer: processing, succeeded, failed, and canceled. An InboundTransfer is processing if it is created and pending. The status changes to succeeded once the funds have been "confirmed" and a transaction is created and posted. The status changes to failed if the transfer fails.

Source
status=(new_value : String | Nil)

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

Source
status_transitions
Source
status_transitions=(new_value : Stripe::TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status_transitions 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