Configuration

Configuration Services supports running Clearingworks automations, called Configuration Jobs. Each configuration job is designed to perform a specific list of configuration actions. Each action may require information in the form of a Configuration Card. Each configuration job is configured using the Clearingworks Admin UI. Technically this service supports running configuration jobs through a generic path, but for documentation purposes, each avaialble configuration job is listed as its own path.

Run configuration job: CM New Multi-Account Retail Lbx

Runs configuration job with this description: Creates a new multi-account retail lockbox

SecurityJWT

Request

Request Body schema:
application/json

newBusUnitName required	string New Business Unit Name
parentBusUnitName required	string Parent Business Unit
poBox required	string PO Box
contactBillerName required	string Contact Biller Name
contactAddrLine1 required	string Contact Address Line 1
contactAddrLine2	string Contact Address Line 2
contactCityStateZip required	string Contact City State and Zip
exceptionExpirationDays required	string Exception Expiration Days
depositorAccountNumber required	string Depositor Account Number
accountNumberEnter required	string Cust. Account #: enter in data entry Enum: "true" "false"
accountNumberLabel	string Cust. Account #: label
accountNumberMatchTo	string Cust. Account #: match to reference data Enum: "true" " false"
accountNumberRegex	string Cust. Account #: match this regular expression
accountNumberMaxLength	string Cust. Account #: maximum length
accountNumberRequired	string Cust. Account #: required Enum: "true" "false"
altAccountNumberEnter required	string Cust. Alt Account #: enter in data entry Enum: "true" "false"
altAccountNumberLabel	string Cust. Alt Account #: label
altAccountNumberMatchTo	string Cust. Alt Account #: match to reference data Enum: "true" " false"
altAccountNumberRegex	string Cust. Alt Account #: match this regular expression
altAccountNumberMaxLength	string Cust. Alt Account #: maximum length
altAccountNumberRequired	string Cust. Alt Account #: required Enum: "true" "false"
customString3Enter required	string Custom Field 1: enter in data entry Enum: "true" "false"
customString3Label	string Custom Field 1: label
customString3Regex	string Custom Field 1: match this regular expression
customString3MaxLength	string Custom Field 1: maximum length
customString3Required	string Custom Field 1: required Enum: "true" "false"
customString4Enter required	string Custom Field 2: enter in data entry Enum: "true" "false"
customString4Label	string Custom Field 2: label
customString4Regex	string Custom Field 2: match this regular expression
customString4MaxLength	string Custom Field 2: maximum length
customString4Required	string Custom Field 2: required Enum: "true" "false"
customString5Enter required	string Custom Field 3: enter in data entry Enum: "true" "false"
customString5Label	string Custom Field 3: label
customString5Regex	string Custom Field 3: match this regular expression
customString5MaxLength	string Custom Field 3: maximum length
customString5Required	string Custom Field 3: required Enum: "true" "false"
minimumAmountEnter required	string Minimum Amount: enter in data entry Enum: "true" "false"
minimumAmountLabel	string Minimum Amount: label
minimumAmountRequired	string Minimum Amount: required Enum: "true" "false"
payoffAmountEnter required	string Payoff Amount: enter in data entry Enum: "true" "false"
payoffAmountLabel	string Payoff Amount: label
payoffAmountRequired	string Payoff Amount: required Enum: "true" "false"
arAmount1Enter required	string AR Amount 1: enter in data entry Enum: "true" "false"
arAmount1Label	string AR Amount 1: label
arAmount1Required	string AR Amount 1: required Enum: "true" "false"
arAmount2Enter required	string AR Amount 2: enter in data entry Enum: "true" "false"
arAmount2Label	string AR Amount 2: label
arAmount2Required	string AR Amount 2: required Enum: "true" "false"
arAmount3Enter required	string AR Amount 3: enter in data entry Enum: "true" "false"
arAmount3Label	string AR Amount 3: label
arAmount3Required	string AR Amount 3: required Enum: "true" "false"
makerNameEnter required	string Maker Name: enter in data entry Enum: "true" "false"
makerNameLabel	string Maker Name: label

Responses

200

Success

400

Bad Request, Invalid Parameters

404

Not Found

500

Internal Server Error

post/cw/configuration/runConfigurationJob/CMNewMulti-AccountRetailLbx

Request samples

