CredonixDocs
Abrir Credonix
Referencia de la APIComplementos de pago

Cancelar

Cancela un complemento de pago sin cancelar el pago.

Descripción general

Este endpoint cancela un complemento de pago, real o de prueba. El pago sigue activo y el saldo pendiente de la orden de cobro no cambia. Después puedes emitir un nuevo complemento para el mismo pago. Para cancelar el pago junto con sus complementos, usa Cancelar pago.

  • Complemento real: se cancela con la razón social de la orden de cobro, con el motivo 03, y se guarda el acuse de cancelación. Si el complemento ya está cancelado, la API responde 409 con COMPLEMENT_NOT_EMITTED.
  • Complemento de prueba: se cancela en modo de prueba. Cancelar de nuevo un complemento de prueba ya cancelado responde 200 con el complemento.

No lleva cuerpo. Requiere el permiso Administrar en Órdenes de cobro.

Endpoint

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

Path params:

  • paymentId — el ID del pago.
  • complementId — el ID del complemento de pago, real o de prueba.

Cancela el complemento

Sin cuerpo. Devuelve el complemento con status: "canceled", con la forma de Listar complementos de pago. Una vez cancelado, Descargar archivos del complemento devuelve el acuse de cancelación en pdf y xml cuando está disponible.

Errores

StatusCódigoCausa
400LEGAL_ENTITY_NOT_FOUNDNo se encontró la razón social.
400LEGAL_ENTITY_NOT_CONFIGUREDLa razón social no tiene la configuración necesaria para cancelar el complemento de prueba.
401MISSING_API_KEY | INVALID_API_KEY | API_KEY_REVOKEDAPI key ausente, inválida o revocada.
403INSUFFICIENT_PERMISSIONSLa API key no tiene el permiso Administrar en Órdenes de cobro.
404NOT_FOUNDEl pago no existe en tu organización, el complemento no pertenece al pago o la orden de cobro no tiene razón social.
409COMPLEMENT_NOT_EMITTEDEl complemento real ya está cancelado. La respuesta incluye { "message": "Solo es posible cancelar complementos de pago no cancelados." }.
502COMPLEMENT_CANCELLATION_FAILEDEl SAT o el PAC rechazó la cancelación.
Emitir complemento de pago POST
Página anterior
Descargar archivos del complemento GET
Página siguiente
Abrir Credonix