support
Volver a la documentación
Buscar
Categoria
Tags
parámetros principalesdesplegar todo
amount
requerido
currency
requerido
orderId
recomendado
formAction
paymentMethods
[1]
excludedPaymentMethods
[1]
información sobre tu cliente
customer
reference
recomendado
email
recomendado
billingDetails
title
category
firstName
lastName
phoneNumber
streetNumber
address
district
zipCode
city
state
country
language
cellPhoneNumber
identityCode
identityType
legalName
shippingDetails
category
firstName
lastName
phoneNumber
streetNumber
address
address2
district
zipCode
city
state
country
deliveryCompanyName
shippingSpeed
shippingMethod
legalName
identityCode
shoppingCart
insuranceAmount
shippingAmount
taxAmount
cartItemInfo
[1]
productLabel
productType
productRef
productQty
productAmount
productVat
opciones generales de la transacción
acquirerTransientData
[1]
:
contrib
ipnTargetUrl
fingerPrintId
metadata
[1]
:
overridePaymentCinematic
paymentMethodToken
strongAuthentication
taxAmount
taxRate
useCase
formTokenVersion
opciones relacionadas con la tarjeta
transactionOptions
cardOptions
paymentSource
mid
manualValidation
captureDelay
firstInstallmentDelay
installmentNumber
retry
debitCreditSelector
initiatedTransactionIndicator
restrictedInstallments
[1]
initialIssuerTransactionIdentifier
installmentOptions
[1]
[1]
Información sobre el sub-vendedor
subMerchantDetails
companyType
legalNumber
name
requerido
url
phoneNumber
address1
address2
zip
city
country
mcc
mid
softDescriptor
state
facilitatorId
Pruébame
Documentación

Web Service Charge/CreatePayment

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

POSThttps://api.lyra.com/api-payment/V4/Charge/CreatePayment

Casos de uso


Casos de uso VALOR Enlace
Creación de una transacción simple Complete el campoformActionaPAYMENT. Inicio rápido
Crear un alias con un pago Complete el campoformActionaREGISTER_PAY. Creación de un token con pago
Pago con propuesta al titular para crear un token. Complete el campoformActionaASK_REGISTER_PAY. Creación de un token con pago
Pago en 0 clics Complete el campoformActionaSILENTy el campopaymentMethodTokencon el alias. Pago en 0 clics
Pago con 1 clic Complete el campoformActionaPAYMENTy el campopaymentMethodTokencon el alias. Pago en 1 clic
Pago con Wallet (billetera electrónica) Complete el campoformActionaCUSTOMER_WALLETy el campocustomer.reference. Gestión de los wallets de comprador
Crear una transacción inicial para pago contra reembolso Complete el campouseCaseaSHIPMENT_MULTIPLE_AUTHORISATION. Realizar un pago al envío

Parámetros de entrada

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

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

contrib

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

Formato

currency

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

Ejemplo: "EUR" para el euro.

Formato

Valores posibles

. Los valores posibles son:

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

ipnTargetUrl

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

Formato

orderId

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

Formato

metadata

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

Ejemplo de llamada

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

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

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

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

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

Formato

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

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.
ASK_REGISTER_PAY Añade una casilla de verificación al formulario para la creación de un token. No permite crear un token asociado a un IBAN.
SILENT Transacción iniciada por el vendedor sin la presencia del comprador. Realiza un pago por token sin pasar por el formulario incrustado.
CUSTOMER_WALLET Añade una casilla de verificación al formulario para asociar la tarjeta al wallet. El campo customer.reference es obligatorio para este caso de uso Consulte el capítulo la guía de integración para obtener más información.
null Si el valor es nulo o no definido, se aplica PAYMENT.

PAYMENT

Le Web Service retourne un formToken.

C'est le comportement par défaut. L'appel à Charge/CreatePayment crée une transaction sans effectuer d'opération supplémentaire.

REGISTER_PAY

Le Web Service retourne un formToken.

Un alias (ou token) du moyen de paiement est créé en même temps que la transaction. Cet alias vous permet ensuite de créer des transactions en un clic. L'alias nouvellement créé est renseigné dans la propriété paymentMethodToken. Plus d'informations, voir : Création et utilisation d'alias.

ASK_REGISTER_PAY

Le Web Service retourne un formToken.

Ce paramètre permet d'ajouter dans le formulaire de paiement une case à cocher demandant à l'acheteur s'il veut enregistrer sa carte.

Acción del comprador Descripción
La casilla está marcada Registra un alias de tarjeta (formAction=REGISTER_PAY).
La casilla no está marcada El alias no se crea (formularioAcción=PAYMENT). Comportamiento por defecto.

Más información, consulte: Creación y uso de alias.

CUSTOMER_WALLET

