Introdução
Bem vindo à API de Prevenção a Fraudes em emissão de cartões da QI Tech! Você pode utilizar a nossa API para acessar os endpoints, a fim de receber a resposta de uma transação, além de utilizar para atualizar a situação de uma transação.
Atenção, esta API é direcionada para emissores de cartão, ou seja, empresas que dão o cartão na mão do portador para que ele possa transacionar. Ela tem como objetivo realizar toda a análise de segurança nas transações do seu cliente, evitando fraudes e outros tipos de incidentes (Transações decorrentes de assaltos, por exemplo).
Como funciona
A integração tem três chamadas. Todas usam a mesma API Key no header Authorization.
| Passo | Chamada | O que faz |
|---|---|---|
| 1 | POST /card_issuance/transaction | Envia a transação antes da autorização e devolve a recomendação em fraud_status. |
| 2 | PUT /card_issuance/transaction/{id} | Informa o desfecho real (capturada, cancelada, chargeback). Retroalimenta o modelo. |
| 3 | GET /card_issuance/transaction/{id} | Consulta o estado atual e o histórico de eventos. |
Além disso, alertas comportamentais sobre o portador são entregues por Webhook.
O fraud_status devolvido no passo 1 assume um destes valores:
| Valor | Ação recomendada |
|---|---|
automatically_approved | Gerar o código de autorização. |
automatically_declined | Negar a autorização. |
not_analyzed | A requisição usou analyze=false; siga a sua própria decisão. |
A página Transaction abre com um payload mínimo de 13 campos e traz exemplos prontos em Python, PHP, Node.js, Java, C# e curl.
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á entendeu), 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. As URLs base das APIs são:
- Produção -
https://api.caas.qitech.app/card_issuance/ - Sandbox -
https://api.sandbox.caas.qitech.app/card_issuance/
Não devem ser usados dados reais de pessoas físicas e/ou jurídicas nos ambientes de Sandbox da QI Tech.
No ambiente de Sandbox, as análises enviadas não são cobradas e são respondidas de acordo com regras pré estabelecidas.
Para a análise de uma transação, a seguinte regra é aplicada sobre o valor da transação:
| Mínimo | Máximo | Decisão |
|---|---|---|
| 10000 | - | automatically_approved |
| 0 | 9999 | automatically_declined |
Somente HTTPS
Por questão de segurança, toda a comunicação com as APIs da QI Tech deve ser realizada utilizando a comunicação HTTPS. Para evitar que, por desatenção ou outro motivo, sejam feitas chamadas HTTP, este servidor somente disponibiliza a porta 443 com comunicação TLS 1.2. Chamadas realizadas utilizando outros protocolos serão automaticamente negadas.
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-OF-API-KEY"
Substitua a API key 'EXAMPLE-OF-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-OF-API-KEY
Você deve substituir EXAMPLE-OF-API-KEY com a API Key recebida do suporte.