Ir al contenido

API

En esta página

Cancelar

Cancela un retiro pendiente antes de que empiece la firma de la transacción, entiende qué estados permiten la cancelación y procesa la respuesta actualizada.

POST/v1/withdrawals/:withdrawal_id/cancel

Clave de API: Payout

Cancela un retiro cuya ejecución todavía no ha empezado. La ventana se cierra en el momento en que Paymos se pone a trabajar en el envío, algo que sucede mientras el retiro sigue en created, antes de firmar nada. Por eso el estado created no garantiza por sí solo que el retiro siga siendo cancelable: una vez arrancada la ejecución, la llamada devuelve 409. Cancelar un retiro ya cancelado no tiene efecto: devuelve 200 con ese mismo retiro, no un error.

Cuerpo de la petición

Envía un reason (obligatorio, máximo 500 caracteres). Paymos lo guarda en el retiro y lo registra en el historial de auditoría. No te vuelve: ni la respuesta de la cancelación ni el webhook withdrawal.cancelled llevan el motivo, solo el estado.

{
  "reason": "Customer requested cancellation"
}

Respuesta (200 OK)

{
  "withdrawal_id": "wdr_2M8K6Q4P9X1Z7A3B",
  "external_order_id": "payout-001",
  "status": "cancelled",
  "is_final": true,
  "is_test": true,
  "amount": "100.00",
  "currency": "USDT",
  "network": "TRC20",
  "destination_address": "TN3W4H6rK2ce4vX9YnFQHwKENnHjoxb3m9",
  "created_at": 1739289600,
  "cancelled_at": 1739289660
}

Errores

Consulta Códigos de error para el catálogo completo. La URI de type en cada respuesta de error enlaza directamente con la fila correspondiente.

Obtener retiro Simular la finalización de un retiro