Para nós a conexão entre sistemas é primordial para garantir que a performance de nossas aplicações, entreguem o resultado pretendido pelos nossos parceiros.A implementação de Callback se torna indispensável, uma vez que possibilita uma gama de vantagens significativas.

Por meio das chamadas de call-back, é possível promover uma comunicação assertiva entre todas as áreas envolvidas no processo. Com isso não é necessário uma consulta incessante a API , por meio dos call-backs enviamos as informações, atualizações e notificações de maneira precisa. Dessa forma reduzimos o volume de requisições promovendo um fluxo mais eficiente no que diz respeito a performance do sistema em geral.

O call-back para acompanhamento dos status das propostas, deve ser enviado, tanto para o ambiente de homologação quanto para o ambiente de produção, se possível serem URLs diferentes. Esse call-back, é enviado via Query Parameter.

Métodos de autenticação aceitos pelo callback

AutenticaçãoChave
Bearer TokenAuthorizationBearer <token>
API KeyAPI-Key<sua_chave_de_api>
Basic AuthenticationAuthorizationBasic <base64_encoded_username:password>
X-API-KeyX-API-Key<sua_chave_de_api>
Digest AuthenticationAuthorizationDigest <digest_hash>
JWT (JSON Web Token)AuthorizationBearer <JWT_token>
HMAC (Hash-based Message Authentication Code)AuthorizationHMAC <hash_value>
OAuth TokensAuthorizationBearer <OAuth_token>
AWS SignatureAuthorizationAWS <signature>
Client CertificatesCertificate<client_certificate>

Exemplo de callback de proposta

Segue exemplo de URL e como parametrizamos para recebimento: xxxxxxxxxx.com.br?proposta=&situacao=&identificador=

Sendo:

Proposta: GUID único da proposta gerado no response no momento da inclusão da proposta.

Situação: ID da situação da proposta em nosso sistema.

Identificador: Caso seja enviado, esse campo representa o código da operação enviado na inclusão da proposta.

Tabela de Ids

IDDescriçãoObjetivo
0Em DigitaçãoProposta encontra-se em digitação
1Em AnáliseProposta foi enviada para fila de análise
2AprovadaProposta foi aprovada pela área de análise de crédito
3RecusadaProposta foi recusada pela área de análise de crédito
4CanceladaProposta foi cancelada pela área de análise de crédito
5PendenteProposta foi marcada como pendente pela área de análise de crédito, necessita de intervenção do integrador para retornar à fila de análise
6FinalizadaProposta foi finalizada
7ConferidaProposta foi conferida pela área de formalização
8LiberadaProposta foi liberada pela área de formalização para pagamento
9PagaProposta foi paga pela área financeira
10CedidaProposta foi cedida ao fundo
11Pendente PagamentoProposta foi marcada como pendente de pagamento devido à inconsistência em dados bancários, necessita intervenção do integrador para informar os dados corretos de pagamento e retornar para a fila de pagamento

Observação: Além dos dados já enviados na Query (Guid da Proposta, Status e Identificador), os call-backs de Pago “9” e Pendente pagamento “11” possuem um body com o campo “Descrição da ocorrência”, que informa o motivo da pendência do pagamento quando for um status “11” e quando for status “9” retorna com o texto “Crédito ou débito efetivado”. Segue abaixo exemplos de retorno:

Status 09:

Status 11:

Callbacks da Gestão de Contratos

Criação da Gestão de Contratos

Callback responsável por comunicar a criação de uma agenda de parcelas, detalhando informações sobre parcelas, valores e datas relevantes:

Cancelamento da Gestão de Contratos

Callback utilizado para notificar o cancelamento de uma agenda previamente criada, incluindo os detalhes do evento e o número da proposta associada:

Acréscimo/Abatimento

Callback que informa alterações financeiras em parcelas de uma proposta, seja por acréscimos ou abatimentos aplicados:

Lançamento de Parcela

Callback que comunica eventos relacionados ao lançamento de parcelas, como pagamento, abatimento, encargos ou liquidação:

Prorrogação de Vencimento

Callback usado para notificar prorrogações de vencimento de parcelas, informando a nova data e os motivos da alteração:

Geração de boleto

Callback que informa a geração de um boleto relacionado a uma proposta, incluindo o valor, número e data de vencimento:

Cancelamento de boleto

Callback utilizado para notificar o cancelamento de um boleto, incluindo o código do boleto cancelado e as parcelas associadas:

Considerações Finais

Recomenda-se que o endpoint configurado para receber os callbacks funcione principalmente como um repositório, minimizando o processamento no momento da recepção para evitar atrasos. Implementar processos complexos durante o recebimento dos callbacks pode resultar em timeouts e falhas na comunicação, comprometendo a eficiência do sistema. Opte por processar as mensagens recebidas de forma assíncrona para melhorar a performance e confiabilidade do seu sistema de callbacks.

Esta página foi útil?