¿Preguntas?

Más información en nuestro Centro de Ayuda.

Centro de Ayuda
Contacto

Envíanos un mail con tu duda o sugerencia.

Contacto

API Bancaria

Para todos los ejemplos utilizaremos los mismos datos de prueba:

  • Usuario con solo una cuenta asociada al usuario

    • Username: 12345

    • Password: gfdsa

  • Institución de prueba: test


Login

Endpoint: POST /login/

Parámetros Descripción
provider

Corresponde al nombre del banco, en minúsculas y sin tildes (Devuelto por el endpoint de listado de providers).

username

Documento o nombre de usuario utilizado para ingresar al home banking o app de la institución financiera.

password

Contraseña del usuario web de la institución financiera.

otp
Clave única temporal.

Este campo es opcional a excepción de los siguientes proveedores: bbva_mx.
personal_question
Pregunta personal.

Este campo es opcional a excepción de los siguientes proveedores: banco_general, intermatico.
token
Token de autorización del proveedor.

Este campo es opcional a excepción de los siguientes proveedores: banorte.
company_code
Código de compañía.

Este campo es opcional a excepción de los siguientes proveedores: pe_bbva_netcash.
type
Este campo es opcional y exclusivo de los siguientes proveedores:
davivienda

Opciones:
- cedula_ciudadania cedula de Ciudadania
- cedula_extranjeria cedula de Extranjeria
- nit NIT
- tarjeta_identidad tarjeta de Identidad
- pasaporte Pasaporte
- tarjeta_seguro_social_extranjero trj. Seguro Social Extranjero
- sociedad_extranjera_sin_nit sociedad Extranjera sin NIT en Colombia
- fideicomiso fideicomiso
- nit_menores NIT Menores
- rif_venezuela RIF Venezuela
- nit_extranjeria NIT Extranjeria
- nit_persona_natural NIT Persona Natural
- registro_civil_nacimiento registro Civil De Nacimiento
- nit_desasociado NIT Desasociado
- cif CIF (Numero Unico de Cliente)
- numero_identidad numero de Identidad
- rtn RTN
- cedula_identidad cedula de Identidad
- dimex DIMEX
- ced CED
- pas PAS
- documento_unico_identidad documento Unico de Identidad
- nit_salvadoreno NIT Salvadoreño
rut
Número RUT.

Este campo es opcional a excepción de los siguientes proveedores: itau_corp_uy.
account_number
Número de cuenta.

Este campo es opcional a excepción de los siguientes proveedores: santander_corp_br.
agency
Número de agencia.

Este campo es opcional a excepción de los siguientes proveedores: santander_corp_br.

Respuesta:

Status Descripción
status
  • select_client es necesario seleccionar un cliente.

  • wrong_credentials usuario o password inválidos.

  • missing_credentials falta un campo de credenciales

  • logged_in sesión iniciada correctamente.

  • interaction_required se requiere algún tipo de inicio de sesión interactiva, podría ser un captcha o una pregunta de seguridad.

key

Clave de autenticación que deberá ser usada en todas las requests siguientes (no estará presente si el status es un error).

Login normal

POST /login/ HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

provider=test&username=12345&password=gfdsa

Respuesta:

{
  "status" : "logged_in",
  "key" : "163d06b2-3378-4383-9868-71c2b6fb28da",
}

Respuesta errónea:

{"status": "wrong_credentials"}

Respuesta con interacción requerida:

Para reforzar el sistema de seguridad, algunas instituciones financieras requieren una interacción por parte del usuario, como un token otp, preguntas de seguridad o confirmación 2FA.

{
    "context": "¿Cuántos baños tenia la casa de mis padres?",
    "field": "personal_question",
    "key": "be612b0a-c972-4fb1-bb16-798956a3efa1",
    "status": "interaction_required"
}
curl -X POST "https:///login/" -d "provider=test&username=12345&password=gfdsa" -H "X-API-Key: <API KEY>"

Respuesta:

{
  "status" : "logged_in",
  "key" : "163d06b2-3378-4383-9868-71c2b6fb28da",
}