{"newBusUnitName": "string",
"parentBusUnitName": "string",
"poBox": "string",
"contactBillerName": "string",
"contactAddrLine1": "string",
"contactAddrLine2": "string",
"contactCityStateZip": "string",
"exceptionExpirationDays": "string",
"depositorAccountNumber": "string",
"accountNumberEnter": "true",
"accountNumberLabel": "string",
"accountNumberMatchTo": "true",
"accountNumberRegex": "string",
"accountNumberMaxLength": "string",
"accountNumberRequired": "true",
"altAccountNumberEnter": "true",
"altAccountNumberLabel": "string",
"altAccountNumberMatchTo": "true",
"altAccountNumberRegex": "string",
"altAccountNumberMaxLength": "string",
"altAccountNumberRequired": "true",
"customString3Enter": "true",
"customString3Label": "string",
"customString3Regex": "string",
"customString3MaxLength": "string",
"customString3Required": "true",
"customString4Enter": "true",
"customString4Label": "string",
"customString4Regex": "string",
"customString4MaxLength": "string",
"customString4Required": "true",
"customString5Enter": "true",
"customString5Label": "string",
"customString5Regex": "string",
"customString5MaxLength": "string",
"customString5Required": "true",
"minimumAmountEnter": "true",
"minimumAmountLabel": "string",
"minimumAmountRequired": "true",
"payoffAmountEnter": "true",
"payoffAmountLabel": "string",
"payoffAmountRequired": "true",
"arAmount1Enter": "true",
"arAmount1Label": "string",
"arAmount1Required": "true",
"arAmount2Enter": "true",
"arAmount2Label": "string",
"arAmount2Required": "true",
"arAmount3Enter": "true",
"arAmount3Label": "string",
"arAmount3Required": "true",
"makerNameEnter": "true",
"makerNameLabel": "string"
}

Response samples

{"httpCode": 0,
"message": "Failed to authorize.",
"systemId": 123412351
}

Run configuration job: Onboard Biller

Runs configuration job with this description: Generic Onboarding of a new Biller

SecurityJWT

Request

Request Body schema:
application/json

required	object List for identifying the Lockbox Mail information
required	object Generates depositor accounts from specified bank accounts and updates banking relationships for Direct billers.
required	object Configuration Card for Online Payments
Reference Data required	any
EOD Automation required	any
required	object Bundle for the Identification information.
required	object Card for identifying the tag values for the Property Set.
required	object Configuration of the custom fields.
required	object Billing information
required	object
required	object Creates user accounts for all contacts where createUIAccount is true.
Exceptions required	any

Responses

200

Success

400

Bad Request, Invalid Parameters

404

Not Found

500

Internal Server Error

post/cw/configuration/runConfigurationJob/OnboardBiller

Request samples

{"LockboxConfig": {"consolidatorBusUnit": "CheckAlt, BankXX",
"lockboxBoxes": [{"location": "Electronic",
"assignReservedBox": true,
"poBox": "string",
"barCode": "string"
}
],
"scanlineName": "string",
"usingPayeeVerification": true
},
"Banking": {"bankAccounts": [{"displayName": "Account At The Electric Company Depositor",
"bankRouting": "011000002",
"depositAccountNumber": "000-12245-23",
"name": "First State Properties"
}
],
"bankSettlements": [{"outputType": "ACH",
"bankingRelationshipName": "<Custom>"
}
]
},
"OnlinePaymentsConfig": {"consolidatorBusUnit": "CheckAlt, BankXX"
},
"Reference Data": null,
"EOD Automation": null,
"Identification": {"legalName": "string",
"clientId": "string",
"billerId": "string",
"externalId": "string"
},
"TagCard": {"tagValues": [{"customPropName": "BU_TYPE",
"customPropValue": "LBX_BILLER"
}
]
},
"CustomFieldsConfig": {"customFields": [{"customPropName": "BU_TYPE"
}
]
},
"BillingCard": {"billingCodes": ["string"
]
},
"CatchConfig": {"consolidatorBusUnit": "CheckAlt, BankXX"
},
"UserAccounts": {"userAccounts": [{"createCWAccount": "true",
"createUIAccount": "false",
"role": "Clearingworks Administrator",
"fullName": "John Doe",
"email": "john.doe@myco.com",
"password": "string"
}
]
},
"Exceptions": null
}

Response samples

{"httpCode": 0,
"message": "Failed to authorize.",
"systemId": 123412351
}

