Introducción a la API
Descripción General
La API Pública de FyPay es una plataforma integral para la integración con servicios de pago PIX y gestión de cuentas. Nuestra API le permite:
- Generar cobros PIX dinámicos para recibir pagos
- Enviar pagos PIX a cualquier clave
- Enviar pagos PIX mediante QR Code
- Consultar saldos en tiempo real
- Gestionar devoluciones de transacciones
- Integrar pagos instantáneos en su aplicación
Entorno
Producción
| Recurso | URL |
|---|---|
| URL base de la API | https://api.fypay.me/api |
| Health check | GET https://api.fypay.me/health |
| Dashboard | https://banking.fypay.me |
Todos los endpoints de la API están bajo el prefijo /api (por ejemplo, https://api.fypay.me/api/balance). El health check es la única ruta fuera de ese prefijo.
Autenticación
Todos los endpoints de la API (excepto el de generación de token) requieren autenticación mediante Bearer token. El token se obtiene con sus credenciales OAuth 2.0 y un certificado de cliente X.509 presentado en el handshake TLS (mTLS):
En el Dashboard de FyPay, acceda a Configuración → Credenciales y genere su clientId y clientSecret. El clientSecret se muestra una sola vez.
Use el certificado X.509 (PEM, RSA 2048, válido por 2 años) vinculado a su cuenta y su clave privada.
Llame a POST https://api.fypay.me/api/auth/token con sus credenciales, presentando el certificado en el handshake TLS (por ejemplo, curl --cert client.crt --key client.key).
Incluya el token en el encabezado Authorization: Bearer <token> en las demás solicitudes. No requieren certificado.
La validez del token se informa en el campo expires_in (en segundos) de la respuesta. Renueve el token antes de que expire.
Códigos de Estado HTTP
La API utiliza códigos de estado HTTP estándar para indicar el éxito o fallo de una solicitud:
| Código | Significado | Descripción |
|---|---|---|
200 | OK | Solicitud exitosa |
201 | Created | Recurso creado con éxito |
400 | Bad Request | Datos inválidos en la solicitud |
401 | Unauthorized | Token ausente, inválido o expirado |
403 | Forbidden | Acceso denegado al recurso |
404 | Not Found | Recurso no encontrado |
429 | Too Many Requests | Límite de solicitudes excedido |
500 | Internal Server Error | Error interno del servidor |
503 | Service Unavailable | Servicio temporalmente no disponible |
Formato de Fechas
Todas las fechas en la API siguen el estándar ISO 8601 con zona horaria UTC:
2024-01-15T10:30:00.000ZPrimeros Pasos
Autenticación
Aprenda cómo autenticarse y obtener tokens de acceso
Consultar Saldo
Consulte el saldo de su cuenta
Generar Cobro PIX
Cree cobros para recibir pagos
Enviar Pago PIX
Envíe pagos PIX a cualquier clave
Pagar vía QR Code
Pague escaneando QR Codes PIX
Soporte
Para preguntas técnicas o soporte, contáctenos:
- Email: suporte@fypay.me [A DEFINIR]
- Documentación: https://docs.fypay.me
- Health de la API:
GET https://api.fypay.me/health