Deposits

The Deposits Service supports creating payment transctions in Clearingworks either one transaction at a time or as a batch.

Accept or reject a transaction pending in Deposit Approval

Accepts or rejects the deposit

SecurityJWT
Request
path Parameters
transactionId
required
integer <int64>
accept
required
boolean
Responses
200

Success

403

Forbidden

500

Internal Server Error

get/cw/deposits/decisionPendingDeposit/{transactionId}/{accept}
Request samples 
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Deposit Batch
Deposits a batch of transactions


SecurityJWT 
Request 
Request Body schema: 
object (BusinessUnit) 
Business unit to which this user is authorized (and all business units below)


 
busUnitId
required
integer <int32> 
System Id of the Business Unit owning the batch


 
busUnitName
string
Name of the Business Unit owning the batch


 
billerBusUnitId
integer <int32> 
System Id of the Biller Business Unit


 
billerBusUnitName
string
Name of the Biller Business Unit


 
propertySetId
integer <int32> 
Id of the property set for workflow configuration


 
siteId
integer <int32> 
System Id of the Site where the batch was imported


 
siteName
string
Name of the Site where the batch was imported


 
transactionType
string
Transaction Type of the batch


 
fileId
integer <int64> 
System Id of the File containing the batch


 
fileName
string
Name of the File containing the batch


 
userBatchId
string
User-defined Id of the Batch


 
importDate
string <date-time> 
Timestamp the batch was imported into the system


 
processDate
string <date-time> 
Date assigned for processing the batch


 
channelName
string
Channel Name for the business unit


 
controlDebitCount
integer <int32> 
Batch's total debit count


 
controlCreditCount
integer <int32> 
Batch's total credit count


 
controlDebitAmount
number
Batch's total debit amount


 
controlCreditAmount
number
Batch's total credit amount


 
transportType
string
Transport type


 
transportId
string
Transport identifier


 
Array of objects (Transaction) 
Transactions within the batch


 
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


403
Validation Failure


500
Internal Server Error


post/cw/deposits/depositBatch
Request samples 
{
  • "busUnit": {
    },
  • "busUnitId": 23143,
  • "busUnitName": "Joe's Flowers Pmt Lbx",
  • "billerBusUnitId": 23143,
  • "billerBusUnitName": "Joe's Flowers",
  • "propertySetId": 123423,
  • "siteId": 23143,
  • "siteName": "Dallas",
  • "transactionType": "Singles",
  • "fileId": 23143,
  • "fileName": "23143",
  • "userBatchId": "Canon2314-23412341.1",
  • "importDate": "2023/07/08 13:04:48.145X",
  • "processDate": "2023/07/08 13:04:48.145X",
  • "channelName": "Lockbox",
  • "controlDebitCount": 12,
  • "controlCreditCount": 12,
  • "controlDebitAmount": 43.12,
  • "controlCreditAmount": 43.12,
  • "transportType": "OPEX",
  • "transportId": "OPEX-1",
  • "transactions": [
    ],
  • "systemId": 12341,
  • "partitionNumber": 34,
  • "status": "Accepted",
  • "opmtPaymentType": "string",
  • "softRejectCode": {
    },
  • "hardRejectCode": {
    },
  • "customFields": [
    ],
  • "auditEntries": [
    ],
  • "violations": [
    ]
}
Response samples 
{
  • "busUnit": {
    },
  • "busUnitId": 23143,
  • "busUnitName": "Joe's Flowers Pmt Lbx",
  • "billerBusUnitId": 23143,
  • "billerBusUnitName": "Joe's Flowers",
  • "propertySetId": 123423,
  • "siteId": 23143,
  • "siteName": "Dallas",
  • "transactionType": "Singles",
  • "fileId": 23143,
  • "fileName": "23143",
  • "userBatchId": "Canon2314-23412341.1",
  • "importDate": "2023/07/08 13:04:48.145X",
  • "processDate": "2023/07/08 13:04:48.145X",
  • "channelName": "Lockbox",
  • "controlDebitCount": 12,
  • "controlCreditCount": 12,
  • "controlDebitAmount": 43.12,
  • "controlCreditAmount": 43.12,
  • "transportType": "OPEX",
  • "transportId": "OPEX-1",
  • "transactions": [
    ],
  • "systemId": 12341,
  • "partitionNumber": 34,
  • "status": "Accepted",
  • "opmtPaymentType": "string",
  • "softRejectCode": {
    },
  • "hardRejectCode": {
    },
  • "customFields": [
    ],
  • "auditEntries": [
    ],
  • "violations": [
    ]
}
Deposit Payment
Deposits a single transaction within an auto-generated batch


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


403
Validation Failure


500
Internal Server Error


post/cw/deposits/depositPayment
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": [
    ]
}
Query Deposits
Query for deposits meeting the given criteria. Result rows are of type APIItem.


SecurityJWT 
Request 
Request Body schema: 
object
Item Amount


 
busUnitId
required
integer <int32> 
Business Unit


 
object
Channel Name


 
required
object
Import Date


 
object
Depositor Account


 
documentId
integer <int32> 
Document ID


 
object
Export Date


 
object
Item Reject Code


 
itemId
integer <int64> 
Item Id


 
micrAccount
string
Micr Account/DDA


 
object
Check Number


 
micrRt
string
Routing


 
paymentType
string
Payment Type


 
object
Process Date


 
rowLimit
integer <int32> 
Row Limit


 
rowOffset
integer <int32> 
Row Offset


 
rowSortOrder
string
Row Limit


 
object
Sender ID


 
siteId
integer <int32> 
Site


 
status
string
Status


 
transactionId
integer <int64> 
Transaction id


 
transactionNumber
integer <int64> 
Transaction Number


 
object
User Batch Id


 
Responses 
200
Success


500
Internal Server Error


post/cw/deposits/queryDeposits
Request samples 
{
  • "balancedAmount": {
    },
  • "busUnitId": 0,
  • "channelName": {
    },
  • "dashboardDate": {
    },
  • "depositorAccount": {
    },
  • "documentId": 0,
  • "exportDate": {
    },
  • "hardRejectCode": {
    },
  • "itemId": 0,
  • "micrAccount": "string",
  • "micrCheckNumber": {
    },
  • "micrRt": "string",
  • "paymentType": "string",
  • "processDate": {
    },
  • "rowLimit": 0,
  • "rowOffset": 0,
  • "rowSortOrder": "string",
  • "senderId": {
    },
  • "siteId": 0,
  • "status": "string",
  • "transactionId": 0,
  • "transactionNumber": 0,
  • "userBatchId": {
    }
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
➔ Next to Documentation Service