Respuesta errónea:

{"status": "wrong_credentials"}

Respuesta con interacción requerida:

Para reforzar el sistema de seguridad, algunas instituciones financieras requieren una interacción por parte del usuario, como un token otp, preguntas de seguridad o confirmación 2FA.

{
    "context": "¿Cuántos baños tenia la casa de mis padres?",
    "field": "personal_question",
    "key": "be612b0a-c972-4fb1-bb16-798956a3efa1",
    "status": "interaction_required"
}
import requests

requests.post('https:///login/', data={
    'provider': 'test',
    'username': '12345',
    'password': 'gfdsa',
}, headers={
    'X-API-Key': '<API KEY>'
})

Respuesta:

{
  "status" : "logged_in",
  "key" : "163d06b2-3378-4383-9868-71c2b6fb28da",
}

Respuesta errónea:

{"status": "wrong_credentials"}

Respuesta con interacción requerida:

Para reforzar el sistema de seguridad, algunas instituciones financieras requieren una interacción por parte del usuario, como un token otp, preguntas de seguridad o confirmación 2FA.

{
    "context": "¿Cuántos baños tenia la casa de mis padres?",
    "field": "personal_question",
    "key": "be612b0a-c972-4fb1-bb16-798956a3efa1",
    "status": "interaction_required"
}
var request = require('request');

request.post({
  "url": "https:///login/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "form": {
    "provider": "test",
    "username": "12345",
    "password": "gfdsa"
  }
});

Respuesta:

{
  "status" : "logged_in",
  "key" : "163d06b2-3378-4383-9868-71c2b6fb28da",
}

Respuesta errónea:

{"status": "wrong_credentials"}

Respuesta con interacción requerida:

Para reforzar el sistema de seguridad, algunas instituciones financieras requieren una interacción por parte del usuario, como un token otp, preguntas de seguridad o confirmación 2FA.

{
    "context": "¿Cuántos baños tenia la casa de mis padres?",
    "field": "personal_question",
    "key": "be612b0a-c972-4fb1-bb16-798956a3efa1",
    "status": "interaction_required"
}

Iniciar sesión con interacción:

POST /login/?key=163d06b2-3378-4383-9868-71c2b6fb28da HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

provider=test&username=12345&password=asdfg&personal_question=uno

Respuesta exitosa:

{
  "status" : "logged_in",
  "key" : "163d06b2-3378-4383-9868-71c2b6fb28da",
}
curl -X POST "https:///login/?key=163d06b2-3378-4383-9868-71c2b6fb28da" -d "provider=test&username=12345&password=asdfg&personal_question=uno" -H "X-API-Key: <API KEY>"

Respuesta exitosa:

{
  "status" : "logged_in",
  "key" : "163d06b2-3378-4383-9868-71c2b6fb28da",
}
import requests

requests.post('https:///login/', params={
    'key': '163d06b2-3378-4383-9868-71c2b6fb28da',
}, data={
    'provider': 'test',
    'username': '12345',
    'password': 'asdfg',
    'personal_question': 'uno',
}, headers={
    'X-API-Key': '<API KEY>'
})

Respuesta exitosa:

{
  "status" : "logged_in",
  "key" : "163d06b2-3378-4383-9868-71c2b6fb28da",
}
var request = require('request');

request.post({
  "url": "https:///login/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "key": "163d06b2-3378-4383-9868-71c2b6fb28da"
  },
  "form": {
    "provider": "test",
    "username": "12345",
    "password": "asdfg",
    "personal_question": "uno"
  }
});

Respuesta exitosa:

{
  "status" : "logged_in",
  "key" : "163d06b2-3378-4383-9868-71c2b6fb28da",
}

Informacion del usuario

Endpoint: GET /info/

Parámetros Descripción
key

Clave de autenticación que deberá ser usada en todas las requests siguientes.

Respuesta:

Status Descripción
info.document

Documento de identificacion (DNI, CI, etc)

info.email

Correo electronico

info.name

Nombres y apellidos

Respuesta

