Adição de cliente à lista de bypass

Este endpoint permite que o parceiro Bankly adicione o documento de um cliente (CPF ou CNPJ) à lista de bypass do motor de análise de risco.

A inclusão do cliente na lista de bypass assegura que as transações de cartão vinculadas ao documento do cliente sigam um fluxo alternativo de análise antifraude.

🚧
Importante
Atualmente, o bypass pode ser configurado exclusivamente para que as transações efetuadas com um cartão específico sejam automaticamente aprovadas para os clientes adicionados à lista.

Requisição (Request)

Requisição HTTP

POST https://api-mtls.sandbox.bankly.com.br/antifraud/analysis/bypass

--request POST \ 
--url 'https://api-mtls.sandbox.bankly.com.br/antifraud/analysis/bypass' \
--header 'x-correlation-id: f20347b4-09db-42fe-9fae-b1d5a5ae9db1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer _0XBPWQQ_9173cda2-3866-49af-a55d-cae9b02d2ec6' \
--data '{
    "cardProxy": "2307271002878379965",
    "holder": {
        "document": {
            "value": "47742663023",
            "type": "CPF"
        }
    },
    "category": {
        "name": "Category name",
        "value": "approve"
    },
    "note": "bypass note",
    "expirate":{
      "ttl": "259200",
      "startTime": "2021-10-28T10:42:53.431-03:00"
  	}
}'

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Scope	Descrição
`antifraud.bypass.write`	Concede acesso para solicitar a inclusão de um CPF ou CNPJ em uma lista de bypass no motor de análise de risco.

Cabeçalhos (Headers)

Nome	Descrição
`api-version`	Obrigatório. Versão da API. Atualmente estamos na versão 1.0.
`Authorization`	Obrigatório. Token de autorização do tipo Bearer.
`x-correlation-id`	Informe um GUID, sendo um novo cada requisição.

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição	Especificação
`cardProxy`	`string`	Obrigatório*. Código identificador do cartão.	Informe somente números.
`holder`	`object`	Objeto que deverá conter informações sobre o titular do cartão.	—
`holder.document`	`object`	Objeto que deverá conter informações sobre o documento do titular do cartão.	—
`holder.document.value`	`string`	Obrigatório*. Número do documento.	Informe somente números.
`holder.document.type`	`string`	Obrigatório*. Tipo do documento, que pode ser “CPF” ou “CNPJ”.	—
`category`	`object`	Objeto que deverá conter informações sobre a categoria de bypass e o resultado esperado para a transação.	—
`category.name`	`string`	Obrigatório. Nome da categoria de bypass* na qual o cliente deverá ser inserido.	Insira a palavra em letras minúsculas.
`category.value`	`string`	Obrigatório. Resultado esperado do motor de análise de risco após a verificação do documento do cliente na lista de categorias debypass. Este campo deve ser preenchido com o valor"approve".*	Insira a palavra em letras minúsculas.
`note`	`string`	Nota referente à inserção do cliente na lista de bypass. Ex.: “Incluído devido a questões regulatórias.“	Máximo de 256 caracteres.
`expirate`	`object`	Objeto que deverá conter informações sobre o início e o fim da habilitação do cliente na lista de bypass.	—
`expirate.ttl`	`number`	Tempo, em segundos, em que o cliente ficará habilitado na lista de bypass. Ex.: “259200. Importante: caso este campo não seja enviado, será adotado o valor padrão de 24 horas.	Mínimo de 60 segundos.
`expirate.startTime`	`string`	Data e hora em que o cliente deve ser habilitado na lista. Importante*: caso este campo não seja enviado, a data/hora de início será o momento em que a requisição foi recebida.	Formato ISO 8601 - UTC.

{
	"cardProxy": "2307271002878379965",
  "holder": {
   "document": {
     "value": "66002291016",
     "type": "CPF"
   }
  },
	"category": {
     "name": "bv-cards-ListaTesteCPF",
     "value": "approve"
	},
	"note": "bypass note",
  "expirate":{
    "ttl": "259200",
    "startTime": "2021-10-28T10:42:53.431-03:00"
  }
}

Resposta (Response)

O status code 200 indicará que a solicitação foi recebida e o cliente foi incluído na lista de bypass com sucesso.

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Nome	Tipo	Descrição	Número máximo de caracteres
`byPassId`	`string`	Identificador único da lista de bypass na qual o cliente está inserido.	—
`elementId`	`string`	Identificador único do cliente.	—
`elementType`	`string`	Tipo do documento do cliente, que pode ser “CPF” ou “CNPJ”.	—
`createdAt`	`string`	Data e hora de realização da requisição, no formato ISO 8601 - UTC.	—
`startAt`	`string`	Data e hora do início da habilitação do cliente, no formato ISO 8601 - UTC.	—
`finishAt`	`string`	Data e hora do fim da habilitação do cliente, no formato ISO 8601 - UTC.	—

{
   "byPassId": "edb67e13-3e18-4c1e-9417-723e19768824",
   "elementId": "2307271002878379965",
   "elementType": "Card",
   "createdAt": "2024-09-25T14:37:53.7606755Z",
   "startAt": "2024-09-25T14:37:58.7609458Z",
   "finishAt": "2024-09-26T14:37:58.7609458Z"
}

👍
Dica
Para simular uma requisição neste endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Status Code	Código	Mensagem	Descrição
422	ELEMENT_NOT_FOUND	Bypass element not found.	Cartão não encontrado.
422	DECISION_NOT_MAPPED	Decision not found or unmapped to the element type.	A categoria (`category.name`) não foi encontrada ou não está associada ao tipo do documento informado.
422	DECISION_NOT_ENABLED	Decision not enabled for this category.	O resultado do campo `category.value` não está habilitado para a categoria (`category.name`). informada.
422	ELEMENT_IS_NOT_ACTIVE	Bypass element is not active.	O cartão informado (`cardProxy`) não está ativo.
422	ELEMENT_NOT_FOUND	Bypass element not found.	O cartão informado (`cardProxy`) não foi encontrado.
422	ELEMENT_NOT_MATCH	Bypass element does not exist or can not be linked to the bypass.	O cartão (`cardProxy`) não existe ou não pertence ao titular (`holder`) informado.
422	BYPASS_NOT_CREATED	An unexpected error occurred during the bypass create process in the provider.	Um erro desconhecido ocorreu e o cliente não foi incluído na lista de bypass.
422	BYPASS_NOT_CONFIRMED	An unexpected error occurred during the bypass confirmation process.	Um erro desconhecido ocorreu no momento de processamento da requisição, mas o cliente pode ter sido incluído na lista de bypass.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.

Updated 19 days ago

Did this page help you?