PCI/Charge/VerifyPaymentMethod

POSThttps://api.lyra.com/api-payment/V4.1/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

contrib

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

Formato

currency

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:

Moeda	CODIFICAÇÃO ISO 4217	Unidade fracionária
Dólar australiano (036)	AUD	2
Dólar canadense (124)	CAD	2
Franco suíço (756)	CHF	2
Coroa dinamarquesa (208)	DKK	2
Euro (978)	EUR	2
Libra Esterlingo (826)	GBP	2
Iene japonês (392)	JPY	0
Coroa norueguesa (578)	NOK	2
Coroa sueca (752)	SEK	2
Dólar dos Estados-Unidos (840)	USD	2

ipnTargetUrl

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

orderId

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

Formato

metadata

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

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.

Caso de uso	Valores possíveis
CHALLENGE : Com interação do portado	ENABLED : Valor depreciado
	CHALLENGE_REQUESTED : Permite solicitar uma autenticação forte para a transação.
	CHALLENGE_MANDATE : Permite solicitar uma autenticação forte para a transação por razões legais.
FRICTIONLESSSem interação do portado Opção "Frictionless 3DS2" obrigatório.	DISABLED: Permite solicitaruma isençãode autenticação forte. Transações de baixo valor LRM (Low Risk Merchant) Se você não possui a opção “Frictionless 3DS2”, a escolha da preferência é delegada ao emissor do cartão (No Preference). Se a solicitação de frictionless for aceita, a transação não terá a transferência de responsabilidade no caso de contestação pelo portador.
Nenhuma preferência do EC	NO_PREFERENCE : Permite indicar ao DS que o EC não tem preferência. Se o emissor decidir realizar uma autenticação sem interação (frictionless), o pagamento será garantido.
Nenhuma preferência do EC	AUTO : Cabe ao emissor do cartão escolher a preferência (No Preference).

Tabela de isenções (valor DISABLED)

isenção	Descrição
Transações de baixo valor	Para os pagamentos em euro, pode solicitaruma isençãoa autenticação forte: Se o valor for inferior a 30 €, e no limite de 5 operações sucessivas ou de um valor cumulado inferior a 100 €. Se o valor for superior a 30€, o valor enviado pelo EC será ignorado e a escolha da preferência caberá ao emissor do cartão ( No Preference ). Para os pagamentos realizados em uma outra moeda que o euro, uma solicitação de frictionless será enviada ao emissor.Se a solicitação de frictionless for aceita, a transação não terá a transferência de responsabilidade no caso de contestação pelo portador.
LRM (Low Risk Merchant)	O programa LRM (Low Risk Merchant) de CB procura atender às necessidades de comerciantes de alto volume e risco muito baixo (120.000 transações CB / ano). Você pode solicitar uma isenção de autenticação forte: Se o valor for inferior a € 100, a isenção é sistemática para comerciantes elegíveis. Se o valor estiver entre € 100 e € 250, um experimento está em andamento. O comerciante deve atender às seguintes condições: Tenha um contrato de CB. Seja elegível para o TRA do comprador. Transmita os valores necessários no fluxo 3D Secure, de acordo com as regras definidas pela plataforma. Se a solicitação de frictionless for aceita, a transação não terá a transferência de responsabilidade no caso de contestação pelo portador. Para se beneficiar do programa LRM da CB, você deve entrar em contato com o suporte técnico para obter um contrato explícito.

isenção

Descrição

Transações de baixo valor

Para os pagamentos em euro, pode solicitaruma isençãoa autenticação forte:

Se o valor for inferior a 30 €, e no limite de 5 operações sucessivas ou de um valor cumulado inferior a 100 €.
Se o valor for superior a 30€, o valor enviado pelo EC será ignorado e a escolha da preferência caberá ao emissor do cartão ( No Preference ).

