• França
lyra.com
Procurando
Categoria
Tags
pagina inicial
Suporte técnico

Guia de integração (desvalorizado)

Integração desvalorizada. É recomendado integrar a nova versão V4.1/PCI/Charge/CreatePayment : Guia de integração

Os parâmetros para chamar o serviço PCI/Charge/CreatePayment (obsoleto) dependem do protocolo de autenticação usado e do resultado da autenticação.

Esta seção apresenta os parâmetros para enviar para cada protocolo suportado.

  • Autenticação 3D Secure v2
  • Autenticação desligada

Autenticação 3D Secure v2

Conteúdo da solicitação :

NÍVEL SOBRENOME Descrição REQUISITO
1 amount Valor do pagamento na menor unidade da moeda.
Deve corresponder ao valor da autenticação.		 Sim
1 currency Código (ISO 4217 alfa3) da moeda do pagamento.
Ex: "EUR” para o euro.		 Sim
1 orderId Referência do pedido. Não
1 formAction Permite indicar se você quer salvar o cartão.
Valores possíveis:
  • PAGAMENTO : Pagamento sem criação de alias. Valor padrão.
  • REGISTRO_PAGAMENTO : Criação do alias durante um pagamento.
 Não
1 customer Objeto com os dados do comprador. Não
2 email Endereço e-mail do comprador.
Obrigatório quandoformActioné valorizado aREGISTER_PAY.		 Ver descrição
1 paymentForms Objeto com os dados do cartão. Sim
2 paymentMethodType Tipo de cartão.
Deve ter o valor deCARD.		 Sim
2 pan Número de cartão. Sim
2 expiryMonth Mês de vencimento do cartão.
Ex: 3 ou 03		 Sim
2 expiryYear Ano de vencimento do cartão.
Ex: 27 ou 2027		 Sim
2 securityCode Código de segurança do cartão (CVV ou 4DBC). Não
1 authenticationDetails Um objeto que contém os dados de autenticação do portador. Sim
2 protocol Um objeto que descreve o protocolo de autenticação utilizado. Sim
3 name Nome do protocolo de autenticação.
Deve ter o valor deTHREEDS.		 Sim
3 version Versão do protocolo de autenticação.
Deve ter o valor de2,2.1.0ou para2.2.0.		 Sim
3 directoryServer Nome do Directory Server (DS) utilizado durante a autenticação.
Valores possíveis:
  • Amex
  • CB
  • Diners
  • Discover
  • visa
  • mastercard
 Sim
3 challengePreference Preferência 3DS transmitida para o DS durante a autenticação ao portador.
Obrigatório sestatusé valorizado aSUCCESSouATTEMPT.		 Ver descrição
2 status Status de autenticação.
Valores possíveis:
  • DISABLED
  • ATTEMPT
  • ENROLLED_UNAVAILABLE
  • FAILED
  • NOT_ENROLLED
  • SUCCESS
  • UNAVAILABLE
 Sim
2 authenticationType Tipo de autenticação.
Obrigatório sestatusé valorizado aSUCCESS ou ATTEMPT.
Valores possíveis:
  • CHALLENGE
  • FRICTIONLESS
 Ver descrição
2 authenticationValue Referência gerada pelo emissor que permite validar a integridade dos dados da transação. Em função do DS, corresponde ao CAVV para VISA, ao AAV para Mastercard, ou ao AEVV para AMEX Safekey.
Obrigatório quandostatusé valorizado aSUCCESSouATTEMPT.
Exemplo: +kAr/o8S0DxgGYkz7QQHZCw8V5k=		 Ver descrição
2 commerceIndicator Indicador de comercio eletrônico (ECI). Valor devolvido pela ACS após a autenticação. O valor da ECI depende do status de autenticação e do tipo de cartão.
Obrigatório quandostatusé valorizado aSUCCESSouATTEMPT.
Ex: 05		 Ver descrição
2 dsTransID Identificador exclusivo da transação gerada pelo DS 3DS2.
Obrigatório quandostatusé valorizado aSUCCESSouATTEMPT.
Exemplo: d6706a0d-c48d-4cf4-a1d2-d4a401a3143e		 Ver descrição
2 exemption Isenção aplicada.
Obrigatório quandoauthenticationTypeé valorizado aFRICTIONLESS.
Ver capítuloModo seletivo e isenções.		 Ver descrição
2 requestorName O nome do EC usado para autenticar o portador.
Obrigatório sedirectoryServeré valorizado aCB.		 Ver descrição
2 acsTransID Identificador único de transação gerado pelo ACS.
Obrigatório quandostatusé valorizado aSUCCESSouATTEMPTe quedirectoryServeré valorizado aCB.
Ex: d727ebfe-de4c-4682-85fa-e60ca00a9cff		 Ver descrição
2 authValueAlgorithm Algoritmo de verificação da autenticação do portador.
Obrigatório quandostatusé valorizado aSUCCESSouATTEMPTe quedirectoryServeré valorizado aCB.
Valores possíveis:
  • 0: HMAC
  • 1: CVV
  • 2: CVV_ATN
  • 3: MASTERCARD_SPA
  • a: AV-CB
 Ver descrição
