Resposta AuthenticationResponseData
O objeto AuthenticationResponseData será retornado pelos serviços PCI-DSS abaixo, quando a autenticação do portador for requerida:
- PCI/Charge/Authenticate
- PCI/Authentication/CreateSession
- PCI/Charge/CreatePayment
- PCI/Charge/CreateToken
- PCI/Charge/VerifyPaymentMethod
Pode conter:
- ou seja os dados necessários para realizar a autenticação do portador (AuthenticationInstruction),
- ou seja, o resultado da autenticação (AuthenticationResult).
Referência da resposta
id
token único de autenticação, no formato UUID.
Formato
operationSessionId
Código único da sessão de autenticação.
Formato
instructionType
Caminho: value.instructionType
Tipo da instrução para ser realizada.
Formato
Valores possíveis
| valores | Descrição |
|---|---|
| FORM | Instrução de tipo redirecionamento por formulário |
value.name
Nome da instrução
Valores possíveis
| VALOR | Descrição |
|---|---|
| CHALLENGE | Instrução Challenge, que permite a autenticação interativa do usuário com o ACS |
| FINGERPRINT | Instrução Fingerprint, que permite identificar o usuário com o ACS |
Formato
value._type
Tipo de resposta recebida. A interpretação do restante da resposta depende deste atributo.
Valores possíveis
| VALOR | Descrição |
|---|---|
| AuthenticationInstruction | Resposta de tipo Instrução |
| AuthenticationResult | Resposta de tipo Resultado final |
Formato
value.timeout
Prazo máximo de espera da resposta para a execução de uma instrução, apresentado em segundos. Após este prazo, será preciso acionar o retorno para o servidor da plataforma de pagamento para obter o resultado final.
Formato
value.http.method
Método (verbo) usado para a solicitação.
Valores possíveis
| VALOR | Descrição |
|---|---|
| DELETE | Método Delete |
| GET | Método Get |
| PATCH | Método Patch |
| POST | Método Post |
| PUT | Método Put |
Formato
value.http.url
Url para qual apresentar o formulário http.
Formato
value.http.body
Lista dos parâmetros do corpo da solicitação, sob a forma “nome”: “valor”.
Formato
value.http.headers
Lista dos cabeçalhos da solicitação http, sob a forma de “nome”: “valor”
Formato
value.target.element
Tipo de elemento alvo html no qual deverá ser materializado a instrução.
Valores possíveis
| VALOR | Descrição |
|---|---|
| IFRAME | iFrame |
Formato
value.target.height
Altura do alvo html em pixeis.
Formato
value.target.visible
Boolean que indica se o alvo html deve ser visível ou não.
Formato
value.target.width
Largura do alvo html em pixeis.
Formato
value.target.showUrl
Campo técnico de uso interno, que permite exibir ou ocultar a URL do ACS.
Formato
challengePreference
Caminho: protocol.challengePreference
Indica se o EC solicita um challenge ou não.
Valores possíveis
| valores | Descrição |
|---|---|
| NO_PREFERENCE | Sem referência particular |
| NO_CHALLENGE_REQUESTED | O challenge não foi explicitamente solicitado |
| CHALLENGE_REQUESTED | O challenge é solicitado pelo Estabelecimento Comercial |
Formato
protocol.name
Nome do protocolo de autenticação do portador do cartão.
Valores possíveis
| VALOR | Descrição |
|---|---|
| THREEDS | Protocolo 3D Secure |
Formato
protocol.simulation
Booleano que indica se a autenticação deve ser realizada em modo simulação. Se você valorizar este campo obrigatório como:
true, você ativa o modo simulação.false, você não ativa o modo simulação.
Este modo permite realizar a integração EC sem estar em produção ou usando cartões reais.
Formato
protocol.network
Rede na qual o cartão foi autenticado.
Redes atualmente suportadas
| VALOR |
|---|
| CB |
| VISA |
| MASTERCARD |
| AMEX_SAFEKEY |
| PROTECTBUY |
Formato
protocol.version
Versão do protocolo de autenticação do portador do cartão.
Versões suportadas atualmente
| VALOR | Descrição |
|---|---|
| 1.0.2 | Versão 1.0.2 |
| 2.1.0 | Versão 2.1.0 |
| 2.2.0 | Versão 2.2.0 |
Formato
authenticationType
Caminho: value.authenticationType
O tipo de autenticação que ocorreu.
Valores possíveis
| VALOR | Descrição |
|---|---|
| FRICTIONLESS | Autenticação em modo Frictionless, ou seja de forma transparente pelo cliente |
| CHALLENGE | Autenticação com Challenge, o cliente teve que autenticar-se explicitamente com o ACS |
| DATA_ONLY | Autenticação assumida pelo DS sem interação do cliente |
Formato
commerceIndicator
Caminho: value.commerceIndicator
O Commerce Indicator, chamado ECI (Electronic Commerce Indicator) para o protocolo 3DS. Indicador retornado pelo ACS para apresentar os resultados da tentativa de autenticação do portador do cartão.
No caso de uma autenticação sem pagamento (caso do registro de um cartão), a Mastercard pode retornar os dois valores seguintes:
| VALOR | Descrição |
|---|---|
| N0 | Not authenticated |
| N2 | Authenticated |
Formato
value.status
O status de autenticação, ou seja o resultado positivo/negativo da autenticação.
Valores possíveis
| VALOR | Descrição |
|---|---|
| ATTEMPT | Prova de tentativa de autenticação quando a autenticação não está disponível |
| ENROLLED_UNAVAILABLE | Não foi possível obter o status de inscrição |
| FAILED | Autenticação errada |
| NOT_ENROLLED | Cartão não inscrito |
| SUCCESS | Autenticação sucedida |
| UNAVAILABLE | A autenticação não pôde acabar (erro técnico, etc...) |
| DISABLED | Modo seletivo da autenticação solicitada |
| REJECTED | Autenticação recusada pela ACS |
Formato
authenticationIdType
Caminho: value.authenticationId.authenticationIdType
O tipo de autenticação que ocorreu.
Valores possíveis
| VALOR | Descrição |
|---|---|
| dsTransId | O campo é procedente do campo dsTransId do protocolo 3DS V2 |
Formato
value
Caminho: value.authenticationId.value
Valor do código da transação de autenticação conhecido pela rede bancária.
O comprimento do campo varia dependendo do protocolo de autenticação.
| PROTOCOLO | Formato / Comprimento | valor Exemplo: |
|---|---|---|
| 3DS v2 (dsTransId) | cadeia / 32 caracteres alfanuméricos + 4 travessões | 4317fdc3-ad24-5443-8000-000000000891 |
Formato
authenticationValueType
Caminho: value.authenticationValue.authenticationValueType
Tipo do valor de autenticação.
Valores possíveis
| VALOR | Descrição |
|---|---|
| AEVV | American Express Verification Value (usado pela Amex) |
| CAVV | Cardholder Authentication Verification Value (usado pela VISA) |
| AAV | Accountholder Authentication Value (usado pela Mastercard) |
Formato
value
Caminho: value.authenticationValue.value
Valor de autenticação final (em função do DS este valor pode se chamar CAVV, AEVV ou AAV). Uma cadeia de caracteres codificados com base64 de 28 caracteres de comprimento.
Formato
authenticationType
Caminho: value.extension.authenticationType
Tipo da extensão de resultado.
Formato
Valores possíveis
| valores | Descrição |
|---|---|
| THREEDS_V2 | Extensão para as autenticações 3DS Secure v2 |
acsTransId
Caminho: value.extension.acsTransId
Identifiant de transaction de l'ACS. Ce champ concerne uniquement le réseau CB. Voir : Guide d'intégration
Formato
cbScore
Caminho: value.extension.cbScore
Score CB como definido na extensão CB da mensagem ARES.
Formato
algorithm
Caminho: value.extension.algorithm
Código do algoritmo usado para gerar o Valor de Autenticação (usado durante a autorização)
Valores possíveis
| VALOR | Descrição |
|---|---|
| 0 | HMAC |
| 1 | CVV |
| 2 | CVV com ATN |
| 3 | MasterCard SPA |
Formato
value.reason.code
Código adicional informativo sobre a origem do resultado. Ex: DS_TIMEOUT.
Formato
value.reason.message
Mensagem adicional informativa sobre a origem do resultado.