Transaction

The Transaction Service provides access to payment transactions through a query for general transaction information, and the ability to get a specific transaction including images.

Query Transactions

Query for transactions meeting the given criteria. Result rows are of type APIItem.

SecurityJWT
Request
Request Body schema:
object

Check ABA

object

Check Account

object

Check Number

object

Custom String 3

object

Custom String 4

object

Custom String 5

object

Payee Name

object

Payor Name

accountNumber
string

Account Number

arAmount1
number

AR Amount 1

arAmount2
number

AR Amount 2

arAmount3
number

AR Amount 3

object

Applied Amount

busUnitId
required
integer <int32>

Business Unit

object

Channel

clientTraceNumber
string

Client Trace Number

depositorAccount
string

Depositor Account Number

documentId
integer <int32>

Document ID

externalBusUnitId
string

External ID on the business unit

hardRejectCode
string

Reject Code

object

Invoice Number

itemId
integer <int64>

Item Reference Id

minimumAmount
number

Minimum Amount

object

Payment Type

object

Payment Amount

object

Payment Check Num

object

Payment DDA

object

Payment Routing

payoffAmount
number

Payoff Amount

object

Posting Batch Sequence

receiver
string

Receiver

rowLimit
integer <int32>

Row Limit

rowOffset
integer <int32>

Row Offset

rowSortOrder
string

Row Sort Order

sequenceNumber
integer <int32>

Import Batch Sequence

siteId
integer <int32>

Location

status
string

Status

object

Note

stmtTransType
string

CR/DR

required
object

Date

transactionId
integer <int64>

Transaction ID

object

Transaction Type

txnBalancedAmount
number

Total Amount

object

Import Batch Number

Responses
200

Success

500

Internal Server Error

post/cw/transaction/queryTransactions
Request samples
{
  • "CheckAba": {
    },
  • "CheckAccount": {
    },
  • "CheckNumber": {
    },
  • "CustomString3": {
    },
  • "CustomString4": {
    },
  • "CustomString5": {
    },
  • "PayeeName": {
    },
  • "PayorName": {
    },
  • "accountNumber": "string",
  • "arAmount1": 0,
  • "arAmount2": 0,
  • "arAmount3": 0,
  • "balancedAmount": {
    },
  • "busUnitId": 0,
  • "channelName": {
    },
  • "clientTraceNumber": "string",
  • "depositorAccount": "string",
  • "documentId": 0,
  • "externalBusUnitId": "string",
  • "hardRejectCode": "string",
  • "invoiceNumber": {
    },
  • "itemId": 0,
  • "minimumAmount": 0,
  • "opmtPaymentType": {
    },
  • "paymentAmount": {
    },
  • "paymentCheckNum": {
    },
  • "paymentDda": {
    },
  • "paymentRouting": {
    },
  • "payoffAmount": 0,
  • "postingBatchSequence": {
    },
  • "receiver": "string",
  • "rowLimit": 0,
  • "rowOffset": 0,
  • "rowSortOrder": "string",
  • "sequenceNumber": 0,
  • "siteId": 0,
  • "status": "string",
  • "stickyNote": {
    },
  • "stmtTransType": "string",
  • "transactionCommitDate": {
    },
  • "transactionId": 0,
  • "transactionType": {
    },
  • "txnBalancedAmount": 0,
  • "userBatchId": {
    }
}
Response samples
{
  • "rows": [
    ],
  • "totalCount": 0
}

Get Transaction

Retrieves details of a given transaction, including items and images.

SecurityJWT
Request
path Parameters
partitionNumber
required
integer <int32>
transactionId
required
integer <int64>
Responses
200

Success

404

Not Found

500

Internal Server Error

get/cw/transaction/getTransaction/{partitionNumber}/{transactionId}
Request samples 
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": [
    ]
}
Get Custom Field Value
Gets the value of a custom field for a specific transaction.


SecurityJWT 
Request 
path Parameters
partitionNumber
required
integer <int32> 
 
transactionId
required
integer <int64> 
 
fieldName
required
string
 
Responses 
200
Success


404
Not Found


500
Internal Server Error


get/cw/transaction/customField/{partitionNumber}/{transactionId}/{fieldName}
Request samples 
Response samples 
{
  • "fieldName": "string",
  • "fieldValue": "string"
}
Set Custom Field Value
Sets or updates the value of a custom field for a specific transaction.


SecurityJWT 
Request 
path Parameters
partitionNumber
required
integer <int32> 
 
transactionId
required
integer <int64> 
 
Request Body schema: 
fieldName
string
Unique name of the field as provided in a APIFieldDef.


 
fieldValue
string
Value of the field.


 
Responses 
200
Success


404
Not Found


500
Internal Server Error


post/cw/transaction/customField/{partitionNumber}/{transactionId}
Request samples 
{
  • "fieldName": "string",
  • "fieldValue": "string"
}
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Get Transaction
Retrieves details of a given transaction, including items and images.


SecurityJWT 
Request 
path Parameters
partitionNumber
required
integer <int32> 
 
transactionId
required
integer <int64> 
 
Responses 
200
Success


404
Not Found


500
Internal Server Error


get/cw/transaction/getTransactionWithHighResImages/{partitionNumber}/{transactionId}
Request samples 
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": [
    ]
}
IRD
IRD


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


 
required
object
Export Date


 
itemId
required
integer <int64> 
PK Clearingworks (External) unique id for the payment


 
transactionId
required
integer <int64> 
Clearingworks (External) transaction id


 
Responses 
200
Success


500
Internal Server Error


