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": "Payable with record number 1f25c80d-881b-4a96-a024-afd275263740 has not been created. The calculated gross total from line items does not match the provided remittance gross total.",
      "statusId": 4,
      "eventReferenceId": "1f25c80d-881b-4a96-a024-afd275263740",
      "eventTimeStamp": "2024-03-28T06:36:10.641711-04:00",
      "correlationId": "",
      "errorsAndNotices": {
        "errorFound": true,
        "errors": [
          {
            "message": "",
            "propertyName": "",
            "reasonCode": "",
            "reason": "Payable with record number 1f25c80d-881b-4a96-a024-afd275263740 has not been created. The calculated gross total from line items does not match the provided remittance gross total."
          }
        ],
        "notices": []
      }
    }

Errors are triggered when an action fails to complete successfully. These are critical notifications that require immediate attention to resolve operational issues. Below are some of the common error codes and their descriptions.

Payable Action StatusId Message Text Method of Payment
Creation
of a Payable		 4 Payable with record number recordNumber could not be created because there is already a payable with that record number Any (1-5)
Creation
of a Payable		 4 PayableReferenceId must be unique Any (1-5)
Creation
of a Payable		 4 The payable with the record number recordNumber could not be created because the payment type is set to SmartDisburse and the following payees are missing an Amount value: partyReferenceId. 5 (SMART Disburse)
Creation
of a Payable		 4 Request payload with payment method of SmartDisburse has no behaviors listed. The payable with the record number recordNumber has not been created. 5 (SMART Disburse)
Creation
of a Payable		 4 One of the SmartDisburseDetails parameters exceeds the 1000 character limit. The payable with the record number recordNumber has not been created. 5 (SMART Disburse)
Creation
of a Payable		 4 The payable with the record number recordNumber could not be created because the payment type is set to SmartDisburse and there are one or more payees that are missing the question field in one or more of their security questions. 5 (SMART Disburse)
Creation
of a Payable		 4 The payable with the record number recordNumber could not be created because the payment type is set to SmartDisburse and there are one or more payees that are missing the answer field in one or more of their security questions. 5 (SMART Disburse)
Creation
of a Payable		 4 Request payload with payment method of SmartDisburse is missing one of the following TokenDeliveryMethods: EmailAddress: , SmsPhoneNumber: . The payable with the record number recordNumber has not been created. 5 (SMART Disburse)
Creation
of a Payable		 4 The payable with the record recordNumber could not be created because the payment type is set to SmartDisburse and there are multiple payees with IsPrimary set to true. 5 (SMART Disburse)
Creation
of a Payable		 4 The payable with the record could not be created because the payment type is set to SmartDisburse and there are multiple payees with IsPrimary set to true. 5 (SMART Disburse)
Initiation
of a Payable		 4 Smart Disburse failed due to internal error: 1: 'Expiration Date' must not be empty. 5 (SMART Disburse)
Initiation
of a Payable		 4 Smart Disburse failed due to internal error: 1: ExpirationDate cannot be in the past. 2: EffectiveDate cannot be after ExpirationDate. 5 (SMART Disburse)
Initiation
of a Payable		 4 Primary Payee can not be an Approver 5 (SMART Disburse)
Initiation
of a Payable		 4 The IsPrimary field is required to be set as True against one of the Payees. 5 (SMART Disburse)
Initiation
of a Payable		 4 All payees cannot be set to approver. 5 (SMART Disburse)
Initiation
of a Payable		 4 The sum of Payees.SmartDisburse.Amount must equal Payable.NetTotal 5 (SMART Disburse)
Initiation
of a Payable		 4 EffectiveDate cannot be after ExpirationDate. 5 (SMART Disburse)
Initiation
of a Payable		 4 ExpirationDate cannot be in the past 5 (SMART Disburse)
Initiation
of a Payable		 4 Payment.ParticipantAccountReferences.Id OriginationAccountRefernceID does not belong to Payment.ParticipantId ParticipantId_of_Business 5 (SMART Disburse)
Cancellation
of a Payable		 4 Unable to update status for Payable with record number recordNumber. The current Smart Disburse status of does not allow cancelation 5 (SMART Disburse)
Cancellation
of a Payable		 4 Unable to update status for Payable with record number recordNumber. The current Smart Disburse status of PendingEndorsement does not allow cancelation 5 (SMART Disburse)
Cancellation
of a Payable		 4 No payable with RecordNumber recordNumber was found. Any (1-5)
Creation
of a Payable		 4 Payable with record number recordNumber has not been created. The calculated gross total from line items does not match the provided remittance gross total. Any (1-5)
Creation
of a Payable		 4 Payable with record number recordNumber has not been created. The provided lineItemTotal for one or more line items does not match the calculated total based on unitPrice and quantity. Any (1-5)
Creation
of a Payable		 4 The length of first name and last name exceeds the 140 character limit for Check method of Payment. The payable with the record number recordNumber has not been created. Check
Creation
of a Payable		 4 The business name exceeds the 140 character limit for Check method of Payment. The payable with the record number recordNumber has not been created. Check
Creation
of a Payable		 4 Country subdivision exceeds the 35 character limit for Check method of payment. The payable with the record number recordNumber has not been created. Check
Creation
of a Payable		 4 Post code exceeds the 16 character limit for Check method of payment. The payable with the record number recordNumber has not been created. Check
Creation
of a Payable		 4 Request payload with payment method Check is missing at least one of the following values: PayeeName: firstName lastName, AdressLine1: addressLine1, TownName: townName, CountrySubDivision: countrySubdivision, PostalCode: postCode, Country: . The payable with the record number recordNumber has not been created. Check

