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.micuentaweb.pe/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 sol peruano).

Ejemplo: 30050 para 300,50 PEN.

Formato

amount

Monto del pago en su fracción monetaria más pequeña (el céntimo para el sol peruano).

Ejemplo: 30050 para 300,50 PEN.

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: Ej: "PEN" para el sol peruano.

Formato

Valores posibles

. Los valores posibles son:

Moneda CODIFICACIÓN ISO 4217 Unidad fraccionaria
Sol peruano (604) PEN 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

Transmitir los datos para el análisis de riesgos

Las transacciones se someten sistemáticamente a un análisis de riesgo para determinar si se necesita una autentificación 3D-Secure o si presentan un riesgo demasiado elevado para aceptarlas. Para que el análisis sea lo más pertinente posible, usted debe transmitir un máximo de informaciones en su formulario de pago.

Para detallar el análisis, usted puede utilizar los campos descritos a continuación. Se devuelven estos campos en la notificación de fin de pago.

Para ilustrar, aquí hay un ejemplo con el número de teléfono : cybersource_mdd_13.

{
  "amount": 180,
  "currency": "PEN",
  "customer": {
    "email": "[sample@example.com|mailto:sample@example.com]"
  },
  "metadata": {
    "cybersource_mdd_13": "0606060606"
  },
  "orderId": "myOrderId-417842"
}

Valores posibles

Los valores posibles son:

Nombre del campo DESCRIPCIÓN Opcional / Recomendado Formato
cybersource_mdd_12 Email que el cliente ingresó en el registro o el que coloca durante el proceso de compra. R String (255)
cybersource_mdd_13 Numero de telefono utilizado. R String (255)
cybersource_mdd_14 Información del cliente que realiza la compra, en el campo se registrará el tipo concatenado con el número de identidad.

01-DNI

02-CARNET DE EXTRANJERIA

03-PASAPORTE

10-RUC 10

20-RUC 20

15-RUC 15

17-RUC 17

30-PTT

Ejm :
  • 01-07659002 (dni)
  • 20-20102034561 (ruc juridico)
R String (255)
cybersource_mdd_15 Identificador único del cliente de cara al comercio. O String (255)
cybersource_mdd_16 ¿Registro mediante Redes Soc u otras?

SI

NO

O String (255)
cybersource_mdd_17 Cliente Frecuente.

SI

NO

O String (255)
cybersource_mdd_18 Número de días transcurridos desde primera compra del cliente. O Float
cybersource_mdd_19 Número de días transcurridos desde última compra del cliente. O Float
cybersource_mdd_20 Número de cupón de descuento. O String (255)
cybersource_mdd_21 Número de Giftcard. O String (255)
cybersource_mdd_22 Indica si el cliente se ha registrado en la web del comercio y bajo qué modalidad Registrado.

01=Invitado

02=Empleado

03=Registro directo

O String (255)
cybersource_mdd_23 Ticket promedio del cliente (sin incluir la compra actual). O Float
cybersource_mdd_24 Riesgo de la transacción.

BAJO

MEDIO

ALTO

O String (255)
cybersource_mdd_27 Información del beneficiario de la compra, en el campo se registrará el tipo concatenado con el número de identidad .

01-DNI

02-CARNET DE EXTRANJERIA

03-PASAPORTE

10-RUC 10

20-RUC 20

15-RUC 15

17-RUC 17

30-PTT

Ejm :
  • 01-07659002 (dni)
  • 20-20102034561 (ruc juridico)
R String (255)
cybersource_mdd_28 Aplica a ventas telefónicas, identificado único de la persona que atendió al cliente durante el proceso de venta (Asistidas). R String (255)
cybersource_mdd_29 Número de items que compra el cliente por pedido. O Float
cybersource_mdd_30 Enviado/Pendiente.

Enviado

Pendiente

R String (255)
cybersource_mdd_31 Número de horas entre la compra y la entrega del producto / servicio. R Float
cybersource_mdd_32 Número de días que se encuentra esa dirección registrada en sistemas. R Float
cybersource_mdd_33 Número de pedidos realizados a esa dirección registrada en sistemas. O Float
cybersource_mdd_34 Número de compras realizadas en los últimos 6 meses según historial del cliente. O Float
cybersource_mdd_35 Identificador único del establecimiento del comercio. Aplica para delivery de productos/servicios y recoge en el establecimiento. R String (255)
cybersource_mdd_36 Nombre del establecimiento del comercio. Aplica para delivery de productos/servicios y recoge en el establecimiento. R String (255)
cybersource_mdd_37 Indica si la compra se enviará mediante delivery a la dirección del cliente o será recogida en el local del comercio Delivery / recoge en tienda.

