| Bookmark Name | Actions |
|---|
Approval Matrix
The 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 Infinity SME Banking Documentation.
| Name | Description | Introduced In |
|---|---|---|
| GetApprovalRulesOperation | This API allows the user to fetch all the approval rules that are set in the application. | 2020.04 |
| GetApprovalMatrix | This API allows the user to fetch all the approval matrix entries for a given accountId, actionID, and limitTypeId. | 2020.04 |
| UpdateApprovalMatrix | This API allows the user to update the approval matrix entries that match the accountId, actionId, and limitTypeId parameters that are provided as a request by the user. | 2020.04 |
GetApprovalRulesOperation
| Description: | This API allows the user to fetch all the approval rules that are set in the application. | |||||
| Method: | POST | |||||
| URL: | services/data/v1/ApprovalMatrixObjects/operations/ApprovalRules/getApprovalRules | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: | X-Kony-Authorization | |||||
| Body Request: |
None |
|||||
| Response: |
Parameters records Specifies an array of records and their details. records/name Specifies the name of the record. records/numberOfApprovals Specifies the number of approvals granted for the record. records/id Specifies the unique ID of each record. {
"records": [
{
"name": "All Approvals",
"numberOfApprovals": "-1",
"id": "ALL"
},
{
"name": "Any one approval",
"numberOfApprovals": "1",
"id": "ANY_ONE"
},
{
"name": "Any three approvals",
"numberOfApprovals": "3",
"id": "ANY_THREE"
},
{
"name": "Any two approvals",
"numberOfApprovals": "2",
"id": "ANY_TWO"
}
],
"opstatus": 0,
"httpStatusCode": 0
}
|
|||||
| Error Code(s): | Error Code: 12001
Error message: Logged in User is not authorized to perform this action |
|||||
| Service Flow: |
|
GetApprovalMatrix
| Description: | This API allows the user to fetch all the approval matrix entries for a given accountId, actionID, limitTypeId, and companyId. | |||||
| Method: | POST | |||||
| URL: | /services/data/v1/ApprovalMatrixObjects/operations/ApprovalMatrix/getApprovalMatrix | |||||
| Security Level: | Authenticated App User | |||||
| Header Request: | X-Kony-Authorization | |||||
| Body Request: |
Based on the Input Request parameters used the fetched response varies.
Input Request 1 Parameters accountID Specifies the unique account ID of the approval matrix entry. limitTypeId Specifies the unique limit type ID of the approval matrix entry. The limit type is based on approval limit values such as daily, weekly, or per-transaction.
{
"accountId":"200217094231431",
"limitTypeId":"DAILY_LIMIT"
}
Input Request 2 Parameters accountID Specifies the unique account ID of the approval matrix entry. actionID Specifies the unique action ID of the approval matrix entry. limitTypeId Specifies the unique limit type ID of the approval matrix entry. The limit type is based on approval limit values such as daily, weekly, or per-transaction. {
"accountId":"200217094231431",
"actionID":"ACH_COLLECTION_CREATE",
"limitTypeId":"DAILY_LIMIT"
}
Input Request 3 accountID Specifies an array of records and their details. {
"Company_id":"200218062125485"
}
|
|||||
| Response: |
Response 1 View the Response Parameters
companyId Specifies the unique ID of the Company/Organization. accounts Specifies an array of accounts to which the approval matrices are set. accounts/accountId Specifies the unique ID of the account. accounts/limitTypes Specifies an array of limit types. accounts/limitTypes/limitTypeId Specifies the unique limit type ID of the approval matrix entry. The limit type is based on approval limit values such as daily, weekly, or per-transaction. accounts/limitTypes/actions Specifies an array of actions for which the approvals have been granted. accounts/limitTypes/actionsfeatureName Specifies the name of the feature that corresponds to an action. accounts/limitTypes/actionsfeatureStatus Specifies the status of the action feature. The feature can be active or inactive. accounts/limitTypes/actionsactionId Specifies the unique ID of the action. accounts/limitTypes/actionsactionDescription Specifies the description of the action. accounts/limitTypes/actionsfeatureId Specifies the unique ID of the feature of the action. accounts/limitTypes/actionslimits Specifies an array of limits for an action and provides the limit details. accounts/limitTypes/actions/limits/numberOfApprovals Specifies the number of approvals that have been granted for the corresponsiding action. accounts/limitTypes/actions/limits/approvers Specifies the array of details about the approver. accounts/limitTypes/actions/limits/approvers/approverName Specifies the name of the approver. accounts/limitTypes/actions/limits/lowerlimit Specifies the lower limit for an action. accounts/limitTypes/actions/limits/upperlimit Specifies the upper limit for an action. accounts/limitTypes/actionsactionName Specifies the name of the action. View the Response Sample Code
{
"companyId": "200218062125485",
"opstatus": 0,
"accounts": [
{
"accountId": "200217094231431",
"limitTypes": [
{
"limitTypeId": "DAILY_LIMIT",
"actions": [
{
"featureName": "ACH Collection",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "ACH_COLLECTION_CREATE",
"actionDescription": "Automated Clearing House Collection Service",
"featureId": "ACH_COLLECTION",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Automated Clearing House Collection Service"
},
{
"featureName": "ACH Payment",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "ACH_PAYMENT_CREATE",
"actionDescription": "Automated Clearing House Payment Service",
"featureId": "ACH_PAYMENT",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Automated Clearing House Payment Service"
},
{
"featureName": "Bill Payment Service",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "BILL_PAY_CREATE",
"actionDescription": "Bill Payment Service",
"featureId": "BILL_PAY",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Bill Payment Service"
},
{
"featureName": "Domestic Wire Transfer",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "DOMESTIC_WIRE_TRANSFER_CREATE",
"actionDescription": "Wire Transfers within the country",
"featureId": "DOMESTIC_WIRE_TRANSFER",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Wire Transfers within the country"
},
{
"featureName": "International Account to Account Fund Transfer ",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE",
"actionDescription": "Fund Transfer to Accounts in International Banks and Credit Unions",
"featureId": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Fund Transfer to Accounts in International Banks and Credit Unions"
},
{
"featureName": "International Wire Transfer",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "INTERNATIONAL_WIRE_TRANSFER_CREATE",
"actionDescription": "International Wire Transfers",
"featureId": "INTERNATIONAL_WIRE_TRANSFER",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "International Wire Transfers "
},
{
"featureName": "Interbank Account to Account Fund Transfer",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"actionDescription": "Fund Transfer to Accounts in other domestic Banks and Credit Unions",
"featureId": "INTER_BANK_ACCOUNT_FUND_TRANSFER",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Fund Transfer to Accounts in other domestic Banks and Credit Unions"
},
{
"featureName": "Intra Bank Fund Transfer",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "INTRA_BANK_FUND_TRANSFER_CREATE",
"actionDescription": "Fund Transfer to other members of the Credit Union. Member to member Transfer",
"featureId": "INTRA_BANK_FUND_TRANSFER",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Intra Bank Fund Transfer - Create"
},
{
"featureName": "Remote Deposit Capture",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "RDC",
"actionDescription": "Check Deposit be capturing image of the check from the MB or Tablet App",
"featureId": "RDC",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "RDC"
},
{
"featureName": "Transfer between Customer's Accounts",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"actionDescription": "Fund Transfer between different eligible accounts of a member",
"featureId": "TRANSFER_BETWEEN_OWN_ACCOUNT",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Transfer between Customer's Accounts - Create Transaction"
}
]
}
]
}
],
"httpStatusCode": 0
}
Response 2 View the Response Parameters
companyId Specifies the unique ID of the Company/Organization. accounts Specifies an array of accounts to which the approval matrices are set. accounts/accountId Specifies the unique ID of the account. accounts/limitTypes Specifies an array of limit types. accounts/limitTypes/limitTypeId Specifies the unique limit type ID of the approval matrix entry. The limit type is based on approval limit values such as daily, weekly, or per-transaction. accounts/limitTypes/actions Specifies an array of actions for which the approvals have been granted. accounts/limitTypes/actionsfeatureName Specifies the name of the feature that corresponds to an action. accounts/limitTypes/actionsfeatureStatus Specifies the status of the action feature. The feature can be active or inactive. accounts/limitTypes/actionsactionId Specifies the unique ID of the action. accounts/limitTypes/actionsactionDescription Specifies the description of the action. accounts/limitTypes/actionsfeatureId Specifies the unique ID of the feature of the action. accounts/limitTypes/actionslimits Specifies an array of limits for an action and provides the limit details. accounts/limitTypes/actions/limits/numberOfApprovals Specifies the number of approvals that have been granted for the corresponsiding action. accounts/limitTypes/actions/limits/approvers Specifies the array of details about the approver. accounts/limitTypes/actions/limits/approvers/approverName Specifies the name of the approver. accounts/limitTypes/actions/limits/lowerlimit Specifies the lower limit for an action. accounts/limitTypes/actions/limits/upperlimit Specifies the upper limit for an action. accounts/limitTypes/actionsactionName Specifies the name of the action. View the Response Sample Code
{
"companyId": "200218062125485",
"opstatus": 0,
"accounts": [
{
"accountId": "200217094231431",
"limitTypes": [
{
"limitTypeId": "DAILY_LIMIT",
"actions": [
{
"featureName": "ACH Collection",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "ACH_COLLECTION_CREATE",
"actionDescription": "Automated Clearing House Collection Service",
"featureId": "ACH_COLLECTION",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Automated Clearing House Collection Service"
},
{
"featureName": "ACH Payment",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "ACH_PAYMENT_CREATE",
"actionDescription": "Automated Clearing House Payment Service",
"featureId": "ACH_PAYMENT",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Automated Clearing House Payment Service"
},
{
"featureName": "Bill Payment Service",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "BILL_PAY_CREATE",
"actionDescription": "Bill Payment Service",
"featureId": "BILL_PAY",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Bill Payment Service"
},
{
"featureName": "Domestic Wire Transfer",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "DOMESTIC_WIRE_TRANSFER_CREATE",
"actionDescription": "Wire Transfers within the country",
"featureId": "DOMESTIC_WIRE_TRANSFER",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Wire Transfers within the country"
},
{
"featureName": "International Account to Account Fund Transfer ",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE",
"actionDescription": "Fund Transfer to Accounts in International Banks and Credit Unions",
"featureId": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Fund Transfer to Accounts in International Banks and Credit Unions"
},
{
"featureName": "International Wire Transfer",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "INTERNATIONAL_WIRE_TRANSFER_CREATE",
"actionDescription": "International Wire Transfers",
"featureId": "INTERNATIONAL_WIRE_TRANSFER",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "International Wire Transfers "
},
{
"featureName": "Interbank Account to Account Fund Transfer",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"actionDescription": "Fund Transfer to Accounts in other domestic Banks and Credit Unions",
"featureId": "INTER_BANK_ACCOUNT_FUND_TRANSFER",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Fund Transfer to Accounts in other domestic Banks and Credit Unions"
},
{
"featureName": "Intra Bank Fund Transfer",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "INTRA_BANK_FUND_TRANSFER_CREATE",
"actionDescription": "Fund Transfer to other members of the Credit Union. Member to member Transfer",
"featureId": "INTRA_BANK_FUND_TRANSFER",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Intra Bank Fund Transfer - Create"
},
{
"featureName": "Remote Deposit Capture",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "RDC",
"actionDescription": "Check Deposit be capturing image of the check from the MB or Tablet App",
"featureId": "RDC",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "RDC"
},
{
"featureName": "Transfer between Customer's Accounts",
"featureStatus": "SID_FEATURE_ACTIVE",
"actionId": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"actionDescription": "Fund Transfer between different eligible accounts of a member",
"featureId": "TRANSFER_BETWEEN_OWN_ACCOUNT",
"limits": [
{
"numberOfApprovals": 0,
"approvers": [
{
"approverName": ""
}
],
"lowerlimit": -1,
"upperlimit": -1
}
],
"actionName": "Transfer between Customer's Accounts - Create Transaction"
}
]
}
]
}
],
"httpStatusCode": 0
}
Response 3 To view the Response 3, click here. |
|||||
| Error Code(s): |
|
|||||
| Service Flow: |
|
UpdateApprovalMatrix
| Description: | This API allows the user to update the approval matrix entries that match the accountId, actionId, and limitTypeId parameters that are provided as a request by the user. | ||||||
| Method: | POST | ||||||
| URL: | services/data/v1/ApprovalMatrixObjects/operations/ApprovalMatrix/updateApprovalMatrix | ||||||
| Security Level: | Authenticated App User | ||||||
| Header Request: | X-Kony-Authorization | ||||||
| Body Request: |
Parameters accountId Specifies the unique ID of the account whose approval matrix entry is to be updated. actionId Specifies the unique ID of the action. limitTypeId Specifies the unique limit type ID of the approval matrix entry. The limit type is based on approval limit values such as daily, weekly, or per-transaction. limits Specifies an array of limits for an action and provides the limit details. limits/lowerlimit Specifies the lower limit for the action. limits/upperlimit Specifies the upper limit for the action. limits/approvalruleId Specifies the unique ID of the approval rule. limits/approvers Specifies an array of approver details. limits/approvers/approverId Specifies the unique ID of the approver. {
"accountId": "1234567",
"actionId": "BILL_PAY_CREATE",
"limitTypeId": "Daily",
"limits": [
{
"lowerlimit": -1,
"upperlimit": 200,
"approvalruleId": "TWO",
"approvers": [
{
"approverId": "12456778"
},
{
"approverId": "12456456789"
}
]
},
{
"lowerlimit": 200,
"upperlimit": 300,
"approvalruleId": "ONE",
"approvers": [
{
"approverId": "12456778"
},
{
"approverId": "12456456789"
}
]
},
{
"lowerlimit": 300,
"upperlimit": -1,
"approvalruleId": "ALL",
"approvers": [
{
"approverId": "12456778"
},
{
"approverId": "12456456789"
}
]
}
]
}
|
||||||
| Response: | {
Success:“Successful”,
opstatus:0,
httpstatuscode:200
}
|
||||||
| Error Code(s): |
|
||||||
| Service Flow: |
|
Add Bookmark
save your best linksView Bookmarks
Visit your best links
BACK
Are you sure you want to log-off?