Data Payload

Caribbean
Colombia
Mexico

This section outlines the structure and content of the data sent via our webhook service, ensuring that you understand how to effectively parse and utilize the information received.

What is a Webhook Payload?

A webhook payload is the data packet sent from Fiserv's systems to your specified endpoint whenever an event, such as the completion of a boarding process, occurs. The payload contains critical information about the event, encapsulated in a structured JSON format. By processing this payload, your systems can automatically react to the event, updating internal records or triggering further actions as required.

📘

API Specs

Please review our API Specs in this link: https://docs.apis-fiserv.com/latam/reference/post-boarding-applicationid

Success Payload Structure Sample

{
  "institutionNumber": 74,
  "applicationId": 78861,
  "status": "SUCESSFUL_PROCESSED",
  "stage": "IPG",
  "errorDetail": "",
  "internalId": "65000001",
  "externalId": "65000001",
  "merchantLevel": 3,
  "parentId": "00000065",
  "storeId": "811265001147",
  "terminalId": [
    "P1234567",
    "P8901234"
  ]
}

Failure Payload Structure Sample

{
  "institutionNumber": 74,
  "applicationId": 78861,
  "status": "FAIL_PROCESSED",
  "stage": "IPG",
  "errorDetail": "IPG error: The service Config value \\\"falseoo\\\" matched not the validation regexp",
  "merchantLevel": 3,
  "parentId": "00000065",
}

Headers


FieldDescriptionType
apikeyThis header will be populated if the institution has selected apikey as authorization method, it will be populated with the apikey shared by the institution.string
AuthorizationAuthorization Bearer token. This header will be populated only if institution has selected OAuth as authorization method.string

Data Payload Specs

FieldDescriptionMandatoryType/SpecValue/Sample
institutionNumberUnique identifier for the organization (institution / bank)Yesinteger / min. 2 digits, max. 8 digits74
applicationIDUnique identifier for the application to board the merchantYesinteger / ≤ 1e+2678861
statusEnd Status of the application submitted for boarding the merchant.YesstringReview our guide Status & Stages for more information.
stageStage where the boarding was finished from orchestration. It is used to inform the last step processed when successfully finished or in which step of execution the application failed.No, only if status is FAIL_PROCESSEDstringReview our guide Status & Stages for more information.
errorDetailDetail of the error in case the application status is different than Successful_Processed. It is used to provide more details regarding the causes of a rejection or error. This details will also be useful to fix the application and resubmit it, if allowed.YesstringIPG error: The service Config value \"falseoo\" matched not the validation regexp
internalIDUnique merchant number generated by Fiserv in the boarding process.Yesstring / max. length ≤ 865000001
externalIDMerchant number to be used throughout the authorization and clearing cycle. This field can be generated by Fiserv for some institutions or informed by client.Yesstring / length ≤ 20
merchantLevelLevel of the merchant based on the hierarchy defined in boarding, that reflects the hierarchy.Yesinteger / 1 digit3
parentIdThe internal Merchant ID to which the merchant needs to be linked to as a child merchant. It is an existing group / sub-group merchant IdYesstring / length ≤ 865000001
storeIDUnique identifier for the eCommerce store. It is generated by Fiserv for eCommerce merchants.No, only for merchants with ecommerce.string / length ≤ 12811265001147
terminalIDUnique identifier for terminal(s). It is generated by Fiserv and stored in our autorizer, when the application is boarding merchants and terminals.No, only for merchants with card present.array of strings /
length ≥ 1
"P1234567", "P8901234"