Errors

The errors array within the web-hook payload plays critical role in identifying issues that arise during an event, associated with a Payable. In certain scenarios, the errors array may capture multiple errors related to a single event.

Each error listed within the array gives detailed info on the specific issue, covering:

• message is a general description of the error, providing an overview of what went wrong
• propertyName field is included if the error is tied to a specific property of the Party. It helps in pinpointing the exact attribute of the Party that encountered an issue, streamlining the troubleshooting process
• reasonCode is an identifier for the type of error encountered
• reason is a description of the ReasonCode meaning. Provides context for the type of error that occurred.

    {
      "message": "Party with partyReferenceId 1f25c80d-881b-4a96-a024-afd275263740 has not been created.",
      "statusId": 4,
      "eventReferenceId": "1f25c80d-881b-4a96-a024-afd275263740",
      "eventTimeStamp": "2024-03-28T06:36:10.641711-04:00",
      "correlationId": "",
      "errorsAndNotices": {
        "errorFound": true,
        "errors": [
          {
            "message": "Party with partyReferenceId 1f25c80d-881b-4a96-a024-afd275263740 has not been created. Business name is required if party type is business.",
            "propertyName": "businessName",
            "reasonCode": "RVFE0001",
            "reason": "Cannot be null, empty, or zero"
          }
        ],
        "notices": []
      }
    }