Run configuration job: Offboard Biller

Runs configuration job with this description: Disables and sets end dates for offboarding process

SecurityJWT

Request

Request Body schema:
application/json

offboardBusUnit required	integer <int32> Offboard Business Unit
disableNow required	number <double> Disable Now
billingEndDate required	string <date-time> Billing End Date
billerDeleteDate	string <date-time> Data Deletion Date

Responses

200

Success

400

Bad Request, Invalid Parameters

404

Not Found

500

Internal Server Error

post/cw/configuration/runConfigurationJob/OffboardBiller

Request samples

{"offboardBusUnit": 0,
"disableNow": 0,
"billingEndDate": "2019-08-24T14:15:22Z",
"billerDeleteDate": "2019-08-24T14:15:22Z"
}

Response samples

{"httpCode": 0,
"message": "Failed to authorize.",
"systemId": 123412351
}

Run configuration job: CM New Wholesale Lockbox

Runs configuration job with this description: Creates a new wholesale lockbox

SecurityJWT

Request

Request Body schema:
application/json

newBusUnitName required	string New Business Unit Name
parentBusUnitName required	string Parent Business Unit
poBox required	string PO Box
contactBillerName required	string Contact Biller Name
contactAddrLine1 required	string Contact Address Line 1
contactAddrLine2	string Contact Address Line 2
contactCityStateZip required	string Contact City State and Zip
exceptionExpirationDays required	string Exception Expiration Days
propertySetType required	string Account/Invoice Enum: "Account" "Invoice" "Account+Invoice"
depositorAccountNumber required	string Depositor Account Number
accountNumberEnter required	string Cust. Account #: enter in data entry Enum: "true" "false"
accountNumberLabel	string Cust. Account #: label
accountNumberRegex	string Cust. Account #: match this regular expression
accountNumberMaxLength	string Cust. Account #: maximum length
accountNumberRequired	string Cust. Account #: required Enum: "true" "false"
altAccountNumberEnter required	string Cust. Alt Account #: enter in data entry Enum: "true" "false"
altAccountNumberLabel	string Cust. Alt Account #: label
altAccountNumberRegex	string Cust. Alt Account #: match this regular expression
altAccountNumberMaxLength	string Cust. Alt Account #: maximum length
altAccountNumberRequired	string Cust. Alt Account #: required Enum: "true" "false"
customString3Enter required	string Custom Field 1: enter in data entry Enum: "true" "false"
customString3Label	string Custom Field 1: label
customString3Regex	string Custom Field 1: match this regular expression
customString3MaxLength	string Custom Field 1: maximum length
customString3Required	string Custom Field 1: required Enum: "true" "false"
customString4Enter required	string Custom Field 2: enter in data entry Enum: "true" "false"
customString4Label	string Custom Field 2: label
customString4Regex	string Custom Field 2: match this regular expression
customString4MaxLength	string Custom Field 2: maximum length
customString4Required	string Custom Field 2: required Enum: "true" "false"
customString5Enter required	string Custom Field 3: enter in data entry Enum: "true" "false"
customString5Label	string Custom Field 3: label
customString5Regex	string Custom Field 3: match this regular expression
customString5MaxLength	string Custom Field 3: maximum length
customString5Required	string Custom Field 3: required Enum: "true" "false"
minimumAmountEnter required	string Minimum Amount: enter in data entry Enum: "true" "false"
minimumAmountLabel	string Minimum Amount: label
minimumAmountRequired	string Minimum Amount: required Enum: "true" "false"
payoffAmountEnter required	string Payoff Amount: enter in data entry Enum: "true" "false"
payoffAmountLabel	string Payoff Amount: label
payoffAmountRequired	string Payoff Amount: required Enum: "true" "false"
arAmount1Enter required	string AR Amount 1: enter in data entry Enum: "true" "false"
arAmount1Label	string AR Amount 1: label
arAmount1Required	string AR Amount 1: required Enum: "true" "false"
arAmount2Enter required	string AR Amount 2: enter in data entry Enum: "true" "false"
arAmount2Label	string AR Amount 2: label
arAmount2Required	string AR Amount 2: required Enum: "true" "false"
arAmount3Enter required	string AR Amount 3: enter in data entry Enum: "true" "false"
arAmount3Label	string AR Amount 3: label
arAmount3Required	string AR Amount 3: required Enum: "true" "false"
makerNameEnter required	string Maker Name: enter in data entry Enum: "true" "false"
makerNameLabel	string Maker Name: label