GET /info/?key=163d06b2-3378-4383-9868-71c2b6fb28da HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>
{
    "info": {
        "document": "12345",
        "email": "test@example.com",
        "name": "Test User"
    },
    "status": "success"
}
curl -X GET "https:///info/?key=163d06b2-3378-4383-9868-71c2b6fb28da"  -H "X-API-Key: <API KEY>"
{
    "info": {
        "document": "12345",
        "email": "test@example.com",
        "name": "Test User"
    },
    "status": "success"
}
import requests

requests.get('https:///info/', params={
    'key': '163d06b2-3378-4383-9868-71c2b6fb28da',
}, headers={
    'X-API-Key': '<API KEY>'
})
{
    "info": {
        "document": "12345",
        "email": "test@example.com",
        "name": "Test User"
    },
    "status": "success"
}
var request = require('request');

request.get({
  "url": "https:///info/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "key": "163d06b2-3378-4383-9868-71c2b6fb28da"
  }
});
{
    "info": {
        "document": "12345",
        "email": "test@example.com",
        "name": "Test User"
    },
    "status": "success"
}

Listar cuentas

Endpoint: GET /account/

Parámetros Descripción
key

Clave de autenticación que deberá ser usada en todas las requests siguientes.

Respuesta:

Status Descripción
accounts

Lista de cuentas

accounts.balance

Saldo actual de la cuenta

accounts.branch

Sucursal del banco

accounts.currency

Moneda de la cuenta.

accounts.id

Número de cuenta interno en el banco

accounts.name

Nombre o alias de la cuenta

accounts.number

Número de cuenta a utilizar en los siguientes endpoint

Respuesta

GET /account/?key=163d06b2-3378-4383-9868-71c2b6fb28da HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>
{
  "accounts": [
    {
      "balance": 1234.95,
      "branch": "02 - 18 De Julio",
      "currency": "UYU",
      "id": "hash1",
      "name": "Cuenta total",
      "number": "001234567890"
    },
    {
      "balance": 12.01,
      "branch": "02 - 18 De Julio",
      "currency": "USD",
      "id": "hash2",
      "name": "Cuenta total",
      "number": "005234567890"
    },
    {
      "balance": 4301,
      "branch": "61 - Ciudad Vieja",
      "currency": "UYU",
      "id": "hash3",
      "name": "Caja De Ahorro Atm",
      "number": "007234567890"
    },
    {
      "balance": 53.96,
      "branch": "61 - Ciudad Vieja",
      "currency": "USD",
      "id": "hash4",
      "name": "Caja De Ahorro Atm",
      "number": "007234567890"
    }
  ],
  "status": "success"
}
curl -X GET "https:///account/?key=163d06b2-3378-4383-9868-71c2b6fb28da"  -H "X-API-Key: <API KEY>"
{
  "accounts": [
    {
      "balance": 1234.95,
      "branch": "02 - 18 De Julio",
      "currency": "UYU",
      "id": "hash1",
      "name": "Cuenta total",
      "number": "001234567890"
    },
    {
      "balance": 12.01,
      "branch": "02 - 18 De Julio",
      "currency": "USD",
      "id": "hash2",
      "name": "Cuenta total",
      "number": "005234567890"
    },
    {
      "balance": 4301,
      "branch": "61 - Ciudad Vieja",
      "currency": "UYU",
      "id": "hash3",
      "name": "Caja De Ahorro Atm",
      "number": "007234567890"
    },
    {
      "balance": 53.96,
      "branch": "61 - Ciudad Vieja",
      "currency": "USD",
      "id": "hash4",
      "name": "Caja De Ahorro Atm",
      "number": "007234567890"
    }
  ],
  "status": "success"
}
import requests

