Appendix - Extended Transaction Event

Message Properties

NAME	TYPE	DESCRIPTION
transactionId	Integer	Unique ID for the transaction.
ownerEntityId	Integer	Unique ID for the entity that owns the merchant entity (e.g., FI or Partner entity).
entityId	Integer	Unique ID for the merchant entity.
referenceId	Integer	Unique reference ID for the JHA SmartWatch™️ message.
messageVersion	String	SmartWatch™️ message version number.
messageTypeId	Integer	This ID shows which message type is being sent, either Extended Transaction Event (1) or Base Transaction Event (0).
isTest	Boolean	Boolean data element that shows whether the message was generated by a testing tool or not.
customer	Object (`customer properties`)	An object that contains information about the customer that is related to the transaction.
location	Object (`location properties`)	An object that contains information about the location that the transaction was submitted to.
noticeOfChanges	Object (`noticeOfChanges properties`)	An array that houses a list of noticeOfChanges objects. Each noticeOfChanges object has information describing a unique notice of change event that occurred with this transaction.
event	Object (`event properties`)	An object containing information about the event.
createDateTime	String	The date and time that the transaction was created.
createdBy	String	The user who created the transaction.
statusId	Integer	An ID showing the current status of the transaction (see look up tables).
paymentTypeId	Integer	An ID that shows the current payment type of the transaction (see look up tables).
nameOnAccount	String	The name of the account that the transaction is drawing from.
number	String	The unique transaction number for this transaction.
operationTypeId	Integer	An ID that shows what operation this transaction was submitted as (see look up tables).
totalAmount	Integer	The total dollar amount of the transaction.
authResponseId	Integer	An ID that shows the response for an auth request associated with the transaction (see look up tables).
paymentOriginId	Integer	An ID that shows the payment origin of the transaction.
settlementStatusId	Integer	An ID that shows the current settlement status.
displayAccountNumber	String	The last 4 digits of the account that the transaction is drawing from.
checkNumber	String	The check number as shown on the physical check document for Check21 transactions.
ownerApplicationId	Integer	An ID that shows the application/product that currently owns the transaction.
receivingApplicationId	Integer	An ID that shows the application/product that initially received the transaction.
ownerAppReferenceId	Integer	A unique ID for the transaction assigned by the owning application/product.
batchNumber	Integer	The batch number is a unique identifier assigned to the batch that holds the transaction.
actualOriginatedAsId	Integer	The payment type ID that the transaction originated as.
requestedOriginatedAsId	Integer	The payment type ID that the transaction was requested to be originated as.
isDuplicate	Boolean	A Boolean value that shows whether the transaction is a duplicate or not.
effectiveDate	String	The effective date is the date that the transaction was requested to be processed. This date typically matches the created date, but not in all circumstances.
faceFeeTypeId	Integer	This unique ID shows what the face fee type is for the transaction.
referenceNumber	String	This is the transaction reference number assigned to this transaction by the transaction processing system.
field1	String	This is the first of three custom data fields that can be used to assign additional custom data to a transaction.
field2	String	This is the second of three custom data fields that can be used to assign additional custom data to a transaction.
field3	String	This is the third of three custom data fields that can be used to assign additional custom data to a transaction.
thirdPartyReferenceNumber	String	This data element will show any reference numbers assigned by third parties.
description	String	This description holds any relevant details about the event.
transactionDateTime	String	This is the date and time that the transaction was originally submitted. The value should be the same as the createDateTime.
hasImage	Boolean	This Boolean value shows whether the transaction has an associated document image with it (e.g., Check21 transactions).
returnCode	String	The ACH/Check21 return code for any returns will show here.
convenienceFee	Decimal	The amount of convenience fee for this transaction. (Card Only).
reviewerReason	String	The reason the reviewer rejected this item. (RDA Only).
achTraceNumber	String	The ACH Trace Number assigned to this transaction in the ACH file it was included in.

Customer Properties

NAME	TYPE	DESCRIPTION
id	String	This is the Homebanking ID or Cash Mgmt ID assigned to the customer.
field1	String	This is the first of three custom data fields that can be used to assign additional custom data to a customer.
field2	String	This is the second of three custom data fields that can be used to assign additional custom data to a customer.
field3	String	This is the third of three custom data fields that can be used to assign additional custom data to a customer.
firstName	String	The customer's first name.
lastName	String	The customer's last name.
custAddress1	String	Line one of the customer's address.
custAddress2	String	Line two of the customer's address.
custCity	String	The city that the customer is located in.
custStateRegion	String	The state/region that the customer is located in.
custPostalCode	String	The postal code/zip code that the customer is located in.
customerID	String	This is the unique ID generated by EPS and assigned to the customer.