Responses

200

Success

400

Bad Request, Invalid Parameters

404

Not Found

500

Internal Server Error

post/cw/configuration/runConfigurationJob/CMNewWholesaleLockbox

Request samples

{"newBusUnitName": "string",
"parentBusUnitName": "string",
"poBox": "string",
"contactBillerName": "string",
"contactAddrLine1": "string",
"contactAddrLine2": "string",
"contactCityStateZip": "string",
"exceptionExpirationDays": "string",
"propertySetType": "Account",
"depositorAccountNumber": "string",
"accountNumberEnter": "true",
"accountNumberLabel": "string",
"accountNumberRegex": "string",
"accountNumberMaxLength": "string",
"accountNumberRequired": "true",
"altAccountNumberEnter": "true",
"altAccountNumberLabel": "string",
"altAccountNumberRegex": "string",
"altAccountNumberMaxLength": "string",
"altAccountNumberRequired": "true",
"customString3Enter": "true",
"customString3Label": "string",
"customString3Regex": "string",
"customString3MaxLength": "string",
"customString3Required": "true",
"customString4Enter": "true",
"customString4Label": "string",
"customString4Regex": "string",
"customString4MaxLength": "string",
"customString4Required": "true",
"customString5Enter": "true",
"customString5Label": "string",
"customString5Regex": "string",
"customString5MaxLength": "string",
"customString5Required": "true",
"minimumAmountEnter": "true",
"minimumAmountLabel": "string",
"minimumAmountRequired": "true",
"payoffAmountEnter": "true",
"payoffAmountLabel": "string",
"payoffAmountRequired": "true",
"arAmount1Enter": "true",
"arAmount1Label": "string",
"arAmount1Required": "true",
"arAmount2Enter": "true",
"arAmount2Label": "string",
"arAmount2Required": "true",
"arAmount3Enter": "true",
"arAmount3Label": "string",
"arAmount3Required": "true",
"makerNameEnter": "true",
"makerNameLabel": "string"
}

Response samples

{"httpCode": 0,
"message": "Failed to authorize.",
"systemId": 123412351
}

Run configuration job: Financial Transmission

Runs configuration job with this description: Financial Transmission Details Search extract

SecurityJWT

Request

Request Body schema:
application/json

StreamSecurityConfigName	string StreamSecurityConfigName
BusUnitId	integer <int32> BusUnitId
observationDate required	string <date-time> Observation Date

Responses

200

Success

400

Bad Request, Invalid Parameters

404

Not Found

500

Internal Server Error

post/cw/configuration/runConfigurationJob/FinancialTransmission

Request samples

{"StreamSecurityConfigName": "string",
"BusUnitId": 0,
"observationDate": "2019-08-24T14:15:22Z"
}

Response samples

{"httpCode": 0,
"message": "Failed to authorize.",
"systemId": 123412351
}

Get Configuration Job Metadata

Retrieve the query parameters for a given configuration job.

SecurityJWT

Request

path Parameters

jobName

required

string

Responses

200

Success

404

Not found

500

Internal Server Error

get/cw/configuration/getConfigurationJobMetadata/{jobName}

Request samples

Response samples

{"processName": "CM Add Biller",
"processDescription": "CM Add Biller",
"parameterDefs": [{"name": "importDate",
"description": "Date the transaction was imported",
"dataType": "String",
"validValues": ["string"
],
"required": "true",
"validOperators": ["N/A"
],
"defaultOperator": "=",
"defaultMinValue": "-1bod",
"defaultMaxValue": "+1eod",
"minValidValue": "0",
"maxValidValue": "9999999.99",
"maxValidRange": 30
}
],
"parameterValidationInfoList": [{"parameterName": "string",
"parameterUsage": "REQUIRED",
"regExpPattern": "string",
"validValues": ["string"
],
"minLength": 0,
"maxLength": 0,
"minValue": 0,
"maxValue": 0,
"commitExists": true
}
],
"defaultSelectionModel": {"parameterList": [{"name": "exportDate",
"dataType": "String",
"operator": "EQUALS",
"minValue": "0",
"maxValue": "99999",
"valueList": ["string"
]
}
]
}
}

Run Configuration Job

Run a configuration job with the given criteria.

SecurityJWT

Request

path Parameters