Para os pagamentos realizados em uma outra moeda que o euro, uma solicitação de frictionless será enviada ao emissor.Se a solicitação de frictionless for aceita, a transação não terá a transferência de responsabilidade no caso de contestação pelo portador.

LRM (Low Risk Merchant)

O programa LRM (Low Risk Merchant) de CB procura atender às necessidades de comerciantes de alto volume e risco muito baixo (120.000 transações CB / ano).

Você pode solicitar uma isenção de autenticação forte:

Se o valor for inferior a € 100, a isenção é sistemática para comerciantes elegíveis.
Se o valor estiver entre € 100 e € 250, um experimento está em andamento. O comerciante deve atender às seguintes condições:
- Tenha um contrato de CB.
- Seja elegível para o TRA do comprador.
- Transmita os valores necessários no fluxo 3D Secure, de acordo com as regras definidas pela plataforma.

Se a solicitação de frictionless for aceita, a transação não terá a transferência de responsabilidade no caso de contestação pelo portador.

Formato

fingerPrintId

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

paymentMethodType

Caminho: paymentForms.paymentMethodType

Tipo de meio de pagamento. Exemplo: PAYCONIQ

Formato

paymentForms.pan

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

Formato

expiryMonth

Caminho: paymentForms.expiryMonth

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

Formato

expiryYear

Caminho: paymentForms.expiryYear

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

Formato

securityCode

Caminho: paymentForms.securityCode

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

paymentForms.brand

Rede do cartão.

Formato

cardHolderName

Caminho: paymentForms.cardHolderName

Sobrenome e nome do portador do cartão

Formato

identityDocumentNumber

Caminho: paymentForms.identityDocumentNumber

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

identityDocumentType

Caminho: paymentForms.identityDocumentType

Tipo de documento de identidade.

Formato

customer.reference

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

Formato

customer.email

Endereço e-mail do comprador.

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

Formato

customer.ipAddress

Endereço IP do comprador.

Formato

address

Caminho: customer.billingDetails.address

Endereço de faturamento.

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

Formato

address2

Caminho: customer.billingDetails.address2

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

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

Formato

valores	Descrição
PRIVATE	Cliente de tipo Pessoa física
COMPANY	Cliente de tipo Pessoa Jurídica

cellPhoneNumber

Caminho: customer.billingDetails.cellPhoneNumber

Telefone mobile do comprador.

Aceita todos os formatos:

Exemplos:

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

Formato

city

Caminho: customer.billingDetails.city

Cidade de faturamento.

Formato

country

Caminho: customer.billingDetails.country

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

Formato

Valores possíveis

Exemplos de valores possíveis:

País	Código
ÁUSTRIA	AT
Brasil	BR
CORSEGA	FR
COSTA DO MARFIM	CI
FRANÇA	FR
GUADALUPE	GP
ÍNDIA	IN
MARTINICA	MQ
NOVA-CALEDONIA	NC
ST-PIERRE-ET-MIQUELON	PM
POLINÉSIA FRANCESA	PF

district

Caminho: customer.billingDetails.district

Bairro do endereço de faturamento.

Formato

firstName

Caminho: customer.billingDetails.firstName

Nome do comprador.

Formato

identityCode

Caminho: customer.billingDetails.identityCode

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

Formato

identityType

Caminho: customer.billingDetails.identityType

Tipo de documento de identidade.

Formato

language

Caminho: customer.billingDetails.language

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:

Idioma	Código
Alemão (Alemanha)	DE
Inglês (Reino-Unido)	EN
Inglês (Estados-Unidos)	EN
Chinês (Tradicional)	ZH
Espanhol (Espanha)	ES
Espanhol (Chile)	ES
Francês (França)	FR
Italiano (Itália)	IT
Japonês (Japão)	JP
Holandês (Holanda)	NL
Polonês (Polônia)	PL
Português (Brasil)	PT
Português (Portugal)	PT
Russo (Rússia)	RU

lastName

Caminho: customer.billingDetails.lastName

