Notification service

If the merchant wishes to be notified of the final status of the transaction, it is necessary to implement a web service that meets the following definitions:

Method HTTP

POST

Protocol

REST

Format

JSON

URL

string

It will be taken from the urlIPN field indicated in the input data of section Parameter definition

Shipment data

The exposed service must accept the following data as they will be the values that Izipay will send:

• Incoming HTTP Headers.

transactionId

String

required

Unique id for each transaction generated by the merchant.

Length (min - max): 5 - 40

Example:16881500822750

• Input parameters (HTTP Body)**.

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

Example:CARD

order

Array[{Object}]

required

Array of Order Objects

payMethodAuthorization

String

required

Indicator of the payment method of the order:

Allowed values:CARDAPPLE_PAYYAPE_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

Information

For more detailed information visit the Notifications section.