Skip to main content
POST
Esta rota encerra uma autenticação 3DS que ficou pela metade. Use quando o comprador fecha o desafio do banco, volta para trocar de cartão ou desiste da compra. Cancelar deixa claro que aquela autenticação não será usada e evita confusão entre tentativas.

Quando usar

Antes de chamar

  • Tenha o authenticationId devolvido por POST /v1/three-ds/authenticate.
  • A autenticação precisa estar em requires_submission ou requires_challenge.
  • Use a chave pública (pk_, ou pk_test_ no sandbox) no cabeçalho Basic, como usuário e com senha vazia.
O contrato desta rota declara a autenticação basic e diz, na descrição da rota, que a chave usada é a pública (pk_). A descrição genérica do esquema basic no contrato fala em chave secreta. Siga a descrição da rota: chave pública.

Corpo da requisição

string
required
ID da autenticação 3DS a cancelar, exatamente como veio em POST /v1/three-ds/authenticate. O valor é opaco: não valide prefixo nem tamanho. Ex.: tdsa_1QmCRMJM0r9zBvr4OVmMRa6X.

Respostas

string
ID da autenticação cancelada. Ex.: tdsa_1QmCRMJM0r9zBvr4OVmMRa6X.
string
Status da autenticação depois do cancelamento. Ex.: canceled.
Os erros vêm no formato { statusCode, message, error }. Trate o erro pelo código HTTP, não pelo texto da mensagem.
O contrato não documenta a resposta para o cancelamento de uma autenticação que já está em estado final (por exemplo, succeeded). Chame esta rota só nos estados requires_submission e requires_challenge.
Para o negócio: cancelar uma autenticação não cria nem cancela cobrança. A cobrança só existe depois de POST /v1/charges. Se o comprador desistiu antes disso, nada foi cobrado.

Exemplo: comprador fechou o desafio

Para o desenvolvedor: para uma nova tentativa depois do cancelamento, inicie uma nova autenticação em POST /v1/three-ds/authenticate. Use o novo authenticationId devolvido por ela nas etapas seguintes.

Erros comuns

Veja também

Iniciar autenticação

Comece uma nova tentativa.

Enviar autenticação

Etapa anterior ao desafio.

3DS via API

Guia do fluxo completo.

Visão geral do 3D Secure

Os três caminhos de 3DS.