Organization

The Organization Service provides access to the definition of the Business Unit and Site hierarchical structures within Clearingworks that define the organizations available within the system. This service also provides access to brand resources for a given business unit.

APIOrganizationService_getMerchantAccountLimits

SecurityJWT
Request
path Parameters
busUnitName
required
string
merchantAccountName
required
string
Responses
200

Success

404

Not Found

500

Internal Server Error

get/cw/organization/getMerchantAccountLimits/{busUnitName}/{merchantAccountName}
Request samples 
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
List Merchant Fields
Retrieves the field definitions for a given business unit. Rows are of type APIFieldDef


SecurityJWT 
Request 
path Parameters
busUnitName
required
string
 
query Parameters
objectType
required
string
 
customOnly
required
boolean
 
persistentOnly
required
boolean
 
Responses 
200
Success


404
Not Found


500
Internal Server Error


get/cw/organization/listMerchantFields/{busUnitName}
Request samples 
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Save a new brand resource for a given merchant.
Saves brand resource for a given merchant


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


 
resourceName
string
Name of the resource.


 
resourceNames
Array of strings
List of resource names.


 
busUnitId
integer <int32> 
System Identity of the Business Unit where the resource is defined.


 
resourceType
string
Type of resource.


 
value
object (Serializable) 
 
Responses 
200
Success


400
Bad Request, Invalid Parameters


403
Forbidden


404
Not Found


500
Internal Server Error


post/cw/organization/brandResource
Request samples 
{
  • "busUnit": {
    },
  • "resourceName": "Search.CustomerAccounts",
  • "resourceNames": [
    ],
  • "busUnitId": 1401,
  • "resourceType": "SearchPath",
  • "value": { }
}
Response samples 
{
  • "busUnit": {
    },
  • "resourceName": "Search.CustomerAccounts",
  • "resourceNames": [
    ],
  • "busUnitId": 1401,
  • "resourceType": "SearchPath",
  • "value": { }
}
List Merchant Accounts
Retrieves the merchant acocunts for a given business unit. Rows are of type APIDepositorAccount


SecurityJWT 
Request 
path Parameters
busUnitName
required
string
 
Responses 
200
Success


500
Internal Server Error


get/cw/organization/listMerchantAccounts/{busUnitName}
Request samples 
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Get a brand resource for a given merchant. To get list of all resource names, use ALL as the resourceName
Gets the brand resource for a given merchant


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


404
Not Found


500
Internal Server Error


get/cw/organization/brandResource/{busUnitName}/{resourceName}
Request samples 
Response samples 
{
  • "busUnit": {
    },
  • "resourceName": "Search.CustomerAccounts",
  • "resourceNames": [
    ],
  • "busUnitId": 1401,
  • "resourceType": "SearchPath",
  • "value": { }
}
List Business Units
Retrieves the business units for the given criteria. Rows are of type APIBusinessUnit


SecurityJWT 
Request 
Request Body schema: 
billerBusUnitId
string
billerBusUnitId


 
busUnitId
integer <int32> 
busUnitId


 
object
Business Unit Name


 
customFieldSpecs
string
Custom Field Specifications


 
enabled
boolean
Enabled


 
externalBusUnitId
string
externalBusUnitId


 
object
Last Modified Date


 
objectId
integer <int32> 
Business Unit Id


 
parentId
integer <int32> 
Parent Business Unit Id


 
rowLimit
integer <int32> 
Row Limit


 
rowOffset
integer <int32> 
Row Offset


 
rowSortOrder
string
Row Limit


 
Responses 
200
Success


500
Internal Server Error


post/cw/organization/listBusinessUnits
Request samples 
{
  • "billerBusUnitId": "string",
  • "busUnitId": 0,
  • "busUnitName": {
    },
  • "customFieldSpecs": "string",
  • "enabled": true,
  • "externalBusUnitId": "string",
  • "lastModifiedDate": {
    },
  • "objectId": 0,
  • "parentId": 0,
  • "rowLimit": 0,
  • "rowOffset": 0,
  • "rowSortOrder": "string"
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
List Merchant Custom Fields
Retrieves the basic custom fields (up to 5 Strings and 5 Amounts) for a given business unit. Rows are of type APIFieldDef


SecurityJWT 
Request 
path Parameters
busUnitName
required
string
 
Responses 
200
Success


404
Not Found


500
Internal Server Error


get/cw/organization/listMerchantCustomFields/{busUnitName}
Request samples 
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Get reference file status
Gets the status of reference file imports. Rows are of type APIReferenceFileStatus.


SecurityJWT 
Request 
path Parameters
busUnitName
required
string
 
Responses 
200
Success


404
Not Found


500
Internal Server Error


get/cw/organization/getReferenceFileStatus/{busUnitName}
Request samples 
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
Get last EOD Automation information
Retrieves information about the count/amount and timing of the last automation run.


SecurityJWT 
Request 
path Parameters
busUnitName
required
string
 
Responses 
200
Success


404
Not Found


500
Internal Server Error


get/cw/organization/getMerchantLastAutomationRunInfo/{busUnitName}
Request samples 
Response samples 
{
  • "modelBuildTime": "03-30-2023T01:05:06.234-05",
  • "numAcceptedTxns": "133",
  • "numRejectedTxns": "3",
  • "numAcceptedStmts": "133",
  • "numAcceptedPmts": "133",
  • "acceptedAmount": 23432.23
}
List Sites
Retrieves the sites for the given criteria. Rows are of type APISite


SecurityJWT 
Request 
Request Body schema: 
billerBusUnitId
string
billerBusUnitId


 
busUnitId
integer <int32> 
Business Unit


 
busUnitName
string
busUnitName


 
customFieldSpecs
string
Custom Field Specifications


 
externalBusUnitId
string
externalBusUnitId


 
object
Last Modified Date


 
parentSiteId
integer <int32> 
Parent Site Id


 
rowLimit
integer <int32> 
Row Limit


 
rowOffset
integer <int32> 
Row Offset


 
rowSortOrder
string
Row Sort Order


 
Responses 
200
Success


500
Internal Server Error


post/cw/organization/listSites
Request samples 
{
  • "billerBusUnitId": "string",
  • "busUnitId": 0,
  • "busUnitName": "string",
  • "customFieldSpecs": "string",
  • "externalBusUnitId": "string",
  • "lastModifiedDate": {
    },
  • "parentSiteId": 0,
  • "rowLimit": 0,
  • "rowOffset": 0,
  • "rowSortOrder": "string"
}
Response samples 
{
  • "rows": [
    ],
  • "totalCount": 0
}
➔ Next to Query