class Stripe::TransferReversal

• Stripe::TransferReversal
• Reference
• Object

Overview

Stripe Connect platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platform's balance and subtract from the destination account's balance. Reversing a transfer that was made for a destination charge is allowed only up to the amount of the charge. It is possible to reverse a transfer_group transfer only if the destination account has enough balance to cover the reversal. Related guide: Reverse 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_reversal]."

MAX_LENGTH_FOR_ID = 5000

VALID_VALUES_FOR_OBJECT = String.static_array("transfer_reversal")

Constructors

• .new(pull : JSON::PullParser)
• .new(*, amount : Int64 | Nil = nil, balance_transaction : Stripe::FeeRefundBalanceTransaction | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, destination_payment_refund : Stripe::TransferReversalDestinationPaymentRefund | Nil = nil, id : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, source_refund : Stripe::TransferReversalSourceRefund | Nil = nil, transfer : Stripe::TransferReversalTransfer | 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).

• #balance_transaction : Stripe::FeeRefundBalanceTransaction | Nil
• #balance_transaction=(new_value : Stripe::FeeRefundBalanceTransaction | 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).

• #destination_payment_refund : Stripe::TransferReversalDestinationPaymentRefund | Nil
• #destination_payment_refund=(new_value : Stripe::TransferReversalDestinationPaymentRefund | 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.

• #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).

• #source_refund : Stripe::TransferReversalSourceRefund | Nil
• #source_refund=(new_value : Stripe::TransferReversalSourceRefund | Nil)

  Custom attribute writer method checking allowed values (enum).

• #transfer : Stripe::TransferReversalTransfer | Nil
• #transfer=(new_value : Stripe::TransferReversalTransfer | 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