Revierte un pago

POST

payment

{id}

cancel_or_refund

curl -X POST https://api.therius.io/v1/payment/9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e/cancel_or_refund \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001"
  }'

{
  "id": "9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e",
  "status": "cancelled",
  "paymentCode": "PC-1234567890",
  "orderCode": "ORDER-20240101-002",
  "merchantCode": "MERCHANT_001",
  "amount": { "currency": "USD", "value": 9900, "exponent": 2 }
}

Si no quieres rastrear en tu propio sistema si un pago está en el estado authorized o captured, POST /payment/{id}/cancel_or_refund lo maneja por ti. Therius verifica el estado actual del pago y automáticamente cancela la autorización (si no está capturada) o emite un reembolso total (si ya está capturada). Esto es especialmente útil en flujos de reversión de pedidos donde el estado del pago puede variar según el momento — por ejemplo, un cliente que cancela un pedido mientras el cumplimiento está en curso.

Identificar el pago

{id} es el id de pago de Therius devuelto por POST /payment/authorization y POST /payment/purchase. orderCode y paymentCode son tus propios campos de referencia y no se aceptan aquí. Un id desconocido o no propio devuelve 404.

Este endpoint siempre revierte el pago completo — anula toda la retención de autorización, o reembolsa todo el monto capturado. Para emitir un reembolso parcial en un pago capturado, llama a Refund con un amount en su lugar.

Ejemplo

Revertir un pago sin conocer su estado

curl -X POST https://api.therius.io/v1/payment/9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e/cancel_or_refund \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001"
  }'

{
  "id": "9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e",
  "status": "cancelled",
  "paymentCode": "PC-1234567890",
  "orderCode": "ORDER-20240101-002",
  "merchantCode": "MERCHANT_001",
  "amount": { "currency": "USD", "value": 9900, "exponent": 2 }
}

Respuesta cuando el pago estaba capturado (ruta de reembolso) — 200 OK

{
  "id": "9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e",
  "status": "refunded",
  "paymentCode": "PC-1234567890",
  "orderCode": "ORDER-20240101-001",
  "merchantCode": "MERCHANT_001",
  "amount": { "currency": "USD", "value": 4999, "exponent": 2 }
}

Este endpoint es ideal para flujos de reversión de pedidos disparados por tu UI de cancelación de cara al cliente, donde la misma ruta de código maneja tanto los estados previos a la captura como los posteriores. Usa el status en la respuesta para determinar qué acción se tomó y actualiza tus registros internos en consecuencia.

Autorizaciones

Authorization

string

header

requerido

Your secret API key: Bearer prv_production_xxx (production) or Bearer prv_sandbox_xxx (sandbox).

Encabezados

Idempotency-Key

string<uuid>

A UUID you generate per operation. Required in production. Retrying with the same key returns the original response.

Parámetros de ruta

string<uuid>

requerido

The Therius payment id returned by POST /payment/authorization or POST /payment/purchase.

Cuerpo

application/json

merchantCode

string

requerido

Your merchant account identifier. Validated against the Bearer key's merchant; required if the key maps to more than one merchant account.

reference

string

Optional internal reference for this operation.

Respuesta

200 - application/json

Reverse result

Result of a capture, refund, cancel or cancel_or_refund.

string

The Therius payment id.

merchantCode

string

orderCode

string

paymentCode

string

Therius receipt ID.

amount

object

Show child attributes

status

enum<string>

Outcome of the operation.

Opciones disponibles:

captured,

refunded,

cancelled,

failed

curl -X POST https://api.therius.io/v1/payment/9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e/cancel_or_refund \
  -H "Authorization: Bearer prv_production_your_key_here" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "merchantCode": "MERCHANT_001"
  }'

{
  "id": "9f8b2c1e-4d5a-6b7c-8d9e-0f1a2b3c4d5e",
  "status": "cancelled",
  "paymentCode": "PC-1234567890",
  "orderCode": "ORDER-20240101-002",
  "merchantCode": "MERCHANT_001",
  "amount": { "currency": "USD", "value": 9900, "exponent": 2 }
}

Pagos

Tokenización

Suscripciones

Planes

Sesión del SDK

Revierte un pago

Identificar el pago

Ejemplo

Revertir un pago sin conocer su estado

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta

​Identificar el pago

​Ejemplo

​Revertir un pago sin conocer su estado

Autorizaciones

Encabezados

Parámetros de ruta

Cuerpo

Respuesta

Identificar el pago

Ejemplo

Revertir un pago sin conocer su estado