PCI/Charge/VerifyPaymentMethod

A operação PCI/Charge/VerifyPaymentMethod é um Web Service da l’API REST. Permite aos Estabelecimentos Comerciais com certificação PCI-DSS verificar a validade de um cartão. Se o cartão estiver inscrito, uma autenticação 3D Secure será realizada.

Este Web Service recebe os dados e retorna o detalhe da transação de verificação.

Esse Web Service de ativa a autenticação 3D Secure quando se verifica o meio de pagamento. É portanto necessário entender como funciona esta funcionalidade. Para ver como integrá-lo, a documentação de referência está disponível aqui: Serviço de verificação de cartão PCI

Configurações de entrada

Nome da solução e-commerce usada no site de e-commerce bem como o número da versão.

Formato

Moeda do pagamento. Código alfabético em maiúsculas de acordo com ISO 4217 alfa-3.

Exemplo: "EUR” para o euro.

Formato

Valores possíveis

Os valores possíveis são os seguintes:

Você pode sobrescrever a URL de notificação instantânea (também chamada IPN) no formulário se você usar uma só loja para diferentes canais de venda, diferentes tipologias de pagamento, diferentes idiomas etc...

Formato

Referência do pedido definida pelo Estabelecimento Comercial. Não suporta os caracteres UTF-8.

Formato

Valores personalizados vinculados à transação, no formato json.

Exemplo de chamada:

Por exemplo, para passar um valor personalizado, adicione a sua solicitação:

{
    "metadata": {
        "MyValueKey": "1234"
    }
}

Esse valor é retornado no objeto da transação recém-criada.

Pode também usar os metadatas " orderInfo1 ", " orderInfo2 " e " orderInfo3 ”para enviar informações adicionais sobre o pedido.

Estes dados serão depois exibidos na aba Extra do detalhe da transação no seu Back Office EC.

Formato

strongAuthentication permite indicar a preferência do EC para autenticação do comprador.

• Sem interação do portado ( frictionless ).
• Com interação do portador (autenticação forte ou challenge ).
• Nenhuma preferência do EC.

Uma autenticação forte é requerida ao salvar um cartão. Use o campo formAction com os valores seguintes:

• REGISTER_PAY : para realizar um pagamento ao salvar um meio de pagamento.
• ASK_REGISTER_PAY : para realizar um pagamento com uma solicitação para salvar o meio de pagamento.
• CUSTOMER_WALLET : para salvar o meio de pagamento.

Neste caso, o valor do campo strongAuthentication torna-se automaticamente CHALLENGE_MANDATE.

Tabela de isenções (valor DISABLED)

Formato

Este campo é usado pelos Estabelecimentos Comerciais que implementam o analisador de risco na página de pagamento deles Permite enviar o login de sessão (ou fingerPrint Id) à plataforma de pagamento para finalizar a análise de risco.

Os analisadores suportados são:

• NOTO
• Cybersource
• MonitorPlus
• ClearSale

Pode conter maiúsculas, minúsculas, números e hifens ([A-Z][a-z], 0-9, _, -).

Formato

Tipo de meio de pagamento. Exemplo: PAYCONIQ

Formato

O PAN (Primary Account Number) é o número principal do cartão geralmente formado de 16 números).

Formato

Mês de vencimento com 2 dígitos. Exemplo: "09" para setembro.

Formato

Ano de vencimento com 2 dígitos. Exemplo: "25" para 2025.

Formato

Código de segurança (CVV).

O comprimento dele pode variar entre 3 ou 4 dígitos em função do tipo de cartão.

Formato

Rede do cartão.

Formato

Sobrenome e nome do portador do cartão

Formato

Número de RG do comprador.

O formato depende do tipo de documento de identidade: de 7 a 13 caracteres, números, letras e/ou pontos.

Na América Latina, este parâmetro pode ser obrigatório para certos adquirentes.

Formato

Tipo de documento de identidade.

Formato

Código de identificação do comprado para o Estabelecimento Comercial.

Formato

Endereço e-mail do comprador.

• Especificações de estrutura de e-mail: RFC-2822

Formato

Endereço IP do comprador.

Formato

Endereço de faturamento.

Advertência: Os símbolos > e < não são autorizados.

Formato

Informações complementares sobre o endereço de faturamento.

Advertência: Os símbolos > e < não são autorizados.

Formato

Tipo de cliente.

Formato

Valores possíveis

Telefone mobile do comprador.

Aceita todos os formatos:

Exemplos:

• 0623456789
• +33623456789
• 0033623456789
• (+34) 824 65 43 21
• 87 77 12 34

Formato

Cidade de faturamento.

Formato

País do comprador (em maiúscula, conforme à norma ISO 3166-1 alfa-2).

