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:

Constant 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

Constructor Detail

Instance Method Detail