DepositorAccount

The DepositorAccount Service provides access to depositor accounts (bank accounts) used by a biller or merchant. A given biller/merchant may have one or more depositor accounts, and these accounts may have a nickname and display name, in addition to the routing transaction and account number. Each payment transaction is applied to a given depositor account; the specific depositor account is often determined based on the Customer Account information (reference data).

List Depositor Accounts

Get a list of depositor accounts

SecurityJWT
Request
Request Body schema:
object

Account Name

billerBusUnitId
string

billerBusUnitId

busUnitId
integer <int32>

Business Unit

busUnitName
string

busUnitName

externalBusUnitId
string

externalBusUnitId

object

Last Modified Date

rowLimit
integer <int32>

Row Limit

rowOffset
integer <int32>

Row Offset

rowSortOrder
string

Row Sort Order

Responses
200

Success

500

Internal Server Error

post/cw/depositoraccounts/listDepositorAccounts
Request samples
{
  • "acctName": {
    },
  • "billerBusUnitId": "string",
  • "busUnitId": 0,
  • "busUnitName": "string",
  • "externalBusUnitId": "string",
  • "lastModifiedDate": {
    },
  • "rowLimit": 0,
  • "rowOffset": 0,
  • "rowSortOrder": "string"
}
Response samples
{
  • "rows": [
    ],
  • "totalCount": 0
}

Update Deposit Limits

Update the provided deposit limits, matching on systemId. The updated deposit limits is returned

SecurityJWT
Request
Request Body schema:
object (BusinessUnit)

Business unit to which this user is authorized (and all business units below)

refInSubUnits
boolean

Is this deposit limits available for reference in lower level business unit

revwPmtAmtPerCheck
number

Per check amount requiring review

denyPmtAmtPerCheck
number

Per check amount which will be rejected

revwPmtAmtPerDeposit
number

Per deposit amount requiring review

denyPmtAmtPerDeposit
number

Per deposit amount which will be rejected

revwPmtAmtPerDay
number

Daily deposit amount requiring review

denyPmtAmtPerDay
number

Daily deposit amount which will be rejected

revwPmtAmtPerMonth
number

Monthly deposit amount requiring review

denyPmtAmtPerMonth
number

Daily deposit amount which will be rejected

revwPmtCntPerDeposit
integer <int32>

Per deposit check count requiring review

denyPmtCntPerDeposit
integer <int32>

Per deposit check count which will be rejected

revwPmtCntPerDay
integer <int32>

Daily check count requiring review

denyPmtCntPerDay
integer <int32>

Daily check count which will be rejected

revwPmtCntPerMonth
integer <int32>

Monthly check count requiring review

denyPmtCntPerMonth
integer <int32>

Monthly check count which will be rejected

revwDepCntPerDay
integer <int32>

Daily deposit/batch count requiring review

denyDepCntPerDay
integer <int32>

Daily deposit/batch count which will be rejected

revwDepCntPerMonth
integer <int32>

Monthly deposit/batch count requiring review

denyDepCntPerMonth
integer <int32>

Monthly deposit/batch count which will be rejected

objectType
string

Type of the object as mapped to CWObjectType

owningBusUnitId
integer <int32>

Id of Business Unit that owns this configuration object. For a Business Unit, this is the parent business unit.

systemId
integer <int32>

System identity for this configuration object.

name
string

Unique name for this configuration object.

description
string

Description for this configuration object.

lastModifiedDate
string <date-time>

Last modification date

Array of objects (CustomConfigProperty)

Custom Properties for the Configuration Object

Responses
200

Success

400

Bad Request, Invalid Parameters

404

Not Found

500

Internal Server Error