requests.get('https:///account/', params={
    'key': '163d06b2-3378-4383-9868-71c2b6fb28da',
}, headers={
    'X-API-Key': '<API KEY>'
})
{
  "accounts": [
    {
      "balance": 1234.95,
      "branch": "02 - 18 De Julio",
      "currency": "UYU",
      "id": "hash1",
      "name": "Cuenta total",
      "number": "001234567890"
    },
    {
      "balance": 12.01,
      "branch": "02 - 18 De Julio",
      "currency": "USD",
      "id": "hash2",
      "name": "Cuenta total",
      "number": "005234567890"
    },
    {
      "balance": 4301,
      "branch": "61 - Ciudad Vieja",
      "currency": "UYU",
      "id": "hash3",
      "name": "Caja De Ahorro Atm",
      "number": "007234567890"
    },
    {
      "balance": 53.96,
      "branch": "61 - Ciudad Vieja",
      "currency": "USD",
      "id": "hash4",
      "name": "Caja De Ahorro Atm",
      "number": "007234567890"
    }
  ],
  "status": "success"
}
var request = require('request');

request.get({
  "url": "https:///account/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "key": "163d06b2-3378-4383-9868-71c2b6fb28da"
  }
});
{
  "accounts": [
    {
      "balance": 1234.95,
      "branch": "02 - 18 De Julio",
      "currency": "UYU",
      "id": "hash1",
      "name": "Cuenta total",
      "number": "001234567890"
    },
    {
      "balance": 12.01,
      "branch": "02 - 18 De Julio",
      "currency": "USD",
      "id": "hash2",
      "name": "Cuenta total",
      "number": "005234567890"
    },
    {
      "balance": 4301,
      "branch": "61 - Ciudad Vieja",
      "currency": "UYU",
      "id": "hash3",
      "name": "Caja De Ahorro Atm",
      "number": "007234567890"
    },
    {
      "balance": 53.96,
      "branch": "61 - Ciudad Vieja",
      "currency": "USD",
      "id": "hash4",
      "name": "Caja De Ahorro Atm",
      "number": "007234567890"
    }
  ],
  "status": "success"
}

Listar movimientos

Endpoint: GET /account/{accountNumber}/movement/

Parámetros Descripción
accountNumber

Número de cuenta (es el valor number del resultado de consultar al endpoint de listado de cuentas, para la cuenta para la que se desea sacar el listado).

key

Clave de sesion

currency

Moneda de la cuenta en formato ISO 4217, por ejemplo UYU o USD.

date_start

Fecha de inicio de los movimientos, en formato DD/MM/YYYY

date_end

Fecha de fin de los movimientos, en formato DD/MM/YYYY

Respuesta:

Status Descripción
movements

Lista de movimientos

credit

Monto en crédito del movimiento

debit

Monto en debito del movimiento

date

Fecha del movimiento

detail

Detalle asociado al movimiento

id

Número de manejo interno del movimiento

reference

Número de referencia mostrado por el banco

extra_data

Información adicional del movimiento. Ej: Campo ITF para movimientos de BBVA PE. (Campo Nulo si la información no está disponible)

Respuesta

