Exception Created

exception.created

This event occurs when an exception is created.

Payload Object

string (UUID)

Event ID.

type

string

Event type. Value is exception.created.

createdAt

string (date-time)

Date and time the event occurred.

data

object

Data related to the event.

entityId

string (UUID)

ID of the entity that created the exception.

exceptionId

string (UUID)

ID of the exception.

businessAccountId

string (UUID)

ID of the Business Account.

exceptionCategory

string, enum values:

string, enum values: BANK_ACCOUNT_VERIFICATION, CUSTOMER, TRANSACTION

Exception category.

exceptionType

string, enum values: ACH_RETURN, ACH_NOC, BANK_ACCOUNT_VERIFICATION_DECLINED, BANK_ACCOUNT_VERIFICATION_NOC, EARNED_WAGE_ACCESS, RECONCILIATION

Type of exception.

description

string

Description of the exception.

Sample Payload Object

				
					{
  "id": "f8405d12-38fc-48fa-bc18-bd83af3e9c57",
  "type": "exception.created",
  "createdAt": "2025-04-10T21:10:53.857Z",
  "data": {
    "entityId": "e5bcb84f-d730-4666-a835-2c47504ad532",
    "exceptionId": "9c66bbe1-afc8-4102-9f02-81befdacc757",
    "businessAccountId": "c9402ad1-eb6f-48c6-bdd4-78396323a6a6",
    "exceptionCategory": "TRANSACTION",
    "exceptionType": "ACH_RETURN",
    "description": "ACH return"
  }
}