Parameters definition

By using the config object with this input data in the SDK integration, ensures an accurate and complete flow of information, allowing to interact efficiently with the functionalities and services provided by the SDK. the functionalities and services provided by the SDK. It is important to follow the specific guidelines and recommendations provided by the SDK documentation to ensure a correct use of this input data. The config object stores information related to the transaction, as well as data related to the form appearance.

• Input data: The config object is composed of the following attributes:

config

Object

required

Configuration object, contains the other objects (order, token, billing, ...).

transactionId

String

required

Unique id for each transaction generated by the commerce. It must be the same as the one sent when generating the session token.

Length (min - max): 5 - 40

Example:16881500822750

Allowed format:Only values containing numbers and letters are allowed, whether uppercase or lowercase, without spaces or special characters.

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

action

String

required

Indicator that determines the form of the purchase, accepts the following values: pay: Purchases with card (without tokenization), register: card registration (tokenization), pay_register: Purchases and card registration, pay_token: Purchases with card token (Private or Brand).

Allowed values:payregisterpay_registerpay_token

Example:pay

merchantCode

String

required

Commerce code or submerchant (child code of the merchantFacilitator), generated by Izipay during affiliation.

Length (min - max): 7 - 15

Example:4001834

Allowed format:Only allows values containing letters, both uppercase and lowercase, and spaces.

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

facilitatorCode

String

Facilitator commerce code, generated by Izipay during affiliation.

Length (min - max): 7 - 15

Example:4000901

Allowed format:Only allows values containing letters, both uppercase and lowercase, and spaces.

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

order

Object

required

Purchase object

orderNumber

String

required

Order number of the transaction. It must be the same as the one sent when generating the session token.

Length (min - max): 5 - 15

Example:1687996765

showAmount

Boolean

Displays the amount on the "Pay" button of the payment form.

currency

String

required

Currency of the transaction.

Allowed values:PENUSD

Example:PEN

amount

Decimal

required

Txn amount. It must be the same as the one sent when generating the session token. Integers with 2 decimals, consider decimal separator without thousands delimiter.

Length (min - max): 4 - 13

installments

Number

Number of Installments that will affect the purchase.

Length (min - max): 2 - 2

Example:00

deferred

Number

Deferred number that will affect the purchase.

Length (min - max): 1

Example:0

payMethod

String

Indicator of the payment method of the purchase, in case it is more than one, separate by comma.

Allowed values:allCARDQRAPPLE_PAYYAPE_CODEPAGO_PUSH

Example:CARD,QR,APPLE_PAY

processType

String

required

Process Type for a transaction AT: Authorization PA: Pre-Authorization.

Allowed values:ATPA

Example:AT

merchantBuyerId

String

required

Unique identifier of the buyer in the commerce system.

Length (min - max): 6 - 100

Example:mc1991

dateTimeTransaction

Datetime

required

Date and Time of the transaction sent by the commerce or terminal.

Length (min - max): 16 - 16

Example:1688149430031000

Allowed format:Only allows values containing numbers

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

card

Object

Object where card data is sent.

brand

String

Allowed values

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

Example:VS

pan

String

Card number of the cardholder.

Length (min - max): Hasta 344

Example:XVGRpy8X/OHHo8jPi/V6TEm+BQxY8o9cixbClcaCxgA=

Allowed format:Only allows values that are RSA encryptions in base 64

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

expirationMonth

String

Card expiration month. RSA ENCRYPTION

Length (min - max): Hasta 344

Example:WFSonBkoy9/5nfTzs85Dcw==

Allowed format:Only allows values that are RSA encryptions in base 64

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

expirationYear

String

Card expiration year. RSA ENCRYPTION

Length (min - max): Hasta 344

Example:WlaonBkoy9/5nfTzs85Dcw==

Allowed format:Only allows values that are RSA encryptions in base 64

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

cvc

String

Card security code indicated on the back. RSA ENCRYPTION

Length (min - max): Hasta 344

Example:UFaenxoryNz6nvfwsM1AcA==

Allowed format:Only allows values that are RSA encryptions in base 64

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

token

Object

Tokenization, Private and Brand object

cardToken

String

Token value that identifies the card of the cardholder.

Length (min - max): 0 - 64

Example:27340718bfdf2de6a125d29ecc6ebf279cc4daf20150aee8a3b4911f02d0ef81

billing

