class Stripe::TreasuryOutboundTransfer

Overview

Use OutboundTransfers to transfer funds from a FinancialAccount to a PaymentMethod belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account. Simulate OutboundTransfer state changes with the /v1/test_helpers/treasury/outbound_transfers endpoints. These methods can only be called on test mode objects. Related guide: Moving money with Treasury using OutboundTransfer objects

Included Modules

Defined in:

stripe/models/treasury_outbound_transfer.cr

Constant Summary

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [treasury.outbound_transfer]."
ERROR_MESSAGE_FOR_STATUS = "invalid value for \"status\", must be one of [canceled, failed, posted, processing, returned]."
MAX_LENGTH_FOR_DESCRIPTION = 5000
MAX_LENGTH_FOR_DESTINATION_PAYMENT_METHOD = 5000
MAX_LENGTH_FOR_FINANCIAL_ACCOUNT = 5000
MAX_LENGTH_FOR_HOSTED_REGULATORY_RECEIPT_URL = 5000
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_STATEMENT_DESCRIPTOR = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("treasury.outbound_transfer")
VALID_VALUES_FOR_STATUS = String.static_array("canceled", "failed", "posted", "processing", "returned")

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, amount : Int64 | Nil = nil, cancelable : Bool | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, description : String | Nil = nil, destination_payment_method : String | Nil = nil, destination_payment_method_details : Stripe::OutboundTransfersPaymentMethodDetails | Nil = nil, expected_arrival_date : Int64 | Nil = nil, financial_account : String | Nil = nil, hosted_regulatory_receipt_url : String | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, returned_details : Stripe::TreasuryOutboundTransferReturnedDetails | Nil = nil, statement_descriptor : String | Nil = nil, status : String | Nil = nil, status_transitions : Stripe::TreasuryOutboundTransfersResourceStatusTransitions | Nil = nil, tracking_details : Stripe::TreasuryOutboundTransferTrackingDetails | Nil = nil, transaction : Stripe::TreasuryOutboundPaymentTransaction | Nil = nil) #

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


[View source]

Instance Method Detail

def ==(other : self) #

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


def amount : Int64 | Nil #

[View source]
def amount=(new_value : Int64 | Nil) #

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


[View source]
def cancelable : Bool | Nil #

[View source]
def cancelable=(new_value : Bool | Nil) #

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


[View source]
def created : Int64 | Nil #

[View source]
def created=(new_value : Int64 | Nil) #

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


[View source]
def currency : String | Nil #

[View source]
def currency=(new_value : String | Nil) #

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


[View source]
def description : String | Nil #

[View source]
def description=(new_value : String | Nil) #

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


[View source]
def destination_payment_method : String | Nil #

[View source]
def destination_payment_method=(new_value : String | Nil) #

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


[View source]
def destination_payment_method_details : Stripe::OutboundTransfersPaymentMethodDetails | Nil #

[View source]
def destination_payment_method_details=(new_value : Stripe::OutboundTransfersPaymentMethodDetails | Nil) #

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


[View source]
def expected_arrival_date : Int64 | Nil #

[View source]
def expected_arrival_date=(new_value : Int64 | Nil) #

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


[View source]
def financial_account : String | Nil #

[View source]
def financial_account=(new_value : String | Nil) #

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


[View source]
def hash(hasher) #

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


def hosted_regulatory_receipt_url : String | Nil #

[View source]
def 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


[View source]
def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

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


[View source]
def list_invalid_properties : Array(String) #

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


[View source]
def livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

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


[View source]
def metadata : Hash(String, String) | Nil #

[View source]
def metadata=(new_value : Hash(String, String) | Nil) #

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


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

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


[View source]
def returned_details : Stripe::TreasuryOutboundTransferReturnedDetails | Nil #

[View source]
def returned_details=(new_value : Stripe::TreasuryOutboundTransferReturnedDetails | Nil) #

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


[View source]
def statement_descriptor : String | Nil #

[View source]
def statement_descriptor=(new_value : String | Nil) #

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


[View source]
def status : String | Nil #

[View source]
def status=(new_value : String | Nil) #

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


[View source]

[View source]
def status_transitions=(new_value : Stripe::TreasuryOutboundTransfersResourceStatusTransitions | Nil) #

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


[View source]
def tracking_details : Stripe::TreasuryOutboundTransferTrackingDetails | Nil #

[View source]
def tracking_details=(new_value : Stripe::TreasuryOutboundTransferTrackingDetails | Nil) #

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


[View source]

[View source]
def transaction=(new_value : Stripe::TreasuryOutboundPaymentTransaction | Nil) #

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


[View source]
def valid? : Bool #

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


[View source]