Definición de parámetros

Al utilizar el objeto config con estos datos de entrada en la integración del SDK, se asegura un flujo de información preciso y completo, lo que permite interactuar eficientemente con las funcionalidades y servicios proporcionados por el SDK. Es importante seguir las pautas y recomendaciones específicas proporcionadas por la documentación del SDK para garantizar una correcta utilización de estos datos de entrada. El objeto config almacena la información relacionada a la transacción, así como datos relacionados a la apariencia del formulario.

• Datos de entrada: El objeto config está compuesto por los siguientes atributos:

config

Object

required

Objeto de Configuración, contienen los demás objetos (order, token, billing,…).

transactionId

String

required

Id único por cada transacción generada por el comercio. Debe ser el mismo que fue enviado al generar el token de sesión.

Longitud (min - max): 5 - 40

Ejemplo:16881500822750

Formato permitido:Solo se permiten valores que contengan números y letras, ya sean mayúsculas o minúsculas, sin espacios ni caracteres especiales.

Regex:/^[0-9a-zA-Z]+$/

action

String

required

Indicador que determina la forma de la compra, acepta los siguientes valores: pay: Compras con tarjeta (sin tokenización), register: registra de tarjeta(tokenización), pay_register: Compras y registro de tarjeta, pay_token: Compras con token (Privado o de la Marca) de tarjeta.

Valores permitidos:payregisterpay_registerpay_token

Ejemplo:pay

merchantCode

String

required

Código del comercio o submerchant(código hijo del merchantFacilitator), generado por Izipay durante la afiliación.

Longitud (min - max): 7 - 15

Ejemplo:4001834

Formato permitido:Solo permite valores que contengan letras, tanto mayúsculas como minúsculas y espacios en blanco.

Regex:/^[A-Za-z\s]*$/

facilitatorCode

String

Código de comercio facilitador, generado por Izipay durante la afiliación.

Longitud (min - max): 7 - 15

Ejemplo:4000901

Formato permitido:Solo permite valores que contengan letras, tanto mayúsculas como minúsculas y espacios en blanco.

Regex:/^[A-Za-z\s]*$/

order

Object

required

Objeto de la compra

orderNumber

String

required

Número de Pedido de la transacción. Debe ser el mismo que fue enviado al generar el token de sesión.

Longitud (min - max): 5 - 15

Ejemplo:1687996765

showAmount

Boolean

Visualiza el monto en el botón "Pagar" del formulario de pagos.

currency

String

required

Moneda de la transacción.

Valores permitidos:PENUSD

Ejemplo:PEN

amount

Decimal

required

Monto de la Txn. Debe ser el mismo enviado al generar el token de sesión. Enteros con 2 decimales, considerar separador decimal sin delimitador de miles.

Longitud (min - max): 4 - 13

installments

Number

Número de Cuotas que afectarán a la compra.

Longitud (min - max): 2 - 2

Ejemplo:00

deferred

Number

Número Diferido que afectará a la compra.

Longitud (min - max): 1

Ejemplo:0

payMethod

String

Indicador del método de pago de la compra, en caso sea más de uno, separar por coma.

Valores permitidos:allCARDQRAPPLE_PAYYAPE_CODEPAGO_PUSH

Ejemplo:CARD,QR,APPLE_PAY

processType

String

required

Tipo de Proceso para una transacción AT: Autorización PA: Pre-Autorizacion.

Valores permitidos:ATPA

Ejemplo:AT

merchantBuyerId

String

required

Identificador único del comprador en el sistema del comercio.

Longitud (min - max): 6 - 100

Ejemplo:mc1991

dateTimeTransaction

Datetime

required

Fecha y Hora de la transacción enviado por el comercio o terminal.

Longitud (min - max): 16 - 16

Ejemplo:1688149430031000

Formato permitido:Solo permite valores que contengan números

Regex:/^[0-9]+$/

card

Object

Objeto donde se envía los datos de tarjetas.

brand

String

Valores permitidos

• MC: MasterCard
• VS: Visa
• AE: Amex
• DN: Diners

Ejemplo:VS

pan

String

Número de tarjeta del tarjetahabiente.

Longitud (min - max): Hasta 344

Ejemplo:XVGRpy8X/OHHo8jPi/V6TEm+BQxY8o9cixbClcaCxgA=

Formato permitido:Solo permite valores que sean encriptaciones RSA en base 64

