Introducción a la API

Descripción General

La API Pública de Avista 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

https://api.public.firebanking.com.br

Autenticación

Todos los endpoints de la API (excepto el endpoint de generación de token) requieren autenticación con Bearer token. El proceso de autenticación sigue el estándar OAuth 2.0 con certificados X.509:

Solicite su clientId y clientSecret a través del portal de Avista

Instale el certificado de cliente proporcionado en su entorno

Use el endpoint /api/auth/token con sus credenciales y certificado para generar un Bearer token

Incluya el token en el encabezado Authorization: Bearer {token} en todas las solicitudes

El token generado es válido por 30 minutos y debe ser renovado después de ese período.

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 (GET)
`201`	Created	Recurso creado exitosamente (POST)
`400`	Bad Request	Datos inválidos en la solicitud
`401`	Unauthorized	Token ausente, inválido o expirado
`404`	Not Found	Recurso no encontrado
`500`	Internal Server Error	Error interno del servidor