NetPay Loop es la forma más rápida para que tu empresa les cobre suscripciones a los clientes. Esta solución puedes utilizarla para recibir donaciones, mensualidades del gimnasio, pago de clases, cuotas de mantenimiento, suscripción a servicios, etc.
1.- Crea clientes:
Es necesario que utilices nuestra API en primera instancia crear a los clientes
2.- Crea planes:
Los planes van a determinar los montos a cobrar ya sean fijos o variables nuestra API tiene la posibilidad de utilizarlo de las dos formas.
3.- Crea suscripciones:
Una vez tengas los clientes y los planes es momento de asignar a cada cliente algún plan que hayas creado, a esto se le llama suscripción, el resultado seria:
Cliente1 tiene un plan de pagos de $500 programados de cobro cada mes.
Este documento se mostrará cómo usar nuestra API REST para autenticar, realizar solicitudes y recuperar datos. Todas las respuestas hacia y desde la API estarán en JSON, utiliza códigos de respuesta HTTP, autenticación y verbos estándar.
Puede usar la API NetPay en modo de prueba, que no afecta sus datos en vivo ni interactúa con las redes bancarias. La clave API que utiliza para autenticar la solicitud determina si la solicitud es en modo en vivo o en modo de prueba.
Base URL
En cada acción se deberá de sustituir la variable {{baseUrl}} para poder realizar la petición.
Pruebas: https://ecommerce.netpay.com.mx/gateway-ecommerce
Producción: https://suite.netpay.com.mx/gateway-ecommerce
Códigos de estado HTTP
Utilizamos códigos de respuesta HTTP convencionales para indicar el éxito o el fracaso de una solicitud al API. En general, los códigos en el rango 2xx indican éxito, los códigos en el rango 4xx indican un error que resultó de la información proporcionada (por ejemplo, faltaba un parámetro requerido, sintaxis no válida, etc.), y los códigos en el rango 5xx indican un error con Servidores de NetPay.
| Código | Descripción |
|---|---|
| 200 - OK | Todo funcionó como se bien. |
| 400 - Petición Incorrecta | La solicitud era inaceptable, a menudo debido a la falta de un parámetro requerido. |
| 401 - No autorizado | No se proporcionó una clave API válida. |
| 402: solicitud fallida | Los parámetros eran válidos pero la solicitud falló. |
| 403 - Prohibido | La clave API no tiene permisos para realizar la solicitud. |
| 404 - No encontrado | El recurso solicitado no existe. |
| 405 - Método incorrecto | Esta esperando que utilices un método distinto al que se esta mandando |
| 409 - Conflicto | La solicitud entra en conflicto con otra solicitud. |
| 429 - Demasiadas solicitudes | Demasiadas solicitudes llegan a la API demasiado rápido. Recomendamos un retroceso exponencial de sus solicitudes. |
| 500, 502, 503, 504 - Errores del servidor | Error en nuestros servidores, por favor, envía un correo a [email protected] notificando el error. |
Request
Las solicitudes deben realizarse a través de HTTPS para garantizar que las transacciones estén cifradas. Los siguientes métodos de solicitud son compatibles:
| Método | Descripción |
|---|---|
| GET | Recupera datos sobre colecciones y recursos individuales. |
| POST | Para colecciones, crea un nuevo recurso de ese tipo. También se utiliza para realizar acciones en puntos finales de acción. |
| PUT | Actualiza un recurso existente. |
| DELETE | Borra un recurso. Esta es una acción destructiva. |
Información importante antes de empezar
Tarjetas de prueba
| Débito | Datos |
|---|---|
| Visa | 4000000000000002 con cualquier cvv y exp date válido |
| MasterCard | 5200000000000007 con cualquier cvv y exp date válido |
| Crédito MSI | Datos |
|---|---|
| Visa | 4918717162313532 con cualquier cvv y exp date válido |
| MasterCard | 5120481234567895 con cualquier cvv y exp date válido |
| AMEX | 340000000003961 con cualquier cvv y exp date válido |
| Tarjetas que pasaran por nuestro Dynamic 3DS y se rechazaran automáticamente (No aplican en MSI) | Datos |
|---|---|
| Visa | 4000000000000010 con cualquier cvv y exp date válido |
| MasterCard | 5200000000000015 con cualquier cvv y exp date válido |
| AMEX | 340000000006022 con cualquier cvv y exp date válido |