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.

• 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, …)

enviroment

String

required

Campo que permite cambiar los endpoints que consume la librería.

Valores permitidos:TESTSBOXPROD

Ejemplo:TEST

publickey

String

required

Es la “Clave API Nuevo Botón de Pagos” obtenida desde la plataforma de BackOffice de Comercio de Punto Web

Longitud (min - max): 0 - 50

Ejemplo:VErethUtraQuxas57wuMuquprADrAHAb

transactionId

String

required

Identificador único de la operación generado por el comercio

Longitud (min - max): 5 -40

Ejemplo:16868479028040

action

String

required

Indicador que determina la forma de la compra, 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 de Izipay (tokens obtenidos en los action register y pay_register)

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

facilitatorCode

String

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

Longitud (min - max): 7 - 15

Ejemplo:4000901

order

Object

required

Objeto de compra

orderNumber

String

required

Número de Pedido de la transacción de compra

Longitud (min - max): 5 - 15

Ejemplo:1687996765

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

payMethod

Array <Enum: PayOption>

required

Listado de indicadores de método de pago de la compra

Valores permitidos:PayOption.CARDPayOption.YAPE

Ejemplo:PayOption.CARD

processType

String

required

Tipo de Proceso para una transacción.

Valores permitidos:autorizepreauthorize

Ejemplo:autorize

merchantBuyerId

String

required

Identificador UNICO del comprador en el sistema del comercio.

Longitud (min - max): 6 - 100

Ejemplo:mc1991

dateTimeTransaction

String

required

Fecha de la transacción enviado por el comercio o terminal en formato timestamp.

Longitud (min - max): 16 - 16

Ejemplo:1688149430031000

token

Object

Objeto con información de tarjeta tokenizada. Es Obligatorio solo cuando action=pay_token

cardToken

String

Valor token que identifica la tarjeta del tarjetahabiente. Es Obligatorio solo cuando action=pay_token

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

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. Si el campo billing.country es US o CA (Estados Unidos o Canada) respeta la regla de formato 2 caracteres. Ejemplo: California = CA

Longitud (min - max): 3 - 25

Ejemplo:Lima

country

String

required

País de la dirección de facturación del tarjetahabiente - Código ISO de 2 caracteres. Ejemplo: Perú = PE

Longitud (min - max): 2 - 2

Ejemplo:PE

postalCode

String

required

Código Postal (CP) de la dirección de facturación del tarjetahabiente. Si el campo billing.country es “US”(Estados Unidos) respeta las siguientes reglas de formato de 5 caracteres (NNNNN) o 9 caracteres (NNNNN-NNNN)Si el campo billing.country es “CA”(Canada), respeta la siguiente regla de formato 6 caracteres (ANA NAN). Donde N = Numerico y A = alfanumerico

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

shipping

Object

Objeto del envío

firtsName

String

Nombres para envío

Longitud (min - max): 2 - 50

Ejemplo:Daniel

lastName

String

Apellidos para envío

Longitud (min - max): 2 - 50

Ejemplo:Trejo Tortuga

email

String

Correo electrónico para envío

Longitud (min - max): 5 - 50

Ejemplo:dtrejott@izi.pe

phoneNumber

String

Teléfono para envío

Longitud (min - max): 7 - 15

Ejemplo:985459781

street

String

Dirección para envío

Longitud (min - max): 5 - 40

Ejemplo:Av. Jorge Chávez 275

city

String

Ciudad de la dirección para envío

Longitud (min - max): 3 - 25

Ejemplo:Lima

state

String

Nombre del departamento o estado de facturación del tarjetahabiente. Si el campo billing.country es US o CA (Estados Unidos o Canada) respeta la regla de formato 2 caracteres. Ejemplo: California = CA

Longitud (min - max): 3 - 25

Ejemplo:Lima

country

String

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

Longitud (min - max): 2 - 2

Ejemplo:PE

postalCode

String

Código Postal (CP) de la dirección de facturación del tarjetahabiente. Si el campo billing.country es “US”(Estados Unidos) respeta las siguientes reglas de formato de 5 caracteres (NNNNN) o 9 caracteres (NNNNN-NNNN)Si el campo billing.country es “CA”(Canada), respeta la siguiente regla de formato 6 caracteres (ANA NAN). Donde N = Numerico y A = alfanumerico

Longitud (min - max): 5 - 10

Ejemplo:15038

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:21458796

urlIPN

String

URL del API de notificación del comercio (IPN).

Longitud (min - max): 5 - 400

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

appearance

Object

required

Objeto de apariencia del formulario.

language

String

Idioma por defecto del formulario. Valor por defecto ESP (español)

Valores permitidos:ESPENG

Ejemplo:ESP

formControls

Object

Objeto con configuraciones de controles

isAmounLabelVisible

Boolean

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

Ejemplo:false

isLangControlVisible

Boolean

Mostrar o no los idiomas disponibles | ESP, ENG

Ejemplo:true

theme

string

Temas preestablecidos: “green", "red", "black"

Valores permitidos:redlightredgreenpurpleblackblueligthgreen

Ejemplo:red