put/cw/depositoraccounts/depositLimits
Request samples
{
  • "busUnit": {
    },
  • "refInSubUnits": true,
  • "revwPmtAmtPerCheck": 132314.23,
  • "denyPmtAmtPerCheck": 132314.23,
  • "revwPmtAmtPerDeposit": 132314.23,
  • "denyPmtAmtPerDeposit": 132314.23,
  • "revwPmtAmtPerDay": 132314.23,
  • "denyPmtAmtPerDay": 132314.23,
  • "revwPmtAmtPerMonth": 132314.23,
  • "denyPmtAmtPerMonth": 132314.23,
  • "revwPmtCntPerDeposit": 123,
  • "denyPmtCntPerDeposit": 123,
  • "revwPmtCntPerDay": 123,
  • "denyPmtCntPerDay": 123,
  • "revwPmtCntPerMonth": 123,
  • "denyPmtCntPerMonth": 123,
  • "revwDepCntPerDay": 123,
  • "denyDepCntPerDay": 123,
  • "revwDepCntPerMonth": 123,
  • "denyDepCntPerMonth": 123,
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}
Response samples
{
  • "busUnit": {
    },
  • "refInSubUnits": true,
  • "revwPmtAmtPerCheck": 132314.23,
  • "denyPmtAmtPerCheck": 132314.23,
  • "revwPmtAmtPerDeposit": 132314.23,
  • "denyPmtAmtPerDeposit": 132314.23,
  • "revwPmtAmtPerDay": 132314.23,
  • "denyPmtAmtPerDay": 132314.23,
  • "revwPmtAmtPerMonth": 132314.23,
  • "denyPmtAmtPerMonth": 132314.23,
  • "revwPmtCntPerDeposit": 123,
  • "denyPmtCntPerDeposit": 123,
  • "revwPmtCntPerDay": 123,
  • "denyPmtCntPerDay": 123,
  • "revwPmtCntPerMonth": 123,
  • "denyPmtCntPerMonth": 123,
  • "revwDepCntPerDay": 123,
  • "denyDepCntPerDay": 123,
  • "revwDepCntPerMonth": 123,
  • "denyDepCntPerMonth": 123,
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}

Add Deposit Limits

Adds the provided deposit limits.

SecurityJWT
Request
Request Body schema:
object (BusinessUnit)

Business unit to which this user is authorized (and all business units below)

refInSubUnits
boolean

Is this deposit limits available for reference in lower level business unit

revwPmtAmtPerCheck
number

Per check amount requiring review

denyPmtAmtPerCheck
number

Per check amount which will be rejected

revwPmtAmtPerDeposit
number

Per deposit amount requiring review

denyPmtAmtPerDeposit
number

Per deposit amount which will be rejected

revwPmtAmtPerDay
number

Daily deposit amount requiring review

denyPmtAmtPerDay
number

Daily deposit amount which will be rejected

revwPmtAmtPerMonth
number

Monthly deposit amount requiring review

denyPmtAmtPerMonth
number

Daily deposit amount which will be rejected

revwPmtCntPerDeposit
integer <int32>

Per deposit check count requiring review

denyPmtCntPerDeposit
integer <int32>

Per deposit check count which will be rejected

revwPmtCntPerDay
integer <int32>

Daily check count requiring review

denyPmtCntPerDay
integer <int32>

Daily check count which will be rejected

revwPmtCntPerMonth
integer <int32>

Monthly check count requiring review

denyPmtCntPerMonth
integer <int32>

Monthly check count which will be rejected

revwDepCntPerDay
integer <int32>

Daily deposit/batch count requiring review

denyDepCntPerDay
integer <int32>

Daily deposit/batch count which will be rejected

revwDepCntPerMonth
integer <int32>

Monthly deposit/batch count requiring review

denyDepCntPerMonth
integer <int32>

Monthly deposit/batch count which will be rejected

objectType
string

Type of the object as mapped to CWObjectType

owningBusUnitId
integer <int32>

Id of Business Unit that owns this configuration object. For a Business Unit, this is the parent business unit.

systemId
integer <int32>

System identity for this configuration object.

name
string

Unique name for this configuration object.

description
string

Description for this configuration object.

lastModifiedDate
string <date-time>

Last modification date

Array of objects (CustomConfigProperty)

Custom Properties for the Configuration Object

Responses
200

Success

400

