Approval Matrix
Approval Matrix defines the rules for approvals, including the number of approvals required and the designated approver based on the value of the transaction. Use the feature to define the approval limits (per-transaction, daily, and weekly) for each account associated with the company.
For more information on Approval Matrix, refer to the Temenos Digital SME Banking Documentation.
| Name | Description | Introduced In |
|---|---|---|
| GetApprovalMatrix | This API is used to get approval matrix details. | 2020.04 |
| UpdateApprovalMatrix | This API is used to update approval matrix at user level/signatory group level. | 2020.04 |
| updateApprovalMatrixStatus | This API is used to enable or disable the approval matrix. | 2021.01 |
| isApprovalMatrixDisabled | This API is used to check if the approval matrix is enabled or disabled. | 2021.01 |
| getApprovalMatrixByContractId | This API is used to request for approval matrix by contract id. | 2021.07 |
| Description: | This API is used to enable or disable the approval matrix. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/ApprovalMatrix/operations/ApprovalMatrix/updateApprovalMatrixStatus |
| Security Level: | Authenticated App User |
| Header Request: |
X-Kony-Authorization Content-Type |
| Body Request: |
Parameters contractId (Mandatory) Specifies the unique ID of the contract. cif Specifies the core customer ID. disable (Mandatory) Specifies whether the Approval Matrix is disabled. {
"contractId": "5060820687", //contractId
"cif": "800199",
"disable": "false"
}
|
| Response: | {
"cif": "800199",
"contractId": "5060820687",
"opstatus": 0,
"isDisabled": "false",
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider | Temenos Digital |
| Enterprise API | {base_url}/services/dbpApprovalMatrixServices/updateApprovalMatrixStatus |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| contractId | contractId | NA | NA |
| cif | cif | NA | NA |
| isDisabled | isDisabled | NA | NA |
| Description: | This API is used to check if the approval matrix is enabled or disabled. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/ApprovalMatrixObjects/operations/ApprovalMatrix/isApprovalMatrixDisabled |
| Security Level: | Authenticated App User |
| Header Request: |
X-Kony-Authorization ·Content-Type |
| Body Request: |
Parameters contractId (Mandatory) Specifies the unique ID of the contract. cif Specifies the core customer ID. {
"coreCustomerId": "191017",
"contractId": "2865541526"
}
|
| Response: |
Parameters contractId Specifies the unique ID of the contract. cif Specifies the core customer ID. isDisabled Specifies whether the Approval Matrix is disabled.
{
"contractId": "2865541526",
"cif": "191017",
"isDisabled": "false",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider | Temenos Digital |
| Enterprise API | {base_url}/services/dbpApprovalMatrixServices/isApprovalMatrixDisabled |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| contractId | contractId | NA | NA |
| cif | cif | NA | NA |
| isDisabled | isDisabled | NA | NA |
| Description: | This API is used to get approval matrix details. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/ApprovalMatrix/operations/ApprovalMatrix/getApprovalMatrix |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: | {
"cif": "191017",
"contractId": "2865541526",
"accountId": ""
}
|
| Response: |
{
"approvalMode": "0",
"cifName": "QA191017 QA191017",
"common": {
"limitTypes": [
{
"limitTypeId": "DAILY_LIMIT",
"actions": [
{
"actionType": "MONETARY",
"featureName": "ACH Collection",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "ACH_COLLECTION_CREATE",
"isAccountLevel": "1",
"actionDescription": "Automated Clearing House Collection Service",
"maxAmount": "1000.0",
"featureId": "ACH_COLLECTION",
"limits": [
{
"numberOfApprovals": 0,
"invalid": false,
"approvalRuleId": "NO_APPROVAL",
"approvers": [
{
"approverName": ""
}
],
"currency": "USD",
"approvalRuleName": "No approval",
"lowerlimit": "-1.00",
"upperlimit": "-1.00"
}
],
"actionName": "Initiate ACH Collection"
}
]
}
]
},
"opstatus": 0,
"accounts": [
{
"ownershipType": "OWNER",
"accountId": "130265",
"accountName": "Current Account",
"accountType": "Checking",
"limitTypes": [
{
"limitTypeId": "DAILY_LIMIT",
"actions": [
{
"actionType": "MONETARY",
"featureName": "ACH Collection",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "ACH_COLLECTION_CREATE",
"isAccountLevel": "1",
"actionDescription": "Automated Clearing House Collection Service",
"maxAmount": "1000.0",
"featureId": "ACH_COLLECTION",
"limits": [
{
"numberOfApprovals": 0,
"invalid": false,
"approvalRuleId": "NO_APPROVAL",
"approvers": [
{
"approverName": ""
}
],
"currency": "USD",
"approvalRuleName": "No approval",
"lowerlimit": "-1.00",
"upperlimit": "-1.00"
}
],
"actionName": "Initiate ACH Collection"
}
]
}
]
}
],
"cifId": "191017",
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider | Temenos Digital |
| Enterprise API | {base_url}/services/dbpApprovalMatrixServices/fetchApprovalMatrix |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| cifId | cifId | NA | NA |
| cifName | cifName | NA | NA |
| accounts | accounts | NA | NA |
| accountId | accountId | NA | NA |
| accountName | accountName | NA | NA |
| accountType | accountType | NA | NA |
| limitTypes | limitTypes | NA | NA |
| limitTypeId | limitTypeId | NA | NA |
| actions | actions | NA | NA |
| Description: | This API is used to update approval matrix at user level/signatory group level. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/ApprovalMatrix/operations/ApprovalMatrix/updateApprovalMatrix |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: | {
"actionId": "CHEQUE_BOOK_REQUEST_CREATE",
"limitTypeId": "NON_MONETARY_LIMIT",
"cif": "190966",
"contractId": "2601423173",
"isGroupMatrix": "1",
"limits": [
{
"lowerlimit": "-1.00",
"upperlimit": "-1.00",
"groupList": "[de68fb49-83fe-44ba-abdd-b9e17703d6a9]",
"groupRule": "[[1]]"
}
]
}
|
| Response: | {
"opstatus": 0,
"status": "Success",
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider | Temenos Digital |
| Enterprise API | {base_url}/services/dbpApprovalMatrixServices/UpdateApprovalMatrixService |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| Success | Success | NA | NA |
| Description: | This API is used to request for approval matrix by contract id |
| Method: | POST |
| URL: | {base_url}services/data/v1/ApprovalMatrix/operations/ApprovalMatrix/getApprovalMatrixByContractId |
| Security Level: | Authenticated App User |
| Header Request: |
|
| Body Request: |
Parameters contractId (Mandatory) Specifies the unique ID of the contract for which the approval matrix must be updated.
{
"contractId": "5060820687"
}
|
| Response: | {
"cif": [
{
"approvalMode": "1",
"cifName": "Rolf Gerling1",
"common": {
"limitTypes": [
{
"limitTypeId": "DAILY_LIMIT",
"actions": [
{
"actionType": "MONETARY",
"featureName": "ACH Collection",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "ACH_COLLECTION_CREATE",
"actionDescription": "Automated Clearing House Collection Service",
"maxAmount": "1000.0",
"featureId": "ACH_COLLECTION",
"limits": [
{
"numberOfApprovals": "0",
"invalid": "false",
"approvalRuleId": "NO_APPROVAL",
"approvers": [],
"approvalRuleName": "No approval",
"lowerlimit": "-1.00",
"upperlimit": "-1.00"
}
],
"actionName": "Initiate ACH Collection"
}
]
}
]
}
],
"cifId": "800199"
}
],
"contractId": "5060820687",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider | Temenos Digital |
| Enterprise API | {base_url}/services/dbpApprovalMatrixServices/fetchApprovalMatrixByContractId |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| cif | cif | NA | NA |
| approvalMode | approvalMode | NA | NA |
| cifName | cifName | NA | NA |
| common | common | NA | NA |
| limitTypes | limitTypes | NA | NA |
| limitTypeId | limitTypeId | NA | NA |
| actions | actions | NA | NA |
| actionType | actionType | NA | NA |
| featureName | featureName | NA | NA |
| featureStatus | featureStatus | NA | NA |
| actionId | actionId | NA | NA |
| actionDescription | actionDescription | NA | NA |
| maxAmount | maxAmount | NA | NA |
| featureId | featureId | NA | NA |
| limits | limits | NA | NA |
| numberOfApprovals | numberOfApprovals | NA | NA |
| invalid | invalid | NA | NA |
| approvalRuleId | approvalRuleId | NA | NA |
| approvers | approvers | NA | NA |
| approvalRuleName | approvalRuleName | NA | NA |
| lowerlimit | lowerlimit | NA | NA |
| upperlimit | upperlimit | NA | NA |
| actionName | actionName | NA | NA |
| cifId | cifId | NA | NA |
| contractId | contractId | NA | NA |
In this topic