Le Web Service retourne un formToken.

Ce paramètre permet d'ajouter dans le formulaire de paiement une case à cocher demandant à l'acheteur s'il veut enregistrer sa carte dans son wallet. Nécessite la référence acheteur customer.reference.

Acción del comprador Descripción
La casilla está marcada Añadir una tarjeta al wallet.
La casilla no está marcada Comportamiento por defecto. La tarjeta no se agrega a la billetera.

SILENT Réservé pour les transactions initiées par le marchand sans la présence de l'acheteur et notamment pour les paiements récurrents lorsque la récurrence est gérée par le marchand.

En el área de aplicación de la DSP2, la autentificación del titular es obligatoria cuando el titular está presente. Por lo tanto, el modo SILENT se reserva para aquellos casos en que el titular está ausente o para los vendedores que se encuentren fuera del área de la DSP2.

En el área de aplicación de la DSP2, se ignora el campo strongAuthentication y no se realiza autentificación alguna del titular.

Le Web Service retourne directement une transaction plutôt qu'un formToken lors d'un paiement par alias (token). La transaction se fait donc de serveur à serveur.

paymentMethodToken

Token asociado a un medio de pago.

Formato

strongAuthentication

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

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

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

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

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

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

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

Opción "Frictionless 3DS2" obligatoria

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

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

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

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

Tabla de exenciones (valor DISABLED)

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

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

    Vous pouvez demander une exemption à l'authentification forte :

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

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

Formato

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

paymentMethods

Lista de formas de pago para ofrecer al comprador

Ejemplo: "VISA;MASTERCARD".

Si la lista solo contiene un modo de pago, la página de ingreso de datos de este medio de pago será presentada directamente. De lo contrario, se presentará la página de selección de los medios de pago.

Si este campo está vacío (indicado), se ofrecerán todos los medios de pago elegibles (monedas, restricciones técnicas, etc.) asociados a la tienda.

Formato

customer.reference

Identificador del comprador en el sitio web comercial.

Obligatorio si vads_cust_status está establecido en PRIORITY.

En ese caso, la referencia del comprador se utiliza como identificador del wallet.

Formato

customer.email

E-mail del comprador.

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

Este parámetro es obligatorio al crear un alias (definiciónformActionaREGISTER_PAY,ASK_REGISTER_PAYoCUSTOMER_WALLET).
Si este parámetro está ausente al crear elformToken(Crear un formToken), la plataforma muestra automáticamente un campo para ingresar el correo electrónico del comprador.

Formato

address

Camino: customer.billingDetails.address

Dirección de facturación.

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

Formato

address2

Camino: customer.billingDetails.address2

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

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

Formato

category

Camino: customer.billingDetails.category

Tipo de cliente.

Formato

Valores posibles

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

cellPhoneNumber

Camino: customer.billingDetails.cellPhoneNumber

Teléfono móvil del comprador.

Acepta todos los formatos:

Ejemplos:

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

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

Formato

city

Camino: customer.billingDetails.city

Ciudad de facturación.

Formato

country

Camino: customer.billingDetails.country

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

Formato

Valores posibles

Ejemplos de valores posibles:

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

district

Camino: customer.billingDetails.district

Barrio de la dirección de facturación.

Formato

firstName

Camino: customer.billingDetails.firstName

Nombre del comprador.

Formato

identityCode

Camino: customer.billingDetails.identityCode

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

Formato

identityType

Camino: customer.billingDetails.identityType

Tipo del documento de identidad.

Formato

language

Camino: customer.billingDetails.language

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

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

Formato

Valores posibles

Ejemplos de valores posibles:

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

lastName

Camino: customer.billingDetails.lastName

Nombre del comprador.

Formato

legalName

Camino: customer.billingDetails.legalName

Razón social.

Formato

phoneNumber

Camino: customer.billingDetails.phoneNumber

Número de teléfono del comprador.

Acepta todos los formatos:

Ejemplos:

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

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

Formato

state

Camino: customer.billingDetails.state

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

Formato

streetNumber

Camino: customer.billingDetails.streetNumber

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

Carácteres aceptados:

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

Formato

title

Camino: customer.billingDetails.title

Tratamiento del comprador.

Ejemplos:

  • Sr.
  • Sr.
  • Sra.

Formato

zipCode

Camino: customer.billingDetails.zipCode

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

Formato

address

Camino: customer.shippingDetails.address

Dirección de entrega.

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

Formato

address2

Camino: customer.shippingDetails.address2

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

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

Formato

category

Camino: customer.shippingDetails.category

Tipo de cliente.

Formato

Valores posibles

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

city

Camino: customer.shippingDetails.city

Ciudad de entrega.

Formato

country

Camino: customer.shippingDetails.country

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