customTheme

Object

Objeto para customización de controles

payButtonBackgroundColor

String

Color que se desea dar al botón de pagar, valor en hexadecimal con #

Longitud (min - max): 3 - 60

Ejemplo:#FFFFFF

textInputBorderColor

String

Color que se desea dar al borde de los campos input, valor en hexadecimal con #

Longitud (min - max): 3 - 60

Ejemplo:#F3F3F3

textInputPlaceholderTextColor

String

Color que se desea dar al placeholder de los campos input, valor en hexadecimal con #

Longitud (min - max): 3 - 60

Ejemplo:#F1F1F1

logo

String

URL de logo del comercio

Longitud (min - max): 10 - 200

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

visualSettings

Object

required

Objeto que define el comportamiento del SDK y algunos elemento visuales dentro de el.

showResultScreen

Boolean

Visualizar la pantalla de resultado de la operación/pago, valor por defecto true.

Ejemplo:true

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

Datos de salida para versiones del SDK Android

SDK 1.3.0+

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:Ok

messageUserEng

String

required

Mensaje amigable para el usuario en inglés

Longitud (min - max): 5 - 50

Ejemplo:Ok

response

Object

required

Objeto de datos de respuesta

payMethod

String

required

Indicador del método de pago de la compra

Valores permitidos:CARDYAPE_CODE

Ejemplo:CARD

order

Array[{Object}]

required

Array de Objetos Order

payMethodAuthorization

String

required

Indicador del método de pago de la orden:

Valores permitidos:CARDYAPE_CODE

Ejemplo:CARD

codeAuth

String

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

Longitud (min - max): 0 - 10

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:10

deferred

String

Número Diferido que afectará a la compras.

Longitud (min - max): 1 - 1

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

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

Tipo de 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

facilitatorCode

String

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

Longitud (min - max): 7 - 15

token

Object

Objeto de Tokenizacion, Privada y Marca.

merchantBuyerId

String

Identificador único del comprador en el sistema del comercio.

Longitud (min - max): 6 - 100

cardToken

String

Valor token que identifica la tarjeta del tarjetahabiente.

Longitud (min - max): 0 - 64

alias

String

Alias de tarjeta.

Longitud (min - max): 0 - 20

authentication

Object

Objeto de autenticación.

result

String

Resultado de la autenticación.

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:b166214e976c7e76390889

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:16881500822750

SDK 1.2.2- (deprecada)

code

String

required

Código de respuesta

Longitud (min - max): 2 - 3

Ejemplo:00

message

String

required

Mensaje de respuesta

Longitud (min - max): 5 - 30

Ejemplo:Ok

messageUser

String

Mensaje amigable para el usuario

Longitud (min - max): 5 - 50

Ejemplo:Ok

messageUserEng

String

Mensaje amigable para el usuario en inglés

Longitud (min - max): 5 - 50

Ejemplo:Ok

response

Object

required

Objeto de datos de respuesta

payMethod

String

required

Indicadores de los métodos de pago separados por coma, si se envía un solo método no añadir coma.

Valores permitidos:CARD

Ejemplo:CARD

currency

String

required

Moneda de la transacción.

Valores permitidos:PENUSD

Ejemplo:PEN

amount

String

required

Monto de la Txn. Enteros con 2 decimales

Longitud (min - max): 4 - 13

Ejemplo:10.00

orderNumber

String

required

Número de Pedido de la transacción de compra.

Longitud (min - max): 5 - 15

Ejemplo:1687996765

merchantCode

String

required

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

Longitud (min - max): 7 - 15

timeTransaction

String

required

Hora de la transacción

Longitud (min - max): 6 - 6

Ejemplo:185330

dateTransaction

String

required

Fecha de la transacción

Longitud (min - max): 8 - 8

Ejemplo:20221212

uniqueId

String

Identificador de la transacción realizado por Izipay o Cybersource. Incluido solo en las respuestas de las autorizaciones de pagos.

Longitud (min - max): 0 - 40

Ejemplo:1011173920740022

codeAuth

String

Código de autorización emitido por el banco

Longitud (min - max): 2 - 50

Ejemplo:AB123

signature

String

Firma de la transacción

Longitud (min - max): 5 - 100

Ejemplo:b166214e976c7e76390889

referenceNumber

String

Número de referencia de la transacción

Longitud (min - max): 1 - 20

Ejemplo:1315646

payloadHttp

String

Datos enviados por el servicio de autorización al SDK. No se recomienda su almacenamiento pues es un valor extenso de longitud variable.

Longitud (min - max): Variable

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

card

String

required

Objeto con los datos de la tarjeta

Longitud (min - max): 2 - 50

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): 5 - 25

Ejemplo:411111******1111

save

Boolean

Indicador de si la tarjeta fue guardada

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

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

tokenization

Object

Objeto con datos de la tarjeta tokenizada

cardToken

String

Valor token que identifica la tarjeta del tarjetahabiente

Longitud (min - max): 0 - 64

Ejemplo:27340718bfdf2de6a125d29ecc6ebf279cc4daf20150aee8a3b4911f02d0ef81