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
externalIdde 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 elexternalId de la transacción original y el parámetro status establecido en CANCELLED. El sistema detiene de inmediato cualquier procesamiento posterior del pago.
Paso 1: Cancelar el pago de APM a través de la API
Para cancelar un pago de APM, envía una solicitudPATCH 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 utilizacurl:
curl
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:- Cancelación exitosa: Cancela un pago de APM pendiente con un externalId válido.
- Transacción no válida: Intenta cancelar un externalId inexistente.
- Ya completada: Intenta cancelar una transacción completada.
- Validación de permisos: Realiza pruebas con usuarios que tengan diferentes niveles de permisos.
- 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.

