Respuesta Payment
Payment es un objeto que describe el resultado de un pago. Es devuelto por el servicio web REST Charge/CreatePayment y por la IPN.
El objeto Payment puede contener diversas transacciones.
Estructura del objeto Payment
El objeto Payment se estructura de la siguiente manera:
Generalmente, la lista transactions solo contiene una transacción. Pero en caso de pago fraccionado (pedido pagado con distintos medios de pago), se pueden crear varias transacciones. Por eso, siempre debe utilizar los campos orderStatus y orderCycle para comprobar el estado del pedido.
Referencia de la respuesta
orderStatus
Estado consolidado de las transacciones contenidas en el pedido.
DESCRIPCIÓN
Un pedido puede contener varias transacciones. OrderStatus consolida el status de todas las transacciones vinculadas al pedido.
Para obtener más información sobre el ciclo de vida de una transacción, consulte: Ciclo de vida de una transacción
Valores posibles
Los valores posibles son:
| STATUS | DESCRIPCIÓN |
|---|---|
| PAID | El pedido ha sido pagado |
| UNPAID | El pedido no ha sido pagado |
| RUNNING | El pedido está en curso |
| PARTIALLY_PAID | El pedido fue parcialmente pagado |
Formato
orderCycle
Definido si el pedido está abierto ( OPEN , el pago está autorizado), o cerrado ( CLOSED , ya no se puede modificar).
orderCycle toma el valor CLOSED si ya no se puede modificar:
- Cuando el pedido está totalmente pagado
- Cuando se agoten todos los intentos de pago autorizados
De lo contrario, orderCycle toma el valor OPEN
Valores posibles
Los valores posibles son:
| STATUS | DESCRIPCIÓN |
|---|---|
| OPEN | El pedido está en curso. Deberá conservar la cesta de la compra, ya que es posible que se realicen más intentos de pago. |
| CLOSED | El pedido está totalmente pagado o el último intento fue rechazado (en cuyo caso hay que generar un nuevo formToken ). |
Formato
Casos de uso de OPEN
De manera predeterminada, el comprador tiene 4 intentos para pagar su pedido. Mientras no se realicen todos estos intentos, orderCycle se establece en OPEN .
Un pedido también se puede pagar con varias transacciones o varios medios de pago. Mientras no se pague todo el pedido, orderCycle se establece en OPEN .
Si la transacción asociada está en validación manual, orderCycle se establece en OPEN .
Casos de uso CLOSED
Si se paga el pedido completo, orderCycle se establecerá en CLOSED .
Cuando el pedido caduca, el valor de orderCycle se establece en CLOSED .
Si fallan todos los intentos de pago autorizados (4, de forma predeterminada), orderCycle se establece en CLOSED .
Si la transacción fue creada inicialmente con validación manual, cuando la transacción se valide o se cancele, el valor de orderCycle será CLOSED .
shopId
Identificador de la tienda.
Formato
orderEffectiveAmount
Camino: orderDetails.orderEffectiveAmount
Monto original de la transacción en caso de conversión de moneda.
Formato
orderDetails.mode
Permite definir el modo en el cual se ha creado el pedido.
Valores posibles
Los valores posibles son:
| STATUS | DESCRIPCIÓN |
|---|---|
| TEST | para un pedido de prueba |
| PRODUCTION | para un pedido real |
Formato
orderCurrency
Camino: orderDetails.orderCurrency
Código de la moneda del pedido en formato 4217 alpha-3.
Ejemplo: "COP" para el peso colombiano.
Formato
orderDetails.orderId
Referencia del pedido definida por el vendedor. No admite los caracteres UTF-8.
Formato
orderTotalAmount
Camino: orderDetails.orderTotalAmount
Cantidad total del pedido expresada en su unidad monetaria más pequeña (el céntimo para el peso colombiano).
Ejemplo: 30050 por 300.50 COP.
Formato
customer.reference
Identificador del comprador en el sitio del vendedor.
Formato
customer.email
Dirección de correo electrónico del comprador.
Formato
address
Camino: customer.billingDetails.address
Direccion 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
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
Apellido 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 en formato 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
Apellido 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 comprobada. 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 | Otro: Reservado para su uso futuro. |
| PICKUP_POINT | Retiro en punto de retiro. 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
ipAddress
Camino: customer.extraDetails.ipAddress
Dirección IP del comprador.
Formato
fingerPrintId
Camino: customer.extraDetails.fingerPrintId
Formato
browserUserAgent
Camino: customer.extraDetails.browserUserAgent
Encabezado “User-Agent” del navegador del comprador (HTTP/1.1 - RFC. 2616)
Formato
browserAccept
Camino: customer.extraDetails.browserAccept
Encabezado “Accept” del navegador del comprador (HTTP/1.1 - RFC. 2616)
Formato
insuranceAmount
Camino: customer.shoppingCart.insuranceAmount
Cantidad del seguro para todo el pedido expresada en su unidad monetaria más pequeña (el céntimo para el peso colombiano).
Ejemplo: 30050 por 300.50 COP.
Formato
shippingAmount
Camino: customer.shoppingCart.shippingAmount
Importe de los gastos de envío de todo el pedido expresado en su unidad monetaria más pequeña (el céntimo de peso colombiano).
Ejemplo: 30050 por 300.50 COP.
Formato
taxAmount
Camino: customer.shoppingCart.taxAmount
Importe de los impuestos de todo el orden expresado en su unidad monetaria más pequeña (el céntimo para el peso colombiano).
Ejemplo: 30050 por 300.50 COP.
Formato
cartItemInfo
Camino: customer.shoppingCart.cartItemInfo
cardItemInfo es una lista que contiene objetos Customer/ShoppingCartItemInfo.
Para más información, consulte las propiedades de customer.shoppingCart.*
Formato
productAmount
Camino: customer.shoppingCart.cartItemInfo.productAmount
Cantidad del producto expresada en su unidad monetaria más pequeña (el céntimo para el peso colombiano).
Ejemplo: 30050 por 300.50 COP.
Formato
productLabel
Camino: customer.shoppingCart.cartItemInfo.productLabel
Nombre del producto.
Formato
productQty
Camino: customer.shoppingCart.cartItemInfo.productQty
Cantidad del producto.
Formato
productRef
Camino: customer.shoppingCart.cartItemInfo.productRef
Referencia del producto.
Formato
productType
Camino: customer.shoppingCart.cartItemInfo.productType
Tipo de producto.
Formato
Valores posibles
| Valor | DESCRIPCIÓN |
|---|---|
| FOOD_AND_GROCERY | Alimentos y productos comestibles |
| AUTOMOTIVE | Automóviles / Motos |
| ENTERTAINMENT | Entretenimiento / Cultura |
| HOME_AND_GARDEN | Casa y jardín |
| HOME_APPLIANCE | Equipamiento del hogar |
| AUCTION_AND_GROUP_BUYING | Subastas y compras conjuntas |
| FLOWERS_AND_GIFTS | Flores y regalos |
| COMPUTER_AND_SOFTWARE | Computadores y software |
| HEALTH_AND_BEAUTY | Salud y belleza |
| SERVICE_FOR_INDIVIDUAL | Servicios a personas |
| SERVICE_FOR_BUSINESS | Servicios a empresas |
| SPORTS | Deportes |
| CLOTHING_AND_ACCESSORIES | Ropa y accesorios |
| TRAVEL | Viajes |
| HOME_AUDIO_PHOTO_VIDEO | Sonido, imagen y video |
| TELEPHONY | Telefonía |
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 al monto. Ejemplos: 20.0 o 19.6532 |
Para expresar un porcentaje aplicado al monto del producto en cuestión, el valor debe contener un máximo de 4 dígitos tras el punto decimal. El decimal es obligatorio para expresar un porcentaje. La posición decimal está marcada por el carácter "."
companyType
Camino: subMerchantDetails.companyType
Tipo de empresa del subvendedor. Transmitido por el facilitador de pago.
Formato
legalNumber
Camino: subMerchantDetails.legalNumber
Número legal del subvendedor. 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
Información complementaria sobre 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 de 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.
Ce champ est obligatoire pour les acquéreurs Fiserv et Procesos
Formato
softDescriptor
Camino: subMerchantDetails.softDescriptor
Título (descriptor suave) del subcomerciante que aparece en el extracto bancario del comprador. Transmitido por el facilitador de pago.
{: .lita-excluded } CÓD AGRUPADOR ASIGNADO POR PRISMA + "*" + NOMBRE FANTASÍA VENDEDOR
{: .lita-excluded } El campo es de texto libre aunque debe contruirse bajo el siguiente criterio:
{: .lita-excluded } Long total: 25 caracteres incluyendo el cód de agrupador
{: .lita-excluded } Caracteres aceptados: [A-Z];[0-9];[*]
{: .lita-excluded } Ejemplos: {: .lita-excluded }- "TP ELECTONICA TUCUMAN" {: .lita-excluded }- "MP MARTIN GONZALEZ"
Formato
transactions.amount
Monto del pago en su unidad monetaria más pequeña (el centavo para el peso colombiano).
Ejemplo: 30050 por 300.50 COP.
Formato
creationDate
Camino: transactions.creationDate
Fecha y hora de registro de la transacción.
Formato
currency
Camino: transactions.currency
Moneda de pago. Código del alfabeto en mayúsculas según ISO 4217 alfa-3.
Ejemplo: "COP" para el peso colombiano.
Formato
Valores posibles
Los valores posibles son:
| Moneda | CODIFICACIÓN ISO 4217 | Unidad fraccionaria |
|---|---|---|
| Peso argentino (032) | ARS | 2 |
| Peso Colombiano (170) | COP | 2 |
| Peso mexicano (484) | MXN | 2 |
| Sol peruano (604) | PEN | 2 |
| Dólar estadounidense (840) | USD | 2 |
| Real brasileño (986) | BRL | 2 |
detailedErrorCode
Camino: transactions.detailedErrorCode
Código de error detallado devuelto por el adquirente, sin filtro ni modificación.
Consulte Lista de códigos de retorno de autorización para más detalles.
Formato
detailedErrorMessage
Camino: transactions.detailedErrorMessage
Mensaje de error detallado devuelto por la aplicación de pago sin filtro.
Contiene información contextual para ayudar a entender el error.
Se puede asignar a este campo el valor null cuando errorCode tiene el valor ACQ_001 .
Consulte la descripción del campo detailedErrorCode para conocer el motivo del rechazo de la autorización.
Formato
detailedStatus
Camino: transactions.detailedStatus
El parámetro detailedStatus proporciona información detallada sobre el estado del pago. Cada uno de los estados es propio a los medios de pago utilizados.
Valores posibles
Los valores posibles son:
| detailedStatus | DESCRIPCIÓN |
|---|---|
| ACCEPTED | Estado de una transacción de tipo VERIFICATION cuya autorización o solicitud de información ha sido aceptada. Este estado no puede cambiar. Las transacciones con estado ACCEPTED no se capturan nunca. Se crea una transacción de tipo VERIFICATION al actualizar o crear un token sin pago. |
| AUTHORISED | El monto está autorizado y será capturado automáticamente. |
| AUTHORISED_TO_VALIDATE | La transacción, creada en validación manual, está autorizada. El vendedor debe validar manualmente la transacción para que sea capturada al banco. La transacción puede ser validada siempre y cuando la fecha de expiración de la solicitud de autorización no se haya vencida. Si esta fecha se supera, el pago toma el estado EXPIRED. El estado Expirado es definitivo. |
| CANCELLED | La transacción fue cancelada. |
| CAPTURED | El importe de la transacción ha sido capturado. |
| EXPIRED | Se alcanzó la fecha de vencimiento de la solicitud de autorización sin que el vendedor valide la transacción. No se realizará el débito al titular. |
| PARTIALLY_AUTHORISED | La transacción ha sido parcialmente pagada. |
| REFUSED | La transacción fue rechazada. |
| UNDER_VERIFICATION | Verificación del adquiriente en curso. Este estado no es definitivo. |
| WAITING_AUTHORISATION | El plazo de captura es superior al periodo de validez de la autorización. |
| WAITING_AUTHORISATION_TO_VALIDATE | El plazo de captura es superior al periodo de validez de la autorización. El vendedor debe validar manualmente la transacción para que se realice la orden de autorización y la captura. |
| ERROR | Ocurrió un error inesperado. |
Para obtener más información sobre el ciclo de vida de una transacción, consulte: Ciclo de vida de una transacción .
Formato
effectiveStrongAuthentication
Camino: transactions.effectiveStrongAuthentication
Indica si el titular se ha autenticado correctamente durante el pago.
Valores posibles
Los valores posibles son:
| Valor | DESCRIPCIÓN |
|---|---|
| ENABLED | El titular se ha autenticado correctamente. |
| DISABLED | El pago no está sujeto a la autenticación del titular de la tarjeta o la autenticación del titular de la tarjeta ha fallado. |
Formato
errorCode
Camino: transactions.errorCode
Código de error. Consulte Códigos de error para más detalles.
Formato
errorMessage
Camino: transactions.errorMessage
Mensaje de error. Consulte Códigos de error para más detalles.
Formato
metadata
Camino: transactions.metadata
Valores personalizados vinculados a la transacción, en formato json.
Ejemplo de llamada
Por ejemplo, para transmitir un valor personalizado, como el color de ojos de su comprador, agregue a su solicitud:
{
"metadata": {
"eyesColor": "blue"
}
}Este valor se devolverá en el objeto de transacción recién creado.
También puede utilizar los metadatos “ info1 ”, “ info2 ” y “ info3 ” para transmitir la información adicional sobre el pedido.
Estos datos aparecerán en la pestaña Extra del detalle de la transacción desde su
Formato
operationType
Camino: transactions.operationType
Tipo de operación.
Valores posibles
Los valores posibles son:
| Valor | DESCRIPCIÓN |
|---|---|
| DEBIT | Operación de débito |
| CREDIT | Transacción de reembolso |
| VERIFICATION | Operación de verificación de un medio de pago |
Formato
transactions.uuid
Referencia única de la transacción generada por la plataforma de pago.
Formato
paymentMethodToken
Camino: transactions.paymentMethodToken
Token (o alias) asociado a un medio de pago.
Solo se admiten los tokens asociados a una tarjeta bancaria.
Formato
paymentMethodType
Camino: transactions.paymentMethodType
Tipo de medio de pago.
Valores posibles
| Valor | DESCRIPCIÓN |
|---|---|
| CARD | Pago con tarjeta. |
| SDD | Domiciliación SEPA |
Formato
shopId
Identificador de la tienda.
Formato
transactions.status
Estado simplificado de la transacción. Es común a todos los medios de pago. Permite implementar un código genérico compatible con todos los medios de pago.
Cada medio de pago tiene también sus propios estados. Consulte la propiedad detailedStatus para obtener más detalles.
Valores posibles
Los valores posibles son:
| STATUS | DESCRIPCIÓN |
|---|---|
| PAID | La transacción ha sido pagada |
| UNPAID | La transacción no ha sido pagada |
| RUNNING | La transacción está en curso |
| PARTIALLY_PAID | La transacción ha sido parcialmente pagada |
Para obtener más información sobre el ciclo de vida de una transacción, consulte: Ciclo de vida de una transacción .
Formato
liabilityShift
Camino: transactions.transactionDetails.liabilityShift
Define si el pago está garantizado.
Valores posibles
Los valores posibles son:
| VALORES | DESCRIPCIÓN |
|---|---|
| YES | el pago está garantizado |
| NO | el pago no está garantizado |
| nulle | el pago no está garantizado |
Formato
mid
Camino: transactions.transactionDetails.mid
Número de contrato del vendedor. Si completa este campo, asegúrese de utilizar el contrato correcto según la red de la tarjeta.
Formato
effectiveAmount
Camino: transactions.transactionDetails.effectiveAmount
Monto original de la transacción en caso de conversión de moneda.
Formato
sequenceNumber
Camino: transactions.transactionDetails.sequenceNumber
Número de secuencia de la transacción.
Formato
effectiveCurrency
Camino: transactions.transactionDetails.effectiveCurrency
Moneda original de la transacción en caso de conversión de moneda.
Formato
creationContext
Camino: transactions.transactionDetails.creationContext
Especifica el proceso que ha iniciado la transacción.
Valores posibles
Los valores posibles son:
| VALORES | DESCRIPCIÓN |
|---|---|
| CHARGE | Para una solicitud de débito |
| REFUND | Para una solicitud de crédito |
Formato
parentTransactionUuid
Camino: transactions.transactionDetails.parentTransactionUuid
UUID de la transacción fuente.
Formato
paymentSource
Camino: transactions.transactionDetails.cardDetails.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 autenticación fuerte al momento del pago. |
| MOTO | Ingreso realizado por un operador. La información sobre el pago se envía por correo o correo electrónico. Requiere un contrato 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, 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”. |
manualValidation
Camino: transactions.transactionDetails.cardDetails.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 predeterminada de la tienda (definida en el |
expectedCaptureDate
Camino: transactions.transactionDetails.cardDetails.expectedCaptureDate
Fecha de captura expresada en formato ISO 8601, definida por W3C.
Formato
effectiveBrand
Camino: transactions.transactionDetails.cardDetails.effectiveBrand
Marca de la tarjeta.
| Medio de pago | Tipo de tarjeta (effectiveBrand) |
|---|---|
| Alkosto | ALKOSTO |
| American Express | AMEX |
| American Express Bansud | AMEX_BANSUD |
| American Express Galicia | AMEX_GALICIA |
| American Express HSBC | AMEX_HSBC |
| American Express Naranja | AMEX_NARANJA |
| American Express Patagonia | AMEX_PATAGONIA |
| American Express Santander | AMEX_SANTANDER |
| Baloto | BALOTO |
| Cabal | CABAL |
| Cabal Débito | CABAL_DEBIT |
| Carnet | CARNET |
| Cencosud | CENCOSUD |
| Codensa | CODENSA |
| Diners | DINERS |
| Discover | DISCOVER |
| Edenred | EDENRED_CO |
| Edenred Edenred Dotación | EDENRED_CO_DON |
| Edenred Auto | EDENRED_CO_GAS |
| Edenred Regalo | EDENRED_CO_GIFT |
| Edenred Alimentacio | EDENRED_CO_TR |
| Efecty Pago en efectivo | EFECTY |
| Elo | ELO |
| Éxito | EXITO |
| Éxito Cash | EXITO_CASH |
| Paiement par Wallet Google Pay | GOOGLEPAY |
| Hiper | HIPER |
| Hipercard | HIPERCARD |
| JCB | JCB |
| Maestro | MAESTRO |
| Mastercard | MASTERCARD |
| Mastercard débito | MASTERCARD_DEBIT |
| MasterPass | MASTERPASS |
| Mastercard BBVA | MC_BBVA |
| Mastercard Cencosud | MC_CENCOSUD |
| Mastercard CityBank | MC_CITYBANK |
| Mastercard Columbia | MC_COLUMBIA |
| Mastercard Comafi | MC_COMAFI |
| Mastercard Cordobesa | MC_CORDOBESA |
| Mastercard Falabella | MC_FALABELLA |
| Mastercard Galicia | MC_GALICIA |
| Mastercard HSBC | MC_HSBC |
| Mastercard ICBC | MC_ICBC |
| Mastercard Itau | MC_ITAU |
| Mastercard Macro | MC_MACRO |
| Mastercard Nación | MC_NACION |
| Mastercard Patagonia | MC_PATAGONIA |
| Mastercard Santander | MC_SANTANDER |
| Movil Red | MOVIL_RED |
| Naranja | NARANJA |
| Nequi | NEQUI |
| Oh | OH |
| PayPal | PAYPAL |
| PayPal - Mode sandbox | PAYPAL_SB |
| Billetera electrónica PIM | PIM |
| PSE | PSE |
| Red Aval | RED_AVAL |
| Ripley | RIPLEY |
| Sorocred | SOROCRED |
| Visa | VISA |
| Visa BBVA | VISA_BBVA |
| Visa Chaco | VISA_CHACO |
| Visa Ciudad | VISA_CIUDAD |
| Visa Columbia | VISA_COLUMBIA |
| Visa Comafi | VISA_COMAFI |
| Visa Cordobesa | VISA_CORDOBESA |
| Visa Corrientes | VISA_CORRIENTES |
| Visa Credicoop | VISA_CREDICOOP |
| Visa débito | VISA_DEBIT |
| Visa Electron | VISA_ELECTRON |
| Visa Formosa | VISA_FORMOSA |
| Visa Galicia | VISA_GALICIA |
| Visa Hipotecario | VISA_HIPOTECARIO |
| Visa HSBC | VISA_HSBC |
| Visa ICBC | VISA_ICBC |
| Visa Industrial | VISA_INDUSTRIAL |
| Visa Itau | VISA_ITAU |
| Visa Macro | VISA_MACRO |
| Visa Nación | VISA_NACION |
| Visa Neuquen | VISA_NEUQUEN |
| Visa Patagonia | VISA_PATAGONIA |
| Visa Provincia | VISA_PROVINCIA |
| Visa Santander | VISA_SANTANDER |
Formato
pan
Camino: transactions.transactionDetails.cardDetails.pan
Número de tarjeta truncado.
Formato
expiryMonth
Camino: transactions.transactionDetails.cardDetails.expiryMonth
Mes de vencimiento.
Formato
expiryYear
Camino: transactions.transactionDetails.cardDetails.expiryYear
Año de vencimiento.
Formato
country
Camino: transactions.transactionDetails.cardDetails.country
Código de país de la tarjeta.
Formato
issuerCode
Camino: transactions.transactionDetails.cardDetails.issuerCode
Código bancario asociado al banco emisor.
Formato
issuerName
Camino: transactions.transactionDetails.cardDetails.issuerName
Nombre del banco asociado al banco emisor
Formato
effectiveProductCode
Camino: transactions.transactionDetails.cardDetails.effectiveProductCode
Código de producto de la tarjeta utilizada para el pago.
Formato
paymentMethodSource
Camino: transactions.transactionDetails.cardDetails.paymentMethodSource
Permite caracterizar el modo de medio de pago utilizado.
Valores posibles
Los valores posibles son:
| STATUS | DESCRIPCIÓN |
|---|---|
| NEW | Transacción creada a partir de un nuevo medio de pago. |
| TOKEN | Transacción creada a partir de un medio de pago existente. |
Formato
legacyTransId
Camino: transactions.transactionDetails.cardDetails.legacyTransId
Identificador de la transacción en 6 caracteres.
Formato
cardHolderName
Camino: transactions.transactionDetails.cardDetails.cardHolderName
Nombre completo del titular de la tarjeta.
Formato
identityDocumentType
Camino: transactions.transactionDetails.cardDetails.identityDocumentType
Tipo de documento de identidad.
Valores posibles:
| Tipo | DESCRIPCIÓN |
|---|---|
| DNI | Documento Nacional de Identidad |
| CC | Cédula de ciudadania |
| TI | Tarjeta de Identidad |
| CE | Cédula de Extranjeria |
| NI | Número de Identificación Tributaria |
| PS | Pasaporte |
Formato
identityDocumentNumber
Camino: transactions.transactionDetails.cardDetails.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 Latinoamérica, este parámetro puede ser obligatorio para algunos adquirientes.
Formato
legacyTransDate
Camino: transactions.transactionDetails.cardDetails.legacyTransDate
Fecha y hora de recepción de la solicitud de pago. Utilizada para encontrar las transacciones cuyo ID está en un formato anterior.
Formato
amount
Camino: transactions.transactionDetails.cardDetails.authorizationResponse.amount
Monto de la autorización.
Formato
currency
Camino: transactions.transactionDetails.cardDetails.authorizationResponse.currency
Código de la moneda utilizada en la solicitud de autorización.
Formato
authorizationDate
Camino: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationDate
Fecha y hora de la solicitud de autorización.
Formato
authorizationNumber
Camino: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationNumber
Número de la solicitud de autorización.
Formato
authorizationResult
Camino: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationResult
Código de retorno de la solicitud de autorización.
Consulte Lista de códigos de retorno de autorización para más detalles.
Formato
authorizationMode
Camino: transactions.transactionDetails.cardDetails.authorizationResponse.authorizationMode
Especifica cómo realizar la solicitud de autorización.
Valores posibles
| valores | DESCRIPCIÓN |
|---|---|
| MARK | Se realizó una preautorización de un monto nulo o unitario. Véase más adelante. |
| FULL | Autorización por el monto total indicado en la solicitud. |
Lorsque authorizationMode vaut MARK : Une autorisation de 1 USD a été réalisée afin de vérifier la validité de la carte Este caso se presenta cuando la fecha de depósito supera el periodo de validez de una autorización (7 días para VISA / MasterCard / CB / AMEX en Francia por ejemplo)
Formato
amount
Camino: transactions.transactionDetails.cardDetails.markAuthorizationResponse.amount
Monto de la preautorización.
Formato
currency
Camino: transactions.transactionDetails.cardDetails.markAuthorizationResponse.currency
Código de la moneda utilizada en la solicitud de preautorización.
Formato
authorizationDate
Camino: transactions.transactionDetails.cardDetails.markAuthorizationResponse.authorizationDate
Fecha y hora de la solicitud de preautorización.
Formato
authorizationNumber
Camino: transactions.transactionDetails.cardDetails.markAuthorizationResponse.authorizationNumber
Número de la solicitud de preautorización.
Formato
authorizationResult
Camino: transactions.transactionDetails.cardDetails.markAuthorizationResponse.authorizationResult
Código de retorno de la solicitud de preautorización.
Formato
captureDate
Camino: transactions.transactionDetails.cardDetails.captureResponse.captureDate
Fecha y hora de captura.
Formato
captureFileNumber
Camino: transactions.transactionDetails.cardDetails.captureResponse.captureFileNumber
Número de captura.
Formato
refundAmount
Camino: transactions.transactionDetails.cardDetails.captureResponse.refundAmount
Monto reembolsado.
Formato
refundCurrency
Camino: transactions.transactionDetails.cardDetails.captureResponse.refundCurrency
Moneda del monto reembolsado.
Formato
effectiveRefundAmount
Camino: transactions.transactionDetails.cardDetails.captureResponse.effectiveRefundAmount
Formato
effectiveRefundCurrency
Camino: transactions.transactionDetails.cardDetails.captureResponse.effectiveRefundCurrency
Formato
transactionCondition
Camino: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.transactionCondition
Estado de la autenticación 3D Secure.
Valores posibles
Estado de la autenticación del titular.
| VALOR | DESCRIPCIÓN |
|---|---|
| COND_3D_SUCCESS | Autenticación exitosa. El vendedor y el titular de la tarjeta están inscritos en el programa 3D Secure y el titular se ha autenticado correctamente. |
| COND_3D_FAILURE | Fallo de la autenticación. El vendedor y el titular de la tarjeta están inscritos en el programa 3D Secure pero el comprador no ha logrado autenticarse (contraseña incorrecta). |
| COND_3D_ERROR | Error de autenticación. El vendedor está inscrito en el programa 3D Secure pero se produjo un error técnico en el servidor de la plataforma de pago durante el proceso de autenticación (durante la comprobación de la inscripción de la tarjeta en el programa 3D o durante la autenticación del titular). |
| COND_3D_NOTENROLLED | Titular no inscrito. El vendedor participa en el programa 3D Secure pero la tarjeta del titular no está registrada. |
| COND_3D_ATTEMPT | Intento de autenticación. El vendedor y el titular de la tarjeta están inscritos en el programa 3D Secure pero el comprador no se ha autenticado (el servidor de control de acceso del banco que emisor de la tarjeta solo permite generar una prueba de intento de autenticación). |
| COND_SSL | 3D Secure no aplicable. El vendedor no está inscrito en 3D Secure o el canal de venta no está cubierto por esta garantía. |
Formato
enrolled
Camino: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.enrolled
Estado de inscripción del titular.
Valores posibles
Los valores posibles son:
| VALOR | DESCRIPCIÓN |
|---|---|
| YES | Titular inscrito, autenticación 3DS posible. Nota: En el Back Office, aparece el valor ENROLLED (pestaña 3D Secure de Detalles de una transacción). |
| NO | Titular no inscrito. Nota: En el Back Office, aparece el valor NOT_ENROLLED (pestaña 3D Secure de Detalles de una transacción). |
| UNKNOWN | No se puede verificar el estado de la inscripción. Nota: En el Back Office, aparece el valor UNAVAILABLE (pestaña 3D Secure de Detalles de una transacción). |
Formato
status
Camino: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.status
Estado de la autenticación del titular.
Valores posibles
Estado de la autenticación del titular.
| VALOR | DESCRIPCIÓN |
|---|---|
| YES | Autenticación exitosa. Nota: En el Back Office, aparece el valor SUCCESS (pestaña 3D Secure de Detalles de una transacción). |
| NO | Error de autenticación. Nota: En el Back Office, aparece el valor FAILED (pestaña 3D Secure de Detalles de una transacción). |
| UNKNOWN | Autenticación imposible. Nota: En el Back Office, aparece el valor UNAVAILABLE (pestaña 3D Secure de Detalles de una transacción). |
| ATTEMPT | Intento de autenticación. Nota: En el Back Office, aparece el valor ATTEMPT (pestaña 3D Secure de Detalles de una transacción). |
Formato
eci
Camino: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.eci
Indicador de comercio electrónico
Valores posibles
El valor depende del estado de autenticación 3DS y del tipo de tarjeta. Los valores posibles son:
| TIPO DE TARJETA | STATUS=Y | STATUS=A | STATUS=U | STATUS=N |
|---|---|---|---|---|
| VISA - AMEX | 5 | 6 | 7 | - |
| MasterCard | 02 | 01 | - | - |
Formato
xid
Camino: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.xid
Identificador único de la transacción.
Formato
cavvAlgorithm
Camino: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.cavvAlgorithm
Algoritmo de verificación de la autenticación del titular.
Valores posibles
Los valores posibles son:
| VALOR | DESCRIPCIÓN |
|---|---|
| HMAC | HMAC |
| CVV | Card Verification Value |
| CVV_ATN | CVV Authentication Tracking Number |
| SPA | MasterCard SPA Algorithm. |
| A | AV-CB |
Formato
cavv
Camino: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.cavv
Cardholder Authentication Verification Value.
Formato
signValid
Camino: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.signValid
Validez de la firma del mensaje PaRes.
Valores posibles
Estado de la autenticación del titular.
| VALOR | DESCRIPCIÓN |
|---|---|
| nulle | Sin 3DS. |
| 0 | firma incorrecta. |
| 1 | firma correcta. |
Formato
brand
Camino: transactions.transactionDetails.cardDetails.threeDSResponse.authenticationResultData.brand
Marca de la tarjeta.
Formato
id
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.id
Identificador único de autenticación, en formato UUID.
Formato
operationSessionId
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.operationSessionId
Identificador único de autenticación, en formato UUID.
Formato
instructionType
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.instructionType
Tipo de instrucción a realizar.
Formato
Valores posibles
| valores | DESCRIPCIÓN |
|---|---|
| FORM | Instrucciones de tipo redireccionamiento para formularios. |
name
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.name
Nombre de la instrucción.
Valores posibles
| Valor | DESCRIPCIÓN |
|---|---|
| CHALLENGE | Instrucción Challenge, que permite la autenticación interactiva del usuario con el ACS. |
| FINGERPRINT | Instrucción Fingerprint, que permite la autenticación interactiva del usuario con el ACS. |
Formato
_type
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value._type
Tipo de respuesta recibida. La interpretación del resto de la respuesta depende de este atributo.
Valores posibles
| Valor | DESCRIPCIÓN |
|---|---|
| AuthenticationInstruction | Respuesta de tipo Instrucción |
| AuthenticationResult | Respuesta de tipo Resultado final |
Formato
timeout
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.timeout
Tiempo máximo de espera de la respuesta al ejecutar una instrucción, expresada en segundos. Pasado este plazo, conviene forzar el retorno al servidor de la plataforma de pago para obtener el resultado final.
Formato
method
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.method
Método (verbo) utilizado para la solicitud.
Valores posibles
| Valor | DESCRIPCIÓN |
|---|---|
| DELETE | Método Delete |
| GET | Método Get |
| PATCH | Método Patch |
| POST | Método Post |
| PUT | Método Put |
Formato
url
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.url
URL para el envío del formulario http.
Formato
body
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.body
Lista de parámetros del cuerpo de la solicitud, bajo la forma "nombre": "valor".
Formato
headers
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.http.headers
Lista de encabezados de la solicitud http, bajo la forma "nombre": "valor".
Formato
element
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.element
Tipo de elemento destino html en el que se materializará la instrucción.
Valores posibles
| Valor | DESCRIPCIÓN |
|---|---|
| IFRAME | iFrame |
Formato
height
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.height
Altura del objetivo html en píxeles.
Formato
visible
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.visible
Booleano que indica si la página de destino html debe ser visible o no.
Formato
width
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.width
Altura de la página de destino html en píxeles.
Formato
showUrl
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.target.showUrl
Campo técnico para uso interno, que permite mostrar u ocultar la URL del ACS.
Formato
challengePreference
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.challengePreference
Indica si el vendedor solicita un challenge o no.
Valores posibles
| valores | DESCRIPCIÓN |
|---|---|
| NO_PREFERENCE | Ninguna preferencia particular |
| NO_CHALLENGE_REQUESTED | El challenge no se pregunta explícitamente. |
| CHALLENGE_REQUESTED | El challenge es solicitado por el vendedor. |
Formato
name
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.name
Nombre del protocolo de autenticación del titular de la tarjeta.
Valores posibles
| Valor | DESCRIPCIÓN |
|---|---|
| THREEDS | Protocolo 3D Secure |
| PROCESOS_DINERS | Protocolo Procesos Diners OTP |
| OSB | Protocolo OTP OSB |
Formato
simulation
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.simulation
Booleano que indica si la autenticación debe realizarse en modo de simulación. El modo de simulación permite una integración comercial sin estar en modo de producción ni utilizar tarjetas reales.
Formato
network
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.network
Red en la que se autentificó el medio de pago.
Versiones actualmente compatibles
| Valor |
|---|
| CB |
| VISA |
| MASTERCARD |
| AMEX_SAFEKEY |
| ELO |
| PROCESOS_DINERS |
| DINERS |
| DISCOVER |
| OSB |
Formato
version
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.protocol.version
Versión del protocolo de autenticación del titular de la tarjeta.
Versiones actualmente compatibles
| Valor | DESCRIPCIÓN |
|---|---|
| 1.0.2 | Versión 1.0.2 |
| 2.1.0 | Versión 2.1.0 |
Formato
authenticationType
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationType
El tipo de autenticación que tuvo lugar.
Valores posibles
| Valor | DESCRIPCIÓN |
|---|---|
| FRICTIONLESS | Autenticación en modo Frictionless, es decir, de forma transparente para el cliente |
| CHALLENGE | Autenticación con Challenge, el cliente tuvo que autenticarse explícitamente con el ACS |
Formato
commerceIndicator
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.commerceIndicator
Indicador del comercio, llamado ECI (Electronic Commerce Indicator) para el protocolo 3DS. Indicador devuelto por el ACS para informar los resultados del intento de autenticació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
status
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.status
El estado de autenticación, es decir, el resultado positivo/negativo de la autenticación.
Valores posibles
| Valor | DESCRIPCIÓN |
|---|---|
| ATTEMPT | Prueba de intento de autenticación cuando la autenticación no está disponible |
| ENROLLED_UNAVAILABLE | No se puede obtener el estado de inscripción |
| FAILED | Autenticación fallida |
| NOT_ENROLLED | Tarjeta no inscrita |
| SUCCESS | Autenticación exitosa |
| UNAVAILABLE | No se pudo completar la autenticación (error técnico, etc.) |
| DISABLED | Activación de la autenticación solicitada |
| REJECTED | Autenticación rechazada por el ACS |
Formato
authenticationIdType
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationId.authenticationIdType
El tipo de autenticación que tuvo lugar.
Valores posibles
| Valor | DESCRIPCIÓN |
|---|---|
| xid | El campo proviene del campo xid del protocolo 3DS V1. |
| dsTransId | El campo proviene del campo xid del protocolo 3DS V2. |
Formato
value
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationId.value
Valor del identificador de la transacción de autenticación conocida por la red bancaria.
La longitud del campo varía según el protocolo de autenticación.
| Protocolo | Formato / Longitud | valor Ejemplo: |
|---|---|---|
| 3DS v1 (xid) | chaine / 28 caractères alphanumériques | f8e120f1fe934db8b8e58ba4c423db48 |
| 3DS v2 (dsTransId) | chaine / 32 caractères alphanumériques + 4 tirets | 4317fdc3-ad24-5443-8000-000000000891 |
Formato
authenticationValueType
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationValue.authenticationValueType
Tipo del valor de autenticación.
Valores posibles
| Valor | DESCRIPCIÓN |
|---|---|
| AEVV | American Express Verification Value (utilizado por Amex) |
| CAVV | Cardholder Authentication Verification Value (utilizado por VISA) |
| AAV | Accountholder Authentication Value (utilizado por Mastercard) |
Formato
value
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.authenticationValue.value
Valor de autenticació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
code
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.reason.code
Código adicional que proporciona información sobre el origen del resultado. Ejemplo: DS_TIMEOUT
Formato
message
Camino: transactions.transactionDetails.cardDetails.authenticationResponse.value.reason.message
Mensaje adicional que proporciona información sobre el origen del resultado.
Formato
installmentNumber
Camino: transactions.transactionDetails.cardDetails.installmentNumber
Número de cuotas.
Formato
installmentCode
Camino: transactions.transactionDetails.cardDetails.installmentCode
Código de la opción de pago utilizada para el pago.
Formato
subscriptionId
Camino: transactions.transactionDetails.subscriptionDetails.subscriptionId
Identificador de la recurrencia.
Formato
name
Camino: transactions.transactionDetails.fraudManagement.riskControl.name
Nombre del control aplicado en el marco de la gestión de riesgos.
Valores posibles
Los valores posibles son:
| VALOR | DESCRIPCIÓN |
|---|---|
| CARD_FRAUD | Controla la presencia del número de la tarjeta del comprador en la lista gris de tarjetas. |
| SUSPECT_COUNTRY | Controla la presencia del país emisor de la tarjeta del comprador en la lista de países prohibidos. |
| IP_FRAUD | Controla la presencia de la dirección IP del comprador en la lista gris de direcciones IP. |
| CREDIT_LIMIT | Controla la frecuencia y los montos de compra de un mismo número de tarjeta, o el monto máximo de un pedido. |
| BIN_FRAUD | Controla la presencia del código BIN de la tarjeta del comprador en la lista gris de códigos BIN. |
| ECB | Controla si la tarjeta del comprador es de tipo e-carte bleue. |
| COMMERCIAL_CARD | Controla si la tarjeta del comprador es una tarjeta comercial. |
| SYSTEMATIC_AUTO | Controla si la tarjeta del comprador es una tarjeta con autorización sistemática. |
| INCONSISTENT_COUNTRIES | Controla si el país de la dirección IP, el país emisor de la tarjeta de pago y el país de la dirección del comprador se corresponden. |
| NON_WARRANTY_PAYMENT | Controla la transferencia de responsabilidad de la transacción. |
| SUSPECT_IP_COUNTRY | Controla la presencia del país del comprador, identificado mediante su dirección IP, en de la lista de países prohibidos. |
Formato
result
Camino: transactions.transactionDetails.fraudManagement.riskControl.result
Nombre del control aplicado en el marco de la gestión de riesgos.
Valores posibles
Resultado del control de riesgo.
| VALOR | DESCRIPCIÓN |
|---|---|
| OK | OK |
| WARNING | Control informativo no exitoso |
| ERROR | Control de bloqueo no exitoso. |
Formato
score
Camino: transactions.transactionDetails.fraudManagement.riskAnalysis.score
Identificador del análisis para el analizador de riesgo.
Formato
resultCode
Camino: transactions.transactionDetails.fraudManagement.riskAnalysis.resultCode
Código de retorno de un analizador de riesgo externo.
Valores posibles
Los valores posibles son:
| STATUS | DESCRIPCIÓN |
|---|---|
| INVALID_CREDENCIAL | Problema de configuración del contrato de análisis de riesgos. |
| COMUNICATION_PROBLEM | No es posible comunicarse con el analizador de riesgos. |
| DATA_PROCESSING_PROBLEM | Problema al procesar el envío o la respuesta de análisis de riesgos. |
| MISSING_MANDATORY_ORDER_INFO | Faltan los datos del pedido. |
| MISSING_MANDATORY_SHIPPING_INFO | Faltan los datos de entrega. |
| MISSING_MANDATORY_SHIPPING_ADDRESS_INFO | Faltan datos sobre la dirección de entrega. |
| MISSING_MANDATORY_BILLING_INFO | Faltan datos de facturación. |
| MISSING_MANDATORY_BILLING_ADDRESS_INFO | Faltan datos sobre la dirección de facturación |
| MISSING_MANDATORY_CARD_INFO | Faltan datos sobre los medios de pago. |
| MISSING_MANDATORY_CUSTOMER_INFO | Faltan datos sobre el comprador. |
| APA | Específico de ClearSale. La transacción ha sido aprobada automáticamente de acuerdo a la configuración definida. |
| APM | Específico de ClearSale. La transacción ha sido aprobada manualmente por un analista. |
| RPM | Específico de ClearSale. El pedido ha sido rechazado por falta de información sobre el comprador, en virtud de la política aplicada. |
| AMA | Específico de ClearSale. En espera de análisis manual. El pedido está fila de espera para su análisis. |
| ERR | Específico de ClearSale. Error. |
| NVO | Específico de ClearSale. Nuevo pedido. En espera de procesamiento y clasificación. |
| SUS | Específico de ClearSale. Pedido suspendido manualmente. El pedido se suspende por sospecha de fraude. |
| CAN | Específico de ClearSale. Pedido cancelado. La transacción ha sido cancelada por el comprador. |
| FRD | Específico de ClearSale. Fraude confirmado con el operador de la tarjeta de crédito o del titular de la tarjeta. |
| RPA | Específico de ClearSale. Pedido rechazado automáticamente. El pedido ha sido rechazado en aplicación de los parámetros del analizador de fraude externo. |
| RPP | Específico de ClearSale. Pedido rechazado automáticamente. El pedido ha sido rechazado en virtud de la política del cliente o de ClearSale. |
| 100 | Específico de CyberSource. La transacción se ha realizado correctamente. |
| 101 | Específico de CyberSource. Transacción rechazada. Faltan uno o más campos. |
| 102 | Específico de CyberSource. Transacción rechazada. Uno o más campos contienen datos no válidos. |
| 150 | Específico de CyberSource. Error. |
| 151 | Específico de CyberSource. Error. Se ha recibido la solicitud pero se excedió el plazo. Este error no incluye la expiración de plazos entre el cliente y el servidor. |
| 152 | Específico de CyberSource. Error. Se ha recibido la solicitud pero un servicio no terminó a tiempo. |
| 202 | Específico de CyberSource. Transacción rechazada. Tarjeta expirada. |
| 231 | Específico de CyberSource. Transacción rechazada. Número de cuenta no válido. |
| 234 | Específico de CyberSource. Transacción rechazada. Se produjo un problema con la configuración de CyberSource del vendedor. |
| 400 | Específico de CyberSource. Transacción rechazada. La puntuación del fraude supera el umbral de tolerancia. |
| 480 | Específico de CyberSource. El pedido se ha señalado para su análisis por el Decision Manager. |
| 481 | Específico de CyberSource. El pedido ha sido rechazado por el Decision Manager. |
| APPROVE | Específico de Konduto. Konduto recomienda aceptar la transacción. Si ninguna regla no contradice esta recomendación, el estado de la transacción será AUTHORISED (autorizada). |
| DECLINE | Específico de Konduto. Konduto recomienda rechazar la transacción. El estado de la transacción será REFUSED (rechazada). |
| REVIEW | Específico de Konduto. Konduto recomienda verificar la transacción. En función del resultado de la autenticación 3D Secure, el estado de la transacción será: |
| AUTHORISED_TO_VALIDATE | En caso de autenticación exitosa del titular. |
| REFUSED | En caso de fallo de autenticación del titular. |
Formato
status
Camino: transactions.transactionDetails.fraudManagement.riskAnalysis.status
Código de retorno de un analizador de riesgo externo.
Estado del análisis de riesgo.
Valores posibles
Los valores posibles son:
| VALOR | DESCRIPCIÓN |
|---|---|
| P_SEND_OK | Éxito. “Sent to clearsale and successfully processed”. |
| P_TO_SEND | El envío se programa. "Transaction analysis is scheduled to be sent to risk analyzer". |
| P_TO_SEND_KO | Error de procesamiento. “Problem when tried to send to risk analyzer”. |
| P_PENDING_AT_ANALYZER | Tratamiento en curso por el analizador de riesgo. “Analysis result is still being processed by the risk analyzer. We should keep checking/waiting for the analysis result”. |
| P_MANUAL | En espera de envío manual. "Analysis should be requested through user request (not automatically)" |
| P_SKIPPED | Descartada. “Analysis request discarded by current transaction status/problem”. |
| P_SEND_EXPIRED | Expirada.* “Analysis request expired”. |
Formato
requestId
Camino: transactions.transactionDetails.fraudManagement.riskAnalysis.requestId
Identificador del análisis para el analizador de riesgo.
Formato
extraInfo
Camino: transactions.transactionDetails.fraudManagement.riskAnalysis.extraInfo
Específico de CyberSource. Códigos de retorno del DecisionManager.
Formato
fingerPrintId
Camino: transactions.transactionDetails.fraudManagement.riskAnalysis.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
results
Camino: transactions.transactionDetails.fraudManagement.riskAssessments.results
Lista de acciones realizadas en la transacción, tras la aplicación de las reglas de gestión de riesgo avanzadas activadas en el Back Office.
Valores posibles
Los valores posibles son:
| VALOR | DESCRIPCIÓN |
|---|---|
| ENABLE_3DS | 3D Secure habilitado. |
| DISABLE_3DS | 3D Secure deshabilitado. |
| MANUAL_VALIDATION | Transacción creada con validación manual. La captura del pago se bloquea temporalmente para permitir que el vendedor realice todas las verificaciones deseadas. |
| REFUSE | Transacción rechazada. |
| RUN_RISK_ANALYSIS | Llamada a un analizador de riesgos externo siempre que el vendedor tenga un contrato. Consultar la descripción del objeto TransactionDetails. FraudManagement. RiskAnalysis para identificar la lista de errores posibles y su descripción. |
| INFORM | Alerta transmitida. Se advierte al vendedor que se ha identificado un riesgo. El vendedor es informado mediante una o más de las reglas del centro de notificaciones (URL de notificación, correo electrónico o SMS). |
Formato
taxRate
Camino: transactions.transactionDetails.taxRate
Usado por ciertos medios de pago en Latinoamérica. Permite transmitir el tipo de impuesto aplicado a todo el pedido. El valor debe ser el porcentaje a aplicar (21 para el 21%)
Formato
taxAmount
Camino: transactions.transactionDetails.taxAmount
Importe de los impuestos de todo el orden expresado en su unidad monetaria más pequeña (el céntimo para el peso colombiano).
Ejemplo: 30050 por 300.50 COP.
Formato
preTaxAmount
Camino: transactions.transactionDetails.preTaxAmount
Permite definir el monto sin impuestos de todo el pedido.
El valor debe expresarse en la unidad monetaria más pequeña de la moneda.
Formato
externalTransactionId
Camino: transactions.transactionDetails.externalTransactionId
Referencia externa de la transacción.
Formato
dccAmount
Camino: transactions.transactionDetails.dcc.dccAmount
Monto de la transacción expresado en la unidad más pequeña de la moneda elegida por dccCurrency (el centavo para el euro).
Este campo solo se valora si la tarjeta es elegible para el servicio de conversión dinámica de moneda (DCC) y el comprador ha elegido pagar en la moneda de su tarjeta.
La tasa de conversión se devuelve en el campo dccChangeRate .
Formato
dccCurrency
Camino: transactions.transactionDetails.dcc.dccCurrency
Código numérico según la norma ISO 4217 de la moneda elegida por el comprador cuando la tarjeta es admisible para el servicio de conversión dinámica de moneda (DCC).
Este campo solo se valora si la tarjeta es elegible para el servicio de conversión dinámica de moneda (DCC) y el comprador ha elegido pagar en la moneda de su tarjeta.
La tasa de conversión se devuelve en el campo dccChangeRate .
Formato
dccChangeRate
Camino: transactions.transactionDetails.dcc.dccChangeRate
Tasa de cambio utilizada para calcular el monto real del pago.
Formato
dccMarkup
Camino: transactions.transactionDetails.dcc.dccMarkup
Indica el porcentaje (o tasa) de margen comercial sobre el importe total.
Este campo solo se valora si la tarjeta es elegible para el servicio de conversión dinámica de moneda (DCC) y el comprador ha elegido pagar en la moneda de su tarjeta.
Ejemplo: "3.5" para una tasa de margen de 3.5%.
Formato
dccRateDate
Camino: transactions.transactionDetails.dcc.dccRateDate
Fecha y hora UTC de la obtención de la tasa de conversión ante el servicio de conversión dinámica de moneda (DCC).
Este campo solo se valora si la tarjeta es elegible para el servicio de conversión dinámica de moneda (DCC) y el comprador ha elegido pagar en la moneda de su tarjeta.
La tasa de conversión se devuelve en el campo dccChangeRate .
Formato
paymentReference
Camino: transactions.transactionDetails.acquirerDetails.paymentReference
Referencia de pago que se muestra en el cupón de pago.
Se utiliza en particular para el miedo de pago Multibanco.
Formato
serviceSupplier
Camino: transactions.transactionDetails.acquirerDetails.serviceSupplier
Identificador de la identidad para la cual se realiza el pago.
Se utiliza en particular para el miedo de pago Multibanco.
Formato
nsu
Camino: transactions.transactionDetails.nsu
Número de secuencia único (Latinoamérica).
Formato
tid
Camino: transactions.transactionDetails.tid
Terminal ID Identificación del punto de venta definido en el contrato de aceptación.
Este campo solo se utiliza en Colombia para elegir entre REDEBAN y CREDIBANCO.
Formato
acquirerNetwork
Camino: transactions.transactionDetails.acquirerNetwork
Código de la red del adquiriente.
Valores posibles:
| Código Red | Descripción |
|---|---|
| AMEXGLOBAL | American Express International |
| AVAL | Aval |
| CREDIBANCO | Credibanco |
| EFECTY | Efecty |
| EVO | Evo |
| FIRSTDATA_IPG | First Data IPG |
| GOOGLEPAY | Google Pay |
| LINK | Link |
| MASTERPASS | MasterPass |
| NEQUI | Nequi |
| PAYPAL | PayPal |
| PAYPAL_SB | PayPal - Modo sandbox |
| PIM | PIM |
| PRISMA | Prisma |
| PROCESOS | Procesos API Redirect |
| PROCESOS_ISO | Procesos API ISO FIS |
| PROCESOS_WS | Procesos API WS |
| PSE | PSE |
| REDEBAN | Redeban |
| VISANET | Visanet |
| WEBPAY | Web Pay |
| WEBPAY_COMPLETA | Web Pay Completa |
Formato
taxRefundAmount
Camino: transactions.transactionDetails.taxRefundAmount
Utilizado en Uruguay, este campo corresponde al importe del crédito de impuesto acordado al vendedor para la transacción. La valeur est exprimée dans la plus petite unité monétaire (le centime pour le peso colombien)
Ejemplo: 30050 por 300.50 COP.
Formato
occurrenceType
Camino: transactions.transactionDetails.occurrenceType
Permite identificar si la transacción es parte de una serie de pagos (suscripción o pago en N cuotas).
Es útil para identificar con precisión el primer pago de una serie.
Con la aplicación de Soft Decline, la plataforma de pago realiza automáticamente un nuevo intento de pago con autenticación 3D Secure cuando sea posible. Esto cambiará el número de secuencia del pago. El campo sequenceNumber ya no facilita la identificación del primer pago de una serie.
Valores posibles
| Valor | DESCRIPCIÓN |
|---|---|
| RECURRENT_INITIAL | Primer pago de una serie. |
| RECURRENT_INTERMEDIAIRE | Enésimo pago de una serie. |
| RECURRENT_FINAL | Último pago de una serie. |
| UNITAIRE | Pago unitario (pago en efectivo). |
Formato
serverDate
Fecha de generación de la respuesta. Se utiliza para medir la posible brecha entre los servidores del vendedor y el servicio de pago.