API REST de Fluxis
La API REST de Fluxis te permite autenticarte, gestionar cuentas y puntos de venta, crear solicitudes de pago y recibir notificaciones webhook. Esta página te orienta; la referencia interactiva está en /api.
URLs base
| Entorno | Host |
|---|---|
| Staging | https://api.stgfluxis.us |
| Production | https://api.fluxis.us |
Todos los endpoints tienen el prefijo /v1.
Autenticación
Cada solicitud protegida requiere ambos encabezados:
Code
Obtén un token intercambiando tu clave API y secreto:
POST /v1/auth/token
Consulta Authentication en la referencia API.
Nunca expongas tu secreto API en código del lado del cliente, navegadores o apps móviles.
Recursos principales
| Recurso | Propósito | Referencia |
|---|---|---|
| Accounts | Cuentas de comercio, direcciones de liquidación | /api — Accounts |
| Point of Sale | Puntos de entrada de pago, solicitudes de pago | /api — Point of Sale |
| Webhooks | Notificaciones de eventos a nivel de cuenta | /api — Webhooks |
| Transactions | Conciliación e informes | /api — Transactions |
| NASPIP | Leer o crear tokens NASPIP | /api — NASPIP Token |
Flujo de integración típico
- Autenticación —
POST /v1/auth/token - Descubrimiento de recursos —
GET /v1/account,GET /v1/pos?page=1&page_size=20 - Crear pagos —
POST /v1/pos/{posID}/payment-request(opayment-request-checkoutpara checkout alojado) - Recibir actualizaciones — Registra
POST /v1/account/{accountID}/webhookconevent_type: payment_request - Conciliar —
GET /v1/transactions?page=1&page_size=50o haz polling deGET /v1/pos/{posID}/payment-request/{paymentRequestID}
Guía paso a paso: Guía de integración API.
Paginación
Los endpoints de listado usan los parámetros de consulta page y page_size (no offset/limit):
- POS:
page≥ 1,page_size1–100 - Transactions:
page≥ 1,page_size5–100 - Webhook logs:
page≥ 1,page_size5–20
Las respuestas incluyen { data, total, page, page_size, total_pages }.
Webhooks
Los webhooks se registran por cuenta, no por POS. Fluxis firma las entregas con HMAC-SHA256.
- Resumen de webhooks — Registro y comportamiento de entrega
- Verificación de firma de webhook — JSON canónico y flujo de prueba
Valores event_type compatibles: payment_request, incoming_transfer, refund.
Explorar la API
Referencia API interactiva
Explora endpoints, esquemas y prueba solicitudes en el playground.
Abrir referencia API →
Guías relacionadas
- Guía de integración API
- Crear y monitorear solicitudes de pago
- Webhooks
- Verificación de firma de webhook
- SDKs (próximamente)