Exception Object

The Exception object represents an unexpected event or an event that requires attention. For example, an exception is created when a bank Financial Account verification is declined or requires action.

Attributes

id

string (UUID)

ID of the exception.

entityId

string (UUID)

ID of the entity that created the exception.

businessAccountId

string (UUID)

ID of the Business Account that created the exception.

assignedTo

object

User that the exception is assigned to.

id

string (UUID)

User’s ID.

firstName

string, min length:1, max length: 40

User’s first name.

lastName

string, min length:1, max length: 40

User’s last name.

email

string (email)

User’s email address.

category

string, enum values: BANK_ACCOUNT_VERIFICATION, CUSTOMER | TRANSACTION

Exception category. The following values are supported:

  • BANK_ACCOUNT_VERIFICATION  Verification of a bank Financial Account.
  • CUSTOMER  Customer Account.
  • TRANSACTION  Transaction.

type

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

Type of exception. The following values are supported:

  • ACH_RETURN  Return transaction created for an ACH transaction.
  • ACH_NOC  Notification of Change (NOC) received for an ACH transaction.
  • BANK_ACCOUNT_VERIFICATION_DECLINED  Verification of a bank Financial Account was declined.
  • BANK_ACCOUNT_VERIFICATION_NOC  Notification of Change (NOC) received for a bank Financial Account verification.
  • EARNED_WAGE_ACCESS  Earned Wage Access (EWA) exception.
  • RECONCILIATION  Transaction created during the reconciliation process.

notes

object

Notes for the exception.

id

string (UUID)

ID of the note.

entityId  

string (UUID)

ID of the entity to which the note is attached.

entityType  

string enum, values: CUSTOMER, RECIPIENT, TEAM_MEMBER, FINANCIAL_ACCOUNT, TRANSACTION, SCHEDULED_TRANSACTION

Type of entity to which the note is attached.

title

string, max length: 128

Note title.

contentText

string, max length: 1000

Note content.

contentType

string

Reserved for future use.

externalUrl

string

Reserved for future use.

sizeInBytes

integer (int64)

Reserved for future use.

businessAccountId  

string (UUID)

ID of the Business Account for the entity that created the note.

createdBy

object

Entity that created the note.

id

string (UUID)

ID of the entity. Will be blank if createdBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

  • employee  Team Member using the RocketKOR Portal.
  • internal  Internal service call.
  • kor_employee  Rocket Financial employee.
  • service-account  Service Account using APIs.

createdAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the note was created.

updatedBy

object

Entity that last updated the note.

id

string (UUID)

ID of the entity. Will be blank if updatedBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

  • employee  Team Member using the RocketKOR Portal.
  • internal  Internal service call.
  • kor_employee  Rocket Financial employee.
  • service-account  Service Account using APIs.

updatedAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the note was last updated.

status

string, enum values: NEW, IN_PROGRESS, RESOLVED, REOPENED

Current status of the exception. The following values are supported:

  • NEW  Exception has been created.
  • IN_PROGRESS  Exception has been assigned to a user.
  • RESOLVED  Exception has been resolved. The exception record can no longer be modified.
  • REOPENED  A RESOLVED exception has been reopened.

description

string

Description of the exception.

createdBy

object

Entity that created the exception.

id

string (UUID)

ID of the entity. Will be blank if createdBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

  • employee  Team Member using the RocketKOR Portal.
  • internal  Internal service call.
  • kor_employee  Rocket Financial employee.
  • service-account  Service Account using APIs.

createdAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the exception was created in the RocketKOR system.

updatedBy

object

Entity that last updated the exception.

id

string (UUID)

ID of the entity. Will be blank if updatedBy.type is internal.

type

string enum, values: employee, internal, kor_employee, service-account

Type of entity. The following values are supported:

  • employee  Team Member using the RocketKOR Portal.
  • internal  Internal service call.
  • kor_employee  Rocket Financial employee.
  • service-account  Service Account using APIs.

updatedAt

string (date-time), format: yyyy-MM-dd’T’HH:mm:ss.SSSz

Date and time the exception was last updated.

Exception Object

				
					{
  "id": "string(UUID)",
  "entityId": "string(UUID)",
  "businessAccountId": "string(UUID)",
  "assignedTo": {
    "id": "string(UUID)",
    "firstName": "string",
    "lastName": "string",
    "email": "string(email)"
  },
  "category": "BANK_ACCOUNT_VERIFICATION | CUSTOMER | TRANSACTION",
  "type": "ACH_RETURN | ACH_NOC | BANK_ACCOUNT_VERIFICATION_DECLINED | BANK_ACCOUNT_VERIFICATION_NOC | EARNED_WAGE_ACCESS | RECONCILIATION",
  "notes": {
    "id": "string(UUID)",
    "entityId": "string(UUID)",
    "entityType": "CUSTOMER | FINANCIAL_ACCOUNT | RECIPIENT | SCHEDULED_TRANSACTION | TEAM_MEMBER | TRANSACTION",
    "title": "string",
    "contentText": "string",
    "contentType": "string",
    "externalUrl": "string",
    "sizeInBytes": integer(int64),
    "businessAccountId": "string(UUID)",
    "createdBy": {
      "id": "string(UUID)",
      "type": "employee | internal | kor_employee | service-account"
    },
    "createdAt": "string(date-time)",
    "updatedBy": {
      "id": "string(UUID)",
      "type": "employee | internal | kor_employee | service-account"
    },
    "updatedAt": "string(date-time)"
  },
  "status": "NEW | IN_PROGRESS | RESOLVED | REOPENED",
  "description": "string",
  "createdBy": {
    "id": "string(UUID)",
    "type": "employee | internal | kor_employee | service-account"
  },
  "createdAt": "string(date-time)",
  "updatedBy": {
    "id": "string(UUID)",
    "type": "employee | internal | kor_employee | service-account"
  },
  "updatedAt": "string(date-time)"
}

Step into the future of Finance with RocketKOR! Simplify payments, banking, lending, and data analytics using our versatile KOR Platform.

A Rocket Financial Inc. company

@ 2024 RocketKOR, Inc. All rights reserved.

Terms of Use     |     Privacy Policy
Exit mobile version