Anular un reembolso

POST

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

POST

/api/refunds/:id/void

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

1 {
2   "id": "re_3jfrywsf",
3   "status": "succeeded",
4   "failure_reason": "string",
5   "customer": {
6     "id": "string",
7     "email": "string",
8     "full_name": "string"
9   },
10   "user_id": "string",
11   "account_id": "ac_restaurant",
12   "account_refunded_amount_in_cents": 2187,
13   "customer_refunded_amount_in_cents": 2500,
14   "refund_application_fee": true,
15   "transfer_adjustments": [
16     {
17       "action": "cancel",
18       "transfer_setup_id": "string",
19       "amount_in_cents": 1,
20       "reversal_transfer_id": "string",
21       "restoration_transfer_id": "string",
22       "restored_at": "2024-01-15T09:30:00Z"
23     }
24   ],
25   "currency": "GTQ",
26   "created_at": "2024-01-15T09:30:00Z",
27   "voided_at": "2024-01-15T09:30:00Z"
28 }

Anula un reembolso con el proveedor antes del cierre del mismo día. Solo aplica a reembolsos reales; no aplica a anulaciones del pago original.

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.

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.

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. 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

Reembolso anulado

idstringOptional

ID del reembolso

statusenumOptional

Estado del reembolso

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

Errors

422

Unprocessable Entity Error