Object

required

Billing object (cardholder)

firstName

String

required

Cardholder's first name

Length (min - max): 2 - 50

Example:Lucho

Allowed format:Only allows values containing letters, whether uppercase or lowercase, including accented letters and the "ñ", as well as white spaces.

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

lastName

String

required

Cardholder's last name

Length (min - max): 2 - 50

Example:Torres

Allowed format:Only allows values containing letters, whether uppercase or lowercase, including accented letters and the "ñ", as well as white spaces.

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

email

String

required

Cardholder's email.

Length (min - max): 5 - 50

Example:luchotorres@gmail.com

phoneNumber

String

required

Cardholder's phone number. IMPORTANT: In case of the Plin Interbank payment method, the length must be 9 digits.

Length (min - max): 7 - 15

Example:989897960

Allowed format:Only allows values containing numbers

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

street

String

required

Cardholder's billing address.

Length (min - max): 5 - 40

Example:Av. Jorge Chávez 275

Allowed format:Only allows values containing letters, whether uppercase or lowercase, including accented letters and the "ñ", as well as numbers from 0 to 9, white spaces and a series of special characters such as - / . ' ´

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

city

String

required

City of the cardholder's billing address.

Length (min - max): 3 - 25

Example:Lima

Allowed format:Only allows values containing letters, both uppercase and lowercase, and spaces.

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

state

String

required

Name of the department or state of cardholder billing.

Length (min - max): 3 - 25

Example:Lima

Allowed format:Only allows values containing letters, both uppercase and lowercase, and spaces.

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

country

String

required

Country of the cardholder billing address - ISO code

Length (min - max): 2 - 2

Example:PE

Allowed format:Only allows values containing letters, both uppercase and lowercase, and spaces.

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

postalCode

String

required

Postal Code (CP) of the cardholder billing address

Length (min - max): 5 - 10

Example:15000

Allowed format:Only allows values containing numbers

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

documentType

String

required

Cardholder's identification document type

Allowed values:DNICEPASAPORTERUCOTROS

Example:DNI

document

String

required

Cardholder's identity document number.

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

Example:12345678

companyName

String

Social reason or company name.

Length (min - max): 2 - 25

Example:Society S.A.C.

Allowed format:It only allows values containing letters (including uppercase, lowercase, vowels with accents such as á, é, í, ó, ú, ñ and ü), numbers, spaces and the following special characters: spot (.), commas (,), hyphens (-), diagonals (/) and the symbol "&". It also supports accented letters from other European languages such as à, è or ö.

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

shipping

Object

Shipping object

firstName

String

Names for shipping.

Length (min - max): 2 - 50

Example:Juan

Allowed format:Only allows values containing letters, whether uppercase or lowercase, including accented letters and the "ñ", as well as white spaces.

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

lastName

String

Last names for shipping.

Length (min - max): 2 - 50

Example:Pérez

Allowed format:Only allows values containing letters, whether uppercase or lowercase, including accented letters and the "ñ", as well as white spaces.

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

email

String

Email for shipping.

Length (min - max): 5 - 50

Example:juanperez@gmail.com

phoneNumber

Number

Phone for shipping.

Length (min - max): 7 - 15

Example:989897960

Allowed format:Only allows values containing numbers

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

street

String

Shipping address.

Length (min - max): 5 - 40

Example:Av. Jorge Chávez 275

Allowed format:Only allows values containing letters, whether uppercase or lowercase, including accented letters and the "ñ", as well as numbers from 0 to 9, white spaces and a series of special characters such as - / . ' ´

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

city

String

City of the shipping address.

Length (min - max): 3 - 25

Example:Lima

Allowed format:Only allows values containing letters, both uppercase and lowercase, and spaces.

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

state

String

Name of the department or state for shipping.

Length (min - max): 3 - 25

Example:Lima

Allowed format:Only allows values containing letters, both uppercase and lowercase, and spaces.

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

country

String

Country of the shipping address - ISO code

Length (min - max): 2 - 2

Example:PE

Allowed format:Only allows values containing letters, both uppercase and lowercase, and spaces.

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

postalCode

String

Postal Code (CP) of the shipping address.

Length (min - max): 5 - 10

Example:15000

Allowed format:Only allows values containing numbers

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

documentType

String

Type of identification document for shipping

Allowed values:DNICEPASAPORTERUCOTROS