GET /account/12345/movement/?key=163d06b2-3378-4383-9868-71c2b6fb28da&currency=UYU&date_start=22%2F11%2F2020&date_end=23%2F11%2F2020 HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>
{
  "movements": [
    {
      "credit": "",
      "date": "12/01/2017",
      "debit": 3500,
      "detail": "RETIRO EFECTIVO CAJERO AUTOMATICO J.C. GOMEZ 1372, MONTEVIDEO TARJ: 4303090202018993",
      "id": -890185180,
      "reference": "000000005084",
      "extra_data": {
        "itf": 1.0
      }
    },
    {
      "credit": "",
      "date": "05/01/2017",
      "debit": 16000,
      "detail": "RETIRO EFECTIVO CAJERO AUTOMATICO J.H Y OBES 1389, MONTEVIDEO TARJ: 4303090202018993",
      "id": 1024917397,
      "reference": "000000002931",
      "extra_data": {
        "itf": 1.0
      }
    },
    {
      "credit": 98640,
      "date": "03/01/2017",
      "debit": "",
      "detail": "SUELDOS 123456TT RECIBIDA /Qualia Fintech S.R.L",
      "id": 1303899175,
      "reference": "TR0003858408"
      "extra_data": {
        "itf": 1.0
      }
    }
  ],
  "status": "success"
}
curl -X GET "https:///account/12345/movement/?key=163d06b2-3378-4383-9868-71c2b6fb28da&currency=UYU&date_start=22%2F11%2F2020&date_end=23%2F11%2F2020"  -H "X-API-Key: <API KEY>"
{
  "movements": [
    {
      "credit": "",
      "date": "12/01/2017",
      "debit": 3500,
      "detail": "RETIRO EFECTIVO CAJERO AUTOMATICO J.C. GOMEZ 1372, MONTEVIDEO TARJ: 4303090202018993",
      "id": -890185180,
      "reference": "000000005084",
      "extra_data": {
        "itf": 1.0
      }
    },
    {
      "credit": "",
      "date": "05/01/2017",
      "debit": 16000,
      "detail": "RETIRO EFECTIVO CAJERO AUTOMATICO J.H Y OBES 1389, MONTEVIDEO TARJ: 4303090202018993",
      "id": 1024917397,
      "reference": "000000002931",
      "extra_data": {
        "itf": 1.0
      }
    },
    {
      "credit": 98640,
      "date": "03/01/2017",
      "debit": "",
      "detail": "SUELDOS 123456TT RECIBIDA /Qualia Fintech S.R.L",
      "id": 1303899175,
      "reference": "TR0003858408"
      "extra_data": {
        "itf": 1.0
      }
    }
  ],
  "status": "success"
}
import requests

requests.get('https:///account/12345/movement/', params={
    'key': '163d06b2-3378-4383-9868-71c2b6fb28da',
    'currency': 'UYU',
    'date_start': '22/11/2020',
    'date_end': '23/11/2020',
}, headers={
    'X-API-Key': '<API KEY>'
})
{
  "movements": [
    {
      "credit": "",
      "date": "12/01/2017",
      "debit": 3500,
      "detail": "RETIRO EFECTIVO CAJERO AUTOMATICO J.C. GOMEZ 1372, MONTEVIDEO TARJ: 4303090202018993",
      "id": -890185180,
      "reference": "000000005084",
      "extra_data": {
        "itf": 1.0
      }
    },
    {
      "credit": "",
      "date": "05/01/2017",
      "debit": 16000,
      "detail": "RETIRO EFECTIVO CAJERO AUTOMATICO J.H Y OBES 1389, MONTEVIDEO TARJ: 4303090202018993",
      "id": 1024917397,
      "reference": "000000002931",
      "extra_data": {
        "itf": 1.0
      }
    },
    {
      "credit": 98640,
      "date": "03/01/2017",
      "debit": "",
      "detail": "SUELDOS 123456TT RECIBIDA /Qualia Fintech S.R.L",
      "id": 1303899175,
      "reference": "TR0003858408"
      "extra_data": {
        "itf": 1.0
      }
    }
  ],
  "status": "success"
}
var request = require('request');

request.get({
  "url": "https:///account/12345/movement/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "key": "163d06b2-3378-4383-9868-71c2b6fb28da",
    "currency": "UYU",
    "date_start": "22/11/2020",
    "date_end": "23/11/2020"
  }
});
{
  "movements": [
    {
      "credit": "",
      "date": "12/01/2017",
      "debit": 3500,
      "detail": "RETIRO EFECTIVO CAJERO AUTOMATICO J.C. GOMEZ 1372, MONTEVIDEO TARJ: 4303090202018993",
      "id": -890185180,
      "reference": "000000005084",
      "extra_data": {
        "itf": 1.0
      }
    },
    {
      "credit": "",
      "date": "05/01/2017",
      "debit": 16000,
      "detail": "RETIRO EFECTIVO CAJERO AUTOMATICO J.H Y OBES 1389, MONTEVIDEO TARJ: 4303090202018993",
      "id": 1024917397,
      "reference": "000000002931",
      "extra_data": {
        "itf": 1.0
      }
    },
    {
      "credit": 98640,
      "date": "03/01/2017",
      "debit": "",
      "detail": "SUELDOS 123456TT RECIBIDA /Qualia Fintech S.R.L",
      "id": 1303899175,
      "reference": "TR0003858408"
      "extra_data": {
        "itf": 1.0
      }
    }
  ],
  "status": "success"
}

