class Stripe::Transfer

• Stripe::Transfer
• Reference
• Object

Overview

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

Included Modules

• JSON::Serializable
• JSON::Serializable::Unmapped
• OpenApi::Json
• OpenApi::Validatable

Defined in:

Constant Summary

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(*, 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 Method Summary

• #==(other : self)

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

• #amount : Int64 | Nil
• #amount=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #amount_reversed : Int64 | Nil
• #amount_reversed=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #created : Int64 | Nil
• #created=(new_value : Int64 | Nil)

  Custom attribute writer method checking allowed values (enum).

• #currency : String | Nil
• #currency=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #description : String | Nil
• #description=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #hash(hasher)

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

• #id : String | Nil
• #id=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #list_invalid_properties : Array(String)

  Show invalid properties with the reasons.

• #livemode : Bool | Nil
• #livemode=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #object : String | Nil
• #object=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #reversed : Bool | Nil
• #reversed=(new_value : Bool | Nil)

  Custom attribute writer method checking allowed values (enum).

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

  Custom attribute writer method checking allowed values (enum).

• #source_type : String | Nil
• #source_type=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #transfer_group : String | Nil
• #transfer_group=(new_value : String | Nil)

  Custom attribute writer method checking allowed values (enum).

• #valid? : Bool

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

Constructor Detail

Instance Method Detail