Refund objects allow you to refund a charge that has previously been created but not yet refunded. Funds will be refunded to the credit or debit card that was originally charged.


Field NameData TypeDescription
idstringUnique identifier for the object.
typestringThe resource type of the return object. The value is "charge".
statusstringStatus of the charge(payment).
pending - Refund is initiated
failed - Refund is failed
succeeded - Refund is succeeded
amount_subunitintegerAmount intended to be refunded by this Refund. In cents
currencystringThree-letter ISO currency code, in lowercase. Must be a supported currency.
metadatahashSet of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

gateway_metadata is reserved keyword used by Elements, original request metadata contains "gateway_metadata" will be rejected
chargehashThe Charge object associates with this Refund
reasonstringReason for the refund, either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).
created_atintegerA timestamp indicates when the charge is created
reference_idstringthe payment reference id from PSP.