Regex:/^[a-zA-Z0-9+/=]+$/

expirationMonth

String

Mes de Expiración de la tarjeta. ENCRIPTACION RSA

Longitud (min - max): Hasta 344

Ejemplo:WFSonBkoy9/5nfTzs85Dcw==

Formato permitido:Solo permite valores que sean encriptaciones RSA en base 64

Regex:/^[a-zA-Z0-9+/=]+$/

expirationYear

String

Año de Expiración de la tarjeta. ENCRIPTACION RSA

Longitud (min - max): Hasta 344

Ejemplo:WlaonBkoy9/5nfTzs85Dcw==

Formato permitido:Solo permite valores que sean encriptaciones RSA en base 64

Regex:/^[a-zA-Z0-9+/=]+$/

cvc

String

Código de seguridad de la tarjeta indicado en al reverso. ENCRIPTACIÓN RSA

Longitud (min - max): Hasta 344

Ejemplo:UFaenxoryNz6nvfwsM1AcA==

Formato permitido:Solo permite valores que sean encriptaciones RSA en base 64

Regex:/^[a-zA-Z0-9+/=]+$/

token

Object

Objeto de Tokenización, Privada y Marca

cardToken

String

Valor token que identifica la tarjeta del tarjetahabiente.

Longitud (min - max): 0 - 64

Ejemplo:27340718bfdf2de6a125d29ecc6ebf279cc4daf20150aee8a3b4911f02d0ef81

billing

Object

required

Objeto de la Facturación (tarjetahabiente)

firstName

String

required

Nombres del tarjetahabiente.

Longitud (min - max): 2 - 50

Ejemplo:Juan

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también espacios en blanco.

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚüÜ\s]+$/

lastName

String

required

Apellidos del tarjetahabiente.

Longitud (min - max): 2 - 50

Ejemplo:Wick Quispe

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también espacios en blanco.

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚüÜ\s]+$/

email

String

required

Correo electrónico del tarjetahabiente.

Longitud (min - max): 5 - 50

Ejemplo:jwickq@izi.com

phoneNumber

String

required

Teléfono del tarjetahabiente. IMPORTANTE: En caso del método de pago Interbank App, la longitud debe ser de 9 dígitos.

Longitud (min - max): 7 - 15

Ejemplo:958745896

Formato permitido:Solo permite valores que contengan números

Regex:/^[0-9]+$/

street

String

required

Dirección de facturación del tarjetahabiente.

Longitud (min - max): 5 - 40

Ejemplo:Av. Jorge Chávez 275

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también números del 0 al 9, espacios en blanco y una serie de caracteres especiales como - / . ' ´

Regex:/^[a-zA-Z\u00C0-\u017F\u00F1\u00D1\-\/.\-'´`0-9 ]+$/u

city

String

required

Ciudad de la dirección de facturación del tarjetahabiente.

Longitud (min - max): 3 - 25

Ejemplo:Lima

Formato permitido:Solo permite valores que contengan letras, tanto mayúsculas como minúsculas y espacios en blanco.

Regex:/^[A-Za-z\s]*$/

state

String

required

Nombre del departamento o estado de facturación del tarjetahabiente.

Longitud (min - max): 3 - 25

Ejemplo:Lima

Formato permitido:Solo permite valores que contengan letras, tanto mayúsculas como minúsculas y espacios en blanco.

Regex:/^[A-Za-z\s]*$/

country

String

required

País de la dirección de facturación del tarjetahabiente - Código ISO

Longitud (min - max): 2 - 2

Ejemplo:PE

Formato permitido:Solo permite valores que contengan letras, tanto mayúsculas como minúsculas y espacios en blanco.

Regex:/^[A-Za-z\s]*$/

postalCode

String

required

Código Postal (CP) de la dirección de facturación del tarjetahabiente.

Longitud (min - max): 5 - 10

Ejemplo:15038

Formato permitido:Solo permite valores que contengan números

Regex:/^[0-9]+$/

documentType

String

required

Tipo de documento de identidad del tarjetahabiente.

Valores permitidos:DNICEPASAPORTERUCOTROS

Ejemplo:DNI

document

String

required

Número de documento de identidad del tarjetahabiente.

Longitud (min - max):DNI:= 8 caracteres
CE:>=9 caracteres <=12 caracteres
PASAPORTE:>=8 caracteres <=12 caracteres
RUC := 11 caracteres
OTROS:>=8 caracteres <=12 caracteres

Ejemplo:21458796

companyName

String

Razón social o nombre de la compañía.

Longitud (min - max): 2 - 25

Ejemplo:JWick S.A.C.

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también números del 0 al 9, espacios en blanco y una serie de caracteres especiales como & . / , = \

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚ\s&.,\/\-\u00C0-\u017FüÜ0-9]+$/u

