Pular para o conteúdo principal

Introdução

Bem vindo à API de Banking da QI Tech! Esta API dá acesso à funcionalidade de prevenção a fraudes para operações de bancos e contas digitais, como por exemplo análises de transferências, pagamentos de contas e pagamentos de boletos.

Abaixo, você pode observar a implementação da API utilizando cUrl. Com isso você possui exemplos para poder adaptar adequadamente à linguagem de programação da sua preferência.

Problemas?

Nós não somos uma companhia que se esconde atrás de uma API! Entre em contato com o nosso suporte e nós responderemos o mais rápido possível. Fique à vontade para nos ligar caso deseje uma resposta rápida!

Adoramos Feedback

Mesmo que você já tenha resolvido o seu problema ou que ele seja muito simples (Até mesmo um typo ou uma organização inadequada que você já notou), envie-nos um e-mail, assim nós tornamos a documentação cada vez mais prática e a próxima pessoa não vai precisar sofrer as dores que você sofreu!

Ambientes

Possuímos dois ambientes para os nossos clientes. A URL base das APIs são:

  • Produção - https://api.caas.qitech.app/
  • Sandbox - https://api.sandbox.caas.qitech.app/

Análises no ambiente de Sandbox

No ambiente de Sandbox, as análises não são cobradas e são respondidas de acordo com regras simplificadas. Para o caso de wire_transfers, bankslips, bill_payments e pix, a resposta dada será baseada no valor da operação (amount) enviado na requisição:

mínimomáximodecisão
16000-Contestado Automaticamente*
1000015999Aprovado Automaticamente
60009999Derivado para Análise Manual
05999Reprovado Automaticamente

* Contestado Automaticamente está disponível apenas para o serviço de pix.

Para o caso de withdrawal e deposit a resposta dada será baseada no valor da operação (amount) enviado na requisição:

mínimomáximodecisão
10000-Aprovado Automaticamente
09999Reprovado Automaticamente

No caso de operações na DICT, a resposta dada será baseada na chave de vínculo na DICT (dict_key) enviada na requisição:

chave na Dictdecisão
"Approve_dict_key"Aprovado Automaticamente
Qualquer outra stringDerivado para Análise Manual
"Reprove_dict_key"Reprovado Automaticamente

Somente HTTPS

Por questão de segurança, toda a comunicação com as APIs da QI Tech devem ser realizadas utilizando a comunicação HTTPS. Para garantir que, por desatenção ou qualquer outro motivo, não ocorram chamadas HTTP, este servidor somente disponibiliza a porta 443 com comunicação TLS 1.2. Chamadas realizadas utilizando outros protocolos serão automaticamente negadas.

Fluxos - Transferências

O fluxo de análise de transferências é iniciado em duas situações:

  • Uma transferência está sendo efetuada pelo usuário do PSP
  • Uma transferência está sendo recebida pelo usuário do PSP

Em ambos os casos, uma chamada ao endpoint de wire_transfer deve ser realizada e os possíveis status resultantes são:

enumeradordescrição
automatically_approvedAprovado Automaticamente
automatically_reprovedReprovado Automaticamente
in_manual_analysisDerivado para Análise Manual
pendingO objeto de transferência bancária está sendo processado.

Caso a transferência seja derivada para análise manual, um analista deverá aprovar ou reprovar a transferência. Neste momento, um Webhook pode ser gerado para notificar a alteração de status ao PSP ou o PSP pode acompanhar a transferência por meio de Polling. Em ambos os casos, os seguintes status podem ser retornados:

enumeradordescrição
manually_approvedAprovado Manualmente
manually_reprovedReprovado Manual

Fluxos - Boletos

O fluxo de análise de Boletos é iniciado em duas situações:

  • Um pagamento de boleto está sendo efetuado pelo usuário do PSP
  • Um pagamento de boleto está sendo recebido pelo usuário do PSP

Em ambos os casos, uma chamada ao endpoint de bankslip deve ser realizada e os possíveis status resultantes são:

enumeradordescrição
automatically_approvedAprovado Automaticamente
automatically_reprovedReprovado Automaticamente
in_manual_analysisDerivado para Análise Manual
pendingO objeto de boleto está sendo processado.

Caso o pagamento de boleto seja derivado para análise manual, um analista deverá aprovar ou reprovar o pagamento. Neste momento, um Webhook pode ser gerado para notificar a alteração de status ao PSP ou o PSP pode acompanhar o pagamento por meio de Polling. Em ambos os casos, os seguintes status podem ser retornados:

enumeradordescrição
manually_approvedAprovado Manualmente
manually_reprovedReprovado Manual

Fluxos - Pagamentos de Contas