2 dsScore Scoring de autenticação retornado pelo DS CB.
Obrigatório quandostatusé valorizado aSUCCESSouATTEMPTe quedirectoryServeré valorizado aCB.
Exemplo: 31		 Ver descrição
2 challengeCancelationIndicator Indicador de cancelamento de challenge recebido na mensagem RReq. (Valor retornado pelo DS no caso de cancelamento da autenticação).
Exemplo: 01		 Não
2 transactionStatusReason Motivo da falha de autenticação devolvida pelo DS em caso de falha de autenticação.
Exemplo: 82		 Não

Encontre a descrição dos campos em nosso playground.

Dados de teste

pan : 4970110000001029 directoryServer : CB
expiryMonth / expiryYear : Escolha livre authValueAlgorithm : 2
securityCode : Escolha livre authenticationValue : +kAr/o8S0DxgGYkz7QQHZCw8V5k=
challengePreference : NO_CHALLENGE_REQUESTED dsTransID : d6706a0d-c48d-4cf4-a1d2-d4a401a3143e
authenticationType : FRICTIONLESS acsTransID : d727ebfe-de4c-4682-85fa-e60ca00a9cff
commerceIndicator : 05 exemption : LOW_VALUE
requestorName : Au choix dsScore : 31

O resultado do pagamento depende do valor de status usado.

Exemplo de solicitação

{
	"amount": "1230",
	"currency": "EUR",
	"paymentForms": [
	  {
		"paymentMethodType": "CARD",
		"pan": "4970110000001029",			 
		"expiryMonth": "09",
		"expiryYear": "27",
		"securityCode": "123"		  
	  }
	],		  
	"customer": {
		"email": "sample@example.com"
	},		  
	"authenticationDetails":{	
		"protocol":{
			"name":"THREEDS",
			"version":"2",
			"directoryServer":"CB",
			"challengePreference":"NO_CHALLENGE_REQUESTED"
		},			
		"status":"SUCCESS",
		"authenticationType":"FRICTIONLESS",
		"commerceIndicator":"05",
		"authenticationValue":"+kAr/o8S0DxgGYkz7QQHZCw8V5k=",
		"dsTransID":"d6706a0d-c48d-4cf4-a1d2-d4a401a3143e",
		"acsTransID":"d727ebfe-de4c-4682-85fa-e60ca00a9cff",
		"authValueAlgorithm":"2",
		"dsScore":"31",
		"exemption":"LOW_VALUE",		
		"requestorName":"DEMO STORE"
	}		  
}

Autenticação desligada

O servidor permite criar um pagamento quando a autenticação do portador foi voluntariamente desativada, seja qual for o protocolo de autenticação.

Neste caso, o motivo desta decisão deve ser especificado através do campoisenção (Ver capítulo Motivo da paralisação e isenções ).

Conteúdo da solicitação :

NÍVEL SOBRENOME Descrição REQUISITO
1 amount Valor do pagamento na menor unidade da moeda.
Deve corresponder ao valor da autenticação.		 Sim
1 currency Código (ISO 4217 alfa3) da moeda do pagamento.
Ex: "EUR” para o euro.		 Sim
1 orderId Referência do pedido. Não
1 formAction Permite indicar se você quer salvar o cartão.
Valores possíveis:
  • PAGAMENTO : Pagamento sem criação de alias. Valor padrão.
  • REGISTRO_PAGAMENTO : Criação do alias durante um pagamento.
 Não
1 customer Objeto com os dados do comprador. Não
2 email Endereço e-mail do comprador.
Obrigatório quandoformActioné valorizado aREGISTER_PAY.		 Ver descrição
1 paymentForms Objeto com os dados do cartão. Sim
2 paymentMethodType Tipo de cartão.
Deve ter o valor deCARD.		 Sim
2 pan Número de cartão. Sim
2 expiryMonth Mês de vencimento do cartão.
Ex: 3 ou 03		 Sim
2 expiryYear Ano de vencimento do cartão.
Ex: 27 ou 2027		 Sim
2 securityCode Código de segurança do cartão (CVV ou 4DBC). Não
1 authenticationDetails Um objeto que contém os dados de autenticação do portador. Sim
2 status Status de autenticação. Deve ser definido comoDESABILITADO . Sim
2 exemption Razão do modo seletivo.
Ver capítuloModo seletivo e isenções.		 Sim

Exemplo de solicitação

{
	"amount": "1230",
	"currency": "EUR",
	"paymentForms": [
	  {
		"paymentMethodType": "CARD",
		"pan": "4970100000000022",			 
		"expiryMonth": "09",
		"expiryYear": "27",
		"securityCode": "123"
	  }
	],		  
	"customer": {
		"email": "sample@example.com"
	},		  
	"authenticationDetails":{				
		"status":"DISABLED",
		"exemption":"OTHER_EXEMPTION"		
	}		  
}
Jobs
Legal
GDPR
25.22-1.11