DELIVERY

RECOJO EN TIENDA

R String (255)
cybersource_mdd_38 Cuenta de destino para la recarga de billeteras de criptomonedas y otros instrumentos financieros. R String (255)
cybersource_mdd_39 Banco al cual pertenece la cuenta de destino.

2= BCP,

3= IBK PRIVADA,

5= IBK,

7= CITI,

9= SBP,

10= LOY,

11= BBVA,

18= BN,

23= COMERCIO,

35=PICHINCHA,

38= BIF,

41=SBP,

43= CSF,

49=MIBANCO

R String (255)
cybersource_mdd_40 Número de placa de auto. R String (255)
cybersource_mdd_41 Indicar si el cliente ha adquirido o está recargando un número PREPAGO o POSTPAGO. Aplica para empresas de telefonía.

PREPAGO

POSTPAGO

R String (255)
cybersource_mdd_42 Identificador único del usuario final del servicio, de cara al comercio. En el caso de telcos, ese el número de celular a recargar. R String (255)
cybersource_mdd_43 Número telefónico ingresado por el cliente al registrarse en la web/app del comercio. R String (255)
cybersource_mdd_44 Código de Reserva. R String (255)
cybersource_mdd_45 Número de código de fidelidad del viajero frecuente. R String (255)
cybersource_mdd_46 Canal de venta ticket..

OTA

APP

WEB

R String (255)
cybersource_mdd_47 Round Trip or One Way Trip

OW

RT

R String (255)
cybersource_mdd_48 Delta entre fecha de salida y fecha de regreso. Solo para vuelos de ida y vuelta (en días). O String (255)
cybersource_mdd_49 Número de adultos viajando. O String (255)
cybersource_mdd_50 Ciudad donde se inicia el viaje comprado por el cliente. R

Código IATA

cybersource_mdd_51 Ciudad donde finaliza el viaje comprado por el cliente. R

Código IATA

cybersource_mdd_52 Compra de millas/km.

SI

NO

R String (255)
cybersource_mdd_53 Vuelo internacional.

SI

NO

R String (255)
cybersource_mdd_54 Clase Tarifa. Letra que corresponde a la clase del billete.

Ejm : W, Y, N.

O String (255)
cybersource_mdd_55 Fecha de inicio del primer vuelo. R DateTime (25)
cybersource_mdd_56 Aeropuerto Origen O

Código IATA

cybersource_mdd_57 Aeropuerto Destino O

Código IATA

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.