Sobrenome do comprador.

Formato

legalName

Caminho: customer.billingDetails.legalName

Razão social.

Formato

phoneNumber

Caminho: customer.billingDetails.phoneNumber

Número de telefone do comprador.

Aceita todos os formatos:

Exemplos:

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

Formato

state

Caminho: customer.billingDetails.state

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

Formato

streetNumber

Caminho: customer.billingDetails.streetNumber

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

title

Caminho: customer.billingDetails.title

Estado civil do comprador.

Exemplos:

Sr.
Sr.
Sra.

Formato

zipCode

Caminho: customer.billingDetails.zipCode

CEP do endereço de faturamento.

Formato

address

Caminho: customer.shippingDetails.address

Endereço de entrega.

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

Formato

address2

Caminho: customer.shippingDetails.address2

Segunda linha do endereço de entrega.

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

Formato

valores	Descrição
PRIVATE	Cliente de tipo Pessoa física
COMPANY	Cliente de tipo Pessoa Jurídica

city

Caminho: customer.shippingDetails.city

Cidade de entrega.

Formato

country

Caminho: customer.shippingDetails.country

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

Formato

Valores possíveis

Exemplos de valores possíveis:

País	Código
ÁUSTRIA	AT
Brasil	BR
CORSEGA	FR
COSTA DO MARFIM	CI
FRANÇA	FR
GUADALUPE	GP
ÍNDIA	IN
MARTINICA	MQ
NOVA-CALEDONIA	NC
ST-PIERRE-ET-MIQUELON	PM
POLINÉSIA FRANCESA	PF

deliveryCompanyName

Caminho: customer.shippingDetails.deliveryCompanyName

Nome da empresa que entrega o produto.

Formato

district

Caminho: customer.shippingDetails.district

Bairro do endereço de faturamento.

Formato

firstName

Caminho: customer.shippingDetails.firstName

Nome do destinatário.

Formato

identityCode

Caminho: customer.shippingDetails.identityCode

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

Formato

lastName

Caminho: customer.shippingDetails.lastName

Sobrenome do comprador.

Formato

legalName

Caminho: customer.shippingDetails.legalName

Razão social para uma entrega em uma empresa.

Formato

phoneNumber

Caminho: customer.shippingDetails.phoneNumber

Número de telefone do comprador.

Aceita todos os formatos:

Exemplos:

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

Formato

shippingMethod

Caminho: customer.shippingDetails.shippingMethod

Modo de entrega.

Formato

Valores possíveis

VALOR	Descrição
RECLAIM_IN_SHOP	Retirada de mercadoria na loja.
RELAY_POINT	Utilização de uma rede de pontos de entrega terceirizados (Kiala, Alveol, etc).
RECLAIM_IN_STATION	Retirada em um aeroporto, uma agência de viagens ou outros.
PACKAGE_DELIVERY_COMPANY	Entrega por transportadora (Colissimo, UPS, etc).
ETICKET	Emissão de uma passagem eletrônica, download de produtos virtuais.
CARD_HOLDER_ADDRESS	Entrega no endereço do comprador. Reservado para um uso futuro.
VERIFIED_ADDRESS	Entrega em um endereço verificado. Reservado para um uso futuro.
NOT_VERIFIED_ADDRESS	Entrega em um endereço não verificado. Reservado para um uso futuro.
SHIP_TO_STORE	Entrega na loja. Reservado para um uso futuro.
DIGITAL_GOOD	Entrega digital. Reservado para um uso futuro.
ETRAVEL_OR_ETICKET	Passagem eletrônica. Reservado para um uso futuro.
OTHER	Outros Reservado para um uso futuro.
PICKUP_POINT	Entrega em ponto de retirada. Reservado para um uso futuro.
AUTOMATED_PICKUP_POINT	Entrega em ponto de retirada automático. Reservado para um uso futuro.

shippingSpeed