shipping

Object

Objeto del envío

firstName

String

Nombres para envío.

Longitud (min - max): 2 - 50

Ejemplo:Daniel

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también espacios en blanco.

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚüÜ\s]+$/

lastName

String

Apellidos para envío.

Longitud (min - max): 2 - 50

Ejemplo:Trejo Tortuga

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también espacios en blanco.

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚüÜ\s]+$/

email

String

Correo electrónico para envío.

Longitud (min - max): 5 - 50

Ejemplo:dtrejo@izi.pe

phoneNumber

Number

Teléfono para envío.

Longitud (min - max): 7 - 15

Ejemplo:985459781

Formato permitido:Solo permite valores que contengan números

Regex:/^[0-9]+$/

street

String

Dirección para envío.

Longitud (min - max): 5 - 40

Ejemplo:Av. Jorge Chávez 275

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también números del 0 al 9, espacios en blanco y una serie de caracteres especiales como - / . ' ´

Regex:/^[a-zA-Z\u00C0-\u017F\u00F1\u00D1\-\/.\-'´`0-9 ]+$/u

city

String

Ciudad de la dirección para envío.

Longitud (min - max): 3 - 25

Ejemplo:Lima

Formato permitido:Solo permite valores que contengan letras, tanto mayúsculas como minúsculas y espacios en blanco.

Regex:/^[A-Za-z\s]*$/

state

String

Nombre del departamento o estado para envío.

Longitud (min - max): 3 - 25

Ejemplo:Lima

Formato permitido:Solo permite valores que contengan letras, tanto mayúsculas como minúsculas y espacios en blanco.

Regex:/^[A-Za-z\s]*$/

country

String

País de la dirección para envío - Código ISO

Longitud (min - max): 2 - 2

Ejemplo:PE

Formato permitido:Solo permite valores que contengan letras, tanto mayúsculas como minúsculas y espacios en blanco.

Regex:/^[A-Za-z\s]*$/

postalCode

String

Código Postal (CP) de la dirección para envío.

Longitud (min - max): 5 - 10

Ejemplo:15038

Formato permitido:Solo permite valores que contengan números

Regex:/^[0-9]+$/

documentType

String

Tipo de documento de identidad para envío

Valores permitidos:DNICEPASAPORTERUCOTROS

Ejemplo:DNI

document

String

Número de documento de identidad para envío

Longitud (min - max):DNI:= 8 caracteres
CE:>=9 caracteres <=12 caracteres
PASAPORTE:>=8 caracteres <=12 caracteres
RUC := 11 caracteres
OTROS:>=8 caracteres <=12 caracteres

Ejemplo:25687469

language

Object

Objeto de Idioma ESP o ENG

init

String

Idioma por defecto del formulario.

Valores permitidos:ESPENG

Ejemplo:ESP

showControlMultiLang

Boolean

Mostrar o no los idiomas disponibles.

Ejemplo:true

render

Object

required

Objeto de presentación del formulario.

typeForm

String

required

Modos de visualización del formulario de pagos: pop-up, embedded y redirect

Valores permitidos:pop-upembeddedredirect

Ejemplo:pop-up

redirectUrls

Object

Objeto de redirección de URL

Este campo es obligatorio solo si el tipo de visualización es Redirect

onSuccess

String

URL a donde redireccionará cuando el proceso de pago se complete exitosamente.

Este dato es obligatorio cuando el tipo de visualización es Redirect.

Longitud (min - max): 5 - 400

Ejemplo:https//www.tu-web.com/onSuccess/

onError

String

URL a donde redireccionará cuando ocurra un error al procesar el pago.

Longitud (min - max): 5 - 400

Ejemplo:https//www.tu-web.com/onError/

onCancel

String

URL a donde redireccionará cuando el proceso de pago sea cancelado.

Longitud (min - max): 5 - 400

Ejemplo:https//www.tu-web.com/onCancel/

container

String

div, section, etc. Lugar donde se renderizará el formulario - solo aplica para embebido.

Longitud (min - max): 2 - 50

showButtonProcessForm

Boolean

Mostrar u ocultar el botón que procesará los datos del formulario. funcionalidad disponible por ahora solo para el método de pago tarjeta en la modalidad de Embebido.

urlRedirect

String

Url de respuesta o redireccionamiento después de recibir una respuesta. Este campo es obligatorio cuando render.typeform es REDIRECT

Longitud (min - max): 5 - 400

urlIPN

String

Url o API de notificación (IPN)

Longitud (min - max): 5 - 400

Ejemplo:https//www.tu-web.com/notificaciones/

appearance

Object

Objeto de apariencia del formulario.

styleInput

String

Estilo de los inputs en el formulario de pago.

Longitud (min - max): 5 -20

logo

String

Url del logo del comercio

La imagen debe estar en formato JPG, PNG y SVG, con un tamaño que no exceda los 100 KB y dimensiones recomendadas de 20x20 píxeles.

Longitud (min - max): 10 - 200

Ejemplo:https://www.miweb.com/logo

theme

String

Nombre del tema que contiene una configuración de colores para el formulario.

Valores permitidos:redlightredgreenpurpleblackblueligthgreen

Ejemplo:red

customTheme

Object

Objeto de tema personalizado.

name

String

Nombre del tema que contiene una configuración de colores para el formulario.

Longitud (min - max): 3 - 20

Ejemplo:Tema principal

font

String

Nombre de la fuente a usar para el formulario.

Longitud (min - max): 3 - 60

isModeAdvance

Boolean

Activación de modo avanzado de la personalización del checkout.

Este campo es requerido únicamente en el contexto de aplicar una configuración avanzada en la personalización del proceso del checkout.

Ejemplo:true

colors

Object

Objeto de colores.

backgroundColor

String

Color de fondo de los elementos.

Longitud (min - max): 3 - 60

textColor

String

Color de texto de los elementos.

Longitud (min - max): 3 - 60

primary

Object

Objeto de color primario.

background

String

Color de fondo de los elementos.

Longitud (min - max): 3 - 60

color

String

Color del texto de los elementos.

Longitud (min - max): 3 - 60

button

Object

Objeto de estilos del botón.

primary

Object

Objeto de estilos del botón primario.

color

String

Color del texto de los elementos.

Longitud (min - max): 3 - 60

background

String

Color del fondo de los elementos.

Longitud (min - max): 3 - 60

mainColor

String

Color principal

Longitud (min - max): 3 - 60

activeColor

String

Color cuando el elemento tenga foco o esté activo.

Longitud (min - max): 3 - 60

select

Object

Objeto de estilos del select.

primary

Object

Objeto de estilos del select primario.

color

String

Color del texto de los elementos.

Longitud (min - max): 3 - 60

borderColor

String

Color del borde de los elementos.

Longitud (min - max): 3 - 60

arrow

Object

Objeto de estilos de la flecha del select primario.

down

String

Color de las flechas del select.

Longitud (min - max): 3 - 60

up

String

Color de las flechas del select.

Longitud (min - max): 3 - 60

boxShadow

String

Color del efecto de los bordes del elemento.

Longitud (min - max): 3 - 60

text

Object

Objeto de estilos del texto.

color

String

Color del texto de los elementos.

Longitud (min - max): 3 - 60

input

Object

Objeto de estilos de los elementos.

color

String

Color del texto de los elementos.

Longitud (min - max): 3 - 60

borderColor

String

Color del borde de los elementos.

Longitud (min - max): 3 - 60

boxShadow

String

Color del efecto de los bordes del elemento.

Longitud (min - max): 3 - 60

customize

Object

Objeto para personalizar el formulario.

Revisa todas las opciones disponibles

visibility

Object

Objeto que contiene la configuración de visibilidad de algunos elementos del formulario.

hideOrderNumber

Boolean

Indica si se debe ocultar el número de pedido.

Consideraciones: hideOrderNumber y hideLogo ocultarán la cabecera del formulario.

Ejemplo:true

hideResultScreen

Boolean

Indica si se debe ocultar la pantalla de resultados.

Ejemplo:false

Revisa todas las opciones disponibles

hideLogo

Boolean

Indica si se debe ocultar el logo.

Ejemplo:true

hideShakeValidation

Boolean

Indica si se debe desactivar la vibración al validar los campos.

Ejemplo:false

hideGlobalErrors

Boolean

Indica si se deben ocultar los errores globales, para que los errores se muestren en cada campo.

Ejemplo:true

Revisa todas las opciones disponibles

hideMessageActivateOnlinePurchases

String

Indica si se debe ocultar el mensaje de: Recuerda activar tus compras por internet.

Ejemplo:true

elements

Arreglo de objetos

Arreglo de objetos que define la configuración de cada elemento del formulario.

Ejemplo:[{...},{...},]

paymentMethod

String

Método de pago al que se aplica la configuración.

Valores permitidos:CARDQRAPPLE_PAYYAPE_CODEPAGO_PUSH

Ejemplo:CARD

order

Number

Posición del elemento en el formulario.

Ejemplo:1

Formato permitido:Solo permite valores que contengan números

Regex:/^[0-9]+$/

Revisa todas las opciones disponibles

fields

Arreglo de objetos

Arreglo de objetos que define la configuración de cada campo del elemento.

Ejemplo:[{...},{...},]

name

String

Nombre del campo.

Valores permitidos:cardNumberexpirationDatesecurityCodefirstNamelastNameemailtypeDocumentdocumentNumberinstallmentsdeferred

Ejemplo:cardNumber

Formato permitido:Solo permite valores que contengan letras, tanto mayúsculas como minúsculas y espacios en blanco.

Regex:/^[A-Za-z\s]*$/

order

Número

Posición del campo en el elemento.

Ejemplo:1

Formato permitido:Solo permite valores que contengan números

Regex:/^[0-9]+$/

Revisa todas las opciones disponibles

visible

Boolean

Mostrar/Ocultar el campo en el elemento.

Ejemplo:true

Revisa todas las opciones disponibles

groupName

String

Nombre del grupo de inputs/campos en el elemento.

Máximo de agrupamientos por fila: 2 campos.

Ejemplo:billing

Formato permitido:Solo permite valores que contengan letras, tanto mayúsculas como minúsculas y espacios en blanco.

Regex:/^[A-Za-z\s]*$/

changeButtonText

Object

Objeto que define el texto del botón.

actionPay

String

Atributo que define el texto del botón de acción de pago.

Valores permitidos:PagarAceptar pagarPague aquíCobrarComprarContinuarContribuirConfirmar PagoDonarEfectuar PagoRecargar

Ejemplo:Donar

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también espacios en blanco.

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚüÜ\s]+$/