Example:DNI

document

String

Number of identification document for shipping

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

Example:12345679

language

Object

Language object ESP or ENG

init

String

Default language of the form.

Allowed values:ESPENG

Example:ESP

showControlMultiLang

Boolean

Show or not the available languages.

Example:true

render

Object

required

Object of presentation of the form.

typeForm

String

required

Modes of visualization of the payment form: pop-up, embedded and redirect

Allowed values:pop-upembeddedredirect

Example:pop-up

redirectUrls

Object

URL redirection object

This field is mandatory only if the display type is Redirect

onSuccess

String

URL to where it will redirect when the payment process is successfully completed.

This data is mandatory when the display type is Redirect.

Length (min - max): 5 - 400

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

onError

String

URL to where it will redirect when an error occurs while processing the payment.

Length (min - max): 5 - 400

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

onCancel

String

URL to where it will redirect when the payment process is canceled.

Length (min - max): 5 - 400

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

container

String

div, section, etc. Place where the form will be rendered - only applies to embedded.

Length (min - max): 2 - 50

showButtonProcessForm

Boolean

Show or hide the button that will process the form data. functionality available for now only for the card payment method in the Embedded mode.

urlRedirect

String

Response or redirection URL after receiving a response. This field is mandatory when render.typeform is REDIRECT

Length (min - max): 5 - 400

urlIPN

String

Notification URL or API (IPN)

Length (min - max): 5 - 400

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

appearance

Object

Form appearance object.

styleInput

String

Style of the inputs in the payment form.

Length (min - max): 5 -20

logo

String

Commerce logo URL

The image must be in JPG, PNG and SVG format, with a size that does not exceed 100 KB and recommended dimensions of 20x20 pixels.

Length (min - max): 10 - 200

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

theme

String

Name of the theme that contains a color configuration for the form.

Allowed values:redlightredgreenpurpleblackblueligthgreen

Example:red

customTheme

Object

Custom theme object.

name

String

Name of the theme that contains a color configuration for the form.

Length (min - max): 3 - 20

Example:Tema principal

font

String

Name of the font to use for the form.

Length (min - max): 3 - 60

isModeAdvance

Boolean

Activation of advanced mode of checkout customization.

This field is required only in the context of applying an advanced configuration in the customization of the checkout process.

Example:true

colors

Object

Color object.

backgroundColor

String

Background color of the elements.

Length (min - max): 3 - 60

textColor

String

Color of text of the elements.

Length (min - max): 3 - 60

primary

Object

Primary color object.

background

String

Background color of the elements.

Length (min - max): 3 - 60

color

String

Color of text of the elements.

Length (min - max): 3 - 60

button

Object

Button style object.

primary

Object

Primary button style object.

color

String

Color of text of the elements.

Length (min - max): 3 - 60

background

String

Color of the background of the elements.

Length (min - max): 3 - 60

mainColor

String

Main color

Length (min - max): 3 - 60

activeColor

String

Color when the element has focus or is active.

Length (min - max): 3 - 60

select

Object

Select style object.

primary

Object

Primary select style object.

color

String

Color of text of the elements.

Length (min - max): 3 - 60

borderColor

String

Color of the border of the elements.

Length (min - max): 3 - 60

arrow

Object

Primary select arrow style object.

down

String

Color of the select arrows.

Length (min - max): 3 - 60

up

String

Color of the select arrows.

Length (min - max): 3 - 60

boxShadow

String

Color of the border effect of the element.

Length (min - max): 3 - 60

text

Object

Text style object.

color

String

Color of text of the elements.

Length (min - max): 3 - 60

input

Object

Style object of the elements.

color

String

Color of text of the elements.

Length (min - max): 3 - 60

borderColor

String

Color of the border of the elements.

Length (min - max): 3 - 60

boxShadow

String

Color of the border effect of the element.

Length (min - max): 3 - 60

customize

Object

Object to customize the form.

Check all available options

visibility

Object

Object that contains the visibility configuration of some elements of the form.

hideOrderNumber

Boolean

Indicates whether the order number should be hidden.

Considerations: hideOrderNumber and hideLogo will hide the header of the form.

Example:true

hideResultScreen

Boolean

Indicates whether the results screen should be hidden.

Example:false

Check all available options

hideLogo

Boolean

Indicates whether the logo should be hidden.

Example:true

hideShakeValidation

Boolean