Preprocesar transferencia

Endpoint: POST /transfer/preprocess

Parámetros Descripción
key

Clave de sesion

origin_account

Numero de cuenta de donde se transfiere

destination_institution

Id de la institucion a donde se transfiere, el id se obtiene en el endpoint de listar instituciones para transferencias

destination_account

Numero de cuenta a donde se transfiere

currency

Moneda de la cuenta en formato ISO 4217, por ejemplo UYU o USD.

amount

Cantidad a transferir

concept

Concepto o descripcion de la transferencia

destination_owner_name

Nombre del titular de la cuenta de destino (vacio si no aplica)

branch

Numero de sucursal de la cuenta de destino (vacio si no aplica)

Respuesta

POST /transfer/preprocess?key=163d06b2-3378-4383-9868-71c2b6fb28da HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

origin_account=12345678&destination_institution=0&destination_account=001002363321&currency=UYU&amount=1.3&concept=descripcion+de+transferencia&destination_owner_name=John+Doe&branch=62
{
    "result": {
        "approved": true,
        "authorization_devices": [
            {
                "data": ["F-4", "B-2", "G-7"],
                "type": "cardCode"
            },
            {
                "data": null,
                "type": "pin"
            }
        ],
        "message": null,
        "request_id": "0b7d6b32d1be4c11bde21e7ddc08cc36"
    },
    "status": "success"
}
curl -X POST "https:///transfer/preprocess?key=163d06b2-3378-4383-9868-71c2b6fb28da" -d "origin_account=12345678&destination_institution=0&destination_account=001002363321&currency=UYU&amount=1.3&concept=descripcion+de+transferencia&destination_owner_name=John+Doe&branch=62" -H "X-API-Key: <API KEY>"
{
    "result": {
        "approved": true,
        "authorization_devices": [
            {
                "data": ["F-4", "B-2", "G-7"],
                "type": "cardCode"
            },
            {
                "data": null,
                "type": "pin"
            }
        ],
        "message": null,
        "request_id": "0b7d6b32d1be4c11bde21e7ddc08cc36"
    },
    "status": "success"
}
import requests

requests.post('https:///transfer/preprocess', params={
    'key': '163d06b2-3378-4383-9868-71c2b6fb28da',
}, data={
    'origin_account': '12345678',
    'destination_institution': '0',
    'destination_account': '001002363321',
    'currency': 'UYU',
    'amount': '1.3',
    'concept': 'descripcion de transferencia',
    'destination_owner_name': 'John Doe',
    'branch': '62',
}, headers={
    'X-API-Key': '<API KEY>'
})
{
    "result": {
        "approved": true,
        "authorization_devices": [
            {
                "data": ["F-4", "B-2", "G-7"],
                "type": "cardCode"
            },
            {
                "data": null,
                "type": "pin"
            }
        ],
        "message": null,
        "request_id": "0b7d6b32d1be4c11bde21e7ddc08cc36"
    },
    "status": "success"
}
var request = require('request');

request.post({
  "url": "https:///transfer/preprocess",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "key": "163d06b2-3378-4383-9868-71c2b6fb28da"
  },
  "form": {
    "origin_account": "12345678",
    "destination_institution": "0",
    "destination_account": "001002363321",
    "currency": "UYU",
    "amount": "1.3",
    "concept": "descripcion de transferencia",
    "destination_owner_name": "John Doe",
    "branch": "62"
  }
});
{
    "result": {
        "approved": true,
        "authorization_devices": [
            {
                "data": ["F-4", "B-2", "G-7"],
                "type": "cardCode"
            },
            {
                "data": null,
                "type": "pin"
            }
        ],
        "message": null,
        "request_id": "0b7d6b32d1be4c11bde21e7ddc08cc36"
    },
    "status": "success"
}

Confirmar transferencia

Endpoint: POST /transfer/confirm