jobName

required

string

Request Body schema:
application/json

Array of objects (ConfigurationCard)

Configuration cards with information related to the merchant

Responses

200

Success

400

Bad Request, Invalid Parameters

404

Not Found

500

Internal Server Error

post/cw/configuration/runConfigurationJob/{jobName}

Request samples

{"cards": [{"cardType": "Identification"
}
]
}

Response samples

{"httpCode": 0,
"message": "Failed to authorize.",
"systemId": 123412351
}

Run configuration job: CM New Deposit-Only Lockbox

Runs configuration job with this description: Creates a new deposit-only lockbox

SecurityJWT

Request

Request Body schema:
application/json

newBusUnitName required	string New Business Unit Name
parentBusUnitName required	string Parent Business Unit
poBox required	string PO Box
contactBillerName required	string Contact Biller Name
contactAddrLine1 required	string Contact Address Line 1
contactAddrLine2	string Contact Address Line 2
contactCityStateZip required	string Contact City State and Zip
exceptionExpirationDays required	string Exception Expiration Days
depositorAccountNumber required	string Depositor Account Number
accountNumberEnter required	string Cust. Account #: enter in data entry Enum: "true" "false"
accountNumberLabel	string Cust. Account #: label
accountNumberRegex	string Cust. Account #: match this regular expression
accountNumberMaxLength	string Cust. Account #: maximum length
accountNumberRequired	string Cust. Account #: required Enum: "true" "false"
altAccountNumberEnter required	string Cust. Alt Account #: enter in data entry Enum: "true" "false"
altAccountNumberLabel	string Cust. Alt Account #: label
altAccountNumberRegex	string Cust. Alt Account #: match this regular expression
altAccountNumberMaxLength	string Cust. Alt Account #: maximum length
altAccountNumberRequired	string Cust. Alt Account #: required Enum: "true" "false"
customString3Enter required	string Custom Field 1: enter in data entry Enum: "true" "false"
customString3Label	string Custom Field 1: label
customString3Regex	string Custom Field 1: match this regular expression
customString3MaxLength	string Custom Field 1: maximum length
customString3Required	string Custom Field 1: required Enum: "true" "false"
customString4Enter required	string Custom Field 2: enter in data entry Enum: "true" "false"
customString4Label	string Custom Field 2: label
customString4Regex	string Custom Field 2: match this regular expression
customString4MaxLength	string Custom Field 2: maximum length
customString4Required	string Custom Field 2: required Enum: "true" "false"
customString5Enter required	string Custom Field 3: enter in data entry Enum: "true" "false"
customString5Label	string Custom Field 3: label
customString5Regex	string Custom Field 3: match this regular expression
customString5MaxLength	string Custom Field 3: maximum length
customString5Required	string Custom Field 3: required Enum: "true" "false"
minimumAmountEnter required	string Minimum Amount: enter in data entry Enum: "true" "false"
minimumAmountLabel	string Minimum Amount: label
minimumAmountRequired	string Minimum Amount: required Enum: "true" "false"
payoffAmountEnter required	string Payoff Amount: enter in data entry Enum: "true" "false"
payoffAmountLabel	string Payoff Amount: label
payoffAmountRequired	string Payoff Amount: required Enum: "true" "false"
arAmount1Enter required	string AR Amount 1: enter in data entry Enum: "true" "false"
arAmount1Label	string AR Amount 1: label
arAmount1Required	string AR Amount 1: required Enum: "true" "false"
arAmount2Enter required	string AR Amount 2: enter in data entry Enum: "true" "false"
arAmount2Label	string AR Amount 2: label
arAmount2Required	string AR Amount 2: required Enum: "true" "false"
arAmount3Enter required	string AR Amount 3: enter in data entry Enum: "true" "false"
arAmount3Label	string AR Amount 3: label
arAmount3Required	string AR Amount 3: required Enum: "true" "false"
makerNameEnter required	string Maker Name: enter in data entry Enum: "true" "false"
makerNameLabel	string Maker Name: label

Responses

200

Success

400

Bad Request, Invalid Parameters

404

Not Found

500

Internal Server Error

post/cw/configuration/runConfigurationJob/CMNewDeposit-OnlyLockbox

Request samples

