Saltar al contenido principal
GET
Get a refund
v1 · Base URL https://api.fintoc.com/v1

Autorizaciones

Authorization
string
header
requerido

Parámetros de ruta

id
string
requerido

The id of the refund to retrieve.

Respuesta

The refund with the given id.

A refund returns funds from a succeeded payment to the payer. Fintoc disburses refunds asynchronously, so a refund moves through pending, in_progress, and succeeded, or ends in failed or canceled. The amount and currency are denominated in the smallest unit of the refunded resource's currency.

id
string
requerido

Unique identifier of the refund.

Ejemplo:

"ref_8XzNbCv1LqKjWp4R"

object
any
requerido

Type of the object. Always refund.

amount
integer
requerido

Amount refunded, as an integer in the smallest unit of currency (for example, 5000 for $5000 CLP, since CLP has no minor unit).

Ejemplo:

5000

created_at
string<date-time>
requerido

ISO 8601 timestamp of when the refund was created.

Ejemplo:

"2026-03-04T17:04:10Z"

currency
enum<string>
requerido

Three-letter ISO 4217 currency code. Always matches the currency of the refunded resource.

Opciones disponibles:
CLP,
MXN
Ejemplo:

"CLP"

failure_code
string | null
requerido

Reason why the refund failed. One of fraud_risk (the disbursement was blocked by Fintoc's fraud checks) or insufficient_funds (your organization did not have enough funds to cover the refund). null unless the refund failed.

metadata
object
requerido

Set of key-value pairs attached to the refund when it was created.

Ejemplo:
mode
enum<string>
requerido

Mode of the object. live objects use real institution data, test objects use fake data for integration testing.

Opciones disponibles:
test,
live
Ejemplo:

"live"

recipient_account
object | null
requerido

Bank account that receives the refunded funds. null for refunds that are not disbursed by bank transfer (for example, card refunds).

resource_id
string
requerido

ID of the refunded resource.

Ejemplo:

"pi_jsperFI9bnyM2RTo"

resource_type
enum<string>
requerido

Type of the refunded resource. Always payment_intent.

Opciones disponibles:
payment_intent
Ejemplo:

"payment_intent"

status
enum<string>
requerido

Current status of the refund. One of pending (the disbursement has not started), in_progress (Fintoc is disbursing the funds), succeeded (the funds reached the recipient account), failed (the disbursement failed; see failure_code), or canceled (the refund was canceled before disbursing).

Opciones disponibles:
pending,
in_progress,
succeeded,
failed,
canceled
Ejemplo:

"succeeded"

updated_at
string<date-time>
requerido

ISO 8601 timestamp of when the refund was last updated.

Ejemplo:

"2026-03-04T17:04:10Z"