Parámetros Descripción
key

Clave de sesion

request_id

Id de la request retornada por el endpoint de preprocesar transferencia

authorization_type
  • cardCode Tarjeta de coordenadas.

  • pin Pin personal de la cuenta.

  • otp Pin genereado por única vez, enviado por sms, email, hard token o soft token.

  • otp-api Dispositivo hard token o soft token, digitalizado por Prometeo.

authorization_data

Valor de verificacion (numero de pin, respuesta de tarjeta de coordenadas, etc) si son varios valores, deben ir separados por coma.

authorization_device_number

Numero de serie asignado al dispositivo de autenticacion. Este campo es opcional a excepción de los siguientes proveedores: Telecrédito.

Respuesta:

Status Descripción
message

Mensaje con respuesta del banco

success

Confirmación de si se realizó la transferencia

Respuesta

POST /transfer/confirm?key=163d06b2-3378-4383-9868-71c2b6fb28da HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>

request_id=0b7d6b32d1be4c11bde21e7ddc08cc36&authorization_type=cardCode&authorization_data=1%2C2%2C3&authorization_device_number=01
{
    "status": "success",
    "transfer": {
        "message": "Transferencia confirmada con exito",
        "success": true
    }
}
curl -X POST "https:///transfer/confirm?key=163d06b2-3378-4383-9868-71c2b6fb28da" -d "request_id=0b7d6b32d1be4c11bde21e7ddc08cc36&authorization_type=cardCode&authorization_data=1%2C2%2C3&authorization_device_number=01" -H "X-API-Key: <API KEY>"
{
    "status": "success",
    "transfer": {
        "message": "Transferencia confirmada con exito",
        "success": true
    }
}
import requests

requests.post('https:///transfer/confirm', params={
    'key': '163d06b2-3378-4383-9868-71c2b6fb28da',
}, data={
    'request_id': '0b7d6b32d1be4c11bde21e7ddc08cc36',
    'authorization_type': 'cardCode',
    'authorization_data': '1,2,3',
    'authorization_device_number': '01',
}, headers={
    'X-API-Key': '<API KEY>'
})
{
    "status": "success",
    "transfer": {
        "message": "Transferencia confirmada con exito",
        "success": true
    }
}
var request = require('request');

request.post({
  "url": "https:///transfer/confirm",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "key": "163d06b2-3378-4383-9868-71c2b6fb28da"
  },
  "form": {
    "request_id": "0b7d6b32d1be4c11bde21e7ddc08cc36",
    "authorization_type": "cardCode",
    "authorization_data": "1,2,3",
    "authorization_device_number": "01"
  }
});
{
    "status": "success",
    "transfer": {
        "message": "Transferencia confirmada con exito",
        "success": true
    }
}

Listar Instituciones para Transferencias

Endpoint: GET /transfer/destinations

Parámetros Descripción
key

Clave de sesion

Respuesta:

Status Descripción
id

Número de identificación de la institución.

name

Nombre de la institución disponible para transferencias.

Respuesta

GET /transfer/destinations?key=163d06b2-3378-4383-9868-71c2b6fb28da HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>
{
    "destinations": [
        {
            "id": 0,
            "name": "SANTANDER"
        },
        {
            "id": 1,
            "name": "B.R.O.U."
        },
        {
            "id": 91,
            "name": "B.H.U."
        },
        {
            "id": 110,
            "name": "BANDES"
        }
    ],
    "status": "success"
}
curl -X GET "https:///transfer/destinations?key=163d06b2-3378-4383-9868-71c2b6fb28da"  -H "X-API-Key: <API KEY>"
{
    "destinations": [
        {
            "id": 0,
            "name": "SANTANDER"
        },
        {
            "id": 1,
            "name": "B.R.O.U."
        },
        {
            "id": 91,
            "name": "B.H.U."
        },
        {
            "id": 110,
            "name": "BANDES"
        }
    ],
    "status": "success"
}
import requests