Formato

Valores possíveis

Exemplos de valores possíveis:

Bairro do endereço de faturamento.

Formato

Nome do comprador.

Formato

CPF/CNPJ. Possibilita identificar de maneira única cada cidadão dentro de um país.

Formato

Tipo de documento de identidade.

Formato

Código do idioma do comprador, conforme a norma ISO 639-1.

Permite especificar o idioma de envio dos e-mails de confirmação de pagamento.

O objeto device e seus atributos não são requeridos se paymentSource tiver o valor MOTO, CC ou OTHER ou se o objeto auhtenticationDetails for informado.

Formato

Valores possíveis

Exemplos de valores possíveis:

Sobrenome do comprador.

Formato

Razão social.

Formato

Número de telefone do comprador.

Aceita todos os formatos:

Exemplos:

• 0123456789
• +33123456789
• 0033123456789
• (00.571) 638.14.00
• 40 41 42 42

Formato

Região (estado) do endereço de faturamento. Recomendado mas não obrigatório passar o valor em ISO-3166-2.

Formato

Número de rua do endereço de faturamento.

Carateres aceites:

• Caracteres alfabéticos (de "A" a "Z" e de "a" a "z")
• Espaço

Formato

Estado civil do comprador.

Exemplos:

• Sr.
• Sr.
• Sra.

Formato

CEP do endereço de faturamento.

Formato

Endereço de entrega.

Advertência: Os símbolos > e < não são autorizados.

Formato

Segunda linha do endereço de entrega.

Advertência: Os símbolos > e < não são autorizados.

Formato

Tipo de cliente.

Formato

Valores possíveis

Cidade de entrega.

Formato

País de entrega (em maiúscula, conforme a norma ISO 3166-1 alfa-2).

Formato

Valores possíveis

Exemplos de valores possíveis:

Nome da empresa que entrega o produto.

Formato

Bairro do endereço de faturamento.

Formato

Nome do destinatário.

Formato

CPF/CNPJ. Possibilita identificar de maneira única cada cidadão dentro de um país.

Formato

Sobrenome do comprador.

Formato

Razão social para uma entrega em uma empresa.

Formato

Número de telefone do comprador.

Aceita todos os formatos:

Exemplos:

• 0123456789
• +33123456789
• 0033123456789
• (00.571) 638.14.00
• 40 41 42 42

Formato

Modo de entrega.

Formato

Valores possíveis

Prazo de entrega.

Formato

Valores possíveis

Exemplos de valores possíveis:

Região do endereço de faturamento.

Formato

Número de rua do endereço de entrega.

Carateres aceites:

• Caracteres alfabéticos (de "A" a "Z" e de "a" a "z")
• Espaço

Formato

CEP do endereço de faturamento.

Formato

Valor do seguro para a totalidade do pedido expresso na sua menor unidade monetária (o centavo para o Euro).

Exemplo: 30050 para 300,50 EUR.

Formato

Montante do frete para o total do pedido, na menor unidade monetária da moeda (o centavo para o Real). Ex: 1234 para 12,34 BRL.

Exemplo: 30050 para 300,50 EUR.

Formato

Valor dos impostos para a totalidade do pedido expresso na sua menor unidade monetária (o centavo para o Euro).

Exemplo: 30050 para 300,50 EUR.

Formato

cardItemInfo é uma lista de objetos Customer/ShoppingCartItemInfo.

Permite descrever cada artigo do carrinho.

Formato

Valor do produto expresso na sua menor unidade monetária (o centavo para o Euro).

Exemplo: 30050 para 300,50 EUR.

Formato

Nome do produto.

Formato

Quantidade de produto.

Formato

Referência produto.

Formato

Tipo de produto.

Valores possíveis

Formato

Tipo de produto.

Valor do imposto sobre o produto (apresentado na menor unidade da moeda).

Valores possíveis

Para mencionar uma percentagem aplicada sobre o valor do produto em questão, o valor deve ter no máximo 4 dígitos após a virgula. A decimal é obrigatória para mencionar uma percentagem. A decimal é marcada pelo símbolo ".".

Formato

Tipo de dispositivo nos quais a autenticação é realizada.

O objeto device e seus atributos não são requeridos se paymentSource tiver o valor MOTO, CC ou OTHER ou se o objeto auhtenticationDetails for informado.

Valores possíveis

Formato

Conteúdo exato do header HTTP accept como foi enviado pelo navegador do cliente.

O objeto device e seus atributos não são requeridos se paymentSource tiver o valor MOTO, CC ou OTHER ou se o objeto auhtenticationDetails for informado.

Formato