Bad Request, Invalid Parameters

403

Forbidden

409

Conflict

500

Internal Server Error

post/cw/depositoraccounts/depositLimits
Request samples
{
  • "busUnit": {
    },
  • "refInSubUnits": true,
  • "revwPmtAmtPerCheck": 132314.23,
  • "denyPmtAmtPerCheck": 132314.23,
  • "revwPmtAmtPerDeposit": 132314.23,
  • "denyPmtAmtPerDeposit": 132314.23,
  • "revwPmtAmtPerDay": 132314.23,
  • "denyPmtAmtPerDay": 132314.23,
  • "revwPmtAmtPerMonth": 132314.23,
  • "denyPmtAmtPerMonth": 132314.23,
  • "revwPmtCntPerDeposit": 123,
  • "denyPmtCntPerDeposit": 123,
  • "revwPmtCntPerDay": 123,
  • "denyPmtCntPerDay": 123,
  • "revwPmtCntPerMonth": 123,
  • "denyPmtCntPerMonth": 123,
  • "revwDepCntPerDay": 123,
  • "denyDepCntPerDay": 123,
  • "revwDepCntPerMonth": 123,
  • "denyDepCntPerMonth": 123,
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}
Response samples
{
  • "busUnit": {
    },
  • "refInSubUnits": true,
  • "revwPmtAmtPerCheck": 132314.23,
  • "denyPmtAmtPerCheck": 132314.23,
  • "revwPmtAmtPerDeposit": 132314.23,
  • "denyPmtAmtPerDeposit": 132314.23,
  • "revwPmtAmtPerDay": 132314.23,
  • "denyPmtAmtPerDay": 132314.23,
  • "revwPmtAmtPerMonth": 132314.23,
  • "denyPmtAmtPerMonth": 132314.23,
  • "revwPmtCntPerDeposit": 123,
  • "denyPmtCntPerDeposit": 123,
  • "revwPmtCntPerDay": 123,
  • "denyPmtCntPerDay": 123,
  • "revwPmtCntPerMonth": 123,
  • "denyPmtCntPerMonth": 123,
  • "revwDepCntPerDay": 123,
  • "denyDepCntPerDay": 123,
  • "revwDepCntPerMonth": 123,
  • "denyDepCntPerMonth": 123,
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}

List Deposit Limits

Get a list of deposit limits

SecurityJWT
Request
Request Body schema:
billerBusUnitId
string

billerBusUnitId

busUnitId
integer <int32>

Business Unit

busUnitName
string

busUnitName

object

description

object

Deposit Limits Name

externalBusUnitId
string

externalBusUnitId

object

Last Modified Date

rowLimit
integer <int32>

Row Limit

rowOffset
integer <int32>

Row Offset

rowSortOrder
string

Row Limit

Responses
200

Success

500

Internal Server Error

post/cw/depositoraccounts/listDepositLimits
Request samples
{
  • "billerBusUnitId": "string",
  • "busUnitId": 0,
  • "busUnitName": "string",
  • "deplDescription": {
    },
  • "deplName": {
    },
  • "externalBusUnitId": "string",
  • "lastModifiedDate": {
    },
  • "rowLimit": 0,
  • "rowOffset": 0,
  • "rowSortOrder": "string"
}
Response samples
{
  • "rows": [
    ],
  • "totalCount": 0
}

Get deposit limits

Get the deposit limits with the given id.

SecurityJWT
Request
path Parameters
systemId
required
integer <int32>
Responses
200

Success

404

Not found

500

Internal Server Error

