Voultech API REST permite interactuar con nuestro sistema, permitiendo acceder al mercado de inversiones y los diversos procesos y/o servicios involucrados. En esta documentación encontrarás todos los detalles para integrarte a la API de Voultech.
<aside> 🔗 ¡Tenemos Swagger! Una herramienta que permite validar y probar los endpoints de nuestra APIs REST de manera fácil y visual.
Para utilizar la documentación Swagger de Voultech API REST, ingresa acá.
Allí encontrarás información detallada sobre los endpoints disponibles, sus parámetros y las respuestas esperadas. Además, podrás probar estos directamente desde la documentación, lo que facilitará el proceso de integración con nuestra API.
</aside>
La API de Voultech sigue las convenciones RESTful, la mayoría de las operaciones se realizan mediante solicitudes GET, POST, PATCH y DELETE en recursos de páginas y bases de datos. Los cuerpos de solicitud y respuesta se codifican como JSON.
camelCase (no en snake_case o kebab-case).AAAA-MM-DD).Es necesario tener credenciales de acceso específico para nuestra Voultech API REST.
La URL base para enviar todas las solicitudes API en ambiente de certificación es https://apiwebcbvoultechcertificacion.azurewebsites.net. Se requiere HTTPS para todas las solicitudes de la API.
La autenticación es realizado a través de un esquema bearer authentication, que involucra un token de seguridad generado cuando se realiza una petición de sign in. Este debe ser enviado en la cabecera HTTP **A**uthorization: Bearer {token} ****cuando se realice cada petición.
El token generado tiene una vigencia limitada, en caso de expiración deberás renovar token o volver a realizar un proceso de sign in. Si aún se tiene una sesión vigente y está próxima a vencer, se puede solicitar renovar el token por otro con el siguiente endpoint.
Dada la cantidad de registros posibles y buscando optimizar los tiempos de respuesta, existe una estructura de paginación para aquellas consultas GET.
Al momento de realizar alguna consulta, en el Header de la respuesta encontrarás información del conjunto de registros actual.
X-Pagination: {"TotalCount":1403,"PageSize":10,"CurrentPage":1,"TotalPages":141,"HasNext":true,"HasPrevious":false}
| HTTP Status | Descripción |
|---|---|
| 200 | OK |
| 201 | Created |
| 400 | Not Found |
| 401 | Unauthorized |
| 409 | Conflict |
<aside> 💡 Principales
Cliente: Datos importantes relacionados a una persona natural o jurídica que exige la normativa de Comisión del Mercado Financiero (CMF). Este corresponde al usuario final.
Cuenta: Permite a los clientes acceder a los mercados financieros para poder realizar inversiones. Esta asociada específicamente a un asesor o Fintech.
Asesor: Gestor de cartera. Canal o motor de inversión (Fintech) se conecta con Voultech y por donde el cliente realiza sus inversiones.
Cartera: Conjunto de diferentes instrumentos financieros que posee un cliente. Posiciones Vigentes a fecha de consulta, incluye valorización a mercado
Caja: Fondo monetario asignado específicamente a una cuenta y divisa en específico.
Movimiento: Flujos de dinero para cada una de las cajas.
Operacion: Flujos de movimientos asociado a nemotécnicos, estos construyen las Cartera de las cuentas.
Orden: Compra/Venta de Instrumentos.
Asignación: Asignación de Órdenes inyectadas a nuestro sistema.
MovimientosShinkansen: Ingreso y consulta de movimientos de Retiro Banco Online.
MovimientosBancoSecurity: Obtiene una lista de Movimientos del banco Security en un rango de fecha determinado.
MovimientosBancoBice: Obtiene una lista de Movimientos del banco Bice en un rango de fecha determinado.
</aside>
El flujo general de enrolar a una persona como cliente consiste en: crear al cliente con sus datos personales, inyectar sus documentos (cédula de identidad + contratos necesarios), crear una cuenta del cliente asociada a la fintech y finalmente asociar una cuenta corriente a este cliente.
Con todos estos pasos el cliente estará listo para operar.
<aside> ❗ Cabe destacar que un cliente ya puede estar creado en la corredora. Sin embargo, se deben inyectar los documentos y crear la cuenta del cliente de todas maneras. Lo mismo puede pasar con la cuenta bancaria, que la cuenta bancaria inyectada ya esté asociada al cliente no representa un problema para el sistema.
</aside>
El flujo de movimientos de un cliente depende del modelo de negocios que se busque ofrecer. En este caso, presentamos un diagrama como ejemplo de un flujo estándar. En este, un cliente realiza un aporte (el cual es notificado a la fintech mediante nuestro Sistema de eventos), luego debe comprar divisas extranjeras para comprar el instrumento, luego vender este y transformar nuevamente sus divisas a las originales, para finalmente, poder hacer un retiro de su dinero.
Este es un flujo estándar para ejemplificar los tipos de movimientos que se pueden hacer con la API Voultech. Para realizar estos movimientos se deben utilizar los siguientes endpoints.