O fluxo de análise de Pagamentos de Contas é iniciado quando:

  • Um pagamento de conta está sendo efetuado pelo usuário do PSP

Neste caso uma chamada ao endpoint de bill_payment deve ser realizada e os possíveis status resultantes são:

enumeradordescrição
automatically_approvedAprovado Automaticamente
automatically_reprovedReprovado Automaticamente
in_manual_analysisDerivado para Análise Manual
pendingO objeto de pagamento de contas está sendo processado.

Caso o pagamento de conta seja derivado para análise manual, um analista deverá aprovar ou reprovar o pagamento. Neste momento, um Webhook pode ser gerado para notificar a alteração de status ao PSP ou o PSP pode acompanhar o pagamento por meio de Polling. Em ambos os casos, os seguintes status podem ser retornados:

enumeradordescrição
manually_approvedAprovado Manualmente
manually_reprovedReprovado Manual

Fluxos - Saques

O fluxo de análise de Saques é iniciado na seguinte situação:

  • Um saque está sendo efetuado pelo usuário do PSP

Em ambos os casos, uma chamada ao endpoint de withdrawal deve ser realizada e os possíveis status resultantes são:

enumeradordescrição
automatically_approvedAprovado Automaticamente
automatically_reprovedReprovado Automaticamente

Caso o saque seja derivado para análise manual, um analista deverá aprovar ou reprovar o saque. Neste momento, um Webhook pode ser gerado para notificar a alteração de status ao PSP ou o PSP pode acompanhar o pagamento por meio de Polling. Em ambos os casos, os seguintes status podem ser retornados:

enumeradordescrição
manually_approvedAprovado Manualmente
manually_reprovedReprovado Manual

Fluxos - Transação PIX

O fluxo de pagamento PIX é iniciado em duas situações:

  • Um pagamento sendo efetuado pelo usuário do PSP integrado na QI Tech
  • Um pagamento sendo recebido de outro PSP

Em ambos os casos, uma chamada ao endpoint de pagamento deve ser realizada e os possíveis status resultantes são:

enumeradordescrição
automatically_approvedAprovado Automaticamente
automatically_reprovedReprovado Automaticamente
in_manual_analysisDerivado para Análise Manual

Caso o pagamento seja derivado para análise manual, um analista deverá aprovar ou reprovar o pagamento. Neste momento, um Webhook pode ser gerado para notificar a alteração de status ao PSP ou o PSP pode acompanhar o pagamento por meio de Polling. Em ambos os casos, os seguintes status podem ser retornados:

enumeradordescrição
manually_approvedAprovado Manualmente
manually_reprovedReprovado Manualmente

Fluxos - Alteração na DICT

O fluxo de alteração na DICT é iniciado em duas situações:

  • O usuário do PSP integrado à QI Tech pede um cadastro/alteração/portabilidade/reivindicação ao PSP integrado à QI Tech
  • Uma portabilidade/reivindicação é recebida pelo PSP integrado à QI Tech

Nos cadastros iniciados pelo usuário do PSP, o fluxo de validação de chave deve ser executado antes da alteração na DICT, por meio das APIs de validação da QI Tech. Caso a validação seja realizada pelo próprio PSP, esta informação também pode ser enviada na requisição à QI Tech.

Para dar início ao processo, nestes dois momentos o PSP integrado à QI Tech deverá realizar uma chamada no endpoint adequado, que responderá um dos seguintes status:

enumeradordescrição
automatically_approvedAprovado Automaticamente
automatically_reprovedReprovado Automaticamente
in_manual_analysisDerivado para Análise Manual

Caso a alteração seja derivada para análise manual, um analista deverá aprovar ou reprovar a alteração. Neste momento, um Webhook pode ser gerado para notificar a alteração de status ao PSP ou o PSP pode acompanhar a alteração por meio de Polling. Em ambos os casos, os seguintes status podem ser retornados:

enumeradordescrição
manually_approvedAprovado Manualmente
manually_reprovedReprovado Manualmente

Autenticação

Para autenticar uma chamada, utilize o código seguinte:

# No shell, você somente precisa adicionar o header adequado em cada requisição
curl "api_endpoint_here"
-H "Authorization: EXAMPLE_API_KEY"

Substitua a API key 'EXAMPLE_API_KEY' com a sua chave adquirida com o nosso suporte.

Utilizamos uma API Key para permitir acesso a nossa API. Ela provavelmente já foi enviada por e-mail para você. Caso você ainda não tenha recebido a sua chave, envie um e-mail para suporte.caas@qitech.com.br.

Nossa API espera receber a API Key em todas as requisições ao nosso servidor em um header como o abaixo:

Authorization: EXAMPLE_API_KEY

Atenção

Você deve substituir EXAMPLE_API_KEY com a API Key recebida do suporte.