Introducción

Documentación

Frisvy expone un ecosistema de APIs REST y servicios SFTP a través de su API Manager para que las empresas recaudadoras e integradoras automaticen su ciclo de cobranzas: desde la publicación de la deuda hasta la rendición de pagos, retenciones e instrumentos.

¿Para quién es esta documentación? Está pensada para los equipos técnicos de empresas externas que integran sus sistemas con Frisvy. Acá vas a encontrar cómo autenticarte y la referencia de cada producto y endpoint disponible.

¿Qué es Frisvy para integradores?

Frisvy intermedia el proceso de cobranzas entre una empresa recaudadora y sus clientes. La empresa publica sus documentos de deuda (input) y Frisvy le rinde los cobros, retenciones e instrumentos detectados (output). Cada etapa se puede integrar de forma programática mediante API REST, archivos por SFTP o notificaciones en tiempo real, según convenga a cada sistema.

Productos

• Publicación de deuda — Informá a Frisvy los documentos a cobrar (facturas, NC, ND) por API REST o SFTP, e iniciá órdenes de pago.
• Rendiciones de cobranzas — Obtené los pagos y retenciones aplicados sobre tus documentos: por API, por SFTP y notificaciones de negocio.
• Rendición de instrumentos de cobro — Consultá los instrumentos acreditados (transferencias, cheques y echeqs) para tu conciliación bancaria.
• Lectura de documentos con IA — Automatizá la captura de comprobantes (retenciones) con IA y consultá el resultado por API o SFTP.

Cómo funciona la integración

Todas las APIs siguen el mismo flujo de autenticación basado en tokens de sesión. El dominio por el que se genera el token y el dominio por el que se consumen los servicios son distintos.

1. Tu empresa se da de alta como recaudadora y gestiona credenciales con el equipo de producto de Frisvy.
2. Generás un token de sesión (JWT) contra el dominio de login, enviando tus credenciales y los scopes del producto.
3. Consumís las APIs enviando ese token en el header Authorization como Bearer.
4. Reutilizás el token durante su vigencia (≈1 hora) y lo renovás cuando expira.

Próximo paso Empezá por la guía de Gestión de credenciales para dar de alta tu empresa y obtener tu primer token.

Modalidades de integración

Según el producto, vas a poder integrarte por una o más de estas modalidades:

• API REST: consumo programático directo desde tus sistemas, en JSON. Ideal para flujos en línea o por lotes.
• SFTP: intercambio de archivos CSV en carpetas dedicadas del servidor seguro de Frisvy (sftp.frisvy.com). Ideal para procesos batch.
• Notificaciones de negocio (webhooks): Frisvy avisa en tiempo real a un endpoint de tu empresa cuando ocurre un evento (por ejemplo, una orden de pago lista para rendir).

Ambientes y dominios

Cada ambiente tiene su propio par de dominios. En la URL se reemplaza {ambiente} por qa o uat. En producción no se incluye la parte de ambiente.

Portal de autogestión y referencia interactiva: portal.apim.frisvy.com

Convenciones generales

• Todas las fechas usan formato ISO 8601 (por ejemplo yyyy-mm-dd o yyyy-mm-ddThh:mm:ssZ), con zona horaria cuando corresponde.
• Los importes usan punto como separador decimal y no llevan separador de miles.
• La autenticación se realiza con el header Authorization: Bearer {access_token}.
• Las consultas vienen paginadas mediante los parámetros page y size.