support
Volver a la documentación
Buscar
Categoria
Tags
parámetros principalesdesplegar todo
currency
requerido
orderId
recomendado
paymentForms
[1]
paymentMethodType
requerido
pan
Tarjetas de Prueba

    Token de formulario no definido

    Número de tarjetaDescripciónEstado3DS3DS2
    requerido
    expiryMonth
    requerido
    expiryYear
    requerido
    securityCode
    brand
    cardHolderName
    identityDocumentNumber
    identityDocumentType
    ipnTargetUrl
    información sobre tu cliente
    customer
    reference
    recomendado
    email
    requerido
    billingDetails
    title
    category
    firstName
    lastName
    phoneNumber
    streetNumber
    address
    district
    zipCode
    city
    state
    country
    language
    cellPhoneNumber
    identityCode
    identityType
    legalName
    shippingDetails
    category
    firstName
    lastName
    phoneNumber
    streetNumber
    address
    address2
    district
    zipCode
    city
    state
    country
    deliveryCompanyName
    shippingSpeed
    shippingMethod
    legalName
    identityCode
    shoppingCart
    insuranceAmount
    shippingAmount
    taxAmount
    cartItemInfo
    [1]
    productLabel
    productType
    productRef
    productQty
    productAmount
    productVat
    ipAddress
    opciones generales de la transacción
    contrib
    fingerPrintId
    metadata
    [1]
    :
    strongAuthentication
    opciones relacionadas con la tarjeta
    transactionOptions
    cardOptions
    paymentSource
    mid
    nuevas propiedades
    authenticationDetails
    protocol
    name
    requerido
    version
    requerido
    directoryServer
    challengePreference
    authenticationType
    status
    requerido
    commerceIndicator
    authenticationValue
    dsScore
    authValueAlgorithm
    requestorName
    requerido
    dsTransID
    acsTransID
    xid
    exemption
    challengeCancelationIndicator
    transactionStatusReason
    Pruébame
    Documentación

    PCI/Charge/VerifyPaymentMethod

    L'appel aux Web Services requiert une authentification HTTP Basic Authentication. Plus d'infos : "Phase d'authentification".

    POSThttps://api.lyra.com/api-payment/V4.1/PCI/Charge/VerifyPaymentMethod

    La activación de esta funcionalidad está sujeta a la aprobación previa de Lyra.

    La operación PCI/Charge/VerifyPaymentMethod es un Web Servicede la API REST. Permite que los vendedores que tienen la certificación PCI DSS verifiquen la validez de una tarjeta. Si la tarjeta está afiliada, se lleva a cabo una autentificación 3-D Secure.

    Este Web Service acepta los datos de la tarjeta y devuelve el detalle de la transacción de comprobación.

    Este Web Service permite realizar una autentificación 3-D Secure al verificar el medio de pago. Por lo tanto, es necesario saber cómo funciona esta funcionalidad Para saber cómo integrarlo, consulte la siguiente documentación: Servicio de verificación de tarjeta PCI

    Parámetros de entrada

    contrib

    Nombre de la solución de e-comercio utilizada en el sitio web comercial y su número de versión.

    Formato

    currency

    Moneda del pago. Código alfabético un mayúsculas según ISO 4217 alpha-3.

    Ejemplo: "EUR" para el euro.

    Formato

    Valores posibles

    . Los valores posibles son:

    Moneda CODIFICACIÓN ISO 4217 Unidad fraccionaria
    Dólar australiano (036) AUD 2
    Dólar canadiense (124) CAD 2
    Franco suizo (756) CHF 2
    Corona danesa (208) DKK 2
    Euro (978) EUR 2
    Libra esterlina (826) GBP 2
    Yen (392) JPY 0
    Corona noruega (578) NOK 2
    Corona sueca (752) SEK 2
    Dólar estadounidense (840) USD 2

    ipnTargetUrl

    Puede sobrescribir la URL de notificación instantánea (también llamada IPN) en el formulario si utiliza una única tienda para diferentes canales de venta, diferentes tipos de pago, diferentes idiomas, etc.

    Formato

    orderId

    Referencia de pedido definida por el vendedor. No admite los caracteres UTF-8.

    Formato

    metadata

    Valores personalizados adjuntos a la transacción, en formato json.

    Ejemplo de llamada

    Por ejemplo, para transmitir un valor personalizado, agregue a su solicitud:

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

    Este valor se devolverá en el objeto de transacción recién creado.

    También puede utilizar los metadatos " orderInfo ", " orderInfo2 " y " orderInfo3 " para transmitir la información adicional sobre el pedido.

    Estos datos se muestran en el Back Office Vendedor, en la información de la transacción (pestaña Extra ).

    Formato

    strongAuthentication

    strongAuthentication permet d'indiquer la préférence du marchand au sujet de l'authentification de l'acheteur.

    • Sin interacción del titular ( frictionless ).
    • Con interacción del titular (autentificación fuerte o challenge ).
    • Sin preferencia del vendedor.

    Siempre es el emisor quien decide el modo de autentificación del comprador.

    Al guardar una tarjeta, la autentificación fuerte del titular es obligatoria. Transmitir el campo formAction con los siguientes valores:

    • REGISTER_PAY : para realizar un pago y guardar el medio de pago.
    • REGISTER_PAY : para realizar un pago y preguntar si se desea guardar el medio de pago.
    • CUSTOMER_WALLET : para guardar el medio de pago.

    En este caso, en el campo strongAuthentication se establece automáticamente el valor CHALLENGE_MANDATE.

    Casos de uso Valores posibles
    CHALLENGE : Con interacción del titular
    • ENABLED : Valor obsoleto
    • CHALLENGE_REQUESTED : Permite solicitar una autenticación fuerte para la transacción.
    • CHALLENGE_MANDATE : Permite solicitar una autenticación fuerte para la transacción por razones reglamentarias.
    FRICTIONLESSSin interacción del titular

    Opción "Frictionless 3DS2" obligatoria

    • DISABLED: Permite solicitaruna exenciónde autenticación fuerte.
      • Transacción de bajo monto.
      • LRM (Low Risk Merchant)

    Si la tienda no dispone de la opción "Frictionless 3DS2", la elección de preferencia se delega al emisor de la tarjeta (No Preference).

    Si el emisor acepta la solicitud de frictionless, la transacción no está cubierta por la transferencia de responsabilidad en caso de disputa del titular de de tarjeta.

    Sin preferencia del vendedor
    • NO_PREFERENCE : Indica al DS que el vendedor no tiene preferencia. El pago quedará garantizado si el emisor decide realizar una autenticación sin interacción (frictionless).
    • AUTO : Se delega la elección de la preferencia al emisor de la tarjeta (No Preference).

    Tabla de exenciones (valor DISABLED)

    una exención Descripción
    Transacción de bajo monto. Para el pago en euros puede solicitaruna exenciónde autentificación fuerte.
    • Si el monto inferior a 30 € y dentro del límite de 5 operaciones sucesivas o de un monto acumulado inferior a 100 €.
    • Si el monto es superior a 30 euros, se ignora el valor transmitido por el vendedor y la elección de la preferencia se delega al emisor de la tarjeta (No Preference).
    Para los pagos realizados en una moneda diferente al euro, se transmite una solicitud de frictionless al emisor.Si el emisor acepta la solicitud de frictionless, la transacción no está cubierta por la transferencia de responsabilidad en caso de disputa del titular de de tarjeta.
    LRM (Low Risk Merchant)

      El objetivo del programa LRM (Low Risk Merchant) de CB es responder a las necesidades de los vendedores de bajo riesgo y con un alto volumen de negocios (120.000 transacciones con tarjeta por año).

      Vous pouvez demander une exemption à l'authentification forte :

      • Si le montant est inférieur à 100 €, l'exemption est systématique pour les marchands éligibles.
      • Si le montant est compris entre 100 € et 250 €, une expérimentation est en cours. Le marchand doit remplir ces conditions :
        • Avoir un contrat CB.
        • Etre éligible à la TRA acquéreur.
        • Transmettre les valeurs requises dans le flux 3D Secure, selon les règles définies par la plateforme.
      Si el emisor acepta la solicitud de frictionless, la transacción no está cubierta por la transferencia de responsabilidad en caso de disputa del titular de de tarjeta.

      Para beneficiar del programa LRM de CB, debe contactar al el servicio de atención al cliente para recibir una aceptación explícita.

    Formato

    fingerPrintId

    Este campo lo utilizan los vendedores que implementan el analizador de riesgos en su página de pago. Permite transmitir el identificador de la sesión (o fingerPrint Id) a la plataforma de pago para finalizar el análisis de riesgo.

    Los analizadores compatibles son:

    • NOTO
    • Cybersource
    • MonitorPlus
    • ClearSale

    Puede contener mayúsculas, minúsculas, números o guiones ([AZ] [az], 0-9, _, -).

    Formato

    paymentMethodType

    Camino: paymentForms.paymentMethodType

    Tipo de medio de pago. Ejemplo: PAYCONIQ

    Formato

    paymentForms.pan

    El PAN (Primary Account Number) es el número principal de la tarjeta, generalmente compuesto por 16 dígitos).

    Formato

    expiryMonth

    Camino: paymentForms.expiryMonth

    Mes de expiración en 2 dígitos. Ejemplo: "09" por septiembre.

    Formato

    expiryYear

    Camino: paymentForms.expiryYear

    Año de expiración en 2 dígitos. Ejemplo: "25" por 2025.

    Formato

    securityCode

    Camino: paymentForms.securityCode

    Código de seguridad de la tarjeta.

    Su longitud puede variar entre 3 o 4 dígitos dependiendo del tipo de tarjeta.

    Formato

    paymentForms.brand

    Marca de la tarjeta.

    Formato

    IMPORTANT: el objeto threeDSResponse quedará obsoleto pronto. Puede no indicarse (null) o estar ausente en las próximas versiones. Se desaconseja utilizar transactions[0].transactionDetails.cardDetails.authenticationResponse

    cardHolderName

    Camino: paymentForms.cardHolderName

    Nombre completo del titular de la tarjeta

    Formato

    identityDocumentNumber

    Camino: paymentForms.identityDocumentNumber

    Número del documento de identidad del comprador.

    El formato depende del tipo de documento de identidad: entre 7 y 13 caracteres, números, letras y/o puntos.

    En América Latina, este parámetro puede ser obligatorio para algunos adquirentes.

    Formato

    identityDocumentType

    Camino: paymentForms.identityDocumentType

    Tipo del documento de identidad.

    Formato

    customer.reference

    Identificador del comprador en el sitio web comercial.

    Formato

    customer.email

    E-mail del comprador.

    • Especificaciones de la estructura del correo electrónico: RFC-2822

    Formato

    customer.ipAddress

    Dirección IP del comprador.

    Formato

    address

    Camino: customer.billingDetails.address

    Dirección de facturación.

    Atención: Los caracteres > y < no están permitidos.

    Formato

    address2

    Camino: customer.billingDetails.address2

    Información adicional sobre la dirección de facturación.

    Atención: Los caracteres > y < no están permitidos.

    Formato

    category

    Camino: customer.billingDetails.category

    Tipo de cliente.

    Formato

    Valores posibles

    valores Descripción
    PRIVATE Cliente de tipo Particular
    COMPANY Cliente de tipo Empresa

    cellPhoneNumber

    Camino: customer.billingDetails.cellPhoneNumber

    Teléfono móvil del comprador.

    Acepta todos los formatos:

    Ejemplos:

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

    Según el medio de pago, algunas restricciones pueden modificar el formato. Para más información, consulte la documentación técnica específica del medio de pago.

    Formato

    city

    Camino: customer.billingDetails.city

    Ciudad de facturación.

    Formato

    country

    Camino: customer.billingDetails.country

    País del comprador (en letras mayúsculas, según la norma ISO 3166-1 alfa-2).

    Formato

    Valores posibles

    Ejemplos de valores posibles:

    País Código
    AUSTRIA AT
    Brasil BR
    CÓRCEGA FR
    COSTA DE MARFIL CI
    FRANCIA FR
    GUADALUPE GP
    INDIA IN
    MARTINICA MQ
    NUEVA CALEDONIA NC
    SAN PEDRO Y MIQUELÓN PM
    POLINESIA FRANCESA PF

    district

    Camino: customer.billingDetails.district

    Barrio de la dirección de facturación.

    Formato

    firstName

    Camino: customer.billingDetails.firstName

    Nombre del comprador.

    Formato

    identityCode

    Camino: customer.billingDetails.identityCode

    Identificación nacional. Identifica de manera única a cada ciudadano en un país.

    Formato

    identityType

    Camino: customer.billingDetails.identityType

    Tipo del documento de identidad.

    Formato

    language

    Camino: customer.billingDetails.language

    Código del idioma del comprador según la norma ISO 639-1.

    Permite especificar el idioma en el que se envían los e-mails de confirmación de pago.

    el objeto device y sus atributos no son obligatorios si el valor de paymentSource está establecido en MOTO, CC MOTO o si se indica el objeto authenticationDetails.

    Formato

    Valores posibles

    Ejemplos de valores posibles:

    Idioma Código
    Alemán (Alemania) DE
    Inglés (Reino Unido) EN
    Inglés (Estados Unidos) EN
    Chino (tradicional) ZH
    Español (España) ES
    Español (Chile) ES
    Francés (Francia) FR
    Italiano (Italia) IT
    Japonés (Japón) JP
    Holandés (Países Bajos) NL
    Polaco (Polonia) PL
    Portugués (Brasil) PT
    Portugués (Portugal) PT
    Ruso (Rusia) RU

    lastName

    Camino: customer.billingDetails.lastName

    Nombre del comprador.

    Formato

    legalName

    Camino: customer.billingDetails.legalName

    Razón social.

    Formato

    phoneNumber

    Camino: customer.billingDetails.phoneNumber

    Número de teléfono del comprador.

    Acepta todos los formatos:

    Ejemplos:

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

    Según el medio de pago, algunas restricciones pueden modificar el formato. Para más información, consulte la documentación técnica específica del medio de pago.

    Formato

    state

    Camino: customer.billingDetails.state

    Región (estado) de la dirección de facturación. Es recomendable pero no obligatorio transmitir el valor ISO-3166-2.

    Formato

    streetNumber

    Camino: customer.billingDetails.streetNumber

    Número de calle de la dirección de facturación.

    Carácteres aceptados:

    • Caracteres alfabéticos (de la "A" a la "Z" y desde la "a" hasta la "z")
    • Espacio

    Formato

    title

    Camino: customer.billingDetails.title

    Tratamiento del comprador.

    Ejemplos:

    • Sr.
    • Sr.
    • Sra.

    Formato

    zipCode

    Camino: customer.billingDetails.zipCode

    Código postal de la dirección de facturación.

    Formato

    address

    Camino: customer.shippingDetails.address

    Dirección de entrega.

    Atención: Los caracteres > y < no están permitidos.

    Formato

    address2

    Camino: customer.shippingDetails.address2

    Segunda línea de la dirección de facturación.

    Atención: Los caracteres > y < no están permitidos.

    Formato

    category

    Camino: customer.shippingDetails.category

    Tipo de cliente.

    Formato

    Valores posibles

    valores Descripción
    PRIVATE Cliente de tipo Particular
    COMPANY Cliente de tipo Empresa

    city

    Camino: customer.shippingDetails.city

    Ciudad de entrega.

    Formato

    country

    Camino: customer.shippingDetails.country

    País de entrega (en letras mayúsculas, según la norma ISO 3166-1 alfa-2).

    Formato

    Valores posibles

    Ejemplos de valores posibles:

    País Código
    AUSTRIA AT
    Brasil BR
    CÓRCEGA FR
    COSTA DE MARFIL CI
    FRANCIA FR
    GUADALUPE GP
    INDIA IN
    MARTINICA MQ
    NUEVA CALEDONIA NC
    SAN PEDRO Y MIQUELÓN PM
    POLINESIA FRANCESA PF

    deliveryCompanyName

    Camino: customer.shippingDetails.deliveryCompanyName

    Nombre de la empresa emisora del producto.

    Formato

    district

    Camino: customer.shippingDetails.district

    Barrio de la dirección de facturación.

    Formato

    firstName

    Camino: customer.shippingDetails.firstName

    Nombre del destinatario.

    Formato

    identityCode

    Camino: customer.shippingDetails.identityCode

    Identificación nacional. Identifica de manera única a cada ciudadano en un país.

    Formato

    lastName

    Camino: customer.shippingDetails.lastName

    Nombre del comprador.

    Formato

    legalName

    Camino: customer.shippingDetails.legalName

    Razón social en caso de entrega a una empresa.

    Formato

    phoneNumber

    Camino: customer.shippingDetails.phoneNumber

    Número de teléfono del comprador.

    Acepta todos los formatos:

    Ejemplos:

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

    Formato

    shippingMethod

    Camino: customer.shippingDetails.shippingMethod

    Modo de entrega.

    Formato

    Valores posibles

    VALOR Descripción
    RECLAIM_IN_SHOP Retiro en tienda.
    RELAY_POINT Uso de una red de puntos de retiro de terceros (Kiala, Alveol, etc.).
    RECLAIM_IN_STATION Retiro en un aeropuerto, una estación o una agencia de viajes.
    PACKAGE_DELIVERY_COMPANY Entrega por transportista (Colissimo, UPS, etc.).
    ETICKET Emisión de un ticket electrónico, descarga de producto virtual.
    CARD_HOLDER_ADDRESS Entrega al comprador. Reservado para su uso futuro.
    VERIFIED_ADDRESS Entrega a una dirección verificada. Reservado para su uso futuro.
    NOT_VERIFIED_ADDRESS Entrega a una dirección no verificada. Reservado para su uso futuro.
    SHIP_TO_STORE Entrega en tienda. Reservado para su uso futuro.
    DIGITAL_GOOD Entrega digital. Reservado para su uso futuro.
    ETRAVEL_OR_ETICKET Boleto electronico. Reservado para su uso futuro.
    OTHER Otros Reservado para su uso futuro.
    PICKUP_POINT Retiro en un punto de relevo. Reservado para su uso futuro.
    AUTOMATED_PICKUP_POINT Recoger en el punto de relevo automático. Reservado para su uso futuro.

    shippingSpeed

    Camino: customer.shippingDetails.shippingSpeed

    Plazo de entrega.

    Formato

    Valores posibles

    Ejemplos de valores posibles:

    VALOR Descripción
    STANDARD Entrega estándar
    EXPRESS Entrega en 24 horas
    PRIORITY Entrega prioritaria (Click & Collect)

    state

    Camino: customer.shippingDetails.state

    Región de la dirección de facturación.

    Formato

    streetNumber

    Camino: customer.shippingDetails.streetNumber

    Número de calle de la dirección de facturación.

    Carácteres aceptados:

    • Caracteres alfabéticos (de la "A" a la "Z" y desde la "a" hasta la "z")
    • Espacio

    Formato

    zipCode

    Camino: customer.shippingDetails.zipCode

    Código postal de la dirección de facturación.

    Formato

    insuranceAmount

    Camino: customer.shoppingCart.insuranceAmount

    Monto del seguro para todo el pedido expresado en su unidad monetaria más pequeña (el centimo del euro).

    Ejemplo: 30050 para 300,50 EUR.

    Formato

    shippingAmount

    Camino: customer.shoppingCart.shippingAmount

    Monto de los gastos de entrega para todo el pedido expresado en su unidad monetaria más pequeña (el centimo para el euro).

    Ejemplo: 30050 para 300,50 EUR.

    Formato

    taxAmount

    Camino: customer.shoppingCart.taxAmount

    Monto de los impuestos para toda la orden expresados en su unidad monetaria más pequeña (el centimo para el euro).

    Ejemplo: 30050 para 300,50 EUR.

    Formato

    cartItemInfo

    Camino: customer.shoppingCart.cartItemInfo

    cardItemInfo es una lista que contiene objetos Customer/ShoppingCartItemInfo.

    Permite describir cada artículo del carrito.

    Formato

    productAmount

    Camino: customer.shoppingCart.cartItemInfo.productAmount

    Cantidad de ingresos expresados en su unidad monetaria más pequeña (el centimo para el euro).

    Ejemplo: 30050 para 300,50 EUR.

    Formato

    productLabel

    Camino: customer.shoppingCart.cartItemInfo.productLabel

    Nombre del producto.

    Formato

    productQty

    Camino: customer.shoppingCart.cartItemInfo.productQty

    Cantidad de producto.

    Formato

    productRef

    Camino: customer.shoppingCart.cartItemInfo.productRef

    Referencia del producto.

    Formato

    productType

    Camino: customer.shoppingCart.cartItemInfo.productType

    Tipo de producto.

    Valores posibles

    VALOR Descripción
    FOOD_AND_GROCERY Alimentos y productos comestibles.
    AUTOMOTIVE Automotriz / Motocicleta
    ENTERTAINMENT Entretenimiento / Cultura
    HOME_AND_GARDEN Casa y jardín
    HOME_APPLIANCE Equipo de la casa
    AUCTION_AND_GROUP_BUYING Subastas y compras a granel
    FLOWERS_AND_GIFTS Flores y regalos
    COMPUTER_AND_SOFTWARE Computadoras y software
    HEALTH_AND_BEAUTY Salud y belleza.
    SERVICE_FOR_INDIVIDUAL Servicios a domicilio
    SERVICE_FOR_BUSINESS Servicios de negocios
    SPORTS Deportes
    CLOTHING_AND_ACCESSORIES Ropa y accesorios
    TRAVEL Viajes
    HOME_AUDIO_PHOTO_VIDEO Sonido, imagen y video
    TELEPHONY Telefonía

    Formato

    productVat

    Camino: customer.shoppingCart.cartItemInfo.productVat

    Tipo de producto.

    Monto del impuesto sobre el producto (en la unidad más pequeña de la moneda).

    Valores posibles

    VALOR Descripción
    Un número entero Monto de la transacción. Su valor debe ser un entero positivo (por ejemplo: 1234 para 12,34 EUR).
    Un número decimal, inferior a 100 Porcentaje aplicado sobre el importe. Ejemplos: 20,0 o 19,6532

    Para expresar un porcentaje aplicado al monto del producto en cuestión, el valor debe tener un máximo de 4 dígitos después del punto decimal. El decimal es obligatorio para expresar un porcentaje. La posición decimal está marcada por el carácter ".".

    Formato

    device.deviceType

    Tipo de dispositivo en el que se realiza la autentificación.

    el objeto device y sus atributos no son obligatorios si el valor de paymentSource está establecido en MOTO, CC MOTO o si se indica el objeto authenticationDetails.

    Valores posibles

    VALOR Descripción
    BROWSER la autentificación se lleva a cabo en un navegador

    Formato

    device.acceptHeader

    El contenido exacto del encabezado HTTP accept, tal como lo envió el navegador del cliente.

    el objeto device y sus atributos no son obligatorios si el valor de paymentSource está establecido en MOTO, CC MOTO o si se indica el objeto authenticationDetails.

    Formato

    device.userAgent

    Contenido exacto del encabezado HTTP "user-agent" enviado por el navegador. Debe truncarse si el valor supera los 2048 caracteres.

    Obtenido del navegador del cliente a través de la propiedad “navigator.userAgent”.

    Código Javascript que permite obtener el valor:

    const language = navigator.userAgent;

    el objeto device y sus atributos no son obligatorios si el valor de paymentSource está establecido en MOTO, CC MOTO o si se indica el objeto authenticationDetails.

    Formato

    device.ip

    Dirección IP del navegador tal como la devuelve el cliente en los encabezados HTTP. Format IPV4 (ejemplo: 1.12.123.255) o IPV6 (ejemplo: 2011:0db8:85a3:0101:0101:8a2e:0370:7334). Longitud variable máximo 45 caracteres.

    el objeto device y sus atributos no son obligatorios si el valor de paymentSource está establecido en MOTO, CC MOTO o si se indica el objeto authenticationDetails.

    Formato

    device.javaEnabled

    Booleano que representa la capacidad del navegador para ejecutar Java. El valor es el que devuelve la función “navigator.javaEnabled()” y puede ser true o false.

    Código Javascript que permite obtener el valor:

    const javaEnabled = navigator.javaEnabled();

    el objeto device y sus atributos no son obligatorios si el valor de paymentSource está establecido en MOTO, CC MOTO o si se indica el objeto authenticationDetails.

    Formato

    device.language

    Cadena de caracteres que indica el idioma del navegador.

    Obtenido del navegador del cliente a través de la propiedad “navigator.language”.

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

    Código Javascript que permite obtener el valor:

    const language = navigator.language;

    Formato

    device.colorDepth

    Este valor representa la profundidad de la paleta de colores utilizada para visualizar las imágenes en bits por píxel.

    Obtenido del navegador del cliente a través de la propiedad “screen.colorDepth”.

    Código Javascript que permite obtener el valor:

    const colorDepth = screen.colorDepth;

    el objeto device y sus atributos no son obligatorios si el valor de paymentSource está establecido en MOTO, CC MOTO o si se indica el objeto authenticationDetails.

    Formato

    device.screenHeight

    La altura total de la pantalla del cliente en píxeles. El valor es aquel devuelto por la propiedad “screen.height”. De 1 a 6 caracteres.

    Código Javascript que permite obtener el valor:

    const screenHeight = screen.height;

    el objeto device y sus atributos no son obligatorios si el valor de paymentSource está establecido en MOTO, CC MOTO o si se indica el objeto authenticationDetails.

    Formato

    device.screenWidth

    El ancho total de la pantalla del cliente en píxeles. El valor es aquel devuelto por la propiedad “screen.width”. De 1 a 6 caracteres.

    Código Javascript que permite obtener el valor:

    const screenWidth = screen.width;

    el objeto device y sus atributos no son obligatorios si el valor de paymentSource está establecido en MOTO, CC MOTO o si se indica el objeto authenticationDetails.

    Formato

    timeZoneOffset

    Camino: device.timeZoneOffset

    Diferencia de tiempo entre la hora UTC y la hora local del navegador del cliente, en minutos. Su valor es de -120 para un usuario en el huso horario UTC+2 y 570 para el huso horario UTC−09:30.

    Código Javascript que permite obtener el valor:

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

    el objeto device y sus atributos no son obligatorios si el valor de paymentSource está establecido en MOTO, CC MOTO o si se indica el objeto authenticationDetails.

    Formato

    name

    Camino: instructionResult.name

    Nombre de la instrucción.

    Valores posibles

    VALOR Descripción
    CHALLENGE Instrucción Challenge, que permite la autentificación interactiva del usuario con el ACS.
    FINGERPRINT Instrucción Fingerprint, que permite la autentificación interactiva del usuario con el ACS.

    Formato

    value

    Camino: instructionResult.value

    Resultado como una cadena JWT, o un código de error en texto plano en caso de error ('timeout' por ejemplo).

    Formato

    challengePreference

    Camino: instructionResult.protocol.challengePreference

    Indica si el vendedor ha solicitado un "challenge" o no.

    Valores posibles

    VALOR Tarjeta 3DS2
    NO_PREFERENCE La elección de la preferencia se delega al emisor de la tarjeta.
    NO_CHALLENGE_REQUESTED Permite solicitar una autentificación sin interacción (frictionless).
    CHALLENGE_REQUESTED Permite solicitar una autentificación fuerte para la transacción.
    CHALLENGE_MANDATED Permite indicar que, por razones reglamentarias, la transacción requiere una autentificación fuerte.
    DATA_ONLY Permite solicitar una autentificación sin interacción, tratada por el DS y no por el ACS del banco emisor.La transacción no cuenta con transferencia de responsabilidad. La autentificación se desactiva si la red es incompatible con esta funcionalidad. El Web Service PCI/Charge/Authenticate devuelve un código de error INT_808 si el campotransactionCategorysu valor no puede serPAYMENT.

    Formato

    name

    Camino: instructionResult.protocol.name

    Nombre del protocolo de autentificación del titular de la tarjeta.

    Valores posibles

    VALOR Descripción
    THREEDS Protocolo 3-D Secure

    Formato

    network

    Camino: instructionResult.protocol.network

    Red en la que se autentificó el medio de pago.

    Este campo es obligatorio para gestionar el tiempo de espera en el método 3ds, cuando el campo instructionResult.value se establece en TIMEOUT.

    Redes compatibles actualmente

    VALOR
    CB
    VISA
    MASTERCARD
    AMEX_SAFEKEY
    PROTECTBUY

    Formato

    simulation

    Camino: instructionResult.protocol.simulation

    Booleano que indica si la autentificación debe realizarse en modo de simulación. Si establece el valor de este campo obligatorio en:

    • true, se activa el modo de simulación.
    • false, no se activa el modo simulación.

    El modo de simulación permite lograr una integración comercial sin estar en producción, ni utilizar tarjetas reales.

    Formato

    version

    Camino: instructionResult.protocol.version

    Versión del protocolo de autentificación del titular de la tarjeta.

    Versiones actualmente soportadas

    VALOR Descripción
    1.0.2 Versión 1.0.2
    2.1.0 Versión 2.1.0
    2.2.0 Versión 2.2.0

    Formato

    operationSessionId

    ID único de autentificación, en formato UUID.

    Nulo a la primera llamada.

    Cuando se requieren varias llamadas al Web Service PCI/Charge/VerifyPaymentMethod para autentificar a un comprador, el valor del ID transmitido debe ser el mismo en cada llamada de una misma autentificación. En ese caso, debe usarse el identificador proporcionado en la respuesta anterior.

    Formato

    mid

    Camino: transactionOptions.cardOptions.mid

    Número de contrato del vendedor. Si este campo es completado, asegúrese de utilizar el contrato correcto en función de la red de la tarjeta.

    Formato

    paymentSource

    Camino: transactionOptions.cardOptions.paymentSource

    Origen del pago.

    Formato

    Valores posibles

    . Los valores posibles son:

    VALOR Descripción
    EC E-Commerce: el comprador ingresa los datos del medio de pago. Este valor permite tener una autentificación fuerte al momento del pago.
    MOTO MAIL OR TELEPHONE ORDER: Ingreso realizado por un operador. Los datos del medio de pago se envían por correo postal o electrónico. Requiere un contrato de tipo VAD.
    CC Call Center: pago realizado a través de un centro de atención telefónico. Requiere un contrato de tipo VAD.
    OTHER Otro canal de venta. Valor de salida devuelto para los pagos realizados desde el Back Office Vendedor, los pagos por archivo, los pagos recurrentes, los pagos de proximidad y los reembolsos desde el CMS de Shopify.
    Absent ou null El valor predeterminado es “EC”.

    retry

    Camino: transactionOptions.cardOptions.retry

    Cantidad de nuevos intentos disponibles en caso de rechazo del pago (1 por defecto).

    Formato

    Referencia de la respuesta

    Existen varias respuestas posibles dependiendo del contexto:

    Respuesta Contexto
    Payment Objeto que contiene la transacción de tipo VERIFICATION generada.
    AuthenticationResponseData Objeto devuelto si se requiere una autentificación 3DS

    Consultar la referencia de las respuestas para más información.