The refund object

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.

Attributes

Field Name

Data Type

Description

id

string

Unique identifier for the object.

type

string

The resource type of the return object. The value is "charge".

status

string

Status of the charge(payment).
pending - Refund is initiated
failed - Refund is failed
succeeded - Refund is succeeded

amount_subunit

integer

Amount intended to be refunded by this Refund. In cents

currency

string

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

metadata

hash

Set 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

charge

hash

The Charge object associates with this Refund

reason

string

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

created_at

integer

A timestamp indicates when the charge is created

reference_id

string

the payment reference id from PSP.