Obtener un reembolso

GET

https://app.recurrente.com/api/refunds/:id

GET

/api/refunds/:id

curl https://app.recurrente.com/api/refunds/id \
     -H "X-SECRET-KEY: <apiKey>"

200Retrieved

{
  "id": "re_3jfrywsf",
  "status": "succeeded",
  "failure_reason": "string",
  "customer": {
    "id": "string",
    "email": "string",
    "full_name": "string"
  },
  "user_id": "string",
  "account_id": "ac_restaurant",
  "account_refunded_amount_in_cents": 2187,
  "customer_refunded_amount_in_cents": 2500,
  "refund_application_fee": true,
  "transfer_adjustments": [
    {
      "action": "cancel",
      "transfer_setup_id": "string",
      "amount_in_cents": 1,
      "reversal_transfer_id": "string",
      "restoration_transfer_id": "string",
      "restored_at": "2024-01-15T09:30:00Z"
    }
  ],
  "currency": "GTQ",
  "created_at": "2024-01-15T09:30:00Z",
  "voided_at": "2024-01-15T09:30:00Z"
}

Obtén los detalles de un reembolso específico.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Path parameters

idstringRequired

ID del reembolso

Response

Detalles del reembolso

idstringOptional

ID del reembolso

statusenumOptional

Estado del reembolso

Allowed values:

failure_reasonstring or nullOptional

Razón del fallo. provider_outcome_unknown indica que el resultado debe reconciliarse antes de reintentar

customerobjectOptional

user_idstringOptional

ID del usuario

account_idstringOptional

Cuenta dueña del cobro reembolsado

account_refunded_amount_in_centsintegerOptional

Monto debitado de la cuenta del comercio (en centavos)

customer_refunded_amount_in_centsintegerOptional

Monto devuelto al cliente (en centavos)

refund_application_feebooleanOptional

Si las comisiones de plataforma se devolvieron con el reembolso

transfer_adjustmentslist of objectsOptional

Transfer setups cancelados o revertidos por este reembolso

currencystringOptional

Moneda

created_atdatetimeOptional

Fecha de creación

voided_atdatetime or nullOptional

Fecha de anulación, si el reembolso fue anulado