Conecte sua conta
O Bancolombia só responde a um cliente com sessão iniciada: seu usuário e senha da Sucursal Virtual Personas. Cada consulta roda com a conexão própria da sua organização, então registre uma antes da sua primeira consulta. Registre a conta uma vez; a Croma inicia sessão em cada consulta e nunca guarda as credenciais em claro.POST /co/bancolombia/connections/v1 Registre uma conexão uma vez. A Croma a verifica com a fonte antes de salvá-la e responde com seu id e um nome mascarado.
connection_id.
Como o fluxo funciona, passo a passo: Conexões.
Liste e exclua:
bancolombia_connect, bancolombia_list_connections, bancolombia_delete_connection. Conectar a partir de um agente nunca passa as credenciais pela conversa: o agente recebe um link seguro e o usuário informa os dados da conta no console da Croma.
Quando uma consulta não pode rodar com nenhuma conexão:
As credenciais são criptografadas assim que chegam à Croma, ficam vinculadas à sua organização e só podem ser abertas pelo serviço isolado que faz login na fonte em seu nome. A API nunca as devolve nem as mostra a ninguém. Excluir uma conexão a destrói permanentemente.
Contas
POST /co/bancolombia/accounts/v1
Resposta
Cada conta tem seu
number, name e custom_name (o apelido que o cliente deu), seu type (savings, checking, credit_card ou other) e type_raw (o rótulo próprio do banco), currency, status, plan_name, os três saldos available_balance, current_balance e effective_balance, as flags allow_credit e allow_debit, holder_relation, joint_holder, opening_date e seu office.
Cada chamada lê o Bancolombia ao vivo com a sua conexão, então a resposta
está atualizada e nunca é compartilhada entre organizações.
Esta consulta pode demorar mais que uma solicitação típica. É um
trabalho assíncrono. Por padrão, a solicitação espera de forma síncrona e
retorna
{ data }, ou você pode fazer polling / usar um callback_url.Movimentos
POST /co/bancolombia/transactions/v1
Resposta
Cada movimento tem sua
date, description, amount (com o sinal que o Bancolombia reporta), movement_type (o rótulo próprio do Bancolombia), reference e seu office.
Cada chamada lê o Bancolombia ao vivo com a sua conexão, então a resposta
está atualizada e nunca é compartilhada entre organizações.
Esta consulta pode demorar mais que uma solicitação típica. É um
trabalho assíncrono. Por padrão, a solicitação espera de forma síncrona e
retorna
{ data }, ou você pode fazer polling / usar um callback_url.Referência completa
Esquemas, todos os campos de resposta e um playground interativo.