Exceptions

The Exceptions Service in Clearingworks integrates external systems into the online decision process for payments. It handles transactions that fail to meet posting requirements and routes them to a queue for manual review by the merchant. This service provides APIs allowing a 3rd party to provide the user interface for a merchant to manage these exceptions.

Run Rules On Transaction

Runs defined field rules for the transaction. This may update the transaction based on calculations and violations

SecurityJWT
Request
Request Body schema:
object (Batch)

Batch level information for the transaction

clientTraceNum
string

Externally-assinged Id for the transaction

transactionNumber
integer <int64>

Number of this transaction with the batch

balancedAmount
number

Total balanced amount of the transaction

workSubType
string

Work Sub-type for controlling users with access to exceptions

senderId
string

SenderId of the user who created the transaction

exportDate
string <date-time>

Timestamp the transaction was exported/committed

Array of objects (Item)

Items of the transaction

systemId
integer <int64>

System Id for this object

partitionNumber
integer <int32>

Database partition number where transaction is stored.

status
string

Current status of the object

opmtPaymentType
string

Payment type of the transcation (CARD/ACH/CHECK..)

object (RejectCode)

Reject code for the transaction if any

object (RejectCode)

Reject code for the transaction if any

Array of objects (FieldValue)

Custom fields of the object

Array of objects (AuditEntry)

Audit Entries of the object

Array of objects (ValViolation)

Validation Violations of the object

Responses
200

Success

404

Not Found

500

Internal Server Error

post/cw/exceptions/runRulesOnTransaction
Request samples
{
  • "batch": {
    },
  • "clientTraceNum": "12341",
  • "transactionNumber": 12,
  • "balancedAmount": 45.12,
  • "workSubType": "Default",
  • "senderId": "string",
  • "exportDate": "2023/07/08 13:04:48.145X",
  • "items": [
    ],
  • "systemId": 12341,
  • "partitionNumber": 34,
  • "status": "Accepted",
  • "opmtPaymentType": "string",
  • "softRejectCode": {
    },
  • "hardRejectCode": {
    },
  • "customFields": [
    ],
  • "auditEntries": [
    ],
  • "violations": [
    ]
}
Response samples
{
  • "batch": {
    },
  • "clientTraceNum": "12341",
  • "transactionNumber": 12,
  • "balancedAmount": 45.12,
  • "workSubType": "Default",
  • "senderId": "string",
  • "exportDate": "2023/07/08 13:04:48.145X",
  • "items": [
    ],
  • "systemId": 12341,
  • "partitionNumber": 34,
  • "status": "Accepted",
  • "opmtPaymentType": "string",
  • "softRejectCode": {
    },
  • "hardRejectCode": {
    },
  • "customFields": [
    ],
  • "auditEntries": [
    ],
  • "violations": [
    ]
}

Refresh the lock

Refreshes the lock on the data entry work returning the new lock timeout.

SecurityJWT
Request
path Parameters
detId
required
integer <int64>
Responses
200

Success

404

Not Found

500

Internal Server Error

get/cw/exceptions/refreshLock/{detId}
Request samples 
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Saves the exception
Saves the transaction exception


SecurityJWT 
Request 
Request Body schema: 
exceptionId
integer <int64> 
System Id for this data entry work, the data entry transaction id.


 
object (DataEntryConfig) 
Data Entry configuration for editing this transaction.


 
object (Transaction) 
Transaction in data entry work.


 
object (RejectCode) 
Reject code for the transaction if any


 
workType
string
The type of data entry work being performed.


 
Responses 
200
Success


403
Forbidden


500
Internal Server Error


post/cw/exceptions/saveTransactionException
Request samples 
{
  • "exceptionId": "12341",
  • "dataEntryConfig": {
    },
  • "transaction": {
    },
  • "rejectCode": {
    },
  • "workType": "string"
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
List Transaction Exceptions
Retrieves the transaction exceptions for the given criteria. Rows are of type APITransactionException


SecurityJWT 
Request 
Request Body schema: 
busUnitId
required
integer <int32> 
Business Unit


 
object
Channel Name


 
object
Import Date


 
rowLimit
integer <int32> 
Row Limit


 
rowOffset
integer <int32> 
Row Offset


 
rowSortOrder
string
Row Sort Order


 
object
Work Sub Type


 
Responses 
200
Success


500
Internal Server Error


post/cw/exceptions/listTransactionExceptions
Request samples 
{
  • "busUnitId": 0,
  • "channelName": {
    },
  • "importDate": {
    },
  • "rowLimit": 0,
  • "rowOffset": 0,
  • "rowSortOrder": "string",
  • "workSubType": {
    }
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Rejects the exception
Rejects the transaction exception


SecurityJWT 
Request 
Request Body schema: 
exceptionId
integer <int64> 
System Id for this data entry work, the data entry transaction id.


 
object (DataEntryConfig) 
Data Entry configuration for editing this transaction.


 
object (Transaction) 
Transaction in data entry work.


 
object (RejectCode) 
Reject code for the transaction if any


 
workType
string
The type of data entry work being performed.


 
Responses 
200
Success


403
Forbidden


500
Internal Server Error


post/cw/exceptions/rejectTransactionException
Request samples 
{
  • "exceptionId": "12341",
  • "dataEntryConfig": {
    },
  • "transaction": {
    },
  • "rejectCode": {
    },
  • "workType": "string"
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Get the Transaction Exception
Gets a work unit for editing. The work unit is locked.


SecurityJWT 
Request 
path Parameters
detId
required
integer <int64> 
 
Responses 
200
Success


404
Not Found


409
Cannot be locked


412
Precondition failed


500
Internal Server Error


get/cw/exceptions/getTransactionException/{detId}
Request samples 
Response samples 
{
  • "exceptionId": "12341",
  • "dataEntryConfig": {
    },
  • "transaction": {
    },
  • "rejectCode": {
    },
  • "workType": "string"
}
Release the lock
Releases the lock on the data entry work.


SecurityJWT 
Request 
path Parameters
detId
required
integer <int64> 
 
Responses 
200
Success


404
Not Found


500
Internal Server Error


get/cw/exceptions/releaseLock/{detId}
Request samples 
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Submits the exception
Submits the transaction exception


SecurityJWT 
Request 
Request Body schema: 
exceptionId
integer <int64> 
System Id for this data entry work, the data entry transaction id.


 
object (DataEntryConfig) 
Data Entry configuration for editing this transaction.


 
object (Transaction) 
Transaction in data entry work.


 
object (RejectCode) 
Reject code for the transaction if any


 
workType
string
The type of data entry work being performed.


 
Responses 
200
Success


403
Forbidden


500
Internal Server Error


post/cw/exceptions/submitTransactionException
Request samples 
{
  • "exceptionId": "12341",
  • "dataEntryConfig": {
    },
  • "transaction": {
    },
  • "rejectCode": {
    },
  • "workType": "string"
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
➔ Next to File Transfer