ALalegra
Pagos

Anular pago

Changed on

Endpoint que permite anular un pago en la aplicación. La anulación de pagos sirve para mantener registro del pago en la aplicación pero que este documento no tenga efecto en la contabilidad o reportes de la aplicación. Para reconocer un pago anulado se debe verificar la propiedad "status", la cual para un pago anulado debe estar en "void".

post/payments/{id}/void

Request

  • Base URL
    https://api.alegra.com/api/v1
  • URL
    https://api.alegra.com/api/v1/payments/{id}/void
  • Auth
    HTTP basic

Path parameters

idstring required

Id del pago que se desea anular. Se debe enviar en la URL.

Request body

causestring

Código del motivo de cancelación,si el complemento de pago se encuentra timbrada el motivo de cancelación es requerido. Consulta el catalogo de códigos disponibles aquí.

relatedIdTransactionstring

Para el motivo 01 es necesario enviar el id del pago que sustituyó al pago a cancelar.

Response

Retorna información de un pago

Changes

  • db2f72066f99Revision changes
    • breaking

      added the new path request parameter id

    • info

      added optional request body

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status