Cancelar | Credonix

Descripción general

Este endpoint cancela un pago. El pago no se elimina: queda con canceled: true, sigue apareciendo en el listado y puedes reactivarlo.

Primero cancela, con el motivo 03, cada complemento de pago emitted del pago, de prueba y real, y guarda su acuse de cancelación. Después, en una sola operación:

Marca los complementos como canceled y el pago con canceled: true.
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.
Recalcula el saldo pendiente y el estatus de la orden de cobro.

Si el pago pertenece a un grupo, solo se cancela este pago; para cancelar todos los pagos del grupo usa Cancelar grupo de pagos.

No lleva cuerpo. Requiere el permiso Administrar en Pagos.

Endpoint

POSThttps://app.credonix.mx/api/v1/payments/{paymentId}/cancel

Path param: paymentId — el ID del pago.

Cancela el pago

Sin cuerpo. Devuelve el pago con canceled: true. En este ejemplo la orden de cobro recupera el monto del pago en su saldo pendiente.

Pago ya cancelado

Cancelar un pago que ya está cancelado responde 409 con PAYMENT_ALREADY_CANCELED.

Errores

Status	Código	Causa
`400`	`LEGAL_ENTITY_NOT_FOUND`	No se encontró la razón social del complemento de pago.
`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`	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_ALREADY_CANCELED`	El pago ya está cancelado.
`409`	`CREDIT_REVERSAL_CONFLICT`	El saldo a favor que generó el pago ya fue aplicado o devuelto.
`502`	`COMPLEMENT_CANCELLATION_FAILED`	El SAT o el PAC rechazó la cancelación de un complemento de pago.