Skip to main content

Trade Result Notification Specification

In case the trade wishes to receive a notification of the final status of the trade the trade must expose 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 the section Parameter definition

1. Shipment data​

The exposed service will have to accept the following data because they will be the values that Izipay will send.

Input header Headers.​

The service exposed by the client must accept the following HTTP header:

transactionId
String
required

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

Example:Lenght: 5 - 40

Input parameters Body.​

The service exposed by the client shall accept the following fields:

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

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

Here is an example of a response

{
  "headers": [
    {"Accept": "application/json"},
    {"Content-Type": "application/json; charset=utf-8"},
    {"Host": "sandbox-api-pw.izipay.pe"},
    {"Transfer-Encoding": "chunked"},
    {"transactionId": "17370678303660"},
    {"Signature": "8RjPs9ykC7ukUMcCiCvSaBdEUwraNQiauWWGlEouAqg="},
    {"traceparent": "00-4ed7ff545f524695ca2cbe180adf78d0-6af61a35aab751b8-00"}
  ],
  "body": {
    "code": "00",
    "message": "Operación exitosa",
    "messageUser": "Operación exitosa",
    "messageUserEng": "Successful",
    "response": {
      "payMethod": "CARD",
      "order": [
        {
          "payMethodAuthorization": "CARD",
          "codeAuth": "831000",
          "currency": "PEN",
          "amount": "149.00",
          "installment": "",
          "deferred": "",
          "orderNumber": "1737067830",
          "stateMessage": "Autorizado",
          "dateTransaction": "20250116",
          "timeTransaction": "174953",
          "uniqueId": "1429386",
          "referenceNumber": "6330605"
        }
      ],
      "card": {
        "brand": "MC",
        "pan": "511842******6017",
        "save": "false"
      },
      "billing": {
        "firstName": "Luis",
        "lastName": "Quispe",
        "email": "luisquispetaquire@gmail.com",
        "phoneNumber": "989800341",
        "street": "Av Sol 123",
        "city": "Lima",
        "state": "Lima",
        "country": "PE",
        "postalCode": "15000",
        "documentType": "DNI",
        "document": "10252022",
        "companyName": ""
      },
      "merchant": {
        "merchantCode": "4001061",
        "facilitatorCode": ""
      },
      "token": {
        "merchantBuyerId": "MC20250101",
        "cardToken": "",
        "alias": ""
      },
      "authentication": {
        "result": ""
      },
      "customFields": [
        {
          "name": "field1",
          "value": ""
        },
        {
          "name": "field2",
          "value": ""
        },
        {
          "name": "field3",
          "value": ""
        },
        {
          "name": "field4",
          "value": ""
        },
        {
          "name": "field5",
          "value": ""
        },
        {
          "name": "field6",
          "value": ""
        },
        {
          "name": "field7",
          "value": ""
        },
        {
          "name": "field8",
          "value": ""
        },
        {
          "name": "field9",
          "value": ""
        },
        {
          "name": "field10",
          "value": ""
        }
      ]
    },
    "transactionId": "17370678303660",
    "payloadHttp": "{\"code\":\"00\",\"message\":\"Operación exitosa\",\"messageUser\":\"Operación exitosa\",\"messageUserEng\":\"Successful\",\"response\":{\"payMethod\":\"CARD\",\"order\":[{\"payMethodAuthorization\":\"CARD\",\"codeAuth\":\"831000\",\"currency\":\"PEN\",\"amount\":\"149.00\",\"installment\":\"\",\"deferred\":\"\",\"orderNumber\":\"1737067830\",\"stateMessage\":\"Autorizado\",\"dateTransaction\":\"20250116\",\"timeTransaction\":\"174953\",\"uniqueId\":\"1429386\",\"referenceNumber\":\"6330605\"}],\"card\":{\"brand\":\"MC\",\"pan\":\"511842******6017\",\"save\":\"false\"},\"billing\":{\"firstName\":\"Luis\",\"lastName\":\"Quispe\",\"email\":\"luisquispetaquire@gmail.com\",\"phoneNumber\":\"989800341\",\"street\":\"Av Sol 123\",\"city\":\"Lima\",\"state\":\"Lima\",\"country\":\"PE\",\"postalCode\":\"15000\",\"documentType\":\"DNI\",\"document\":\"10252022\",\"companyName\":\"\"},\"merchant\":{\"merchantCode\":\"4001061\",\"facilitatorCode\":\"\"},\"token\":{\"merchantBuyerId\":\"MC20250101\",\"cardToken\":\"\",\"alias\":\"\"},\"authentication\":{\"result\":\"\"},\"customFields\":[{\"name\":\"field1\",\"value\":\"\"},{\"name\":\"field2\",\"value\":\"\"},{\"name\":\"field3\",\"value\":\"\"},{\"name\":\"field4\",\"value\":\"\"},{\"name\":\"field5\",\"value\":\"\"},{\"name\":\"field6\",\"value\":\"\"},{\"name\":\"field7\",\"value\":\"\"},{\"name\":\"field8\",\"value\":\"\"},{\"name\":\"field9\",\"value\":\"\"},{\"name\":\"field10\",\"value\":\"\"}]},\"transactionId\":\"17370678303660\"}",
    "signature": "8RjPs9ykC7ukUMcCiCvSaBdEUwraNQiauWWGlEouAqg="
  }
}
Information

For more detailed information visit the Notifications section.

Last updated on