Caminho: customer.shippingDetails.shippingSpeed

Prazo de entrega.

Formato

Valores possíveis

Exemplos de valores possíveis:

VALOR	Descrição
STANDARD	Entrega padrão.
EXPRESS	Entrega em menos de 24h.
PRIORITY	Entrega prioritária (Click & Collect)

state

Caminho: customer.shippingDetails.state

Região do endereço de faturamento.

Formato

streetNumber

Caminho: customer.shippingDetails.streetNumber

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

zipCode

Caminho: customer.shippingDetails.zipCode

CEP do endereço de faturamento.

Formato

insuranceAmount

Caminho: customer.shoppingCart.insuranceAmount

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

shippingAmount

Caminho: customer.shoppingCart.shippingAmount

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

taxAmount

Caminho: customer.shoppingCart.taxAmount

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

cartItemInfo

Caminho: customer.shoppingCart.cartItemInfo

cardItemInfo é uma lista de objetos Customer/ShoppingCartItemInfo.

Permite descrever cada artigo do carrinho.

Formato

productAmount

Caminho: customer.shoppingCart.cartItemInfo.productAmount

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

Exemplo: 30050 para 300,50 EUR.

Formato

productLabel

Caminho: customer.shoppingCart.cartItemInfo.productLabel

Nome do produto.

Formato

productQty

Caminho: customer.shoppingCart.cartItemInfo.productQty

Quantidade de produto.

Formato

productRef

Caminho: customer.shoppingCart.cartItemInfo.productRef

Referência produto.

Formato

productType

Caminho: customer.shoppingCart.cartItemInfo.productType

Tipo de produto.

Valores possíveis

VALOR	Descrição
FOOD_AND_GROCERY	Produtos alimentares e de mercadinho
AUTOMOTIVE	Automóvel / Moto
ENTERTAINMENT	Lazer / Cultura
HOME_AND_GARDEN	Casa e jardim
HOME_APPLIANCE	Equipamentos para a casa
AUCTION_AND_GROUP_BUYING	Leilões e compras em grupo
FLOWERS_AND_GIFTS	Flores e presentes
COMPUTER_AND_SOFTWARE	Computadores e softwares
HEALTH_AND_BEAUTY	Saúde e beleza
SERVICE_FOR_INDIVIDUAL	Serviços para pessoa física
SERVICE_FOR_BUSINESS	Serviços para pessoa jurídica
SPORTS	Esportes
CLOTHING_AND_ACCESSORIES	Roupas e acessórios
TRAVEL	Viagem
HOME_AUDIO_PHOTO_VIDEO	Som, imagem e vídeo
TELEPHONY	Telefonia

Formato

productVat

Caminho: customer.shoppingCart.cartItemInfo.productVat

Tipo de produto.

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

Valores possíveis

VALOR	Descrição
Um número inteiro	Valor da transação. O valor dela deve ser um número inteiro positivo (ex: 1234 para 12,34 EUR).
Um número decimal, inferior a 100	Percentagem aplicada sobre o valor. Exemplos: 20.0 ou 19.6532

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

device.deviceType

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

VALOR	Descrição
BROWSER	a autenticação ocorre em um navegador

Formato

device.acceptHeader

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

device.userAgent

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

device.ip

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

device.javaEnabled

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

device.language

String de caracteres indicando o idioma do navegador.

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

device.colorDepth

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

device.screenHeight

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

device.screenWidth

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

timeZoneOffset

Caminho: device.timeZoneOffset

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

name

Caminho: instructionResult.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

Caminho: instructionResult.value

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

Formato

challengePreference

Caminho: instructionResult.protocol.challengePreference

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

Valores possíveis

