Web Service Charge/CreatePaymentOrder

POSThttps://api.micuentaweb.pe/api-payment/V4/Charge/CreatePaymentOrder

Le Web Service Charge/CreatePaymentOrder permet de créer des ordres de paiement via différents canaux de diffusion.

Para conocer el resultado del pago, implemente la URL de notificación al final el pago (IPN).

Ingrese solamente la URL de notificación en la sección API REST (TEST o PRODUCTION): Procedimiento.
Analice la IPN: Procedimiento.

Consulta la guía de integración de Orden de Pago de Servicios Web.

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

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

orderId

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

Formato

channelType

Camino: channelOptions.channelType

ID de la solicitud de pago a modificar. El valor predeterminado es “URL”.

Formato

Valores posibles

. Los valores posibles son:

VALOR	Descripción
MAIL	La solicitud de pago se envía al comprador por e-mail.
URL	Solo se lleva a cabo la creación de la URL de pago devuelta en la respuesta
SMS	La solicitud de pago se envía al comprador por SMS
WHATSAPP	La solicitud de pago se envía al WhatsApp del comprador
INVOICE	La orden de pago se envía en forma de factura para pagar.
IVR	La orden de pago fue creada y es pagable a través del Servido Vocal Interactivo (IVS)

bcc

Camino: channelOptions.mailOptions.bcc

BCC ("Blind Carbon Copy" o "Copie Carbono Invisible"). Lista de los destinatarios adicionales de la solicitud de pago. Estos destinatarios no son visibles para el destinatario principal (recipient). Use el punto y coma ";" como separador entre cada dirección.

Formato

body

Camino: channelOptions.mailOptions.body

Permite personalizar el cuerpo del mensaje enviado Si el parámetro se deja vacío, se aplicará el mensaje predeterminado.

Formato

Contenido

Para personalizar el cuerpo del e-mail, puede utilizar las siguientes variables:

VALOR	Descripción
%url%	URL de la solicitud de pago Si falta esta variable, el enlace de pago se agregará automáticamente al final del mensaje.
%amount%	Monto y moneda del pago
%start_date%	Fecha de creación de la solicitud de pago.
%end_date%	Fecha de vencimiento de la solicitud de pago.
%shop_name%	Nombre de su tienda como se define en el Back Office
%reference%	Referencia del pedido.
%shop_url%	URL de su tienda
%shop_contact%	Dirección de e-mail del “administrador de la tienda” como se define en el Back Office

Ejemplo: Este e-mail comprende una solicitud de pago de un importe de %amount% válido hasta %end_date%. Para confirmar el pago, haga clic en el siguiente vínculo: %url%

recipient

Camino: channelOptions.mailOptions.recipient

Destinatario del e-mail.

Formato

subject

Camino: channelOptions.mailOptions.subject

Permite personalizar la apariencia de los e-mails. Permite personalizar el asunto del e-mail. Este parámetro es obligatorio a menos que indique un nombre de plantilla válido en el parámetro channelOptions.mailOptions.template.

Formato

Contenido

Para personalizar el asunto del e-mail, utilice las siguientes variables:

VALOR	Descripción
%url%	URL de la solicitud de pago, es importante colocarla en el cuerpo del e-mail
%amount%	Monto y moneda del pago
%start_date%	Fecha de creación de la solicitud de pago.
%end_date%	Fecha de vencimiento de la solicitud de pago.
%shop_name%	Nombre de su tienda como se define en el Back Office
%reference%	Referencia del pedido.
%shop_url%	URL de su tienda
%shop_contact%	Dirección de e-mail del “administrador de la tienda” como se define en el Back Office

Ejemplo: Oferta %reference% válida desde el %start_date% hasta el %end_date% por un monto de %amount%

template

Camino: channelOptions.mailOptions.template

Nombre de la plantilla a utilizar para generar el e-mail. Para que funcione, es necesario que la plantilla exista en el Back Office.

Cada modelo de e-mail está asociado a un idioma (o locale en inglés) Para utilizar una plantilla, asegúrese de indicar el idioma correcto en el parámetro locale.

Si no se encuentra la plantilla se devolverá un error. Si definió un valor en los parámetros subject y body , se ignorará la plantilla.

Formato

message

Camino: channelOptions.smsOptions.message

Mensaje a enviar por SMS.

Formato

phoneNumber

Camino: channelOptions.smsOptions.phoneNumber

Número de teléfono al que enviar el SMS.

Formato

phoneNumber

Camino: channelOptions.whatsAppOptions.phoneNumber