get/cw/depositoraccounts/depositLimits/{systemId}
Request samples 
Response samples 
{
  • "busUnit": {
    },
  • "refInSubUnits": true,
  • "revwPmtAmtPerCheck": 132314.23,
  • "denyPmtAmtPerCheck": 132314.23,
  • "revwPmtAmtPerDeposit": 132314.23,
  • "denyPmtAmtPerDeposit": 132314.23,
  • "revwPmtAmtPerDay": 132314.23,
  • "denyPmtAmtPerDay": 132314.23,
  • "revwPmtAmtPerMonth": 132314.23,
  • "denyPmtAmtPerMonth": 132314.23,
  • "revwPmtCntPerDeposit": 123,
  • "denyPmtCntPerDeposit": 123,
  • "revwPmtCntPerDay": 123,
  • "denyPmtCntPerDay": 123,
  • "revwPmtCntPerMonth": 123,
  • "denyPmtCntPerMonth": 123,
  • "revwDepCntPerDay": 123,
  • "denyDepCntPerDay": 123,
  • "revwDepCntPerMonth": 123,
  • "denyDepCntPerMonth": 123,
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}
Delete Deposit Limits
Delete the depositor limits with the given systemId. The Deposit Limits cannot be deleted if any Depositors or Accounts are using these limits.


SecurityJWT 
Request 
path Parameters
systemId
required
integer <int32> 
 
Responses 
200
Success


404
Not found


500
Internal Server Error


delete/cw/depositoraccounts/depositLimits/{systemId}
Request samples 
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Get all depositor accounts for given business unit
Get the depositor accounts for a business unit.


SecurityJWT 
Request 
path Parameters
busUnitName
required
string
 
Responses 
200
Success


404
Not found


500
Internal Server Error


get/cw/depositoraccounts/depositorAccount/{busUnitName}
Request samples 
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Get depositor account
Get the depositor account with the given name.


SecurityJWT 
Request 
path Parameters
busUnitName
required
string
 
accountName
required
string
 
Responses 
200
Success


404
Not found


500
Internal Server Error


get/cw/depositoraccounts/depositorAccount/{busUnitName}/{accountName}
Request samples 
Response samples 
{
  • "busUnit": {
    },
  • "depositorId": 12343,
  • "depositorName": "The Electric Company Depositor",
  • "displayName": "Account At The Electric Company Depositor",
  • "depositorLimitsId": 132314,
  • "bankName": "Wells Fargo",
  • "bankRouting": "011000002",
  • "depositAccountNumber": "000-12245-23",
  • "accountLimitsId": 132314,
  • "accountOwnershipType": "business, individual",
  • "accountType": "checking, savings",
  • "accountPurpose": "PRIMARY, SETTLEMENT",
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}
Delete Depositor Account
Delete the depositor account with the given name.


SecurityJWT 
Request 
path Parameters
busUnitName
required
string
 
accountName
required
string
 
Responses 
200
Success


404
Not found


500
Internal Server Error


delete/cw/depositoraccounts/depositorAccount/{busUnitName}/{accountName}
Request samples 
Response samples 
{
  • "httpCode": 0,
  • "message": "Failed to authorize.",
  • "systemId": 123412351
}
Add Depositor Account
Adds the provided depositor account. The new depositor account is returned


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


 
depositorId
integer <int32> 
System Id for the Depositor


 
depositorName
string
Name of the Depositor


 
displayName
string
Display name of the Depositor Account


 
depositorLimitsId
integer <int32> 
Id for the limits for the depositor, if any


 
bankName
string
Name for the bank


 
bankRouting
string
Routing number for the bank


 
depositAccountNumber
string
Account number for making deposits


 
accountLimitsId
integer <int32> 
Id for the limits for the account, if any


 
accountOwnershipType
string
Ownership type of the depositor account


 
accountType
string
Type of the depositor account


 
accountPurpose
string
Purpose of the depositor account


 
objectType
string
Type of the object as mapped to CWObjectType


 
owningBusUnitId
integer <int32> 
Id of Business Unit that owns this configuration object. For a Business Unit, this is the parent business unit.


 
systemId
integer <int32> 
System identity for this configuration object.


 
name
string
Unique name for this configuration object.


 
description
string
Description for this configuration object.


 
lastModifiedDate
string <date-time> 
Last modification date


 
Array of objects (CustomConfigProperty) 
Custom Properties for the Configuration Object


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


404
Not Found


500
Internal Server Error


