Introducción
Esta documentación describe los endpoints de la API de Conciliaciones para gestionar y consultar los registros de transacciones en TotalCoin.
Autenticación
El control de acceso a la API se realiza mediante OAuth 2.0 con Tokens Bearer.
Endpoint
POST
api/auth/login
Solicitud
{
"company": "",
"username": "",
"password": ""
}
| Campo | Tipo | Descripción | Requerido |
|---|---|---|---|
| company | String | Nombre de la Empresa | Sí |
| username | String | Nombre de Usuario | Sí |
| password | String | Contraseña | Sí |
Respuesta (HTTP 200)
{
"token": "",
"expires_in": 3600
}
| Campo | Tipo | Descripción |
|---|---|---|
| token | String | Token de autenticación |
| expires_in | Number | Tiempo de expiración del token en segundos |
Errores Comunes
| Código | Descripción |
|---|---|
| 401 | Credenciales inválidas o incorrectas |
| 403 | Permisos insuficientes para acceder a la API |
Endpoints de Conciliación
Obtener Reporte de Conciliación
GET
api/conciliations/report
Parámetros de Consulta
| Parámetro | Tipo | Descripción | Requerido |
|---|---|---|---|
| start_date | String | Fecha de inicio (YYYY-MM-DD) | Sí |
| end_date | String | Fecha de fin (YYYY-MM-DD) | Sí |
| currency | String | Moneda del reporte (USD, EUR, etc.) | No |
| status | String | Estado de las transacciones (completed, pending, failed) | No |
Respuesta (HTTP 200)
{
"report_id": "rep_123456789",
"total_transactions": 150,
"total_amount": 15000.00,
"currency": "USD",
"transactions": [
{
"transaction_id": "txn_123",
"date": "2024-03-13T10:00:00Z",
"amount": 100.00,
"status": "completed",
"description": "Pago de factura #123"
}
]
}
| Campo | Tipo | Descripción |
|---|---|---|
| report_id | String | ID único del reporte |
| total_transactions | Number | Número total de transacciones |
| total_amount | Number | Monto total de las transacciones |
| currency | String | Moneda del reporte |
| transactions | Array | Lista de transacciones detalladas |
Notas Importantes
• Todas las solicitudes deben incluir el token de autenticación en el encabezado Authorization: Bearer {token}
• Las fechas deben estar en formato ISO 8601 (YYYY-MM-DD)
• El rango de fechas no puede exceder 30 días
• Los reportes se generan de forma asíncrona y pueden tardar varios minutos en completarse