Revisa todas las opciones disponibles

customFields

Objeto flexible que permite agregar campos adicionales al proceso de pago, para satisfacer las necesidades específicas de cada comercio. Máximo 10 campos adicionales.

field1

String

Campo libre donde el comercio podrá enviar el dato que crea conveniente.

Longitud (min - max): 1 - 100

Ejemplo:categoría

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también números del 0 al 9, espacios en blanco y una serie de caracteres especiales como & . / , = \

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚ\s&.,\/\-\u00C0-\u017FüÜ0-9]+$/u

field2

String

Campo libre donde el comercio podrá enviar el dato que crea conveniente.

Longitud (min - max): 1 - 100

Ejemplo:ropa

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también números del 0 al 9, espacios en blanco y una serie de caracteres especiales como & . / , = \

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚ\s&.,\/\-\u00C0-\u017FüÜ0-9]+$/u

field3

String

Campo libre donde el comercio podrá enviar el dato que crea conveniente.

Longitud (min - max): 1 - 100

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también números del 0 al 9, espacios en blanco y una serie de caracteres especiales como & . / , = \

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚ\s&.,\/\-\u00C0-\u017FüÜ0-9]+$/u

field4

String

Campo libre donde el comercio podrá enviar el dato que crea conveniente.

Longitud (min - max): 1 - 100

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también números del 0 al 9, espacios en blanco y una serie de caracteres especiales como & . / , = \

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚ\s&.,\/\-\u00C0-\u017FüÜ0-9]+$/u