{"newBusUnitName": "string",
"parentBusUnitName": "string",
"poBox": "string",
"contactBillerName": "string",
"contactAddrLine1": "string",
"contactAddrLine2": "string",
"contactCityStateZip": "string",
"exceptionExpirationDays": "string",
"depositorAccountNumber": "string",
"accountNumberEnter": "true",
"accountNumberLabel": "string",
"accountNumberRegex": "string",
"accountNumberMaxLength": "string",
"accountNumberRequired": "true",
"altAccountNumberEnter": "true",
"altAccountNumberLabel": "string",
"altAccountNumberRegex": "string",
"altAccountNumberMaxLength": "string",
"altAccountNumberRequired": "true",
"customString3Enter": "true",
"customString3Label": "string",
"customString3Regex": "string",
"customString3MaxLength": "string",
"customString3Required": "true",
"customString4Enter": "true",
"customString4Label": "string",
"customString4Regex": "string",
"customString4MaxLength": "string",
"customString4Required": "true",
"customString5Enter": "true",
"customString5Label": "string",
"customString5Regex": "string",
"customString5MaxLength": "string",
"customString5Required": "true",
"minimumAmountEnter": "true",
"minimumAmountLabel": "string",
"minimumAmountRequired": "true",
"payoffAmountEnter": "true",
"payoffAmountLabel": "string",
"payoffAmountRequired": "true",
"arAmount1Enter": "true",
"arAmount1Label": "string",
"arAmount1Required": "true",
"arAmount2Enter": "true",
"arAmount2Label": "string",
"arAmount2Required": "true",
"arAmount3Enter": "true",
"arAmount3Label": "string",
"arAmount3Required": "true",
"makerNameEnter": "true",
"makerNameLabel": "string"
}

Response samples

{"httpCode": 0,
"message": "Failed to authorize.",
"systemId": 123412351
}

Run configuration job: AddDevPortalUser

Runs configuration job with this description: Configuration Job to add a Dev Portal User, and perhaps a new Dev Portal Biller

SecurityJWT

Request

Request Body schema:
application/json

required

object

Creates user accounts for all contacts where createUIAccount is true.

Responses

200

Success

400

Bad Request, Invalid Parameters

404

Not Found

500

Internal Server Error

post/cw/configuration/runConfigurationJob/AddDevPortalUser

Request samples

{"UserAccounts": {"userAccounts": [{"fullName": "John Doe",
"email": "john.doe@myco.com",
"password": "string"
}
]
}
}

Response samples

{"httpCode": 0,
"message": "Failed to authorize.",
"systemId": 123412351
}

Run configuration job: CM New Retail Lockbox

Runs configuration job with this description: Creates a new retail lockbox

SecurityJWT

Request

Request Body schema:
application/json

newBusUnitName required	string New Business Unit Name
parentBusUnitName required	string Parent Business Unit
poBox required	string PO Box
contactBillerName required	string Contact Biller Name
contactAddrLine1 required	string Contact Address Line 1
contactAddrLine2	string Contact Address Line 2
contactCityStateZip required	string Contact City State and Zip
exceptionExpirationDays required	string Exception Expiration Days
depositorAccountNumber required	string Depositor Account Number
accountNumberEnter required	string Cust. Account #: enter in data entry Enum: "true" "false"
accountNumberLabel	string Cust. Account #: label
accountNumberRegex	string Cust. Account #: match this regular expression
accountNumberMaxLength	string Cust. Account #: maximum length
accountNumberRequired	string Cust. Account #: required Enum: "true" "false"
altAccountNumberEnter required	string Cust. Alt Account #: enter in data entry Enum: "true" "false"
altAccountNumberLabel	string Cust. Alt Account #: label
altAccountNumberRegex	string Cust. Alt Account #: match this regular expression
altAccountNumberMaxLength	string Cust. Alt Account #: maximum length
altAccountNumberRequired	string Cust. Alt Account #: required Enum: "true" "false"
customString3Enter required	string Custom Field 1: enter in data entry Enum: "true" "false"
customString3Label	string Custom Field 1: label
customString3Regex	string Custom Field 1: match this regular expression
customString3MaxLength	string Custom Field 1: maximum length
customString3Required	string Custom Field 1: required Enum: "true" "false"
customString4Enter required	string Custom Field 2: enter in data entry Enum: "true" "false"
customString4Label	string Custom Field 2: label
customString4Regex	string Custom Field 2: match this regular expression
customString4MaxLength	string Custom Field 2: maximum length
customString4Required	string Custom Field 2: required Enum: "true" "false"
customString5Enter required	string Custom Field 3: enter in data entry Enum: "true" "false"
customString5Label	string Custom Field 3: label
customString5Regex	string Custom Field 3: match this regular expression
customString5MaxLength	string Custom Field 3: maximum length
customString5Required	string Custom Field 3: required Enum: "true" "false"
minimumAmountEnter required	string Minimum Amount: enter in data entry Enum: "true" "false"
minimumAmountLabel	string Minimum Amount: label
minimumAmountRequired	string Minimum Amount: required Enum: "true" "false"
payoffAmountEnter required	string Payoff Amount: enter in data entry Enum: "true" "false"
payoffAmountLabel	string Payoff Amount: label
payoffAmountRequired	string Payoff Amount: required Enum: "true" "false"
arAmount1Enter required	string AR Amount 1: enter in data entry Enum: "true" "false"
arAmount1Label	string AR Amount 1: label
arAmount1Required	string AR Amount 1: required Enum: "true" "false"
arAmount2Enter required	string AR Amount 2: enter in data entry Enum: "true" "false"
arAmount2Label	string AR Amount 2: label
arAmount2Required	string AR Amount 2: required Enum: "true" "false"
arAmount3Enter required	string AR Amount 3: enter in data entry Enum: "true" "false"
arAmount3Label	string AR Amount 3: label
arAmount3Required	string AR Amount 3: required Enum: "true" "false"
makerNameEnter required	string Maker Name: enter in data entry Enum: "true" "false"
makerNameLabel	string Maker Name: label

