class Stripe::Refund
- Stripe::Refund
- Reference
- Object
Overview
Refund objects allow you to refund a previously created charge that isn't refunded yet. Funds are refunded to the credit or debit card that's initially charged. Related guide: Refunds
Included Modules
- JSON::Serializable
- JSON::Serializable::Unmapped
- OpenApi::Json
- OpenApi::Validatable
Defined in:
stripe/models/refund.crConstant Summary
-
ERROR_MESSAGE_FOR_OBJECT =
"invalid value for \"object\", must be one of [refund]."
-
ERROR_MESSAGE_FOR_REASON =
"invalid value for \"reason\", must be one of [duplicate, expired_uncaptured_charge, fraudulent, requested_by_customer]."
-
MAX_LENGTH_FOR_DESCRIPTION =
5000
-
MAX_LENGTH_FOR_FAILURE_REASON =
5000
-
MAX_LENGTH_FOR_ID =
5000
-
MAX_LENGTH_FOR_INSTRUCTIONS_EMAIL =
5000
-
MAX_LENGTH_FOR_RECEIPT_NUMBER =
5000
-
MAX_LENGTH_FOR_STATUS =
5000
-
VALID_VALUES_FOR_OBJECT =
String.static_array("refund")
-
VALID_VALUES_FOR_REASON =
String.static_array("duplicate", "expired_uncaptured_charge", "fraudulent", "requested_by_customer")
Constructors
- .new(pull : JSON::PullParser)
-
.new(*, amount : Int64 | Nil = nil, balance_transaction : Stripe::FeeRefundBalanceTransaction | Nil = nil, charge : Stripe::RefundCharge | Nil = nil, created : Int64 | Nil = nil, currency : String | Nil = nil, id : String | Nil = nil, metadata : Hash(String, String) | Nil = nil, object : String | Nil = nil, payment_intent : Stripe::RefundPaymentIntent | Nil = nil, reason : String | Nil = nil, receipt_number : String | Nil = nil, source_transfer_reversal : Stripe::RefundSourceTransferReversal | Nil = nil, status : String | Nil = nil, transfer_reversal : Stripe::RefundTransferReversal | Nil = nil, description : String | Nil = nil, destination_details : Stripe::RefundDestinationDetails | Nil = nil, failure_balance_transaction : Stripe::RefundFailureBalanceTransaction | Nil = nil, failure_reason : String | Nil = nil, instructions_email : String | Nil = nil, next_action : Stripe::RefundNextAction | 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).
- #charge : Stripe::RefundCharge | Nil
-
#charge=(new_value : Stripe::RefundCharge | 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_details : Stripe::RefundDestinationDetails | Nil
-
#destination_details=(new_value : Stripe::RefundDestinationDetails | Nil)
Custom attribute writer method checking allowed values (enum).
- #failure_balance_transaction : Stripe::RefundFailureBalanceTransaction | Nil
-
#failure_balance_transaction=(new_value : Stripe::RefundFailureBalanceTransaction | Nil)
Custom attribute writer method checking allowed values (enum).
- #failure_reason : String | Nil
-
#failure_reason=(new_value : String | 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).
- #instructions_email : String | Nil
-
#instructions_email=(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).
- #next_action : Stripe::RefundNextAction | Nil
-
#next_action=(new_value : Stripe::RefundNextAction | 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).
- #payment_intent : Stripe::RefundPaymentIntent | Nil
-
#payment_intent=(new_value : Stripe::RefundPaymentIntent | Nil)
Custom attribute writer method checking allowed values (enum).
- #reason : String | Nil
-
#reason=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #receipt_number : String | Nil
-
#receipt_number=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #source_transfer_reversal : Stripe::RefundSourceTransferReversal | Nil
-
#source_transfer_reversal=(new_value : Stripe::RefundSourceTransferReversal | Nil)
Custom attribute writer method checking allowed values (enum).
- #status : String | Nil
-
#status=(new_value : String | Nil)
Custom attribute writer method checking allowed values (enum).
- #transfer_reversal : Stripe::RefundTransferReversal | Nil
-
#transfer_reversal=(new_value : Stripe::RefundTransferReversal | 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
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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Instance Method Detail
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] amount Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] balance_transaction Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] charge Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] created Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] currency Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] description Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] destination_details Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] failure_balance_transaction Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] failure_reason Object to be assigned
Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code
Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] instructions_email Object to be assigned
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Custom attribute writer method checking allowed values (enum). @param [Object] metadata Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] next_action Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] payment_intent Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] reason Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] receipt_number Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] source_transfer_reversal Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned
Custom attribute writer method checking allowed values (enum). @param [Object] transfer_reversal Object to be assigned
Check to see if the all the properties in the model are valid @return true if the model is valid