requests.get('https:///transfer/destinations', params={
    'key': '163d06b2-3378-4383-9868-71c2b6fb28da',
}, headers={
    'X-API-Key': '<API KEY>'
})
{
    "destinations": [
        {
            "id": 0,
            "name": "SANTANDER"
        },
        {
            "id": 1,
            "name": "B.R.O.U."
        },
        {
            "id": 91,
            "name": "B.H.U."
        },
        {
            "id": 110,
            "name": "BANDES"
        }
    ],
    "status": "success"
}
var request = require('request');

request.get({
  "url": "https:///transfer/destinations",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  },
  "qs": {
    "key": "163d06b2-3378-4383-9868-71c2b6fb28da"
  }
});
{
    "destinations": [
        {
            "id": 0,
            "name": "SANTANDER"
        },
        {
            "id": 1,
            "name": "B.R.O.U."
        },
        {
            "id": 91,
            "name": "B.H.U."
        },
        {
            "id": 110,
            "name": "BANDES"
        }
    ],
    "status": "success"
}

Listar proveedores

Endpoint: GET /provider/

Respuesta:

Status Descripción
code

Código a utilizar para llamar a un proveedor.

country

País del proveedor.

name

Nombre del proveedor.

Un proveedor es una fuente de datos financieros.

Respuesta

GET /provider/ HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>
{
    "providers": [
        {
            "code": "test",
            "country": "UY",
            "name": "Test Provider"
        }
    ],
    "status": "success"
}
curl -X GET "https:///provider/"  -H "X-API-Key: <API KEY>"
{
    "providers": [
        {
            "code": "test",
            "country": "UY",
            "name": "Test Provider"
        }
    ],
    "status": "success"
}
import requests

requests.get('https:///provider/', headers={
    'X-API-Key': '<API KEY>'
})
{
    "providers": [
        {
            "code": "test",
            "country": "UY",
            "name": "Test Provider"
        }
    ],
    "status": "success"
}
var request = require('request');

request.get({
  "url": "https:///provider/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  }
});
{
    "providers": [
        {
            "code": "test",
            "country": "UY",
            "name": "Test Provider"
        }
    ],
    "status": "success"
}

Detalle de proveedores

Endpoint: GET /provider/{code}/

Respuesta:

Status Descripción
auth_fields

Campos para la autentificación en el proveedor.

country

País del proveedor.

name

Nombre del proveedor.

status

Estado del proveedor.

Respuesta

GET /provider/test/ HTTP/1.1
Host: 
Accept: application/json
Content-Type: application/x-www-form-urlencoded
X-API-Key: <API KEY>
{
  "provider": {
        "auth_fields": [
            {
                "interactive": false,
                "name": "username",
                "type": "text"
            },
            {
                "interactive": false,
                "name": "password",
                "type": "password"
            }
        ],
        "country": "UY",
        "name": "test"
  },
  "status": "success"
}
curl -X GET "https:///provider/test/"  -H "X-API-Key: <API KEY>"
{
  "provider": {
        "auth_fields": [
            {
                "interactive": false,
                "name": "username",
                "type": "text"
            },
            {
                "interactive": false,
                "name": "password",
                "type": "password"
            }
        ],
        "country": "UY",
        "name": "test"
  },
  "status": "success"
}
import requests

requests.get('https:///provider/test/', headers={
    'X-API-Key': '<API KEY>'
})
{
  "provider": {
        "auth_fields": [
            {
                "interactive": false,
                "name": "username",
                "type": "text"
            },
            {
                "interactive": false,
                "name": "password",
                "type": "password"
            }
        ],
        "country": "UY",
        "name": "test"
  },
  "status": "success"
}
var request = require('request');

request.get({
  "url": "https:///provider/test/",
  "json": true,
  "headers": {
    "X-API-Key": "<API KEY>"
  }
});
{
  "provider": {
        "auth_fields": [
            {
                "interactive": false,
                "name": "username",
                "type": "text"
            },
            {
                "interactive": false,
                "name": "password",
                "type": "password"
            }
        ],
        "country": "UY",
        "name": "test"
  },
  "status": "success"
}

Especificación OpenAPI