Confirmação do desafio

Este endpoint permite que o cliente do parceiro Bankly responda o desafio enviado para ele, confirmando ou não a sua identidade.

🚧
Importante
O prazo máximo para responder ao desafio 3DS é de 5 minutos para transações web e 10 minutos para transações não web (por exemplo, aplicativos).

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

O challengeId tenha sido obtido por meio do evento PRE_AUTHENTICATION_CHALLENGE_WAS_REQUESTED e vinculado a um desafio criado pelo parceiro;
O desafio tenha sido enviado pelo parceiro a seu cliente.

Requisição (Request)

Requisição HTTP

PATCH https://api.sandbox.bankly.com.br/card-network-transactions/authentication/challenge/{challengeId}/confirm

     --request PATCH \
     --url 'https://api.sandbox.bankly.com.br/card-network-transactions/authentication/challenge/{challengeId}/confirm' \
     --header 'accept: application/json' \
     --header 'api-version: 1' \
     --header 'authorization: Bearer {{Token}}' \
     --header 'content-type: application/*+json' \
     --data '
{
     "allowTransaction": "TRUE",
     "documentNumber": "47742663023"
}'

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
`card.network.transactions.3ds.write`	Concede acesso para a simulação de criação do desafio.

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.

Parâmetros da rota (Path)

No path desta requisição envie os seguintes campos:

Nome	Tipo	Descrição
`challengeId`	`path`	Obrigatório. Id recebido via webhook e que foi associado ao desafio enviado ao cliente do parceiro. No caso de sandbox, trata-se do id retornado na simulação de criação do challengeId.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

Nome	Tipo	Descrição	Especificação
`allowTransaction`	`boolean`	Indica se é para confirmar a transação (true) ou para negá-la (false).	—
`documentNumber`	`string`	Número do documento.	Informe somente números, sem caracteres especiais.

{
     "allowTransaction": "TRUE",
     "documentNumber": "47742663023"
}

Resposta (Response)

O status code 204 indicará sucesso no envio da confirmação.

👍
Dica
Para simular uma requisição nesse 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
409	CONFLICT_STATUS	Status Conflicted to authenticate. Not possible to confirm this authenticate	A solicitação conflitou com o estado atual do recurso existente no servidor.
409	CHALLENGE_EXPIRED	It isn't allowed to confirm an expired challenge	Não é permitido confirmar desafio expirado.
409	CHALLENGE_ALREADY_COMPLETED	It isn't allowed to confirm a challenge already completed	Não é permitido confirmar desafio já concluído.
409	CHALLENGE_STILL_IN_PROCESS	It isn't allowed to confirm a challenge in process	Não é permitido confirmar desafio ainda em processamento.

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.