Saltar al contenido principal
Localpayment te permite cancelar pagos de APM pendientes mediante la integración de tu API. Esta guía describe el proceso completo de cancelación de transacciones de APM utilizando el método de cancelación directa, que solo requiere el externalId de la transacción.

Antes de comenzar

Asegúrate de tener:

Credenciales de API

Credenciales API válidas y token de acceso para la autenticación.

Configuración de la cuenta

Configuración adecuada de la cuenta para el país de destino y verificación de la empresa.

Lista blanca de IP

Incluye en la lista blanca las direcciones IP de tus servidores para el acceso a la API.

Endpoint del webhook

Configura una URL de webhook para recibir notificaciones de pago.

Requisitos adicionales de cancelación:

  • Rol de usuario con permisos de cancelación (consulta la documentación sobre roles de usuario).
  • La transacción original debe estar en un estado que permita su cancelación.
  • El externalId de la transacción de pago de APM que deseas cancelar.
  • Completa la información del beneficiario para los reembolsos que requieren datos.

Cancelación directa para pagos de APM

Las cancelaciones de pagos de APM se procesan como cancelaciones directas, lo que significa que solo necesitas el externalId de la transacción original y el parámetro status establecido en CANCELLED. El sistema detiene de inmediato cualquier procesamiento posterior del pago.
ImportanteLos pagos de APM solo se pueden cancelar mientras estén en estado pendiente o en curso. Una vez que un pago de APM se haya completado o liquidado, deberás procesar un reembolso en lugar de una cancelación.

Paso 1: Cancelar el pago de APM a través de la API

Para cancelar un pago de APM, envía una solicitud PATCH al endpoint Cancelar.

Parámetros clave de la solicitud

La solicitud requiere varios parámetros clave:

Ejemplo de solicitud

A continuación se muestra un ejemplo que utiliza curl:
curl
Consulta todos los parámetros disponibles en la solicitud.

Paso 2: Gestionar la respuesta

Respuesta exitosa

Un pago de APM cancelado correctamente devuelve los detalles de confirmación:

Campos de respuesta clave

Respuesta de error

Cuando falla una solicitud de cancelación, recibirás información de error:

Escenarios de errores comunes


Paso 3: Seguimiento del estado de la cancelación

Tras iniciar una cancelación, supervisa su progreso mediante estos métodos:

Webhooks (recomendado)

Recibe notificaciones en tiempo real cuando cambie el estado de la transacción. Más eficiente para entornos de producción.

Endpoint de la API de estado

Consulta el estado de las transacciones mediante programación. Útil para sondear o recuperar notificaciones de webhook perdidas.

Vista del Business Portal

Interfaz visual para el seguimiento de transacciones. Ideal para la supervisión manual y el análisis detallado de las transacciones.

Códigos de estado de cancelación comunes

Referencia completaConsulta todos los códigos de estado en nuestra documentación sobre el estado de las transacciones.

Probando tu integración

Escenarios de prueba

Verifica que tu integración gestione estos escenarios:
  1. Cancelación exitosa: Cancela un pago de APM pendiente con un externalId válido.
  2. Transacción no válida: Intenta cancelar un externalId inexistente.
  3. Ya completada: Intenta cancelar una transacción completada.
  4. Validación de permisos: Realiza pruebas con usuarios que tengan diferentes niveles de permisos.
  5. Parámetro de estado faltante: Intenta la cancelación sin el campo status obligatorio.

Próximos pasos

Ver estado de la transacción

Consulta el estado actual de las transacciones y cancelaciones mediante la API de estado de transacciones.

Procesar reembolsos

Aprende cómo procesar reembolsos de pagos de APM completados que no se pueden cancelar.
Última modificación el 12 de noviembre de 2026