post/cw/transaction/generateIRD
Request samples 
{
  • "busUnitId": 0,
  • "exportDate": {
    },
  • "itemId": 0,
  • "transactionId": 0
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Query Pending Transactions
Query for Pending transactions meeting the given criteria. Result rows are of type APIItem.


SecurityJWT 
Request 
Request Body schema: 
object
Check ABA


 
object
Check Account


 
object
Check Number


 
object
Custom String 3


 
object
Custom String 4


 
object
Custom String 5


 
object
Payee Name


 
object
Payor Name


 
accountNumber
string
Account Number


 
arAmount1
number
AR Amount 1


 
arAmount2
number
AR Amount 2


 
arAmount3
number
AR Amount 3


 
object
Applied Amount


 
busUnitId
required
integer <int32> 
Business Unit


 
object
Channel


 
clientTraceNumber
string
Client Trace Number


 
depositorAccount
string
Depositor Account Number


 
documentId
integer <int32> 
Document ID


 
hardRejectCode
string
Reject Code


 
object
Invoice Number


 
itemId
integer <int64> 
Item Reference Id


 
minimumAmount
number
Minimum Amount


 
object
Payment Type


 
payoffAmount
number
Payoff Amount


 
object
Posting Batch Sequence


 
receiver
string
Receiver


 
rowLimit
integer <int32> 
Row Limit


 
rowOffset
integer <int32> 
Row Offset


 
rowSortOrder
string
Row Sort Order


 
sequenceNumber
integer <int32> 
Import Batch Sequence


 
siteId
integer <int32> 
Location


 
status
string
Status


 
object
Note


 
stmtTransType
string
CR/DR


 
transactionId
integer <int64> 
Transaction ID


 
object
Transaction Type


 
object
Import Batch Number


 
Responses 
200
Success


500
Internal Server Error


post/cw/transaction/queryPendingTransactions
Request samples 
{
  • "CheckAba": {
    },
  • "CheckAccount": {
    },
  • "CheckNumber": {
    },
  • "CustomString3": {
    },
  • "CustomString4": {
    },
  • "CustomString5": {
    },
  • "PayeeName": {
    },
  • "PayorName": {
    },
  • "accountNumber": "string",
  • "arAmount1": 0,
  • "arAmount2": 0,
  • "arAmount3": 0,
  • "balancedAmount": {
    },
  • "busUnitId": 0,
  • "channelName": {
    },
  • "clientTraceNumber": "string",
  • "depositorAccount": "string",
  • "documentId": 0,
  • "hardRejectCode": "string",
  • "invoiceNumber": {
    },
  • "itemId": 0,
  • "minimumAmount": 0,
  • "opmtPaymentType": {
    },
  • "payoffAmount": 0,
  • "postingBatchSequence": {
    },
  • "receiver": "string",
  • "rowLimit": 0,
  • "rowOffset": 0,
  • "rowSortOrder": "string",
  • "sequenceNumber": 0,
  • "siteId": 0,
  • "status": "string",
  • "stickyNote": {
    },
  • "stmtTransType": "string",
  • "transactionId": 0,
  • "transactionType": {
    },
  • "userBatchId": {
    }
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Query Transactions All Reject Actions
Query for transactions meeting the given criteria, regardless of reject action. Result rows are of type APIItem.


SecurityJWT 
Request 
Request Body schema: 
object
Check ABA


 
object
Check Account


 
object
Check Number


 
object
Custom String 3


 
object
Custom String 4


 
object
Custom String 5


 
object
Payee Name


 
object
Payor Name


 
object
Applied Amount


 
busUnitId
required
integer <int32> 
Business Unit


 
object
Channel


 
clientTraceNumber
string
Client Trace Number


 
depositorAccount
string
Depositor Account Number


 
documentId
integer <int32> 
Document ID


 
hardRejectCode
string
Reject Code


 
required
object
Import Date


 
object
Invoice Number


 
itemId
integer <int64> 
Item Reference Id


 
object
Payment Type


 
object
Posting Batch Sequence


 
receiver
string
Receiver


 
rowLimit
integer <int32> 
Row Limit


 
rowOffset
integer <int32> 
Row Offset


 
rowSortOrder
string
Row Sort Order


 
sequenceNumber
integer <int32> 
Import Batch Sequence


 
siteId
integer <int32> 
Location


 
status
string
Status


 
object
Note


 
transactionId
integer <int64> 
Transaction ID


 
object
Transaction Type


 
object
Import Batch Number


 
Responses 
200
Success


500
Internal Server Error


post/cw/transaction/queryTransactionsAllRejectActions
Request samples 
{
  • "CheckAba": {
    },
  • "CheckAccount": {
    },
  • "CheckNumber": {
    },
  • "CustomString3": {
    },
  • "CustomString4": {
    },
  • "CustomString5": {
    },
  • "PayeeName": {
    },
  • "PayorName": {
    },
  • "balancedAmount": {
    },
  • "busUnitId": 0,
  • "channelName": {
    },
  • "clientTraceNumber": "string",
  • "depositorAccount": "string",
  • "documentId": 0,
  • "hardRejectCode": "string",
  • "importDate": {
    },
  • "invoiceNumber": {
    },
  • "itemId": 0,
  • "opmtPaymentType": {
    },
  • "postingBatchSequence": {
    },
  • "receiver": "string",
  • "rowLimit": 0,
  • "rowOffset": 0,
  • "rowSortOrder": "string",
  • "sequenceNumber": 0,
  • "siteId": 0,
  • "status": "string",
  • "stickyNote": {
    },
  • "transactionId": 0,
  • "transactionType": {
    },
  • "userBatchId": {
    }
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
➔ Next to User Account