Número de teléfono al que enviar el mensaje de WhatsApp.

Formato

ivrPaymentOrderId

Camino: channelOptions.ivrOptions.ivrPaymentOrderId

Este campo es rellenado automáticamente por la plataforma Si el vendedor tiene restricciones específicas, puede sobrescribir este campo excepcionalmente con su propia referencia numérica siempre que garantice su unicidad.

Formato

formAction

permite definir el tipo de comportamiento que desea al crear la transacción.

Valores posibles

. Los valores posibles son:

VALOR	Descripción
PAYMENT	Creación de una transacción simple. Comportamiento predeterminado.
REGISTER	Creación del token sin pago. El valor del monto transmitido debe ser 0.
REGISTER_PAY	Creación del token durante un pago.
REGISTER_UPDATE	Cambio de información asociada al token.
REGISTER_UPDATE_PAY	Cambio de información asociada al token durante un pago.
ASK_REGISTER_PAY	Pago con propuesta al titular para crear un token.
null	Si el valor es nulo o no definido, se aplica el valor PAYMENT.

Formato

dataCollectionForm

Uso del formulario de recaudación de datos. Uso del formulario de recolección de datos. Si se establece en true , se mostrará antes del formulario de pago.

Formato

expirationDate

Hora y fecha de expiración del pago, en formato ISO-8601.

Formato

locale

Configuración regional (o local) en formato cc_XX en donde:

cc es el código de idioma (dos caracteres en minúscula conformes a la norma ISO-639 (por ejemplo, "de" para el alemán, "fr" para el francés, "en" para el inglés).
XX representa el código del país (dos caracteres en mayúscula siguiendo la norma ISO-3166 (ejemplo: "DE" para Alemania, "FR" para Francia, "GB" para el Reino Unido.

Permite definir el idioma de las páginas de pago y el e-mail de confirmación. Si no se define el parámetro, el formulario usa el idioma del navegador.

Formato

merchantComment

el estado de la solicitud de pago Comentario asociado a la solicitud de pago. Permite, por ejemplo, indicar una referencia sobre el emisor de la solicitud de pago.

Formato

paymentReceiptEmail

La dirección de e-mail del comprador a la que se enviará el recibo de pago. Dirección de e-mail del comprador a la que se enviará el ticket de pago. Esta característica solo puede funcionar si la regla de notificación "E-mail de confirmación para el comprador" está activada en el Back Office.

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

allowDCFAmountUpdate

allowDCFAmountUpdate permite definir si el monto puede modificarse en el formulario de recogida de datos Este campo puede ser utilizado únicamente si el campo dataCollectionForm tiene el valor true.

Formato

Valores posibles

. Los valores posibles son:

VALOR	Descripción
NONE	El monto no puede modificarse. Comportamiento predeterminado.
LOWER	El monto solo puede modificarse a la baja.
GREATER	El monto solo puede modificarse al alza.
LOWER_AND_GREATER	El monto puede aumentar o disminuir.
null	Si el valor es nulo o no definido, se aplica NONE.

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

returnMode

returnMode Permite especificar el método de transmisión de datos utilizado al volver al sitio web comercial.

Valores posibles

. Los valores posibles son:

VALOR	Descripción
NONE	No se transmitirá ningún parámetro en la URL de retorno hacia el sitio Web comercial.
GET	Los campos de retorno se transmitirán a la URL de retorno a través de un formulario HTTP GET (en la cadena de consulta o "query string").
POST	Los campos de retorno se transmiten a la URL de retorno en un formulario HTTP POST. Si el retorno a la tienda se realiza en un entorno que no sea https, el navegador muestra un pop-up de seguridad al comprador.
null	Si el valor es nulo o no definido, se aplica NONE.

Formato

returnUrl

returnUrl permite definir la URL donde se redirige por defecto al comprador tras hacer clic en el botón Volver a la tienda si las URL errorUrl , refusedUrl , successUrl o cancelUrl no han sido indicadas.

Si este campo no se transmite, se considera la configuración del Back Office Vendedor.

Si no se define una URL en el Back Office Vendedor o en el formulario, el botón Volver a la tienda redirige al comprador a la URL del sitio web comercial (campo de URL en la configuración de la tienda).

Formato

cancelUrl

cancelUrl permite definir la URL a la que se redirige al comprador tras hacer clic en Anular y volver a la tienda sin haber realizado el pago.

Formato

successUrl

successUrl permite definir la URL a la que será redirigido el comprador si el pago es satisfactorio, tras hacer clic en el botón Volver a la tienda.

Formato

refusedUrl

refusedUrl permite definir la URL a la que se redirige al comprador en caso de rechazo tras hacer clic en el botón Volver a la tienda.

Formato

errorUrl

errorUrl permite definir la URL donde será redirigido el comprador en caso de procesamiento interno.

Formato

postWalletUrl

postWalletUrl permite definir la URL a la que se redirige al comprador al pagar con wallet en dos etapas.

Esta URL se utiliza para transmitir información del comprador (e-mail, dirección de envío, modo de pago, etc.).

A partir de estos elementos, el vendedor puede elegir qué acción realizar (ajustar los gastos de envío, registrar los medios de pago, etc.) antes de permitir que el comprador finalice su pago.

Formato

ipnTargetUrl

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

Formato

redirectSuccessTimeout

Permite definir un lapso en segundos antes de redirigir automáticamente al sitio web comercial al final de un pago aceptado.

Su valor se encuentra entre 0 y 300 segundos.

Después de este lapso, el comprador es redirigido a la URL ingresada en el campo errorUrl. Si este campo no se indica, el comprador es redirigido a la URL de retorno ingresada en el campo returnUrl o a la URL de retorno ingresada en el bom. Si la URL de retorno no está establecida, será redirigido a la URL de la tienda.

Formato

redirectErrorTimeout

Permite definir un lapso en segundos antes de redirigir automáticamente al sitio web comercial al final de un pago rechazado.

Su valor se encuentra entre 0 y 300 segundos.

Después de este lapso, el comprador es redirigido a la URL ingresada en el campo errorUrl. Si este campo no se rellena, el comprador será redirigido a la URL de retorno ingresada en el campo returnUrl o a la URL de retorno ingresada en el bom. Si la URL de retorno no está establecida, será redirigido a la URL de la tienda.

Formato

customer.reference

Identificador del comprador en el sitio web comercial.

Formato

customer.email

E-mail del comprador.

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

Formato

address

Camino: customer.billingDetails.address

Dirección de facturación.

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

Formato

address2

Camino: customer.billingDetails.address2

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

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

Formato

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
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
BRASIL	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

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

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

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.

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).
Sin preferencia del vendedor	AUTO : Se delega la elección de la preferencia al emisor de la tarjeta (No Preference).

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

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

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

installmentNumber

Camino: transactionOptions.cardOptions.installmentNumber

Cantidad de cuotas. Importante: Este campo solo concierne a Brasil

Formato

firstAmount

Camino: transactionOptions.installmentOptions.firstAmount

Monto del primer pago en N cuotas.

Formato

count

Camino: transactionOptions.installmentOptions.count

Número de vencimientos de pago en N cuotas.

Formato

period

Camino: transactionOptions.installmentOptions.period

Intervalo (días) de pago en N cuotas.

Formato

amount

Camino: transactionOptions.installmentOptions.schedules.amount

Importe del vencimiento.

Formato

date

Camino: transactionOptions.installmentOptions.schedules.date

Fecha de vencimiento.

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.

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.

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

Respuesta	Contexto
PaymentOrder	Objeto que contiene la solicitud de pago recién creada.

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

Categoria

Tags

Web Service Charge/CreatePaymentOrder

Parámetros de entrada

amount

Formato

currency

Formato

Valores posibles

orderId

Formato

channelType

Camino: channelOptions.channelType

Formato

Valores posibles

bcc

Camino: channelOptions.mailOptions.bcc

Formato

body

Camino: channelOptions.mailOptions.body

Formato

Contenido

recipient

Camino: channelOptions.mailOptions.recipient

Formato

subject

Camino: channelOptions.mailOptions.subject

Formato

Contenido

template

Camino: channelOptions.mailOptions.template

Formato

message

Camino: channelOptions.smsOptions.message

Formato

phoneNumber

Camino: channelOptions.smsOptions.phoneNumber

Formato

phoneNumber

Camino: channelOptions.whatsAppOptions.phoneNumber

Formato

ivrPaymentOrderId

Camino: channelOptions.ivrOptions.ivrPaymentOrderId

Formato

formAction

Valores posibles

Formato

dataCollectionForm

Formato

expirationDate

Formato

locale

Formato

merchantComment

Formato

paymentReceiptEmail

Formato

taxAmount

Formato

taxRate

Formato

allowDCFAmountUpdate

Formato

Valores posibles

Formato

metadata

Ejemplo de llamada

Formato

Transmitir los datos para el análisis de riesgos

Valores posibles

returnMode

Valores posibles

Formato

returnUrl

Formato

cancelUrl

Formato

successUrl

Formato

refusedUrl