Se requerirá siempre una autentificación fuerte al registrar una tarjeta, cualquiera que sea la preferencia del vendedor.

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.

    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).

    Formato

    acquirerTransientData

    Permite la transmisión de información específica a determinados adquirentes/redes.

    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
    Argentina AR
    Brasil BR
    Colombia CO
    COSTA RICA CR
    ECUADOR EC
    GUATEMALA GT
    MÉXICO MX
    NICARAGUA NI
    PERÚ PE
    SALVADOR SV
    ESTADOS UNIDOS DE AMÉRICA US
    URUGUAY UY

    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.

    Valores posibles:

    País TIPO DESCRIPCIÓN
    ARGENTINA DNI Documento Nacional de Identidad
    BRASIL CNPJ Cadastro Nacional da Pessoa Jurídica
    CPF Cadastro de Pessoas Físicas
    COLOMBIA CC Cédula de ciudadania
    TI Tarjeta de Identidad
    CE Cédula de Extranjeria
    NI Número de Identificación Tributaria
    PS Pasaporte
    Peru DNI_PER Documento National de Identidad
    por Partida de Nacimiento
    No Pasaporte
    LMI Libreta Militar
    NAN Otro

    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 fracción monetaria más pequeña (el céntimo para el sol peruano).

    Ejemplo: 30050 para 300,50 PEN.

    Formato

    shippingAmount

    Camino: customer.shoppingCart.shippingAmount

    Monto de los gastos de envío de todo el pedido expresado en su unidad monetaria más pequeña (el céntimo para el suelo peruano).

    Ejemplo: 30050 para 300,50 PEN.

    Formato

    taxAmount

    Camino: customer.shoppingCart.taxAmount

    Monto de los impuestos de todo el orden expresado en su unidad monetaria más pequeña (el céntimo para el sol peruano).

    Ejemplo: 30050 para 300,50 PEN.

    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 del producto expresada en su unidad monetaria más pequeña (el céntimo para el sol peruano).

    Ejemplo: 30050 para 300,50 PEN.

    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 Montant de la transaction. Sa valeur doit être un entier positif (ex: 1234 pour 12,34 PEN).
    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.
    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.

    Un contrato de VISANET no puede utilizarse para una transacción de MASTERCARD.

    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

    Número de nuevos intentos disponibles en caso de rechazo del pago (3 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.

    • Para la redMastercard
    Value Category Descripción
    C101 Credential-on-file Consumer agrees to store the credential-on-file with the merchant for future cardholder-initiated purchases that may occur from time to time.
    C102 Standing Order (variable amount and fixed frequency) Consumer agrees to store the credential-on-file and initiates a first transaction in a series intended to be for a variable amount and a fixed frequency
    C103 Subscription (fixed amount and frequency) Consumer agrees to store the credential-on-file and initiates a first transaction in a series intended to be for a fixed amount and a fixed frequency
    C104 Installment Consumer agrees to store the credential-on-file to establish an installment plan and initiates a first transaction in a series. The installment plan should reflect the single purchase of goods/services with a known amount and set frequency over a specified duration.
    M101 Standing Order (variable amount and fixed frequency) A transaction made pursuant to an agreement between a cardholder and a merchant, whereby the cardholder authorizes the merchant to store and use the cardholder's account data to initiate one or more future transactions. The transaction can be for a fixed or variable amount but does not occur at regular intervals on a scheduled date.
    M102 Standing Order (variable amount and fixed frequency) A transaction made pursuant to an agreement between a cardholder and a merchant, whereby the cardholder authorizes the merchant to store and use the cardholder's account data for a transaction that must occur at regularly scheduled intervals for a variable amount, as specified in the agreement.
    M103 Subscription (fixed amount and frequency) A transaction made pursuant to an agreement between a cardholder and a merchant, whereby the cardholder authorizes the merchant to store and use the cardholder's account data for a transaction that must occur at regularly scheduled intervals for a fixed amount, as specified in the agreement. The subscription agreement may include an allowance for introductory pricing orfor price changes to occur from time to time.
    M104 Installment A transaction in a series of transactions made pursuant to an agreement between a cardholder and a merchant, where by the cardholder authorizes the merchant to store the cardholder's account data for use by the merchant to initiate one or more future transactions for a known amount over a specified duration based on a single purchase.

    Formato

    initialIssuerTransactionIdentifier

    Camino: transactionOptions.cardOptions.initialIssuerTransactionIdentifier

    Referencia de encadenamiento.

    Formato

    taxAmount

    Monto de los impuestos de todo el orden expresado en su unidad monetaria más pequeña (el céntimo para el sol peruano).

    Ejemplo: 30050 para 300,50 PEN.

    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.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Formato

    legalNumber

    Camino: subMerchantDetails.legalNumber

    Número legal del subvendedor según el campo companyType. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Formato

    name

    Camino: subMerchantDetails.name

    Razón social del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Formato

    url

    Camino: subMerchantDetails.url

    URL del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Formato

    phoneNumber

    Camino: subMerchantDetails.phoneNumber

    Número de teléfono del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Formato

    address1

    Camino: subMerchantDetails.address1

    Dirección del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Formato

    address2

    Camino: subMerchantDetails.address2

    Complemento de la dirección del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Formato

    zip

    Camino: subMerchantDetails.zip

    Código postal del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Formato

    city

    Camino: subMerchantDetails.city

    Ciudad del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    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.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Formato

    mcc

    Camino: subMerchantDetails.mcc

    Código MCC del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Formato

    mid

    Camino: subMerchantDetails.mid

    Número de afiliación (MID) del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Campo obligatorio para los adquirentes Fiserv y Procesos. (Más información: Fiserv.)

    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.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Formato

    state

    Camino: subMerchantDetails.state

    Región de la dirección del subvendedor. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    Formato

    facilitatorId

    Camino: subMerchantDetails.facilitatorId

    Identificador del facilitador de pago. Transmitido por el facilitador de pago.

    Los campos son obligatorios a partir de que al menos un campo del sub-comercio está presente en el formulario de pago (los campos subMerchantDetails" ).

    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.