Location Properties

NAME	TYPE	DESCRIPTION
locationId	Integer	The unique ID for the location that is assigned by the SmartPay™️ system.
locationName	String	The name of the location as created by the customer.

Notice Of Changes Properties

NAME	TYPE	DESCRIPTION
dateCreated	String	The date that the notice of change was created.
reasonCode	String	The associated code describing the reason for the notice of change.
correctedTransactionCode	Integer	This shows the corrected/updated transaction code for the transaction after the changes have been made.
description	String	A description of the notice of change event.

Event Properties

NAME	TYPE	DESCRIPTION
eventId	Integer	A unique ID that identifies the event in question.
eventDateTime	String	The date and time that the event transpired.
eventTypeId	Integer	An ID that shows what type of event has transpired.
eventDataString	Integer	Associated description/details for the event, if any, will show here.
eventDataBigInt	Integer	This is a multi-purpose field that contains data related to the event.
appTypeId	Integer	An ID that shows which application/product the event came from.

Example

{
  "transactionId": 2306398870,
  "ownerEntityId": 257890,
  "entityId": 257894,
  "referenceId": 3097766642,
  "messageVersion": "1.2",
  "messageTypeId": 1,
  "isTest": false,
  "customer": {
    "id": "Hbid_susp",
    "field1": null,
    "field2": null,
    "field3": "1175438",
    "firstName": null,
    "lastName": "MB-Suspend",
    "custAddress1": null,
    "custAddress2": null,
    "custCity": null,
    "custStateRegion": null,
    "custPostalCode": null,
    "customerID": "16734070"
  },
  "location": {
    "locationId": 1175438,
    "locationName": "Mobile Micro Business Capture"
  },
  "noticeOfChanges": [
    {
      "dateCreated": "2024-11-14 08:03:00.000",
      "reasonCode": "C01",
      "correctedTransactionCode": 0,
      "description":""
    },
    {
      "dateCreated": "2024-11-13 08:03:00.000",
      "reasonCode": "C01",
      "correctedTransactionCode": 0,
      "description":""
    }

],
  "event": {
    "eventId": 3097766642,
    "eventDateTime": "2023-10-03T11:00:14",
    "eventTypeId": 62,
    "eventDataString": "",
    "eventDataBigInt": 0,
    "appTypeId": 102
  },
  "createDateTime": "2023-09-29T15:41:43.693",
  "createdBy": "MB-Suspend",
  "statusId": 51,
  "paymentTypeId": 1,
  "nameOnAccount": "",
  "number": "a8597760-7185-4dcf-b766-f0b87c772853-0",
  "operationTypeId": 1,
  "totalAmount": 40,
  "authResponseId": 0,
  "paymentOriginId": 512,
  "settlementStatusId": 5,
  "displayAccountNumber": "1000",
  "checkNumber": "5014",
  "ownerApplicationId": 13,
  "receivingApplicationId": 53,
  "ownerAppReferenceId": 3001303362,
  "batchNumber": 3000905010,
  "actualOriginatedAsId": 3,
  "requestedOriginatedAsId": 3,
  "isDuplicate": false,
  "effectiveDate": "2023-09-29T00:00:00",
  "faceFeeTypeId": 1,
  "referenceNumber": "T:7RG9J4CQZA1",
  "field1": "",
  "field2": "31801014",
  "field3": "",
  "thirdPartyReferenceNumber": "",
  "description": "MB-Suspend",
  "transactionDateTime": "2023-09-29T15:41:43.693",
  "hasImage": true,
  "returnCode": null,
  "convenienceFee": 0,
  "reviewerReason": null,
  "achTraceNumber": "122037760153840"

}

Options

EVENT TYPES:
Declined
Approved
Processing Error
Voided
Captured
Refunded
Reversed
Data Updated
Edited
Queued
Batched
Processed *
Cleared
Collected
Collection Failed
Originated *
Settled *
Represented
Originated SDACH *
Settled SDACH *
Held For Approval
Suspended
Sent To Collection
In Research
Charged Back
Returned NSF
Returned Bad Account
Resolved
Other Check21 Returns
Notice Of Change
Unauthorized
RTP
RTP_Error

note

Responses for these message types may be delayed due to the quantity produced. We recommend that you set up a separate subscription for these message types, so that they do not affect the timeliness of other events.

PRODUCT TYPES:
All transaction
RDA
RDC
mRDC

Message Properties​

Customer Properties​

Location Properties​

Notice Of Changes Properties​

Event Properties​

Example​

Options​