The Refund object

The Refund object represents a refund you create against a PaymentIntent. Fintoc returns the Refund object in Refunds API responses and in refund webhook events. The status field tracks the disbursal, from created to in_progress, and then to succeeded, failed, or canceled.

{
  "id": "re_3MjTCxEhuqCR3lNz1NgprEoI",
  "object": "refund",
  "amount": 100,
  "created_at": "2021-10-15T15:23:11.474Z",
  "currency": "CLP",
  "failure_code": null,
  "metadata": {},
  "mode": "live",
  "recipient_account": {
    "holder_id": "111111111",
    "holder_name": "Jane Doe",
    "institution_id": "cl_banco_de_chile",
    "number": "123456789",
    "type": "checking_account"
  },
  "resource_id": "pi_3MjTCxEhuqCR3lNz1FLrtTeH",
  "resource_type": "payment_intent",
  "status": "succeeded",
  "updated_at": "2021-11-15T12:23:11.474Z"
}

Attribute	Type	Description
`id`	`string`	Unique identifier for the refund.
`object`	`string`	Type of the object. Always `refund`.
`amount`	`integer`	Amount refunded, in the smallest currency unit. Greater than `0` and at most the original `PaymentIntent` amount. Defaults to the full `PaymentIntent` amount.
`created_at`	`string`	ISO 8601 datetime in UTC when the refund was created.
`currency`	`string`	Three-letter ISO 4217 currency code, in uppercase. One of `CLP` or `MXN`. Matches the currency of the original `PaymentIntent`.
`failure_code`	`string` or `null`	Reason the refund failed. One of `fraud_risk` (blocked by Fintoc's fraud checks) or `insufficient_funds` (your organization has insufficient funds to cover the refund). `null` unless the refund failed.
`metadata`	`object`	Set of key-value pairs you can attach to the refund, useful for storing additional structured information.
`mode`	`string`	One of `live` or `test`. Always matches the original `PaymentIntent`; you cannot create a `test` refund for a `live` `PaymentIntent`, or the reverse.
`recipient_account`	`object` or `null`	Bank account that receives the refunded funds. `null` for refunds not disbursed by bank transfer, such as card refunds. See The Recipient Account object below.
`resource_id`	`string`	ID of the `PaymentIntent` being refunded.
`resource_type`	`string`	Type of the refunded resource. Always `payment_intent`.
`status`	`string`	Current status of the refund. One of `created`, `in_progress`, `succeeded`, `failed`, or `canceled`.
`updated_at`	`string`	ISO 8601 datetime in UTC when the refund was last updated.

The Recipient Account object (within the Refund object)

Attribute	Type	Description
`holder_id`	`string`	Tax ID of the account holder, without dots or hyphens. In Chile, a Chilean tax ID (RUT); in Mexico, a Mexican tax ID (RFC).
`holder_name`	`string`	Name of the account holder.
`institution_id`	`string`	Identifier of the account's institution. See Chile institution codes.
`number`	`string`	Account number that receives the refunded funds.
`type`	`string`	Type of the bank account. One of `checking_account` or `sight_account`.

Refund statuses

Status	Description
`created`	Fintoc created the refund. Processing starts at 18:00 on the closest business day.
`in_progress`	The refund is processing. The funds arrive in your customer's bank account within 1 to 2 business days.
`succeeded`	Fintoc transferred the refund to your customer's account.
`failed`	Processing the refund failed.
`canceled`	You canceled the refund before processing started.