Indicates whether the vibration should be deactivated when validating the fields.

Example:false

hideGlobalErrors

Boolean

Indicates whether global errors should be hidden, so that errors are displayed in each field.

Example:true

Check all available options

hideMessageActivateOnlinePurchases

String

Indicates whether the message should be hidden: Remember to activate your online purchases.

Example:true

elements

Arreglo de objetos

Array of objects that defines the configuration of each element of the form.

Example:[{...},{...},]

paymentMethod

String

Payment method to which the configuration applies.

Allowed values:CARDQRAPPLE_PAYYAPE_CODEPAGO_PUSH

Example:CARD

order

Number

Position of the element in the form.

Example:1

Allowed format:Only allows values containing numbers

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

Check all available options

fields

Arreglo de objetos

Array of objects that defines the configuration of each field of the element.

Example:[{...},{...},]

name

String

Field name.

Allowed values:cardNumberexpirationDatesecurityCodefirstNamelastNameemailtypeDocumentdocumentNumberinstallmentsdeferred

Example:cardNumber

Allowed format:Only allows values containing letters, both uppercase and lowercase, and spaces.

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

order

Número

Position of the field in the element.

Example:1

Allowed format:Only allows values containing numbers

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

Check all available options

visible

Boolean

Show/Hide the field in the element.

Example:true

Check all available options

groupName

String

Name of the group of inputs/fields in the element.

Maximum groupings per row: 2 fields.

Example:billing

Allowed format:Only allows values containing letters, both uppercase and lowercase, and spaces.

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

changeButtonText

Object

Object that defines the text of the button.

actionPay

String

Attribute that defines the text of the payment action button.

Allowed values:PagarAceptar pagarPague aquíCobrarComprarContinuarContribuirConfirmar PagoDonarEfectuar PagoRecargar

Example:Donar

Allowed format:Only allows values containing letters, whether uppercase or lowercase, including accented letters and the "ñ", as well as white spaces.

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

Check all available options

customFields

Array<Object>

Array of custom objects that allows adding extra information to the payment process, to meet the specific needs of each commerce. Maximum 10 custom objects.

name

String

Name of the custom object, it should not be repeated.

Important! The SDK only recognizes the specified values. If a different name is entered, the gateway will ignore it and will not process the values sent.

Length (min - max): 6 - 15

Allowed values:field1field2field3field4field5field6field7field8field9field10

Example:field1

value

String

Value of the custom object.

Length (min - max): 1 - 100

Example:""

Allowed format:It only allows values containing letters (including uppercase, lowercase, vowels with accents such as á, é, í, ó, ú, ñ and ü), numbers, spaces and the following special characters: spot (.), commas (,), hyphens (-), diagonals (/) and the symbol "&". It also supports accented letters from other European languages such as à, è or ö.

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

• Output data: The output data responded by the SDK expresses the mandatory in general. to review which fields are mandatory according to the use case, refer to chapter use-cases.

The response object is composed of the following attributes:

code

String

required

Authorization response code

Length (min - max): 2 - 3

Example:00

message

String

required

Authorization response message, according to the language

Length (min - max): 5 - 30

Example:OK

messageUser

String

required

Friendly message for the user, according to the language

Length (min - max): 5 - 50

Example:Operación exitosa

messageUserEng

String

required

Friendly message for the user in English

Length (min - max): 5 - 50

Example:Successful

response

Object

required

Response data object

payMethod

String

required

Indicator of the payment method of the purchase

Allowed values:CARDQRAPPLE_PAYYAPE_CODEPAGO_PUSH

Example:CARD

order

Array[{Object}]

required

Array of Order Objects

payMethodAuthorization

String

required

Indicator of the payment method of the order:

Allowed values:CARDQRAPPLE_PAYYAPE_CODEPAGO_PUSH

Example:CARD

codeAuth

String

required

Authorization code of the purchase generated by the card issuer

Length (min - max): 0 - 10

Example:S62316

currency

String

required

Currency of the transaction.

Allowed values:PENUSD

Example:PEN

amount

String

required

Txn amount. Integers with 2 decimals, consider decimal separator without thousands delimiter

Length (min - max): 4 - 13

Example:10.00

installments

String

Number of Installments that will affect the purchase.

Length (min - max): 2 - 2

Example:06

deferred

String

Deferred number that will affect purchases.

Length (min - max): 1 - 1

