Message Options / Definitions
Below is a list of message types with example files and assigned options for each message type. The message options allow the integrator to filter the messages based upon the type of event being sent, so that they don’t have to handle unnecessary messages.
| MESSAGE TYPES | EXAMPLE | MESSAGE OPTIONS |
|---|---|---|
| Extended Transaction Event | Appendix.ExtendedTransactionEvent.Example | Appendix.ExtendedTransactionEvent.Options |
All our messages will include an “isTest” value (ex. isTest=”true”) to help the SmartWatch subscriber identify where messages were originated. This will allow both teams to send and handle messages without affecting the live pipeline.
When setting up new integrations, the subscription mode will be set to “Test”, so all messages will have the “IsTest” field marked as “True”.
When troubleshooting subscriptions in Active mode (ie live subscriptions) it is best to use the “IsTest” field to determine which messages should be saved in your live database and which messages should not.
- isTest=“true” means the EPS support team has generated the test message
- isTest=“false” means the message is a live event
List of Message Options and Their Definitions
See the list below for message options and the definitions of their associated transaction events.
| OPTION | DEFINITION |
|---|---|
| Declined | A submitted item was declined for processing |
| Approved | Item is approved for processing |
| Processing Error | An error occurred during processing, contact support. |
| Voided | An approved item was voided |
| Captured | An auth item was Captured (usually card) |
| Refunded | A Processed item has been refunded (ACH Only) |
| Reversed | Not Currently Used |
| Data Updated | Not Currently Used |
| Edited | An item was edited (e.g. Check 21 adjustments) |
| Queued | Not Currently Used |
| Batched | Not Currently Used |
| Processed | Item is processed |
| Cleared | A transaction has been processed but the settlement was cancelled (likely due to a return) |
| Collected | Collections succeeded |
| Collection Failed | Collections failed |
| Originated | Debit portion of transaction has occurred |
| Settled | Credit portion of transaction has occurred |
| Represented | Item has been resubmitted as a representment |
| Originated SDACH | Debit portion of transaction has occurred for Same Day ACH transaction |
| Settled SDACH | Credit portion of transaction has occurred for Same Day ACH transaction |
| Held For Approval | Not Currently Used |
| Suspended | A submitted item was suspended (due to velocity, velocity items can also be declined depending on how the merchant’s risk settings) |
| Sent To Collection | If collections are enabled Returned_NSF will go to collections |
| In Research | A non-standard return event. See R Code for details. |
| Charged Back | Transaction has been charged back to cardholder (Card Only) |
| Returned NSF | Item return event |
| Returned Bad Account | Item return event |
| Resolved | An item in a status other than Processed has been resolved |
| Other Check21 Returns | Item return event |
| Notice Of Change | A NOC was received for an item (ACH Only) |
| Unauthorized | Item return event |