3. Acceso a los datos
a) Loggin
Con el consentimiento creado y aprobado y con el data_ID
correctamente almacenado, ya puedes comenzar a capturar tu información bancaria mediante nuestra API Banking, para automatizar procesos o disponibilizar la información en tus sistemas internos..
Para comenzar, en nuestro Endpoint /login
debes indicar la cuenta con la que precisas interactuar. Esto lo realizas indicando en el parámetro username
el data_ID
asociado a los permisos otorgados para esa cuenta.
Nuestra API te devolverá una respuesta exitosa con una key
, indicandote la validez del username provisto y que será utilizada para interactuar con los endpoints de Accounts y Movements.
{
"key": "mocked_key_1234567890abcdef",
"status": "logged_in"
}
b) Accounts
Con la key
obtenida del inicio de sesión exitoso, puedes consultar las cuentas disponibles y su información el Endpoint de accounts
. Aquí encontrarás información importante de tus cuentas y el balance actual de las mismas:
{
"status": "success",
"accounts": [
{
"id": "12345678-12ab-cd34-56ef-ghi11e11j111",
"name": "CONTA_PAGAMENTO_PRE_PAGA",
"number": "123456789-0",
"branch": "0001",
"currency": "BRL",
"balance": "1500.0000"
}
]
}
c) Movements
Nuevamente, con la key
obtenida del inicio de sesión exitoso, puedes consultar el Endpoint>> de movements
, donde, indicando el número de cuenta y las fechas que quieres consultar, obtendrás los movimientos y transacciones asociados:
{
"status": "success",
"movements": [
{
"id": "mocked_movement_id_01",
"reference": "mocked_reference_id_01",
"date": "11/06/2024",
"detail": "Transferência Recebida",
"debit": "",
"credit": "100.0000",
"extra_data": null
},
{
"id": "mocked_movement_id_02",
"reference": "mocked_reference_id_02",
"date": "22/06/2024",
"detail": "Compra no débito",
"debit": "31.4000",
"credit": "",
"extra_data": null
},
{
"id": "mocked_movement_id_03",
"reference": "mocked_reference_id_03",
"date": "17/07/2024",
"detail": "Transferência Recebida",
"debit": "",
"credit": "200.0000",
"extra_data": null
},
{
"id": "mocked_movement_id_04",
"reference": "mocked_reference_id_04",
"date": "18/07/2024",
"detail": "Pagamento de fatura",
"debit": "206.1200",
"credit": "",
"extra_data": null
},
{
"id": "mocked_movement_id_05",
"reference": "mocked_reference_id_05",
"date": "30/07/2024",
"detail": "Transferência Recebida",
"debit": "",
"credit": "12767.2600",
"extra_data": null
}
]
}
Updated about 1 month ago