PCI/Charge/CreatePayment
La operación Charge/CreatePayment es un Web Service de la API REST. Le permite crear una nueva transacción a partir de un número de tarjeta.
En el modo PCI DSS, puede ingresar la información de la tarjeta directamente en el Web Service.
Para el uso no PCI con el formulario incrustado, consulte: Charge/CreatePayment(non-PCI).
autentificación con nuestro servidor de autentificación
Este Web Service permite realizar una transacción 3DS. Por lo tanto, es necesario saber cómo funciona esta funcionalidad Para saber cómo integrarlo, consulte la siguiente documentación: Web Services PCI de pago.
Punto importante sobre los pagos CB
Con la aplicación de la DSP2, los emisores pueden rechazar la transacción si no se ha realizado la autentificación 3-D Secure. Este comportamiento se llama "Soft Decline".
En caso de "Soft Decline", el valor del campo transactionDetails.cardDetails.authorizationResponse.authorizationResult es 81 Es responsabilidad del vendedor iniciar un nuevo pago con autentificación 3-D Secure.
Autentificación con otro servidor de autentificación
El servicio PCI/Charge/CreatePayment permite que los vendedores PCI DSS que han realizado la autentificación del titular de la tarjeta en su propio servidor de autentificación realicen pagos transmitiendo la información de la tarjeta y los datos de autentificación del titular en su solicitud.
Consulte el capítulo la guía de integración para obtener más información.
Parámetros de la solicitud
El Web Service REST PCI/Charge/CreatePayment admite los siguientes parámetros:
amount
Monto del pago en su fracción monetaria más pequeña (el céntimo para el euro).
Ejemplo: 30050 para 300,50 EUR.
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 |
orderId
Referencia de pedido definida por el vendedor. No admite los caracteres UTF-8.
Formato
formAction
formAction le permite definir el tipo de comportamiento que desea al crear la transacción.
Formato
Valores posibles
. Los valores posibles son:
VALOR | Descripción |
---|---|
PAYMENT | Creación de una transacción simple. Comportamiento predeterminado. |
REGISTER_PAY | Creación de un token de los medios de pago al mismo tiempo que la transacción. No permite crear un token asociado a un IBAN. |
null | Si el valor es nulo o no definido, se aplica PAYMENT. |
PAYMENT:
El Web Service devolverá un formToken.
Es el comportamiento predeterminado. La llamada a Charge/CreatePayment crea una transacción sin realizar ninguna operación adicional.
REGISTER_PAY:
El Web Service devolverá un formToken.
Se crea un token del medio de pago al mismo tiempo que la transacción. Este token le permite crear transacciones en un solo clic. El token recién creado se indica en la propiedad paymentMethodToken. Para más información, consulte el artículo sobre Creación y uso de token.
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
cardHolderName
Camino: paymentForms.cardHolderName
Nombre completo del titular de la tarjeta
Formato
firstInstallmentDelay
Camino: paymentForms.firstInstallmentDelay
Cantidad de meses en los que se aplaza el primer pago de un pago a plazos. Campo específico a los adquirentes en Latino américa.
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
installmentNumber
Camino: paymentForms.installmentNumber
Cantidad de cuotas.
Formato
overridePaymentCinematic
Camino: paymentForms.overridePaymentCinematic
Le permite cambiar el modo de captura. Específico de los adquirientes de América Latina. Esta característica no se puede usar en Colombia.
Valores posibles:
VALOR | Descripción |
---|---|
IMMEDIATE_CAPTURE | Secuencia de captura inmediata: el adquiriente inicia la captura el día del pago. |
DELAYED_CAPTURE | Secuencia de captura diferida: la captura es iniciada por la plataforma de pago, siempre antes de que expire la solicitud de autorización. |
Formato
paymentMethodToken
Camino: paymentForms.paymentMethodToken
Token asociado a un medio de pago.
Formato
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
taxRate
Usado por ciertos medios de pago en América Latina. permite transmitir el tipo de impuesto aplicado a todo el pedido. El valor debe ser el porcentaje a aplicar (21 para 21 %).
Formato
device.deviceType
Tipo de dispositivo en el que se realiza la autentificación.
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.
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;
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.
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();
Formato
device.language
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;
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;
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;
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();
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
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
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.
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
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
acquirerTransientData
Permite la transmisión de información específica a determinados adquirentes/redes.
Utilización con Conecs in France
Campo opcional que permite la transferencia del monto de los productos elegibles pagaderos con la tarjeta de cheque restaurante CONECS.
Si el campo no se transmite, el monto total se considerará elegible para el pago con la tarjeta cheque restaurante, incluidos los eventuales costos de envío incluidos en el monto del pedido.
Ejemplo para una cantidad elegible de 17.25 €:
Ejemplo: .
{"CONECS":{"eligibleAmount":"1725"}}
Restringir los códigos BIN aceptados
Para limitar las tarjetas de pago aceptadas según su código BIN, se requiere el formato siguiente:
{"MULTI":{"bins": ["bin1","bin2","bin3"]}}
Nota : Admite códigos BIN de 6 u 8 dígitos.
Ejemplo: .
Códigos BIN6 cifras: 4012 34XX XXXX XXXX;
Códigos BIN8 cifras: 4000 1234 XXXX XXXX.
Formato
contrib
Nombre de la solución de e-comercio utilizada en el sitio web comercial y su número de versión.
Formato
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
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
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
Formato
merchantPostUrlRefused
Permite definir la URL a la que se redirigirá el navegador tras el fallo de la autentificación 3-D Secure.
Formato
merchantPostUrlSuccess
Permite definir la URL a la que se redirigirá el navegador tras una autentificación 3-D Secure satisfactoria.
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.
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 |
|
| |
| |
FRICTIONLESSSin interacción del titular Opción "Frictionless 3DS2" obligatoria |
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 |
|
|
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.
|
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 : |
Formato
useCase
Se utiliza para especificar el caso de uso deseado.
Valor posible
Valor que debe introducirse para el pago múltiple en el envío :
VALOR | Descripción |
---|---|
SHIPMENT_MULTIPLE_AUTHORISATION | Caso práctico "Pago al envío con autorizaciones múltiples |
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 |
Absent ou null | El valor predeterminado es “EC”. |
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
manualValidation
Camino: transactionOptions.cardOptions.manualValidation
Modo de validación de la transacción.
Formato
Valores posibles
. Los valores posibles son:
VALOR | Descripción |
---|---|
NO | Validación automática por la plataforma de pago. |
YES | Validación manual por el vendedor. |
null | Configuración por defecto de la tienda seleccionada (configurable en el |
captureDelay
Camino: transactionOptions.cardOptions.captureDelay
Fecha límite para aplicar en la fecha de captura.
Descripción
Indica el número de días antes de la captura.
Si no se transmite este parámetro, se utiliza el valor predeterminado definido en el
Este último es configurable en el
Si el tiempo de entrega es mayor a 365 días en la solicitud de pago, se reposiciona automáticamente a 365 días.
Formato
firstInstallmentDelay
Camino: transactionOptions.cardOptions.firstInstallmentDelay
Cantidad de meses en los que se aplaza el primer pago de un pago a plazos. Campo específico a los adquirentes en Latino américa.
Formato
installmentNumber
Camino: transactionOptions.cardOptions.installmentNumber
Cantidad de cuotas.
Formato
retry
Camino: transactionOptions.cardOptions.retry
Cantidad de nuevos intentos disponibles en caso de rechazo del pago (1 por defecto).
Formato
name
Camino: authenticationDetails.protocol.name
Nombre del protocolo de autentificación del titular de la tarjeta.
Valores posibles
VALOR | Descripción |
---|---|
THREEDS | Protocolo 3-D Secure |
Formato
version
Camino: authenticationDetails.protocol.version
Versión del protocolo de autentificación del titular de la tarjeta.
Valores posibles
VALOR | Descripción | Protocolo compatible |
---|---|---|
2 | Debe indicarse si la versión exacta no se conoce. En este caso, se considera la última versión que la plataforma admite en 3-D Secure 2 | Todos |
1.0.2 | Versión 1.0.2 | THREEDS |
2.1.0 | Versión 2.1.0 | THREEDS |
2.2.0 | Versión 2.2.0 | THREEDS |
Formato
directoryServer
Camino: authenticationDetails.protocol.directoryServer
Nombre de la red DS en la que se realizó la autentificación.
Valores posibles
NOMBRE DEL PROTOCOLO | VALOR DE DIRECTORYSERVER | NOMBRE DE LA RED |
---|---|---|
THREEDS | AMEX | Red American Express (Safekey) |
CB | Red Carte Bancaire | |
VISA | Red Visa | |
ELO | Red Elo (Brasil) | |
DINERS | Red Diners | |
DISCOVER | Red Discover | |
ELO | Red Elo |
Formato
challengePreference
Camino: authenticationDetails.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 campotransactionCategory su valor no puede serPAYMENT . |
Formato
authenticationType
Camino: authenticationDetails.authenticationType
El tipo de autentificación que tuvo lugar.
Valores posibles
VALOR | Descripción |
---|---|
FRICTIONLESS | autentificación en modo Frictionless, es decir, de forma transparente para el cliente |
CHALLENGE | Autentificación con Challenge, el cliente tuvo que autentificarse explícitamente con el ACS |
DATA_ONLY | Autentificación tratada por el DS sin interacción del cliente |
Formato
status
Camino: authenticationDetails.status
El estado de autentificación, es decir, el resultado positivo/negativo de la autentificación.
Valores posibles
VALOR | Descripción |
---|---|
ATTEMPT | Prueba de intento de autentificación cuando la autentificación no está disponible |
ENROLLED_UNAVAILABLE | No se puede obtener el estado de inscripción |
FAILED | autentificación incorrecta |
NOT_ENROLLED | Tarjeta no enrolada |
SUCCESS | autentificación exitosa |
UNAVAILABLE | No se pudo completar la autentificación (error técnico, etc.) |
DISABLED | autentificación desconectada. El campo exemption se vuelve obligatorio |
Formato
commerceIndicator
Camino: authenticationDetails.commerceIndicator
El indicador de comercio, llamado ECI (Electronic Commerce Indicator) para el protocolo 3DS. Indicador devuelto por el ACS para indicar los resultados del intento de autentificación del titular de la tarjeta.
En caso de autentificación sin pago (registro de una tarjeta) Mastercard puede devolver estos 2 valores:
VALOR | Descripción |
---|---|
N0 | Not authenticated |
N2 | Authenticated |
Formato
authenticationValue
Camino: authenticationDetails.authenticationValue
Valor de autentificación final (según el DS, este valor puede denominarse CAVV, AEVV o AAV). Cadena de caracteres codificada en base 64 con un tamaño de 28 caracteres.
Formato
dsScore
Camino: authenticationDetails.dsScore
Score de l'authentification spécifié par le DS, uniquement pour le réseau CB. Voir : Guide d'intégration.
Formato
authValueAlgorithm
Camino: authenticationDetails.authValueAlgorithm
Algorithme utilisé pour calculer le champ authenticationValue. Ce champ concerne uniquement le réseau CB. Voir : Guide d'intégration.
Formato
requestorName
Camino: authenticationDetails.requestorName
RequestorName utilisé lors de l'authentification initiale. En général ce champ correspond au nom du marchand. Ce champ concerne uniquement le réseau CB. Voir : Guide d'intégration.
Formato
dsTransID
Camino: authenticationDetails.dsTransID
Identificación de la transacción de la DS.
Formato
acsTransID
Camino: authenticationDetails.acsTransID
Identifiant de transaction de l'ACS. Ce champ concerne uniquement le réseau CB. Voir : Guide d'intégration
Formato
xid
Camino: authenticationDetails.xid
Identificador único de la transacción.
Formato
exemption
Camino: authenticationDetails.exemption
Indica la razón por la que no se utiliza la autentificación fuerte. (Necesario en caso de estado DISABLED o en caso de autentificación FRICTIONLESS).
Valores posibles
valores | Descripción |
---|---|
LOW_VALUE | Transacción de monto bajo (ej. monto inferior a 30€ en Europa) |
ACQUIRER_TRA | Análisis de riesgo realizado previamente por el adquirente |
ISSUER_TRA | Análisis de riesgo realizado previamente por el emisor |
LOW_RISK_MERCHANT | Comerciante inscrito en el programa LOW RISK MERCHANT CB |
OUT_OF_SCOPE | Autentificación no requerida, ya que está fuera del scope RTS SCA |
DELEGATED_SCA | Autentificación fuerte delegada a un tercero. |
FIXED_RECURRING_PAYMENT | Pago recurrente de monto fijo y duración definida |
TRUSTED_BENEFICIARY | Beneficiario de confianza |
AUTOMATIC_PAYMENT_MACHINES | Autómata de pago. |
CORPORATE | Procedimiento de pago seguro para empresas |
OTHER_EXEMPTION | Otros usos exentos de autentificación |
TECHNICAL_ERROR | Problema técnico que imposibilita la autentificación |
Formato
challengeCancelationIndicator
Camino: authenticationDetails.challengeCancelationIndicator
Indicador de la cancelación del challenge recibido en el RReq. (Valor que devuelve el DS en caso de anulación de la autentificación).
Formato
transactionStatusReason
Camino: authenticationDetails.transactionStatusReason
Indica el motivo del fallo de la autentificación. (Valor devuelto por el DS en caso de fallo de autentificación).
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 campotransactionCategory su 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
Identificador único para la sesión de autentificación.
Formato
companyType
Camino: subMerchantDetails.companyType
Tipo de empresa del subvendedor. Transmitido por el facilitador de pago.
Pueden aplicarse reglas diferentes según el adquiriente. A menudo este campo permite indicar el tipo de Legal Number
del comprador.
Formato
legalNumber
Camino: subMerchantDetails.legalNumber
Número legal del subvendedor según el campo companyType
. Transmitido por el facilitador de pago.
Formato
name
Camino: subMerchantDetails.name
Razón social del subvendedor. Transmitido por el facilitador de pago.
Formato
url
Camino: subMerchantDetails.url
URL del subvendedor. Transmitido por el facilitador de pago.
Formato
phoneNumber
Camino: subMerchantDetails.phoneNumber
Número de teléfono del subvendedor. Transmitido por el facilitador de pago.
Formato
address1
Camino: subMerchantDetails.address1
Dirección del subvendedor. Transmitido por el facilitador de pago.
Formato
address2
Camino: subMerchantDetails.address2
Complemento de la dirección del subvendedor. Transmitido por el facilitador de pago.
Formato
zip
Camino: subMerchantDetails.zip
Código postal del subvendedor. Transmitido por el facilitador de pago.
Formato
city
Camino: subMerchantDetails.city
Ciudad del subvendedor. Transmitido por el facilitador de pago.
Formato
country
Camino: subMerchantDetails.country
Código del país de la dirección del subvendedor (norma ISO 3166 alpha-2). Transmitido por el facilitador de pago.
Formato
mcc
Camino: subMerchantDetails.mcc
Código MCC del subvendedor. Transmitido por el facilitador de pago.
Formato
mid
Camino: subMerchantDetails.mid
Número de afiliación (MID) del subvendedor. Transmitido por el facilitador de pago.
Formato
softDescriptor
Camino: subMerchantDetails.softDescriptor
Descripción (soft-descriptor) del subvendedor que aparece en el extracto de operaciones bancarias del comprador. Transmitido por el facilitador de pago.
Formato
state
Camino: subMerchantDetails.state
Región de la dirección del subvendedor. Transmitido por el facilitador de pago.
Formato
facilitatorId
Camino: subMerchantDetails.facilitatorId
Identificador del facilitador de pago. Transmitido por el facilitador de pago.
Formato
Referencia de la respuesta
Existen varias respuestas posibles dependiendo del contexto:
Respuesta | Contexto |
---|---|
Payment | Objeto que contiene la transacción generada. Este objeto se devuelve directamente cuando se paga con un simple token. |
AuthenticationResponseData | Objeto devuelto si se requiere una autentificación 3DS |
Consultar la referencia de las respuestas para más información.