Referencia de la APIPagos
Eliminar
Elimina un pago y recalcula el saldo de su orden de cobro.
Descripción general
Este endpoint elimina un pago. A partir de ese momento deja de aparecer en el listado y responde 404 en las demás operaciones. Puedes eliminar pagos activos o cancelados.
Si el pago tiene un complemento de pago emitted o pending (real o de prueba), la solicitud se rechaza con 409 y el código PAYMENT_HAS_COMPLEMENT: primero cancela el pago, lo que también cancela sus complementos, y después elimínalo.
La respuesta exitosa es 204 No Content con cuerpo vacío. Requiere el permiso Administrar en Pagos.
Endpoint
DELETE
https://app.credonix.mx/api/v1/payments/{paymentId}Path param: paymentId — el ID del pago.
Comportamiento
- Revierte el saldo a favor que generó el pago. Si ese saldo a favor ya se aplicó o se reembolsó, la solicitud se rechaza con
CREDIT_REVERSAL_CONFLICT: revierte primero esas aplicaciones. - Elimina el pago y recalcula el saldo pendiente y el estatus de la orden de cobro. Una orden de cobro cancelada sigue en
canceled. - Elimina los archivos de los complementos de pago del pago, reales y de prueba.
- Registra la eliminación en la actividad de la orden de cobro.
Errores
| Status | Código | Causa |
|---|---|---|
400 | INVOICE_TOTAL_INVALID | La orden de cobro no tiene un monto total válido. |
401 | MISSING_API_KEY | INVALID_API_KEY | API_KEY_REVOKED | API key ausente, inválida o revocada. |
403 | INSUFFICIENT_PERMISSIONS | La API key no tiene el permiso Administrar en Pagos. |
404 | NOT_FOUND | El pago no existe en tu organización. |
409 | PAYMENT_HAS_COMPLEMENT | El pago tiene un complemento de pago emitted o pending. La respuesta incluye { "message": "No es posible eliminar el pago, ya que cuenta con un complemento emitido. Para continuar, cancela el pago." }. |
409 | CREDIT_REVERSAL_CONFLICT | El saldo a favor que generó el pago ya fue aplicado o devuelto. |