Department API (V2)

Download OpenAPI specification:Download

Department

Department controller has API methods that enable you to manage department(s) in a company. Add a new department or change the Head of Department (HOD). Get list of departments in the company and update the information about a department. Set and view monthly, weekly or yearly ATM, POS or ecommerce limits of a specific department.

Add Department

Add department with department limit.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

Department search request information

CompanyID
required
integer <int32>

Unique identifier of the company.

DepartmentName
required
string [ 0 .. 50 ] characters

Name of the department.

DepartmentCode
required
string [ 0 .. 8 ] characters

Look up value that identifies the department.

DepartmentDescription
string [ 0 .. 200 ] characters

Description of the department.

DepartmentHeadConsumerID
integer <int32>

Unique identifier of the Head of Department (HOD).

LocationID
required
integer <int32>

Unique identifier of department's location.

required
object (TermLimitReq)

The spend limit of the department for ATM, POS and ecommerce.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/Department/AddDepartment
Request samples
application/json
{
  • "CompanyID": 20365,
  • "DepartmentName": "DepartmentName",
  • "DepartmentCode": "Dept",
  • "DepartmentDescription": "Department Description",
  • "DepartmentHeadConsumerID": 63785,
  • "LocationID": 10,
  • "TermsLimitReq": {
    },
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "DepartmentID": 2500,
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Change HOD

Changes the Head of Department (HOD).

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

ChangeHODReq

DepartmentID
required
integer <int32>

Unique identifier of the department.

NewHODConsumerID
required
integer <int32>

Unique identifier of the consumer who is made the new Head of Department.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/Department/ChangeHOD
Request samples
application/json
{
  • "DepartmentID": 1017,
  • "NewHODConsumerID": 63726,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Limits

Returns POS, ATM and ecommerce spend limits of the department.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

GetLimitsReq

CompanyID
required
integer <int32>

Unique identifier of the company.

DepartmentID
required
integer <int32>

Unique indentifier of the department.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/Department/Getlimits
Request samples
application/json
{
  • "CompanyID": 20365,
  • "DepartmentID": 1017,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Limit": {
    },
  • "LimitUsed": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Get Specific Department

Returns name, description and location of the department.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

Department search request information

CompanyID
required
integer <int32>

Unique identifier of the company.

DepartmentID
required
integer <int32>

Unique identifier of the department.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/Department/GetSpecificDepartment
Request samples
application/json
{
  • "CompanyID": 19288,
  • "DepartmentID": 2,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Department": {
    },
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Consumers By Department

Returns list of personal and account information of primary and secondary consumers by Company Id and Department Id.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

ListConsumersReq

CompanyDetailID
required
integer <int32>

Unique identifier of the company.

BusinessDepartmentID
required
integer <int32>

Unique identifier of the department.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/Department/ListConsumersByDepartment
Request samples
application/json
{
  • "CompanyDetailID": 1,
  • "BusinessDepartmentID": 1,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "DepartmentID": 2,
  • "DepartmentName": "DemoExample Group Ind Dept.",
  • "ConsumerResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Departments

Returns the list of departments in the company.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

Department search request information

CompanyID
required
integer <int32>

Unique identifier of the company.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/Department/ListDepartments
Request samples
application/json
{
  • "CompanyID": 20365,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "DepartmentRes": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Pending Card Authorizations

Returns list of uncleared/pending card transactions.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

ListPendingCardAuthorizationsReq

DepartmentID
required
integer <int32>

Unique identifier of the Department.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/Department/ListPendingCardAuthorizations
Request samples
application/json
{
  • "DepartmentID": 14023,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "AuthorizationResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

List Transactions

Returns list of transactions based on search criteria

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

The object req information.

DepartmentID
required
integer <int32>

Unique identifier of the department.

FromDate
required
string <date-time>

The start date of transaction statement.

Format for date must be 'yyyy-MM-ddTHH:mm:ss.fff',
e.g. '2018-05-24T10:27:26.325' represents 24-May-2018 10:27:26.325.

ToDate
required
string <date-time>

The end date of transaction statement.

Format for date must be 'yyyy-MM-ddTHH:mm:ss.fff',
e.g. '2018-05-24T10:27:26.325' represents 24-May-2018 10:27:26.325.

Reference
string [ 0 .. 150 ] characters

Unique identifier of the transaction.

RowIndex
integer <int32>

A number that denotes the position of the row in rows collections of a table.

Pagesize
integer <int32>

Pagesize If Pagesize is supplied by the Client, this would be the default last XX transactions (configurable for each client).

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/Department/ListTransactions
Request samples
application/json
{
  • "DepartmentID": 1,
  • "FromDate": "2021-01-10T10:03:09.5228713Z",
  • "ToDate": "2021-01-11T10:03:09.5228713Z",
  • "Reference": "",
  • "RowIndex": 1,
  • "Pagesize": 5,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "TotalRows": 259,
  • "TransactionResList": [
    ],
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Set Limits

Set up POS, ATM and ecommerce spend limit of the department.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json

SetLimitsReq

CompanyID
required
integer <int32>

Unique identifier of the company.

DepartmentID
required
integer <int32>

Unique identifier of the department.

ATMDailyLimit
required
integer <int64>

The total amount that can be withdrawn from the ATM in one day.

ATMWeeklyLimit
required
integer <int64>

The total amount that can be withdrawn from the ATM in one week.

ATMMonthlyLimit
required
integer <int64>

The total amount that can be withdrawn from the ATM in one month.

ATMYearlyLimit
required
integer <int64>

The total amount that can be withdrawn from the ATM in one year.

POSDailyLimit
required
integer <int64>

The total amount that can be spent at POS in one day.

POSWeeklyLimit
required
integer <int64>

The total amount that can be spent at POS in one week.

POSMonthlyLimit
required
integer <int64>

The total amount that can be spent at POS in one month.

POSYearlyLimit
required
integer <int64>

The total amount that can be spent at POS in one year.

DailyTotalLimit
required
integer <int64>

The total amount that can be spent in one day. Total daily spend = ATM daily spend + POS daily spend + ecommerce daily spend.

WeeklyTotalLimit
required
integer <int64>

The total amount that can be spent in one week. Total weekly spend = ATM weekly spend + POS weekly spend + ecommerce weekly spend.

MonthlyTotalLimit
required
integer <int64>

The total amount that can be spent in one month. Total monthly spend = ATM monthly spend + POS monthly spend + ecommerce monthly spend.

YearlyTotalLimit
required
integer <int64>

The total amount that can be spent in one year. Total yearly spend = ATM yearly spend + POS yearly spend + ecommerce yearly spend.

ECommDailyLimit
required
integer <int64>

The total amount that can be spent in ecommerce in one day.

ECommWeeklyLimit
required
integer <int64>

The total amount that can be spent in ecommerce in one week.

ECommMonthlyLimit
required
integer <int64>

The total amount that can be spent in ecommerce in one month.

ECommYearlyLimit
required
integer <int64>

The total amount that can be spent in ecommerce in one year.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/Department/Setlimits
Request samples
application/json
{
  • "CompanyID": 20365,
  • "DepartmentID": 1017,
  • "ATMDailyLimit": 100,
  • "ATMWeeklyLimit": 200,
  • "ATMMonthlyLimit": 300,
  • "ATMYearlyLimit": 400,
  • "POSDailyLimit": 100,
  • "POSWeeklyLimit": 200,
  • "POSMonthlyLimit": 300,
  • "POSYearlyLimit": 400,
  • "DailyTotalLimit": 1000,
  • "WeeklyTotalLimit": 2000,
  • "MonthlyTotalLimit": 3000,
  • "YearlyTotalLimit": 4000,
  • "ECommDailyLimit": 100,
  • "ECommWeeklyLimit": 200,
  • "ECommMonthlyLimit": 300,
  • "ECommYearlyLimit": 400,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}

Update Department Details

Update detail of company's department.

Request
header Parameters
Authorization
required
string

A JWT access token returned from the security/login method, uniquely identifying your partner login session. This is required to make requests to the API.

Request Body schema: application/json
CompanyID
required
integer <int32>

Unique identifier of the company.

DepartmentID
required
integer <int32>

Unique identifier of the department in the company.

DepartmentName
string [ 0 .. 50 ] characters

Name of the department.

DepartmentCode
string [ 0 .. 8 ] characters

Department's code.

DepartmentDescription
string [ 0 .. 200 ] characters

Description of the department.

LocationID
integer <int32>

The look up value that identifies the location of the department.Example: 1 = Solaris India , 2 = Solaris uk , 10 = Harrow Gate , 11 = Skipton.

ClientRequestReference
string [ 0 .. 50 ] characters

Solaris partners should provide a reference number in each API request for tracking/auditing purpose of actions performed on the Solaris platform.

CultureID
integer <int32>

Unique identifier of the response language. Default language value is 1. i.e. UK English. Other supported values are 1 = UK English, 2 = Russian, 3 = Latvian.

Responses
200

Success

400

Bad Request

500

Server Error

post/Department/UpdateDepartmentDetails
Request samples
application/json
{
  • "CompanyID": 19288,
  • "DepartmentID": 1068,
  • "DepartmentName": "IT Department",
  • "DepartmentCode": "ITDEPT1",
  • "DepartmentDescription": "Software development",
  • "LocationID": 2,
  • "ClientRequestReference": "[ReferenceExample]",
  • "CultureID": 1
}
Response samples
application/json
{
  • "Description": "Success",
  • "ResponseCode": "000",
  • "ResponseDateTime": "2021-12-21T13:58:02.899",
  • "ClientRequestReference": "reference",
  • "RequestID": 27194
}
Solaris is the brand name for the regulated entities Contis Financial Services Ltd and UAB „Finansinės paslaugos „Contis“, which are part of the Solaris Group.