Conteúdo exato do cabeçalho HTTP "user-agent" enviado pelo navegador. Deve ser truncado se o valor ultrapassa 2048 dígitos.

Obtida do navegador cliente via a propriedade “navigator.userAgent”.

Código javascript que permite recuperar o valor:

const language = navigator.userAgent;

O objeto device e seus atributos não são requeridos se paymentSource tiver o valor MOTO, CC ou OTHER ou se o objeto auhtenticationDetails for informado.

Formato

Endereço IP do navegador como foi enviado nos cabeçalhos HTTP pelo cliente. Formato IPV4 (ex: 1.12.123.255) ou IPV6 (ex: 2011:0db8:85a3:0101:0101:8a2e:0370:7334). Comprimento variável até 45 dígitos.

O objeto device e seus atributos não são requeridos se paymentSource tiver o valor MOTO, CC ou OTHER ou se o objeto auhtenticationDetails for informado.

Formato

Boolean que representa a capacidade do navegador para executar Java. O valor corresponde ao valor retornado pela função “navigator.javaEnabled()” e pode ser true ou false.

Código javascript que permite recuperar o valor:

const javaEnabled = navigator.javaEnabled();

O objeto device e seus atributos não são requeridos se paymentSource tiver o valor MOTO, CC ou OTHER ou se o objeto auhtenticationDetails for informado.

Formato

Obtida do navegador cliente via a propriedade “navigator.language”.

Exemplos: “en”, “en-US”, “de”, “fr”, etc.

Código javascript que permite recuperar o valor:

const language = navigator.language;

Formato

Valor representando a escala da paleta de cores usada para exibir as imagens, em bits por pixel.

Obtida do navegador cliente via a propriedade “screen.colorDepth”.

Código javascript que permite recuperar o valor:

const colorDepth = screen.colorDepth;

O objeto device e seus atributos não são requeridos se paymentSource tiver o valor MOTO, CC ou OTHER ou se o objeto auhtenticationDetails for informado.

Formato

A altura total da tela do cliente em pixeis. O valor é aquele que foi retornado pela propriedade “screen.height”. De 1 a 6 dígitos.

Código javascript que permite recuperar o valor:

const screenHeight = screen.height;

O objeto device e seus atributos não são requeridos se paymentSource tiver o valor MOTO, CC ou OTHER ou se o objeto auhtenticationDetails for informado.

Formato

A largura total da tela do cliente em pixeis. O valor é aquele que foi retornado pela propriedade “screen.width”. De 1 a 6 dígitos.

Código javascript que permite recuperar o valor:

const screenWidth = screen.width;

O objeto device e seus atributos não são requeridos se paymentSource tiver o valor MOTO, CC ou OTHER ou se o objeto auhtenticationDetails for informado.

Formato

Diferença de tempo entre a hora UTC e a hora local do navegador cliente, em minutos. Seu valor é de -120 para um usuário no fuso horário UTC+2 e de 570 para o fuso horário UTC−09:30.

Código javascript que permite recuperar o valor:

const timeZoneOffset = new Date().getTimezoneOffset();

O objeto device e seus atributos não são requeridos se paymentSource tiver o valor MOTO, CC ou OTHER ou se o objeto auhtenticationDetails for informado.

Formato

Nome da instrução

Valores possíveis

Formato

Resultado como uma string JWT ou um código de erro de texto simples em caso de erro (timeout por exemplo).

Formato

Indica se o EC solicitou um challenge ou não.

Valores possíveis

Formato

Nome do protocolo de autenticação do portador do cartão.

Valores possíveis

Formato

Rede na qual o cartão foi autenticado.

Esse campo é obrigatório para gerenciar o timeout no 3ds method, quando o campo instructionResult.value é definido como TIMEOUT.

Redes atualmente suportadas

Formato

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

Versão do protocolo de autenticação do portador do cartão.

Versões suportadas atualmente

Formato

token único de autenticação, no formato UUID.

Null na primeira chamada.

Quando mais de uma chamada ao WebService PCI/Charge/VerifyPaymentMethod forem necessárias para realizar a autenticação de um comprador, o valor do ID enviado deverá ser o mesmo em toda chamada para a mesma autenticação Será então preciso retomar o ID fornecido na resposta anterior.

Formato

Número de contrato Estabelecimento Comercial. Se este campo é informado, tomar cuidado em utilizar o contrato certo em relação à rede do cartão.

Formato

Procedência do pagamento.

Formato

Valores possíveis

Os valores possíveis são os seguintes:

Quantidade de novas tentativas disponíveis no caso de uma recusa de pagamento (1 por padrão).

Formato

Referência da resposta

Mais de uma resposta são possíveis em função do contexto:

Consultar a referência das respostas para maiores detalhes.