Formato

Valores posibles

Ejemplos de valores posibles:

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

deliveryCompanyName

Camino: customer.shippingDetails.deliveryCompanyName

Nombre de la empresa emisora del producto.

Formato

district

Camino: customer.shippingDetails.district

Barrio de la dirección de facturación.

Formato

firstName

Camino: customer.shippingDetails.firstName

Nombre del destinatario.

Formato

identityCode

Camino: customer.shippingDetails.identityCode

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

Formato

lastName

Camino: customer.shippingDetails.lastName

Nombre del comprador.

Formato

legalName

Camino: customer.shippingDetails.legalName

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

Formato

phoneNumber

Camino: customer.shippingDetails.phoneNumber

Número de teléfono del comprador.

Acepta todos los formatos:

Ejemplos:

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

Formato

shippingMethod

Camino: customer.shippingDetails.shippingMethod

Modo de entrega.

Formato

Valores posibles

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

shippingSpeed

Camino: customer.shippingDetails.shippingSpeed

Plazo de entrega.

Formato

Valores posibles

Ejemplos de valores posibles:

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

state

Camino: customer.shippingDetails.state

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

Formato

streetNumber

Camino: customer.shippingDetails.streetNumber

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

Carácteres aceptados:

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

Formato

zipCode

Camino: customer.shippingDetails.zipCode

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

Formato

insuranceAmount

Camino: customer.shoppingCart.insuranceAmount

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

Ejemplo: 30050 para 300,50 EUR.

Formato

shippingAmount

Camino: customer.shoppingCart.shippingAmount

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

Ejemplo: 30050 para 300,50 EUR.

Formato

taxAmount

Camino: customer.shoppingCart.taxAmount

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

Ejemplo: 30050 para 300,50 EUR.

Formato

cartItemInfo

Camino: customer.shoppingCart.cartItemInfo

cardItemInfo es una lista que contiene objetos Customer/ShoppingCartItemInfo.

Permite describir cada artículo del carrito.

Formato

productAmount

Camino: customer.shoppingCart.cartItemInfo.productAmount

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

Ejemplo: 30050 para 300,50 EUR.

Formato

productLabel

Camino: customer.shoppingCart.cartItemInfo.productLabel

Nombre del producto.

Formato

productQty

Camino: customer.shoppingCart.cartItemInfo.productQty

Cantidad de producto.

Formato

productRef

Camino: customer.shoppingCart.cartItemInfo.productRef

Referencia del producto.

Formato

productType

Camino: customer.shoppingCart.cartItemInfo.productType

Tipo de producto.

Valores posibles

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

Formato

productVat

Camino: customer.shoppingCart.cartItemInfo.productVat

Tipo de producto.

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

Valores posibles

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

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

Formato

paymentSource

Camino: transactionOptions.cardOptions.paymentSource

Origen del pago.

Formato

Valores posibles

. Los valores posibles son:

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

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 Back Office Vendedor).

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 Back Office Vendedor.

Este último es configurable en el Back Office Vendedor por todas las personas debidamente autorizadas.

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

debitCreditSelector

Camino: transactionOptions.cardOptions.debitCreditSelector

Este campo es exclusivo para Brasil para la gestión de las tarjetas “multiplo”.

Las tarjetas “Multiplo” son tarjetas de pago (Elo, Visa o Mastercard) que permiten pagar:

  • ya sea en débito inmediato: el monto se debita inmediatamente y se acredita al vendedor al día siguiente.
  • o en crédito: el débito se difiere y el monto puede debitarse en una o más cuotas. Al vendedor se le acredita posteriormente la totalidad o solo una parte del monto total.

Este campo permite forzar el uso de la tarjeta como tarjeta de débito o de crédito.

Valores posibles

valores Descripción
DEBIT Uso de la función “débito” de la tarjeta
CREDIT Uso de la función “crédito” de la tarjeta

Formato

initiatedTransactionIndicator

Camino: transactionOptions.cardOptions.initiatedTransactionIndicator

Finalidad del uso del token de la tarjeta.

Formato

initialIssuerTransactionIdentifier

Camino: transactionOptions.cardOptions.initialIssuerTransactionIdentifier

Referencia de encadenamiento.

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

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

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

formTokenVersion

formTokenVersion define la versión del formToken enviada por el Web Service.

Este parámetro se utiliza en el marco del SDK móvil. Permite asegurarse de que la versión del formToken devuelta está siempre sincronizada con la aplicación móvil implementada en el teléfono del comprador.

El valor por defecto es 4.

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 durante un pago con autentificación simple.
Charge/PaymentForm El objeto contiene un hash para utilizar con el formulario incrustado para crear una nueva transacción.

Consulte la referencia de cada respuesta para más información.