Notices

Notices within the web-hook payload serve as informative messages that communicate positive events or non-critical information related to a Payable.

Unlike errors, notices do not indicate problems but rather convey useful updated or confirmations about the processes associated with your payment.

The structure of the notices includes several key components designed o offer clarity and context:

      {
        "message": "Payable with the record number 879e6b29-969c-42ab-942e-e8f0b8d12e56 has been created on 3/28/2024 6:44:56 AM",
        "statusId": 1,
        "eventReferenceId": "879e6b29-969c-42ab-942e-e8f0b8d12e56",
        "eventTimeStamp": "2024-03-28T06:44:56.2828301-04:00",
        "correlationId": "",
        "errorsAndNotices": {
          "errorFound": false,
          "errors": [],
          "notices": [
            {
              "message": "",
              "propertyName": "",
              "reasonCode": "",
              "reason": "Payable with the record number 879e6b29-969c-42ab-942e-e8f0b8d12e56 has been created on 3/28/2024 6:44:56 AM"
            }
          ]
        }
      }

Notices provide additional information about a successful action, offering insights or warnings that do not necessarily indicate an error but may require attention or action.

Payable Action StatusId Message Text Method of Payment
Creation
of a Payable		 1 Payable with the record number recordNumber has been created on date-time Any (1-5)
Initiation
of a Payable		 2 Payment for payable with the record number recordNumber has been initiated via SmartDisburse on date-time 5 (SMART Disburse)
Initiation
of a Payable		 2 Payment for payable with the record number recordNumber has been initiated from ****accountLast4Digits via ACH on date-time 1 (ACH)
Initiation
of a Payable		 2 Payment for payable with the record number recordNumber has been initiated from ****accountLast4Digits via RTP on date-time 2 (RTP)
Initiation
of a Payable		 2 Payment for payable with the record number recordNumber has been initiated from ****accountLast4Digits via Check on date-time 3 (Check)
Initiation
of a Payable		 2 Payment for payable with the record number recordNumber has been initiated from ****accountLast4Digits via Wire on date-time 4 (Wire)
Updates to a
Scheduled Payable		 5 Payable with RecordNumber recordNumber was updated successfully Any (1-5)
Completion
of a Payable		 3 Payment completed Any (1-5)
Completion
of a Payable		 3 SMART Disburse Payment Complete 5 (SMART Disburse)
Scheduling
of a Payable		 5 Payable with RecordNumber recordNumber is pending initiation for date Any (1-5)
Cancellation
of a Payable		 7 Payable with the record number recordNumber has been successfully canceled. Any (1-5)
Revocation
of a Payable		 7 SMART Disburse Token Revoked 5 (SMART Disburse)
Expiration
of a Payable		 4 SMART Disburse Token Expired 5 (SMART Disburse)