Transactions

Cancelar Preauthorization

Changed on

Cancela una autorización diferida que todavía no fue capturada.

Se usa para liberar el monto retenido cuando el cobro no se va a completar: el cuerpo indica la Transaction con la autorización (transaction_reference) y, opcionalmente, el motivo del aborto. Las rutas /cl, /mx y /br son equivalentes: el país con que se contacta al medio de pago lo determina la Organization autenticada, no el prefijo de la ruta.

La cancelación se pide al medio de pago y, si este la acepta, la Transaction queda abortada. La respuesta usa 200 en ambos casos: success en true cuando el medio de pago canceló, y en false con el mensaje del medio de pago en detail cuando la rechazó.

Responde 404 cuando la Transaction no existe, y 400 cuando la Transaction no está en estado CAPTURE_PENDING.

Límite de tasa: 20 solicitudes por segundo. Al superarlo, la API responde 429. Ver Límites de tasa.

post/{country_code}/preauth/cancel

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/{country_code}/preauth/cancel
  • Auth
    API key in header x-api-key

Path parameters

country_code'cl' | 'mx' | 'br' required

País de la organización sobre la que se opera, como primer segmento de la ruta: cl (Chile), mx (México) o br (Brasil).

Headers

x-account-keystring

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

Request body

abort_reasonstring

Motivo con que queda registrado el aborto de la Transaction.

idempotency_keystring

Llave con que se deduplican los reintentos de la cancelación; si se omite, se genera una.

transaction_referencestring required

Identificador público de la Transaction que tiene la autorización a cancelar.

Example request

{
  "abort_reason": "compra_anulada",
  "transaction_reference": "trs_kR3nQ8sT1vX7yZ2aB5cD9eF4gH6jK0mN"
}

Response

Resultado que devolvió el medio de pago para la cancelación.

detailstring

Mensaje complementario de la operación; null cuando no hay mensaje.

successboolean required

Indica si la operación se completó.

Example response

{
  "success": true
}

Changes