Serviço de marcação de fraude

Após uma transação com antifraude bem sucedida (pagamento com status CON, PPC, PPN ou EST), a loja pode vir a identificar que, na realidade, tratava-se de uma fraude. Nesse caso, a loja pode realizar uma chamada ao serviço de marcação de fraude para avisar a instituição de análise de risco sobre essa ocorrência. Isso irá refinar o processo de análise dessa instituição, tornando-o mais preciso e evitando mais fraudes futuramente.

Atualmente, esta API suporta as seguintes instituições de antifraude:

  • Konduto
  • Fraud Detect
  • ClearSale REST

Detalhes da chamada#

  • Recurso: /v1/transactions/{nit}/fraud
  • Método HTTP: POST
  • Formato da requisição: JSON
  • Formato da resposta: JSON
  • Parâmetros de cabeçalho:
ParâmetroDescriçãoFormatoObrigatório
merchant_idCódigo da loja no Carat. Os códigos de produção e certificação serão diferentes.< 15 ANSIM
merchant_keyChave de autenticação da loja no Carat. As chaves de produção e certificação serão diferentes.< 80 ANSIM
Content-TypeDeve ser enviado com o valor application/json.= 15 ANSIM

Exemplos#

Abaixo está um exemplo de chamada do serviço de marcação de fraude utilizando a ferramenta cURL.

Requisição:

Para usar este exemplo, não esquecer de definir a variável {{url}} com o valor
esitef-homologacao.softwareexpress.com.br

curl
--request POST "https://{{url}}/e-sitef/api/v1/transactions/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/fraud"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{}
--verbose

Resposta:

{
"code": "0",
"message": "OK. Transaction successful.",
"analysis": {
"code": "0",
"message": "Sucesso"
}
}

Parâmetros de requisição#

Até o momento, não existem parâmetros a serem enviados no corpo da requisição.

Parâmetros de resposta#

Em caso de sucesso, o código de resposta HTTP será 201. Qualquer outro código deve ser interpretado como erro. Na tabela abaixo está a descrição dos parâmetros de resposta do serviço de marcação de fraude:

ParâmetroDescriçãoFormato
codeCódigo de resposta do Carat. Qualquer código diferente de 0 significa falha. Saiba mais.< 4 N
messageMensagem de resposta do Carat.< 500 AN
analysis
codeCódigo de resposta da instituição de análise de risco.< 4 N
messageMensagem de resposta da instituição de análise de risco.< 500 AN