class

Stripe::Transfer

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

A Transfer object is created when you move funds between Stripe accounts as part of Connect. Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a Payout object, with corresponding payout endpoints. For more information, read about the transfer/payout split. Related guide: Creating separate charges and transfers

Constants

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [transfer]."

MAX_LENGTH_FOR_DESCRIPTION = 5000

MAX_LENGTH_FOR_ID = 5000

MAX_LENGTH_FOR_SOURCE_TYPE = 5000

MAX_LENGTH_FOR_TRANSFER_GROUP = 5000

VALID_VALUES_FOR_OBJECT = String.static_array("transfer")

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, amount : Int64 | Nil = nil, amount_reversed : Int64 | Nil = nil, balance_transaction : Stripe::TransferBalanceTransaction | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, description : String | Nil = nil, destination : Stripe::TransferDestination | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, reversals : Stripe::TransferReversalList | Nil = nil, reversed : Bool | Nil = nil, source_transaction : Stripe::TransferSourceTransaction | Nil = nil, transfer_group : String | Nil = nil, destination_payment : Stripe::TransferDestinationPayment | Nil = nil, source_type : String | Nil = nil)

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

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 (or local equivalent) to be transferred.

amount=(new_value : Int64 | Nil)

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

amount_reversed

Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).

amount_reversed=(new_value : Int64 | Nil)

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

balance_transaction

balance_transaction=(new_value : Stripe::TransferBalanceTransaction | Nil)

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

created

Time that this record of the transfer was first created.

created=(new_value : Int64 | Nil)

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

currency

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

currency=(new_value : String | Nil)

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

description

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

description=(new_value : String | Nil)

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

destination

destination=(new_value : Stripe::TransferDestination | Nil)

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

destination_payment

destination_payment=(new_value : Stripe::TransferDestinationPayment | Nil)

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

hash(hasher)

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

id

Unique identifier for the object.

id=(new_value : String | Nil)

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

list_invalid_properties

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

livemode

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

livemode=(new_value : Bool | Nil)

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

metadata

metadata=(new_value : Hash(String, String) | Nil)

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

object

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

object=(new_value : String | Nil)

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

reversals

reversals=(new_value : Stripe::TransferReversalList | Nil)

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

reversed

Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false.

reversed=(new_value : Bool | Nil)

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

source_transaction

source_transaction=(new_value : Stripe::TransferSourceTransaction | Nil)

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

source_type

The source balance this transfer came from. One of card, fpx, or bank_account.

source_type=(new_value : String | Nil)

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

transfer_group

A string that identifies this transaction as part of a group. See the Connect documentation for details.

transfer_group=(new_value : String | Nil)

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

valid?

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