Parameter Definition

By using the config object with this input data in the SDK integration, an accurate and complete flow of information is ensured, allowing to efficiently interact with 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 correct use of this input data.

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

config

Object

required

Object of Configuration, contain the other objects (order, token, billing, …)

enviroment

String

required

Field that allows you to change the endpoints consumed by the library.

Allowed values:TESTSBOXPROD

Example:TEST

publickey

String

required

It is the “New Payment Button API Key” obtained from the Commerce BackOffice platform of Punto Web

Length (min - max): 0 - 50

Example:VErethUtraQuxas57wuMuquprADrAHAb

transactionId

String

required

Unique identifier of the operation generated by the commerce

Length (min - max): 5 -40

Example:16868479028040

action

String

required

Indicator that determines the form of the purchase, values: pay: Purchases with card (without tokenization), register: card registration (tokenization), pay_register: Purchases and card registration, pay_token: Purchases with Izipay token (tokens obtained in the register and pay_register actions)

Allowed values:payregisterpay_registerpay_token

Example:pay

merchantCode

String

required

Code of the commerce 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:4000901

order

Object

required

Purchase object

orderNumber

String

required

Purchase transaction order number

Length (min - max): 5 - 15

Example:1687996765

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

payMethod

Array <Enum: PayOption>

required

List of purchase payment method indicators

Allowed values:PayOption.CARDPayOption.YAPE

Example:PayOption.CARD

processType

String

required

Process Type for a transaction.

Allowed values:autorizepreauthorize

Example:autorize

merchantBuyerId

String

required

UNIQUE identifier of the buyer in the commerce system.

Length (min - max): 6 - 100

Example:mc1991

dateTimeTransaction

String

required

Transaction date sent by the commerce or terminal in timestamp format.

Length (min - max): 16 - 16

Example:1688149430031000

token

Object

Object with information of tokenized card. Mandatory only when action=pay_token

cardToken

String

Token value that identifies the card of the cardholder. Mandatory only when action=pay_token

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

lastName

String

required

Cardholder's last name

Length (min - max): 2 - 50

Example:Torres

email

String

required

Cardholder's email

Length (min - max): 5 - 50

Example:luchotorres@gmail.com

phoneNumber

String

required

Cardholder's phone number

Length (min - max): 7 - 15

Example:989897960

street

String

required

Cardholder's 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. If the billing.country field is US or CA (United States or Canada) respects the rule of 2 character format. Example: California = CA

Length (min - max): 3 - 25

Example:Lima

country

String

required

Country of the cardholder billing address - 2 character ISO code. Example: Peru = PE

Length (min - max): 2 - 2

Example:PE

postalCode

String

required

Postal Code (CP) of the cardholder billing address. If the billing.country field is “US”(United States) respects the following format rules of 5 characters (NNNNN) or 9 characters (NNNNN-NNNN)If the billing.country field is “CA”(Canada), respects the following format rule of 6 characters (ANA NAN). Where N = Numeric and A = alphanumeric

Length (min - max): 5 - 10

Example:15000

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

shipping

Object

Shipping object

firtsName

String

Names for shipping

Length (min - max): 2 - 50

Example:Juan

lastName

String

Last names for shipping

Length (min - max): 2 - 50

Example:Pérez

email

String

Email for shipping

Length (min - max): 5 - 50

Example:juanperez@gmail.com

phoneNumber

String

Phone for shipping

Length (min - max): 7 - 15

Example:989897960

street

String

Address for shipping

Length (min - max): 5 - 40

Example:Av. Jorge Chávez 275

city

String

City of the address for shipping

Length (min - max): 3 - 25

Example:Lima

state

String

Name of the department or state of cardholder billing. If the billing.country field is US or CA (United States or Canada) respects the rule of 2 character format. Example: California = CA

Length (min - max): 3 - 25

Example:Lima

country

String

Country of the cardholder billing address - 2 character ISO code.

Length (min - max): 2 - 2

Example:PE

postalCode

String

Postal Code (CP) of the cardholder billing address. If the billing.country field is “US”(United States) respects the following format rules of 5 characters (NNNNN) or 9 characters (NNNNN-NNNN)If the billing.country field is “CA”(Canada), respects the following format rule of 6 characters (ANA NAN). Where N = Numeric and A = alphanumeric

Length (min - max): 5 - 10

Example:15000

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

urlIPN

String

Commerce notification API URL (IPN).

Length (min - max): 5 - 400

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

appearance

Object

required

Form appearance object.

language

String

Default form language. Default value ESP (Spanish)

Allowed values:ESPENG

Example:ESP

formControls

Object

Object with control settings

isAmounLabelVisible

Boolean

Show the amount on the "Pay" button of the payment form

Example:false

isLangControlVisible

Boolean

Show or not the available languages | ESP, ENG

Example:true

theme

string