Example:0

orderNumber

String

required

Order number of the purchase transaction, sent in the security api (Token Session).

Length (min - max): 5 - 15

Example:1687996765

stateMessage

String

required

Message of the transaction status (Authorized/Denied).

Example:Autorizado

dateTransaction

String

required

Transaction date (fechatxn saved in transaction table) Format yyyymmdd.

Length (min - max): 8 - 8

Example:20221212

timeTransaction

String

required

Transaction time (fechatxn saved in transaction table) Format hhmmss.

Length (min - max): 6 - 6

Example:185330

uniqueId

String

Transaction identifier made by Izipay or Cybersource.

Length (min - max): 0 - 20

Example:1011173920740022

referenceNumber

String

Reference number generated by the acquirer. This data is important for the refund request.

Length (min - max): 0 - 7

Example:1315646

card

Object

required

Object with card data

brand

String

required

Card brand

Allowed values

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

Example:VS

pan

String

required

Masked card number used in the transaction

Length (min - max): 12 - 19

Example:411111******1111

save

Boolean

Identifier if the card was registered in the operation

Example:true

billing

Object

required

Billing object (cardholder)

firstName

String

required

Cardholder names

Length (min - max): 2 - 50

Example:Juan

lastName

String

required

Cardholder last names

Length (min - max): 2 - 50

Example:Pérez

email

String

required

Cardholder email

Length (min - max): 5 - 50

Example:juanperez@gmail.com

phoneNumber

String

required

Cardholder phone

Length (min - max): 7 - 15

Example:989897960

street

String

required

Cardholder billing address

Length (min - max): 5 - 40

Example:Av. Jorge Chávez 275

city

String

required

City of the cardholder billing address

Length (min - max): 3 - 25

Example:Lima

state

String

required

Name of the department or state of cardholder billing.

Length (min - max): 3 - 25

Example:Lima

country

String

required

Country of the cardholder billing address - ISO code.

Length (min - max): 2 - 2

Example:PE

postalCode

String

required

Postal Code (CP) of the cardholder billing address.

Length (min - max): 5 - 10

Example:15000

documentType

String

required

Type of cardholder identification document

Allowed values:DNICEPASAPORTERUCOTROS

Example:DNI

document

String

required

Cardholder identification document number.

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

Example:12345678

companyName

String

Social reason or company name.

Length (min - max): 2 - 25

merchant

Object

required

Commerce data object

merchantCode

String

required

Commerce code or submerchant (child code of the merchantFacilitator), generated by Izipay during affiliation.

Length (min - max): 7 - 15

Example:4001834

facilitatorCode

String

Facilitator commerce code, generated by Izipay during affiliation.

Length (min - max): 7 - 15

Example:""

token

Object

Tokenization, Private and Brand object.

merchantBuyerId

String

Unique identifier of the buyer in the commerce system.

Length (min - max): 6 - 100

Example:MC240813110946H8D7HF

cardToken

String

Token value that identifies the card of the cardholder.

Length (min - max): 0 - 64

Example:""

alias

String

Card alias.

Length (min - max): 0 - 20

Example:""

authentication

Object

Authentication object.

result

String

Authentication result.

Example:""

customFields

Array<Object>

Array of custom objects that allows adding extra information to the payment process, to meet the specific needs of each commerce. Maximum 10 custom objects.

name

String

Name of the custom object, it should not be repeated.

Length (min - max): 6 - 15

Allowed values:field1field2field3field4field5field6field7field8field9field10

Example:field1

value

String

Value of the custom object.

Length (min - max): 1 - 100

Example:""

Allowed format:It only allows values containing letters (including uppercase, lowercase, vowels with accents such as á, é, í, ó, ú, ñ and ü), numbers, spaces and the following special characters: spot (.), commas (,), hyphens (-), diagonals (/) and the symbol "&". It also supports accented letters from other European languages such as à, è or ö.

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

payloadHttp

String

required

Original response message used for signature generation.

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

signature

String

required

It is the hash of the request payload expressed in a base64 value string.

Example:QBY3s3RRMwHqFmF93lhRTTqrjcuolsVBCUnDFXniKY8=

transactionId

String

required

Unique id for each transaction generated by the commerce, sent in the security api (Token Session) equivalent to the Correlation Id for the transaction flow.

Length (min - max): 5 - 40

Example:172356538519500