Introducción
Este documento describe los endpoints de la API de TotalCoin para gestionar los eventos de cashin con conciliacion automatica, en el siguiente escenario existen dos actores, los clientes de totalcoin y los usuarios de ese cliente, por lo que se pueden dar los siguientes escenarios:
- El cliente de total genera una pre-orden, y luego su usuario realiza el pago, Tocalcoin recibe el pago, realiza la conciliacion automatica y notifica al cliente llamando al webhook correspondiente.
- Tocalcoin recibe un pago de un usuario, y notifica al cliente sobre el pago, el cliente llama al endpoint de conciliacion automatica y totalcoin llama al webhook de cliente una vez realizada la conciliacion.
Sea cual sea el escenario, el flujo seria el mismo pero en distintos tiempos. Chequear esto al momento de implementar con el equipo de totalcoin.
Autenticación
El control de acceso a la API se realiza mediante OAuth 2.0 con Tokens Bearer.
Endpoint
Solicitud
{
"username": "",
"password": ""
}
| Campo | Tipo | Descripción | Requerido |
|---|---|---|---|
| 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 | Validez del token en segundos |
Posibles Errores
| Código | Descripción |
|---|---|
| 401 | Credenciales inválidas o no existentes |
| 403 | Sin permisos para acceder a la API |
Crear Pre-Orden
Con este endpoint se crea una pre-orden, es decir, el cliente notifica a Totalcoin de que un posible pago se realizara en un futuro cercano.
Endpoint
Solicitud
{
"OperationId": "string",
"Amount": 0,
"DNI": "string",
"CompanyReferenceToConciliate": "string"
}
| Campo | Tipo | Descripción | Requerido |
|---|---|---|---|
| OperationId | String | Representa la referencia externa con la que se va a conciliar. | Sí |
| Amount | Number | Debe corresponder con el monto bruto enviado por el cliente. | Sí |
| Dni | String | Puede ser DNI o CUIT de la persona que envió el dinero | Sí |
| CompanyReferenceToConciliate | String | Este valor debe estar vacio en la pre-orden | Sí |
Respuesta (HTTP 201)
True or False
Posibles Errores
| Código | Descripción |
|---|---|
| 400 | Parámetros de solicitud inválidos |
| 401 | No autorizado - Token inválido o faltante |
| 403 | Prohibido - Permisos insuficientes |
Notificaciones Webhook
El webhook de notificaciones se llama cuando ingresa un pago ya sea por una transferencia,un pago de QR o pago con tarjeta.
O tambien cuaando se realiza la conciliacion automatica de la pre-orden.
Payload del Webhook
{
"Concepto": "1234567890",
"Referencia": "0000004053",
"Monto": 1000,
"MontoNeto": 937.2,
"Tarifas": 51.9,
"Impuestos": 10.9,
"FechaCreacion": "11/19/2020 16:40:20",
"FechaConfirmacion": "11/19/2020 16:40:23",
"FechaAcreditacion": "04/21/2021 14:34:53",
"Estado": "APROBADO",
"MetodoPago": "TARJETA",
"Operacion": "COBRANZA TARJETA",
"NombreCompletoEmisor": "TOTAL COIN",
"EmailEmisor":"@totalcoin.com",
"NombreCompletoReceptor": "TOTAL COIN",
"EmailReceptor": "@totalcoin.com",
"CuilCuitEmisor": "11111111",
"CuilCuitReceptor": "11111111",
"BarCode": null,
"CbuOrigen": "",
"CvuOrigen": null,
"Tarjeta": "VISA",
"Cuotas": "02",
"ReferenciaMerchant": null
}
Los campos mas importantes de ese body son:
| Campo | Descripción |
|---|---|
| Referencia | Numero de referencia interno y unico de la transaccion de Totalcoin |
| Monto | Monto |
| Estado | Ultimo estado de la operacion |
| ReferenciaMerchant | IdOperacion del merchant |