Predefined themes: “green", "red", "black"

Allowed values:greenredblack

Example:red

customTheme

Object

Object for control customization

payButtonBackgroundColor

String

Color you want to give to the pay button, value in hexadecimal with #

Length (min - max): 3 - 60

Example:#FFFFFF

textInputBorderColor

String

Color you want to give to the border of the input fields, value in hexadecimal with #

Length (min - max): 3 - 60

Example:#F3F3F3

textInputPlaceholderTextColor

String

Color you want to give to the placeholder of the input fields, value in hexadecimal with #

Length (min - max): 3 - 60

Example:#F1F1F1

logo

String

Commerce logo URL

Length (min - max): 10 - 200

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

visualSettings

Object

required

Object that defines the behavior of the SDK and some visual elements within it.

showResultScreen

Boolean

Show the operation/payment result screen, default value true.

Example:true

2. Output data:

SDK 1.3.0+

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

messageUserEng

String

required

Friendly message for the user in English

Length (min - max): 5 - 50

Example:Ok

response

Object

required

Response data object

payMethod

String

required

Indicator of the payment method of the purchase

Allowed values:CARDYAPE_CODE

Example:CARD

order

Array[{Object}]

required

Array of Order Objects

payMethodAuthorization

String

required

Indicator of the payment method of the order:

Allowed values:CARDYAPE_CODE

Example:CARD

codeAuth

String

Authorization code of the purchase generated by the card issuer

Length (min - max): 0 - 10

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

deferred

String

Deferred number that will affect purchases.

Length (min - max): 1 - 1

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

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

Type of 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:Lucho

lastName

String

required

Cardholder last names

Length (min - max): 2 - 50

Example:Torres

email

String

required

Cardholder email

Length (min - max): 5 - 50

Example:luchotorres@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

facilitatorCode

String

Facilitator commerce code, generated by Izipay during affiliation.

Length (min - max): 7 - 15

token

Object

Tokenization, Private and Brand object.

merchantBuyerId

String

Unique identifier of the buyer in the commerce system.

Length (min - max): 6 - 100

cardToken

String

Token value that identifies the card of the cardholder.

Length (min - max): 0 - 64

alias

String

Card alias.

Length (min - max): 0 - 20

authentication

Object

Authentication object.

result

String

Authentication result.

customFields

Array[{String}]

Array of Strings

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

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

SDK 1.2.2- (deprecated)

code

String

required

Response code

Length (min - max): 2 - 3

Example:00

message

String

required

Response message

Length (min - max): 5 - 30

Example:Ok

messageUser

String

Friendly message for the user

Length (min - max): 5 - 50

Example:Ok

messageUserEng

String

Friendly message for the user in English

Length (min - max): 5 - 50

Example:Ok

response

Object

required

Response data object

payMethod

String

required

Payment method indicators separated by comma, if a single method is sent, do not add a comma.

Allowed values:CARD

Example:CARD

currency

String

required

Currency of the transaction.

Allowed values:PENUSD

Example:PEN

amount

String

required

Txn amount. Integers with 2 decimals

Length (min - max): 4 - 13

Example:10.00

orderNumber

String

required

Order number of the purchase transaction.

Length (min - max): 5 - 15

Example:1687996765

merchantCode

String

required

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

Length (min - max): 7 - 15

timeTransaction

String

required

Transaction time

Length (min - max): 6 - 6

Example:185330

dateTransaction

String

required

Transaction date

Length (min - max): 8 - 8

Example:20221212

uniqueId

String

Transaction identifier made by Izipay or Cybersource. Included only in the responses of payment authorizations.

Length (min - max): 0 - 40

Example:1011173920740022

codeAuth

String

Authorization code issued by the bank

Length (min - max): 2 - 50

Example:AB123

signature

String

Transaction signature

Length (min - max): 5 - 100

Example:b166214e976c7e76390889

referenceNumber

String

Transaction reference number

Length (min - max): 1 - 20

Example:1315646

payloadHttp

String

Data sent by the authorization service to the SDK. Its storage is not recommended because it is an extensive value of variable length.

Length (min - max): Variable

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

card

String

required

Object with card data

Length (min - max): 2 - 50

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

Example:411111******1111

save

Boolean

Indicator if the card was saved

Example:true

billing

Object

required

Billing object (cardholder)

firstName

String

required

Cardholder names

Length (min - max): 2 - 50

Example:Lucho

lastName

String

required

Cardholder last names

Length (min - max): 2 - 50

Example:Torres

email

String

required

Cardholder email

Length (min - max): 5 - 50

Example:luchotorres@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

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

tokenization

Object

Object with tokenized card data

cardToken

String

Token value that identifies the card of the cardholder

Length (min - max): 0 - 64

Example:27340718bfdf2de6a125d29ecc6ebf279cc4daf20150aee8a3b4911f02d0ef81