post/cw/depositoraccounts/depositorAccount
Request samples 
{
  • "busUnit": {
    },
  • "depositorId": 12343,
  • "depositorName": "The Electric Company Depositor",
  • "displayName": "Account At The Electric Company Depositor",
  • "depositorLimitsId": 132314,
  • "bankName": "Wells Fargo",
  • "bankRouting": "011000002",
  • "depositAccountNumber": "000-12245-23",
  • "accountLimitsId": 132314,
  • "accountOwnershipType": "business, individual",
  • "accountType": "checking, savings",
  • "accountPurpose": "PRIMARY, SETTLEMENT",
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}
Response samples 
{
  • "busUnit": {
    },
  • "depositorId": 12343,
  • "depositorName": "The Electric Company Depositor",
  • "displayName": "Account At The Electric Company Depositor",
  • "depositorLimitsId": 132314,
  • "bankName": "Wells Fargo",
  • "bankRouting": "011000002",
  • "depositAccountNumber": "000-12245-23",
  • "accountLimitsId": 132314,
  • "accountOwnershipType": "business, individual",
  • "accountType": "checking, savings",
  • "accountPurpose": "PRIMARY, SETTLEMENT",
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}
Update Depositor Account
Update the provided depositor account, matching on systemId. The updated depositor account is returned


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


 
depositorId
integer <int32> 
System Id for the Depositor


 
depositorName
string
Name of the Depositor


 
displayName
string
Display name of the Depositor Account


 
depositorLimitsId
integer <int32> 
Id for the limits for the depositor, if any


 
bankName
string
Name for the bank


 
bankRouting
string
Routing number for the bank


 
depositAccountNumber
string
Account number for making deposits


 
accountLimitsId
integer <int32> 
Id for the limits for the account, if any


 
accountOwnershipType
string
Ownership type of the depositor account


 
accountType
string
Type of the depositor account


 
accountPurpose
string
Purpose of the depositor account


 
objectType
string
Type of the object as mapped to CWObjectType


 
owningBusUnitId
integer <int32> 
Id of Business Unit that owns this configuration object. For a Business Unit, this is the parent business unit.


 
systemId
integer <int32> 
System identity for this configuration object.


 
name
string
Unique name for this configuration object.


 
description
string
Description for this configuration object.


 
lastModifiedDate
string <date-time> 
Last modification date


 
Array of objects (CustomConfigProperty) 
Custom Properties for the Configuration Object


 
Responses 
200
Success


400
Bad Request, Invalid Parameters


404
Not Found


500
Internal Server Error


put/cw/depositoraccounts/depositorAccount
Request samples 
{
  • "busUnit": {
    },
  • "depositorId": 12343,
  • "depositorName": "The Electric Company Depositor",
  • "displayName": "Account At The Electric Company Depositor",
  • "depositorLimitsId": 132314,
  • "bankName": "Wells Fargo",
  • "bankRouting": "011000002",
  • "depositAccountNumber": "000-12245-23",
  • "accountLimitsId": 132314,
  • "accountOwnershipType": "business, individual",
  • "accountType": "checking, savings",
  • "accountPurpose": "PRIMARY, SETTLEMENT",
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}
Response samples 
{
  • "busUnit": {
    },
  • "depositorId": 12343,
  • "depositorName": "The Electric Company Depositor",
  • "displayName": "Account At The Electric Company Depositor",
  • "depositorLimitsId": 132314,
  • "bankName": "Wells Fargo",
  • "bankRouting": "011000002",
  • "depositAccountNumber": "000-12245-23",
  • "accountLimitsId": 132314,
  • "accountOwnershipType": "business, individual",
  • "accountType": "checking, savings",
  • "accountPurpose": "PRIMARY, SETTLEMENT",
  • "objectType": "Transaction",
  • "owningBusUnitId": 3143,
  • "systemId": 3143,
  • "name": "First State Properties",
  • "description": "Properties defined for First State",
  • "lastModifiedDate": "2023/07/08 13:04:48.145X",
  • "customProperties": [
    ]
}
➔ Next to Deposits