API (externa) de pagamento.

Introdução

No módulo de Processamento de Baixas, foi desenvolvida uma rota de API destinada ao processamento de contas que estejam em dívida ativa.

Procedimentos

A ferramenta utilizada para demonstrar os procedimentos a seguir e acessar a API externa é o Postman. Recomenda-se o uso dessa ferramenta, porém a escolha fica a critério do usuário.

1. Autenticação

Para iniciar a chamada da API desenvolvida, é necessário realizar a autenticação a fim de obter um token que será enviado para essa API. Utilizando a ferramenta escolhida, configure a requisição como POST e insira a URL de autenticação fornecida pela CEBI, que deve se assemelhar a: urlCebi/login/connect/token. É necessário preencher os parâmetros nos campos "Headers" e "Body". Em seguida, clique no botão "Send" para obter o token de autenticação. Para os parâmetros client_id e client_secret, é necessário fornecer o usuário e a senha disponibilizados pela própria CEBI.

2. Chamada da API

Para realizar a chamada da API, o tipo de requisição deve ser POST. A URL da API deve estar no seguinte formato: urlCebi/baixa/Api/MovimentosBaixaLancada/InclusaoMovimento/Externo.

No fornecimento das keys para a API, é necessário preencher os seguintes campos:

• AgenteArrecadadorId: (int).
• DataPagamento: (DateTime).
• DataContabil: (DateTime).
• Valor: (decimal).
• LigacaoId: (int) 'se trata do CDC do débito'.
• Referencia: (DateTime) 'mês e ano do débito'.
• DigitoVerificador: (int) 'DV da conta'.
• ContaEmDividaAtiva: (bool) 'passar como true por padrão'.
• TipoMovimento: (int) 'passar como 0 por padrão'.

Após a execução da chamada, a mensagem "Processamento de baixa realizado com sucesso." será exibida como resposta.