Webhooks
A Trio utiliza webhooks para enviar atualizações de maneira assíncrona sobre os endpoints de uma Connection.
O webhook pode ser configurado através dos endpoints disponíveis na nossa API.
Em cada notificação a Trio executa um POST com um payload no format JSON na URL cadastrada. Se a resposta da requisição não retornar o código 2XX, faremos mais 3 tentativas com alguns minutos de diferença entre elas.
Eventos
Todas as notificações disparadas pela Trio seguem um padrão de acordo com o exemplo abaixo:
{
"event": {
"account_id": "", // id da conta na requisição POST
"category": "", // BALANCES ou TRANSACTIONS
"type": "",
"status": "completed" // completed or failed
},
"data": {}, // quando completa com sucesso
"error": {} // quando houver uma falha
}
Balances
Com os webhooks vinculados a Balance é possível receber notificações sempre que houver uma atualização de saldo na instituição financeira.
Atualização do saldo
Você receberá o hook fetch_balances
toda vez que um processo de atualização na instituição financeira for concluído e receberá um payload:
{
"event": {
"account_id": "aadf41a1fc8e4f79a49f7f04027ac999",
"category": "BALANCES",
"type": "fetch_balances",
"status": "completed"
},
"data": {
"amount": { "amount": 28048963, "currency": "BRL" }
}
}
Se durante a atualização acontecer algum erro por falha de autenticação ou indisponibilidade, você receberá uma resposta como esta:
{
"event": {
"account_id": "aadf41a1fc8e4f79a49f7f04027ac999",
"category": "BALANCES",
"type": "fetch_balances",
"status": "failed"
},
"error": {
"message": "Unexpected error occurred"
}
}
Transactions
Com os webhooks vinculados, a Transaction poderá receber notificações sempre que houver uma atualização das transações na instituição financeira ou em uma integração recorrente.
Atualização das transações
Você receberá o hook fetch_transactions
toda a vez que um processo de atualização na instituição financeira for concluído, e receberá um payload:
{
"event": {
"account_id": "aadf41a1fc8e4f79a49f7f04027ac999",
"category": "TRANSACTIONS",
"type": "fetch_transactions",
"status": "completed"
},
"data": {
"total_transactions": 6
}
}
Se durante a atualização acontecer algum erro por falha de autenticação ou indisponibilidade você receberá uma resposta como esta:
{
"event": {
"account_id": "aadf41a1fc8e4f79a49f7f04027ac999",
"category": "TRANSACTIONS",
"type": "fetch_transactions",
"status": "failed"
},
"error": {
"message": "Unexpected error occurred"
}
}
Accounts
Com os webhooks vinculados a accounts, é possível receber notificações sempre que uma nova conexão for criada.
Esse webhook é utilizado para instituiçōes com tipo de autorização device, que demandam a busca de informações cadastrais de forma assíncrona. Para demais instituições, a busca de informações bancárias e cadastrais acontece na criação de uma
Connection
.
Atualização das accounts
Você receberá o hook fetch_accounts
toda a vez que um processo de criação de conexão com a instituição financeira for concluído e receberá um payload como este:
{
"event": {
"connection_id": "aadf41a1fc8e4f79a49f7f04027ac999",
"category": "ACCOUNTS",
"type": "fetch_accounts",
"status": "completed"
},
"data": {
"total_accounts": 3,
"holder_id": "bdb2noirjd21no21pd21pod21d12kokdl13"
}
}
Se durante a atualização acontecer algum erro por falha de autenticação ou indisponibilidade, você receberá uma resposta como esta:
{
"event": {
"connection_id": "aadf41a1fc8e4f79a49f7f04027ac999",
"category": "ACCOUNTS",
"type": "fetch_accounts",
"status": "failed"
},
"error": {
"message": "Unexpected error occurred"
}
}
Updated 4 months ago