field5

String

Campo libre donde el comercio podrá enviar el dato que crea conveniente.

Longitud (min - max): 1 - 100

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también números del 0 al 9, espacios en blanco y una serie de caracteres especiales como & . / , = \

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚ\s&.,\/\-\u00C0-\u017FüÜ0-9]+$/u

field6

String

Campo libre donde el comercio podrá enviar el dato que crea conveniente.

Longitud (min - max): 1 - 100

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también números del 0 al 9, espacios en blanco y una serie de caracteres especiales como & . / , = \

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚ\s&.,\/\-\u00C0-\u017FüÜ0-9]+$/u

field7

String

Campo libre donde el comercio podrá enviar el dato que crea conveniente.

Longitud (min - max): 1 - 100

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también números del 0 al 9, espacios en blanco y una serie de caracteres especiales como & . / , = \

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚ\s&.,\/\-\u00C0-\u017FüÜ0-9]+$/u

field8

String

Campo libre donde el comercio podrá enviar el dato que crea conveniente.

Longitud (min - max): 1 - 100

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también números del 0 al 9, espacios en blanco y una serie de caracteres especiales como & . / , = \

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚ\s&.,\/\-\u00C0-\u017FüÜ0-9]+$/u

field9

String

Campo libre donde el comercio podrá enviar el dato que crea conveniente.