VALOR	Cartão 3DS2
NO_PREFERENCE	A escolha da preferência será delegada ao emissor do cartão.
NO_CHALLENGE_REQUESTED	Permite solicitar uma autenticação sem interação (frictionless).
CHALLENGE_REQUESTED	Permite solicitar uma autenticação forte para a transação.
CHALLENGE_MANDATED	Permite indicar que uma autenticação forte é requerida para a transação por razões legais.
DATA_ONLY	Permite solicitar uma autenticação sem interação, assumida pelo DS no lugar do ACS do banco emissor.A transação não se beneficiará com a transferência de responsabilidade. A autenticação será desativada se a rede não for compatível com esta funcionalidade. O serviço PCI/Charge/Authenticate retorna um código de erro INT_808, se o campo`transactionCategory`não tem o valor de`PAYMENT`.

Formato

name

Caminho: instructionResult.protocol.name

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

Valores possíveis

VALOR	Descrição
THREEDS	Protocolo 3D Secure

Formato

network

Caminho: instructionResult.protocol.network

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

VALOR
CB
VISA
MASTERCARD
AMEX_SAFEKEY
PROTECTBUY

Formato

simulation

Caminho: instructionResult.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

version

Caminho: instructionResult.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

operationSessionId

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

mid

Caminho: transactionOptions.cardOptions.mid

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

paymentSource

Caminho: transactionOptions.cardOptions.paymentSource

Procedência do pagamento.

Formato

Valores possíveis

Os valores possíveis são os seguintes:

VALOR	Descrição
EC	E-Commerce: os dados do meio de pagamento são digitados pelo comprador. Este valor permite ter uma autenticação alta no pagamento.
MOTO	MAIL OR TELEPHONE ORDER: Digitação realizada por um operador. Os dados do meio de pagamento são enviados por correio ou por e-mail. Requer um contrato de tipo VAD.
CC	Call Center: pagamento efetuado via um call center. Requer um contrato de tipo VAD.
OTHER	Outro canal de venda. Valor de saída retornado para pagamentos feitos desde Back Office EC, pagamentos por arquivo, pagamentos recorrentes, pagamentos por proximidade, reembolsos do CMS Shopify.
Absent ou null	O valor por default é "EC".

retry

Caminho: transactionOptions.cardOptions.retry

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:

Resposta	Contexto
Payment	Objeto con a transação de tipo VERIFICATION gerada.
AuthenticationResponseData	Objeto retornado se uma autenticação for precisa

Consultar a referência das respostas para maiores detalhes.

Categoria

Tags

Nenhum token de formulário definido

PCI/Charge/VerifyPaymentMethod

Configurações de entrada

contrib

Formato

currency

Formato

Valores possíveis

ipnTargetUrl

Formato

orderId

Formato

metadata

Exemplo de chamada:

Formato

strongAuthentication

Tabela de isenções (valor DISABLED)

Formato

fingerPrintId

Formato

paymentMethodType

Caminho: paymentForms.paymentMethodType

Formato

paymentForms.pan

Formato

expiryMonth

Caminho: paymentForms.expiryMonth

Formato

expiryYear

Caminho: paymentForms.expiryYear

Formato

securityCode

Caminho: paymentForms.securityCode

Formato

paymentForms.brand

Formato

cardHolderName

Caminho: paymentForms.cardHolderName

Formato

identityDocumentNumber

Caminho: paymentForms.identityDocumentNumber

Formato

identityDocumentType

Caminho: paymentForms.identityDocumentType

Formato

customer.reference

Formato

customer.email

Formato

customer.ipAddress

Formato

address

Caminho: customer.billingDetails.address

Formato

address2

Caminho: customer.billingDetails.address2

Formato

category

Caminho: customer.billingDetails.category

Formato

Valores possíveis

cellPhoneNumber

Caminho: customer.billingDetails.cellPhoneNumber

Formato

city

Caminho: customer.billingDetails.city

Formato

country

Caminho: customer.billingDetails.country

Formato

Valores possíveis

district

Caminho: customer.billingDetails.district

Formato

firstName

Caminho: customer.billingDetails.firstName

Formato

identityCode