Saltar al contenido principal
Localpayment proporciona un endpoint para obtener información detallada sobre los planes de suscripción existentes. Esta guía explica cómo obtener los detalles de los planes de suscripción a través de la API de Localpayment, lo que te permite verificar las configuraciones del plan, comprobar su estado y utilizar la información del plan en tu aplicació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.

Paso 1: Obtén los detalles del plan de suscripción.

Para obtener la información de un plan de suscripción, envía una solicitud GET al endpoint Obtén un plan de suscripción.

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

Una solicitud exitosa devuelve los detalles completos del plan de suscripción:

Campos de respuesta clave

Respuesta de error

Cuando no se pueda encontrar o acceder a un plan de suscripción, recibirás información de error:

Paso 3: Seguimiento del estado de la transacción

Tras recuperar un plan de suscripción, podrás comprobar su disponibilidad y estado actual:

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 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. Recuperación exitosa del plan: Obtén los detalles de un plan activo existente.
  2. Plan inexistente: Intentar recuperar un plan que no existe.
  3. ID de plan no válido: Prueba con formatos internalId incorrectos o mal formados.
  4. Fallos de autenticación: Recuperar planes con tokens de acceso no válidos o caducados.

Próximos pasos

Crea un plan de suscripción

Configura nuevos planes de suscripción para diferentes niveles de servicio o modelos de precios.

Actualizar plan de suscripción

Modifica los detalles del plan existente en función de la información obtenida.

Crear suscripción con plan

Utiliza el ID del plan para crear nuevas suscripciones de clientes.
Última modificación el 10 de noviembre de 2026