Longitud (min - max): 1 - 100

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también números del 0 al 9, espacios en blanco y una serie de caracteres especiales como & . / , = \

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚ\s&.,\/\-\u00C0-\u017FüÜ0-9]+$/u

field10

String

Campo libre donde el comercio podrá enviar el dato que crea conveniente.

Longitud (min - max): 1 - 100

Formato permitido:Solo permite valores que contengan letras, ya sean mayúsculas o minúsculas, incluyendo letras acentuadas y la "ñ", así como también números del 0 al 9, espacios en blanco y una serie de caracteres especiales como & . / , = \

Regex:/^[a-zA-ZñÑáéíóúÁÉÍÓÚ\s&.,\/\-\u00C0-\u017FüÜ0-9]+$/u

• Datos de salidas: Los datos de salida que responde el SDK expresan la obligatoriedad en general. para revisar que campos son obligatorios según el caso de uso, consulta el capítulo casos de uso.

El objeto response está compuesto por los siguientes atributos:

code

String

required

Código de respuesta de la autorización

Longitud (min - max): 2 - 3

Ejemplo:00

message

String

required

Mensaje de respuesta de la autorización, de acuerdo al lenguaje

Longitud (min - max): 5 - 30

Ejemplo:OK

messageUser

String

required

Mensaje amigable para el usuario, de acuerdo al lenguaje

Longitud (min - max): 5 - 50

Ejemplo:Operación exitosa

messageUserEng

String

required

Mensaje amigable para el usuario en inglés

Longitud (min - max): 5 - 50

Ejemplo:Successful

response

Object

required

Objeto de datos de respuesta

payMethod

String

required

Indicador del método de pago de la compra

Valores permitidos:CARDQRAPPLE_PAYYAPE_CODEPAGO_PUSH

Ejemplo:CARD

order

Array[{Object}]

required

Array de Objetos Order

payMethodAuthorization

String

required

Indicador del método de pago de la orden:

Valores permitidos:CARDQRAPPLE_PAYYAPE_CODEPAGO_PUSH

Ejemplo:CARD

codeAuth

String

required

Código de Autorizacion de la compra generada por el emisor de la tarjeta

Longitud (min - max): 0 - 10

Ejemplo:S62316

currency

String

required

Moneda de la transacción.

Valores permitidos:PENUSD

Ejemplo:PEN

amount

String

required

Monto de la Txn. Enteros con 2 decimales, considerar separador decimal sin delimitador de miles

Longitud (min - max): 4 - 13

Ejemplo:10.00

installments

String

Número de Cuotas que afectarán a la compra.

Longitud (min - max): 2 - 2

Ejemplo:06

deferred

String

Número Diferido que afectará a la compras.

Longitud (min - max): 1 - 1

Ejemplo:0

orderNumber

String

required

Número de Pedido de la transacción de compra, enviada en el api security (Token Session).

Longitud (min - max): 5 - 15

Ejemplo:1687996765

stateMessage

String

required

Mensaje del estado de la transacción (Autorizado/Denegado).

Ejemplo:Autorizado

dateTransaction

String

required

Fecha de la transacción (fechatxn guardada en tabla transacciones) Formato yyyymmdd.

Longitud (min - max): 8 - 8

Ejemplo:20221212

timeTransaction

String

required

Hora de la transacción (fechatxn guardada en tabla transacciones) Formato hhmmss.

Longitud (min - max): 6 - 6

Ejemplo:185330

uniqueId

String

Indentificador de la transacción realizado por Izipay o Cybersource.

