class

Stripe::Refund

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

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

Constants

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)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
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

Source

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

Source
amount=(new_value : Int64 | Nil)

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

Source
balance_transaction
Source
balance_transaction=(new_value : Stripe::FeeRefundBalanceTransaction | Nil)

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

Source
charge
Source
charge=(new_value : Stripe::RefundCharge | Nil)

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

Source
created

Time at which the object was created. Measured in seconds since the Unix epoch.

Source
created=(new_value : Int64 | Nil)

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

Source
currency

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

Source
currency=(new_value : String | Nil)

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

Source
description

An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).

Source
description=(new_value : String | Nil)

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

Source
destination_details
Source
destination_details=(new_value : Stripe::RefundDestinationDetails | Nil)

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

Source
failure_balance_transaction
Source
failure_balance_transaction=(new_value : Stripe::RefundFailureBalanceTransaction | Nil)

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

Source
failure_reason

Provides the reason for the refund failure. Possible values are: lost_or_stolen_card, expired_or_canceled_card, charge_for_pending_refund_disputed, insufficient_funds, declined, merchant_request, or unknown.

Source
failure_reason=(new_value : String | Nil)

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

Source
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.

Source
id=(new_value : String | Nil)

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

Source
instructions_email

For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.

Source
instructions_email=(new_value : String | Nil)

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

Source
list_invalid_properties

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

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

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

Source
next_action
Source
next_action=(new_value : Stripe::RefundNextAction | Nil)

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

Source
object

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

Source
object=(new_value : String | Nil)

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

Source
payment_intent
Source
payment_intent=(new_value : Stripe::RefundPaymentIntent | Nil)

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

Source
reason

Reason for the refund, which is either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).

Source
reason=(new_value : String | Nil)

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

Source
receipt_number

This is the transaction number that appears on email receipts sent for this refund.

Source
receipt_number=(new_value : String | Nil)

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

Source
source_transfer_reversal
Source
source_transfer_reversal=(new_value : Stripe::RefundSourceTransferReversal | Nil)

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

Source
status

Status of the refund. This can be pending, requires_action, succeeded, failed, or canceled. Learn more about failed refunds.

Source
status=(new_value : String | Nil)

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

Source
transfer_reversal
Source
transfer_reversal=(new_value : Stripe::RefundTransferReversal | Nil)

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

Source
valid?

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

Source