Refund Object

{
  "id": "re_3MjTCxEhuqCR3lNz1NgprEoI",
  "object": "refund",
  "resource_type": "payment_intent",
  "resource_id": "pi_3MjTCxEhuqCR3lNz1FLrtTeH",
  "amount": 100,
  "created_at": "2021-10-15T15:23:11.474Z",
  "updated_at": "2021-11-15T12:23:11.474Z",
  "currency": "clp",
  "status": "succeeded",
  "mode": "live",
  "metadata": {}
}
AttributeTypeDescription
idstringUnique identifier for the Refund Object
objectstringString representing the object’s type. Its value for refund's will always correspond to refund.
resource_typestringCan take one possible value: PaymentIntent.
resource_idstringReferences the PaymentIntent ID to be refunded.
amountintegerAmount to refund, represented as an integer. This value must always be greater than 0, and less than or equal to the corresponding PaymentIntent amount. Default is entire PaymentIntent amount.
currencystringCurrency ISO code. For now, we support CLP and MXN.
created_atstringRefund's creation date, using ISO 8601 format.
updated_atstringRefund's object last updated date, using ISO 8601 format.
statusstringRefund status. Can be pendingin_progress, succeededfailed or canceled.
modestringIndicates whether the Refund is in live mode or in test mode (for the sandbox). This is strictly dependent on the original object mode (i.e. you can’t create a test Refund for a live PaymentIntent or viceversa).
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.

Refund statuses

StatusDescription
createdThe refund has been created and it will start processing at 18:00 of the closest business day
in_progressThe refund is processing and should arrive to your customer's bank account in 1 or 2 business days.
succeededThe refund has been transferred successfully to your customer's account.
failedAn error occurred while processing the refund.
canceledMerchant requested to cancel created refund.