Responses

200

Success

400

Bad Request, Invalid Parameters

404

Not Found

500

Internal Server Error

post/cw/configuration/runConfigurationJob/CMNewRetailLockbox

Request samples

{"newBusUnitName": "string",
"parentBusUnitName": "string",
"poBox": "string",
"contactBillerName": "string",
"contactAddrLine1": "string",
"contactAddrLine2": "string",
"contactCityStateZip": "string",
"exceptionExpirationDays": "string",
"depositorAccountNumber": "string",
"accountNumberEnter": "true",
"accountNumberLabel": "string",
"accountNumberRegex": "string",
"accountNumberMaxLength": "string",
"accountNumberRequired": "true",
"altAccountNumberEnter": "true",
"altAccountNumberLabel": "string",
"altAccountNumberRegex": "string",
"altAccountNumberMaxLength": "string",
"altAccountNumberRequired": "true",
"customString3Enter": "true",
"customString3Label": "string",
"customString3Regex": "string",
"customString3MaxLength": "string",
"customString3Required": "true",
"customString4Enter": "true",
"customString4Label": "string",
"customString4Regex": "string",
"customString4MaxLength": "string",
"customString4Required": "true",
"customString5Enter": "true",
"customString5Label": "string",
"customString5Regex": "string",
"customString5MaxLength": "string",
"customString5Required": "true",
"minimumAmountEnter": "true",
"minimumAmountLabel": "string",
"minimumAmountRequired": "true",
"payoffAmountEnter": "true",
"payoffAmountLabel": "string",
"payoffAmountRequired": "true",
"arAmount1Enter": "true",
"arAmount1Label": "string",
"arAmount1Required": "true",
"arAmount2Enter": "true",
"arAmount2Label": "string",
"arAmount2Required": "true",
"arAmount3Enter": "true",
"arAmount3Label": "string",
"arAmount3Required": "true",
"makerNameEnter": "true",
"makerNameLabel": "string"
}

Response samples

{"httpCode": 0,
"message": "Failed to authorize.",
"systemId": 123412351
}

Run configuration job: Update Biller

Runs configuration job with this description: Generic Onboarding (Update) of a new Biller

SecurityJWT

Request

Request Body schema:
application/json

required	object List for identifying the Lockbox Mail information
required	object Generates depositor accounts from specified bank accounts and updates banking relationships for Direct billers.
required	object Configuration Card for Online Payments
Reference Data required	any
EOD Automation required	any
required	object Bundle for the Identification information.
required	object Card for identifying the tag values for the Property Set.
required	object Configuration of the custom fields.
required	object Billing information
required	object
required	object Creates user accounts for all contacts where createUIAccount is true.
Exceptions required	any

Responses

200

Success

400

Bad Request, Invalid Parameters

404

Not Found

500

Internal Server Error