Longitud (min - max): 0 - 20

Ejemplo:1011173920740022

referenceNumber

String

Número de referencia generada por el adquiriente. Este dato es importante para la solicitud del refund(devoluciones)

Longitud (min - max): 0 - 7

Ejemplo:1315646

card

Object

required

Objeto con los datos de la tarjeta

brand

String

required

Marca de la tarjeta

Valores permitidos

• MC: MasterCard
• VS: Visa
• AE: Amex
• DN: Diners

Ejemplo:VS

pan

String

required

Número de tarjeta enmascarado utilizado en la transacción

Longitud (min - max): 12 - 19

Ejemplo:411111******1111

save

Boolean

Identificador si se registró la tarjeta en la operación

Ejemplo:true

billing

Object

required

Objeto de la Facturación (tarjetahabiente)

firstName

String

required

Nombres del tarjetahabiente

Longitud (min - max): 2 - 50

Ejemplo:Juan

lastName

String

required

Apellidos del tarjetahabiente

Longitud (min - max): 2 - 50

Ejemplo:Wick Quispe

email

String

required

Correo electrónico del tarjetahabiente

Longitud (min - max): 5 - 50

Ejemplo:jwickq@izi.com

phoneNumber

String

required

Teléfono del tarjetahabiente

Longitud (min - max): 7 - 15

Ejemplo:958745896

street

String

required

Dirección de facturación del tarjetahabiente

Longitud (min - max): 5 - 40

Ejemplo:Av. Jorge Chávez 275

city

String

required

Ciudad de la dirección de facturación del tarjetahabiente

Longitud (min - max): 3 - 25

Ejemplo:Lima

state

String

required

Nombre del departamento o estado de facturación del tarjetahabiente

Longitud (min - max): 3 - 25

Ejemplo:Lima

country

String

required

País de la dirección de facturación del tarjetahabiente - Codigo ISO.

Longitud (min - max): 2 - 2

Ejemplo:PE

postalCode

String

required

Código Postal (CP) de la dirección de facturación del tarjetahabiente.

Longitud (min - max): 5 - 10

Ejemplo:15038

documentType

String

required

Tipo de documento de identidad del tarjetahabiente

Valores permitidos:DNICEPASAPORTERUCOTROS

Ejemplo:DNI

document

String

required

Número de documento de identidad del tarjetahabiente.

Longitud (min - max):DNI:= 8 caracteres
CE:>=9 caracteres <=12 caracteres
PASAPORTE:>=8 caracteres <=12 caracteres
RUC := 11 caracteres
OTROS:>=8 caracteres <=12 caracteres

Ejemplo:21458796

companyName

String

Razón social o nombre de la compañía.

Longitud (min - max): 2 - 25

merchant

Object

required

Objeto de datos del comercio

merchantCode

String

required

Codigo del comercio ó submerchant(codigo hijo del merchantFacilitator), generado por Izipay durante la afiliación.

Longitud (min - max): 7 - 15

Ejemplo:4001834

facilitatorCode

String

Código de comercio facilitador, generado por Izipay durante la afilación.

Longitud (min - max): 7 - 15

Ejemplo:''

token

Object

Objeto de Tokenizacion, Privada y Marca.

merchantBuyerId

String

Identificador único del comprador en el sistema del comercio.

Longitud (min - max): 6 - 100

Ejemplo:MC240813110946H8D7HF

cardToken

String

Valor token que identifica la tarjeta del tarjetahabiente.

Longitud (min - max): 0 - 64

Ejemplo:''

alias

String

Alias de tarjeta.

Longitud (min - max): 0 - 20

Ejemplo:''

authentication

Object

Objeto de autenticación.

result

String

Resultado de la autenticación.

Ejemplo:''

customFields

Array[{String}]

Array de Strings

payloadHttp

String

required

Mensaje original de respuesta que se utiliza para la generación de la firma.

Ejemplo:{"code":"00","message":"OK"…..}

signature

String

required

Es el hash del payload del request expresando en una cadena de un valor en base64.

Ejemplo:QBY3s3RRMwHqFmF93lhRTTqrjcuolsVBCUnDFXniKY8=

transactionId

String

required

Id único por cada transacción generada por el comercio, enviada en el api security (Token Session) equivalente al Id de Correlación para el flujo de la transacción.

Longitud (min - max): 5 - 40

Ejemplo:172356538519500