Cancelar grupo
Cancela todos los pagos activos de un grupo de pagos.
Descripción general
Este endpoint cancela todos los pagos activos de un grupo. Un grupo se forma al registrar un pago con dos o más asignaciones, o al aplicar saldo a favor a varias órdenes de cobro; sus pagos comparten el mismo payment_group_id.
Primero cancela cada complemento de pago emitted de los pagos del grupo: los de prueba y después los reales. Después, en una sola operación:
- Marca los complementos como
canceledy cada pago concanceled: true. - Revierte el saldo a favor que generó cada pago. Si ese saldo a favor ya se aplicó o se reembolsó, la solicitud se rechaza con
CREDIT_REVERSAL_CONFLICT. - Recalcula el saldo pendiente y el estatus de cada orden de cobro afectada.
Si la cancelación de un complemento real falla, los complementos que ya se cancelaron quedan como canceled y los pagos siguen activos. Si falla la de un complemento de prueba, los complementos de prueba cancelados antes quedan como canceled.
La respuesta solo incluye los pagos que estaban activos antes de la llamada. No lleva cuerpo. Requiere el permiso Administrar en Pagos.
Endpoint
https://app.credonix.mx/api/v1/payment-groups/{paymentGroupId}/cancelPath param: paymentGroupId — el payment_group_id del grupo (UUID).
Cancela el grupo
Sin cuerpo. Devuelve payment_group_id y, en results, los pagos cancelados por esta llamada, ordenados por payment_date y created_at descendentes.
Campos de la respuesta
| Campo | Tipo | Descripcion |
|---|---|---|
payment_group_id | string | El grupo cancelado. |
results | array | Pagos cancelados, con la forma de Consultar pago. |
Errores
| Status | Código | Causa |
|---|---|---|
400 | COMPLEMENT_CANCELLATION_DATA_MISSING | Faltan datos para cancelar ante el SAT el complemento de pago de una orden de cobro. |
400 | LEGAL_ENTITY_NOT_FOUND | No se encontró la razón social de un complemento de prueba. |
400 | LEGAL_ENTITY_NOT_CONFIGURED | La razón social no tiene la configuración necesaria para cancelar el complemento de prueba. |
400 | INVOICE_TOTAL_INVALID | Una 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 | PAYMENT_GROUP_WITHOUT_ACTIVE_PAYMENTS | El grupo no existe en tu organización o todos sus pagos ya están cancelados. La respuesta incluye { "message": "Sin pagos activos en este grupo para cancelar." }. |
409 | CREDIT_REVERSAL_CONFLICT | El saldo a favor que generó algún pago del grupo ya fue aplicado o devuelto. |
502 | COMPLEMENT_CANCELLATION_FAILED | El SAT o el PAC rechazó la cancelación de un complemento de pago. |