post/cw/configuration/runConfigurationJob/UpdateBiller

Request samples

{"LockboxConfig": {"consolidatorBusUnit": "CheckAlt, BankXX",
"lockboxBoxes": [{"location": "Electronic",
"assignReservedBox": true,
"poBox": "string",
"barCode": "string"
}
],
"scanlineName": "string",
"usingPayeeVerification": true
},
"Banking": {"bankAccounts": [{"displayName": "Account At The Electric Company Depositor",
"bankRouting": "011000002",
"depositAccountNumber": "000-12245-23",
"name": "First State Properties"
}
],
"bankSettlements": [{"outputType": "ACH",
"bankingRelationshipName": "<Custom>"
}
]
},
"OnlinePaymentsConfig": {"consolidatorBusUnit": "CheckAlt, BankXX"
},
"Reference Data": null,
"EOD Automation": null,
"Identification": {"legalName": "string",
"clientId": "string",
"billerId": "string",
"externalId": "string"
},
"TagCard": {"tagValues": [{"customPropName": "BU_TYPE",
"customPropValue": "LBX_BILLER"
}
]
},
"CustomFieldsConfig": {"customFields": [{"customPropName": "BU_TYPE"
}
]
},
"BillingCard": {"billingCodes": ["string"
]
},
"CatchConfig": {"consolidatorBusUnit": "CheckAlt, BankXX"
},
"UserAccounts": {"userAccounts": [{"createCWAccount": "true",
"createUIAccount": "false",
"role": "Clearingworks Administrator",
"fullName": "John Doe",
"email": "john.doe@myco.com",
"password": "string"
}
]
},
"Exceptions": null
}

Response samples

{"httpCode": 0,
"message": "Failed to authorize.",
"systemId": 123412351
}

List Configuration Jobs

Get a list of available configuration jobs

SecurityJWT

Responses

200

Success

500

Internal Server Error

get/cw/configuration/listConfigurationJobs

Request samples

Response samples

{"rows": [{ }
],
"totalCount": 0
}

Run configuration job: CM Add Elec. Bill Pay To LBX

Runs configuration job with this description: Adds Electronic Bill Pay Channel to existing Lockbox

SecurityJWT

Request

Request Body schema:
application/json

consolidatorBusUnit required	string Consolidator
merchantBusUnit required	string Merchant
rppsId required	integer <int32> RPPS ID
fiservId required	integer <int32> FISERV ID
rppsName required	string RPPS NAME
fiservName required	string FISERV NAME
fiservCode required	string FISERV CODE

Responses

200

Success

400

Bad Request, Invalid Parameters

404

Not Found

500

Internal Server Error

post/cw/configuration/runConfigurationJob/CMAddElecBillPayToLBX

Request samples

{"consolidatorBusUnit": "string",
"merchantBusUnit": "string",
"rppsId": 0,
"fiservId": 0,
"rppsName": "string",
"fiservName": "string",
"fiservCode": "string"
}

Response samples

{"httpCode": 0,
"message": "Failed to authorize.",
"systemId": 123412351
}

➔ Next to CustomerAccount

Configuration

Run configuration job: CM New Multi-Account Retail Lbx

Request Body schema: application/jsonapplication/xmlapplication/json

Run configuration job: Onboard Biller

Request Body schema: application/jsonapplication/xmlapplication/json

Run configuration job: Offboard Biller

Request Body schema: application/jsonapplication/xmlapplication/json

Run configuration job: CM New Wholesale Lockbox

Request Body schema: application/jsonapplication/xmlapplication/json

Run configuration job: Financial Transmission

Request Body schema: application/jsonapplication/xmlapplication/json

Get Configuration Job Metadata

path Parameters

Run Configuration Job

path Parameters

Request Body schema: application/jsonapplication/xmlapplication/json

Run configuration job: CM New Deposit-Only Lockbox

Request Body schema: application/jsonapplication/xmlapplication/json

Run configuration job: AddDevPortalUser

Request Body schema: application/jsonapplication/xmlapplication/json

Run configuration job: CM New Retail Lockbox

Request Body schema: application/jsonapplication/xmlapplication/json

Run configuration job: Update Biller

Request Body schema: application/jsonapplication/xmlapplication/json

List Configuration Jobs

Run configuration job: CM Add Elec. Bill Pay To LBX

Request Body schema: application/jsonapplication/xmlapplication/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json