Temenos Digital
Updated On 09 January 2024 | Min(s) read

ACH Manager

Name Description Introduced In
createACHTemplate This API creates a new ACH Template. 2020.04
getAllACHTemplates This API fetches all the created ACH Templates. 2020.04
getTemplateDetailsById This API is used to view a single ACH Template for a given Template ID. 2020.04
editACHTemplate This API is used to edit an ACH Template for a given Template ID. 2020.04
deleteACHTemplate This API is used to delete an ACH Template for a given Template ID. 2020.04
createACHTranscation This API allows the user to create an ACH Transaction with out Template. 2020.04
execute This API is used to initiate an ACH Transaction using a template. 2020.04
getAllACHTransactions This API is used to view an initiated ACH Transaction. 2020.04
fetchTransactionRecordsById This API allows the user to view an initiated ACH Transaction for a given Transaction ID. 2020.04
UploadACHFile This API is used to fetch all the ACH Files. 2020.04
getFileDetailsByID This API is used to fetch ACH file details for a given ACH File ID, 2020.04
getAllACHFiles This API is used to fetch all the ACH Files. 2020.04
ACHAccountTypes This API is used to fetch ACH account types. 2020.04
TaxType This API is used to fetch all the Tax Types. 2020.04
FetchTaxSubTypes Method to fetch the tax sub types, given the Tax Type. 2020.04
FetchTemplateRequestTypes This API is used to fetch all the Template Request Types. 2020.04
fetchTemplateRecordById This API is used to fetch all the Template Records for a given Template ID. 2020.04
TemplateTypes This API is used to get a list of all Template Types. 2020.04
TransactionTypes This API is used to get a list of all Transaction Types. 2020.04
ACHFileFormats This API is used to list the acceptable ACH File formats. 2020.04
fetchACHFileRecords This API is used to fetch ACH file records. 2020.04
fetchACHFileSubRecords This API is used to fetch ACH file sub records. 2020.04
 
Description: This API creates a new ACH Template.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/ACHTemplates/createACHTemplate
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
		"MaxAmount": "50",
		"TemplateType_id": "1",
		"TemplateRequestType_id": "4",
		"TemplateRequestTypeValue": "CCD (Cash Concentration and Disbursement)",
		"TransactionType_id": "2",
		"TransactionTypeValue": "Payment",
		"DebitAccount": "122998",
		"DebitAccountName": "TEST - X2998",
		"Records": "[{"Record_Name":"adsfsf","ToAccountNumber":"6456345","ToAccountType":"1","ABATRCNumber":"64345","Detail_id":"153131","Amount":"10","AdditionalInfo":"fsnjdgasdaf"}]",
		"TemplateName": "TestConsole123API",
		"TemplateDescription": "vdsbsdgfhsr",
		"TotalAmount": 10
}
Response: 
{
		"Template_id": "70",
		"opstatus": 0,
		"httpStatusCode": 0
}
Error Code(s):
  • 12000 - Internal service error caused due to code exceptions.
  • 12001 - Unauthorized access.
  • 12022 - Missing Debit Account.
  • 12025 - Missing Template Name.
  • 12026 - Missing Transaction Type ID.
  • 12027 - Missing Template Request ID.
  • 12028 - Missing Records.
  • 12029 - Missing Maximum Transfer Amount.
  • 12101 - ACH Template Creation failed.
  • 21013 - ACH Template Deletion failed.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.CreateACHTemplate

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
DebitAccount DebitAccount NA NA
MaxAmount MaxAmount NA NA
Records Records NA NA
TotalAmount TotalAmount NA NA
TemplateDescription TemplateDescription NA NA
TemplateName TemplateName NA NA
TemplateRequestType_id TemplateRequestType_id NA NA
TemplateType_id TemplateType_id NA NA
TransactionType_id TransactionType_id NA NA
transactionId transactionId NA NA
 
Description: This API fetches all the created ACH Templates.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/ACHTemplates/getAllACHTemplates
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
										"searchString": "",
										"sortByParam": "",
										"sortOrder": "",
										"pageSize": 11,
										"pageOffset": 0,
										"filterByParam": "",
										"filterByValue": ""    
}
Response: 
{
										"ACHTemplates": [
										{
										"Template_id": "71",
										"TemplateName": "TestConsole123API",
										"RequestType": "CCD (Cash Concentration and Disbursement)",
										"DebitAccount": "122998",
										"CreatedOn": "2022-06-17T00:22:04Z",
										"MaxAmount": "50",
										"TotalAmount": "23",
										"CreatedBy": "9263436669",
										"userName": "9263436669",
										"EffectiveDate": "2022-06-17",
										"Status": "New",
										"TemplateRequestType_id": "4",
										"TemplateType_id": "1",
										"TemplateTypeValue": "ACH",
										"TemplateDescription": "vdsbsdgfhsr",
										"softDelete": "0",
										"TransactionType_id": "2",
										"Company_id": "4276234185_190649",
										"TransactionTypeValue": "Payment",
										"AccountName": "Current Account",
										"Approver": "9263436669",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Template_id": "68",
										"TemplateName": "TestT1",
										"RequestType": "PPD (Prearranged Payment and Deposit)",
										"DebitAccount": "122963",
										"CreatedOn": "2022-06-16T23:35:21Z",
										"MaxAmount": "2",
										"TotalAmount": "2",
										"CreatedBy": "9263436669",
										"userName": "9263436669",
										"Status": "New",
										"TemplateRequestType_id": "1",
										"TemplateType_id": "1",
										"TemplateTypeValue": "ACH",
										"TemplateDescription": "TestT1",
										"softDelete": "0",
										"TransactionType_id": "1",
										"Company_id": "4276234185_190645",
										"TransactionTypeValue": "Collection",
										"AccountName": "Current Account",
										"Approver": "9263436669",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Template_id": "63",
										"TemplateName": "Tem1",
										"RequestType": "PPD (Prearranged Payment and Deposit)",
										"DebitAccount": "122963",
										"CreatedOn": "2022-06-14T21:25:17Z",
										"MaxAmount": "1000",
										"TotalAmount": "1",
										"CreatedBy": "9263436669",
										"userName": "9263436669",
										"Status": "New",
										"TemplateRequestType_id": "1",
										"TemplateType_id": "1",
										"TemplateTypeValue": "ACH",
										"TemplateDescription": "TestT1",
										"softDelete": "0",
										"TransactionType_id": "1",
										"Company_id": "4276234185_190645",
										"TransactionTypeValue": "Collection",
										"AccountName": "Current Account",
										"Approver": "9263436669",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Template_id": "62",
										"TemplateName": "Tem1",
										"RequestType": "PPD (Prearranged Payment and Deposit)",
										"DebitAccount": "122963",
										"CreatedOn": "2022-06-14T21:24:59Z",
										"MaxAmount": "1000",
										"TotalAmount": "1",
										"CreatedBy": "9263436669",
										"userName": "9263436669",
										"Status": "New",
										"TemplateRequestType_id": "1",
										"TemplateType_id": "1",
										"TemplateTypeValue": "ACH",
										"TemplateDescription": "TestT1",
										"softDelete": "0",
										"TransactionType_id": "1",
										"Company_id": "4276234185_190645",
										"TransactionTypeValue": "Collection",
										"AccountName": "Current Account",
										"Approver": "9263436669",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Template_id": "61",
										"TemplateName": "test",
										"RequestType": "PPD (Prearranged Payment and Deposit)",
										"DebitAccount": "122955",
										"CreatedOn": "2022-06-14T20:55:22Z",
										"MaxAmount": "1",
										"TotalAmount": "1",
										"CreatedBy": "9263436669",
										"userName": "9263436669",
										"Status": "New",
										"TemplateRequestType_id": "1",
										"TemplateType_id": "1",
										"TemplateTypeValue": "ACH",
										"TemplateDescription": "test",
										"softDelete": "0",
										"TransactionType_id": "1",
										"Company_id": "4276234185_190645",
										"TransactionTypeValue": "Collection",
										"AccountName": "Current Account",
										"Approver": "9263436669",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Template_id": "59",
										"TemplateName": "Tabwebcoll",
										"RequestType": "Web Collection",
										"DebitAccount": "122963",
										"CreatedOn": "2022-06-13T22:01:31Z",
										"MaxAmount": "17",
										"TotalAmount": "17",
										"CreatedBy": "9263436669",
										"userName": "9263436669",
										"Status": "New",
										"TemplateRequestType_id": "7",
										"TemplateType_id": "1",
										"TemplateTypeValue": "ACH",
										"TemplateDescription": "Tabwebcoll",
										"softDelete": "0",
										"TransactionType_id": "1",
										"Company_id": "4276234185_190649",
										"TransactionTypeValue": "Collection",
										"AccountName": "Current Account",
										"Approver": "9263436669",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Template_id": "57",
										"TemplateName": "Tabctxcoll",
										"RequestType": "CTX (Corporate Trade Exchange)",
										"DebitAccount": "122998",
										"CreatedOn": "2022-06-13T18:47:00Z",
										"MaxAmount": "7",
										"TotalAmount": "5",
										"CreatedBy": "9263436669",
										"userName": "9263436669",
										"Status": "New",
										"TemplateRequestType_id": "5",
										"TemplateType_id": "1",
										"TemplateTypeValue": "ACH",
										"TemplateDescription": "Tabctxcoll",
										"softDelete": "0",
										"TransactionType_id": "1",
										"Company_id": "4276234185_190649",
										"TransactionTypeValue": "Collection",
										"AccountName": "Current Account",
										"Approver": "9263436669",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Template_id": "56",
										"TemplateName": "Tabccdcoll",
										"RequestType": "CCD (Cash Concentration and Disbursement)",
										"DebitAccount": "122955",
										"CreatedOn": "2022-06-13T18:43:47Z",
										"MaxAmount": "6",
										"TotalAmount": "6",
										"CreatedBy": "9263436669",
										"userName": "9263436669",
										"Status": "New",
										"TemplateRequestType_id": "3",
										"TemplateType_id": "1",
										"TemplateTypeValue": "ACH",
										"TemplateDescription": "Tabccdcoll",
										"softDelete": "0",
										"TransactionType_id": "1",
										"Company_id": "4276234185_190645",
										"TransactionTypeValue": "Collection",
										"AccountName": "Current Account",
										"Approver": "9263436669",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Template_id": "55",
										"TemplateName": "Tabppdcoll",
										"RequestType": "PPD (Prearranged Payment and Deposit)",
										"DebitAccount": "122955",
										"CreatedOn": "2022-06-13T18:41:32Z",
										"MaxAmount": "5",
										"TotalAmount": "5",
										"CreatedBy": "9263436669",
										"userName": "9263436669",
										"EffectiveDate": "2022-06-13",
										"Status": "New",
										"TemplateRequestType_id": "1",
										"TemplateType_id": "1",
										"TemplateTypeValue": "ACH",
										"TemplateDescription": "Tabppdcoll",
										"softDelete": "0",
										"TransactionType_id": "1",
										"Company_id": "4276234185_190645",
										"TransactionTypeValue": "Collection",
										"AccountName": "Current Account",
										"Approver": "9263436669",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Template_id": "54",
										"TemplateName": "Tabftaxpay",
										"RequestType": "Federal Tax",
										"DebitAccount": "122998",
										"CreatedOn": "2022-06-13T18:11:58Z",
										"MaxAmount": "4",
										"TotalAmount": "4",
										"CreatedBy": "9263436669",
										"userName": "9263436669",
										"EffectiveDate": "2022-06-14",
										"Status": "New",
										"TemplateRequestType_id": "8",
										"TemplateType_id": "1",
										"TemplateTypeValue": "ACH",
										"TemplateDescription": "Tabftaxpay",
										"softDelete": "0",
										"TransactionType_id": "2",
										"Company_id": "4276234185_190649",
										"TransactionTypeValue": "Payment",
										"AccountName": "Current Account",
										"Approver": "9263436669",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Template_id": "53",
										"TemplateName": "Tabctxpay",
										"RequestType": "CTX (Corporate Trade Exchange)",
										"DebitAccount": "122955",
										"CreatedOn": "2022-06-13T18:08:04Z",
										"MaxAmount": "3",
										"TotalAmount": "3",
										"CreatedBy": "9263436669",
										"userName": "9263436669",
										"EffectiveDate": "2022-06-13",
										"Status": "New",
										"TemplateRequestType_id": "6",
										"TemplateType_id": "1",
										"TemplateTypeValue": "ACH",
										"TemplateDescription": "Tabctxpay",
										"softDelete": "0",
										"TransactionType_id": "2",
										"Company_id": "4276234185_190645",
										"TransactionTypeValue": "Payment",
										"AccountName": "Current Account",
										"Approver": "9263436669",
										"amICreator": "true",
										"amIApprover": "false"
										}
										],
										"opstatus": 0,
										"httpStatusCode": 0
}
Error Code(s):
  • 12000 - Internal service error caused due to code exceptions.
  • 12001 - Unauthorized access.
  • 13502 - ACH Template Fetch preprocessor failed.
Enterprise Provider: Temenos Digital
Enterprise API:

dbpACHServices.FetchAllACHTemplates

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
sortByParam _sortByParam NA NA
queryType _queryType NA NA
searchString _searchString NA NA
sortOrder _sortOrder NA NA
pageSize _pageSize NA NA
filterByValue _filterByValue NA NA
filterByParam _filterByParam NA NA
pageOffset _pageOffset NA NA
 
Description: This API is used to view a single ACH Template for a given Template ID.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/ACHTemplates/getTemplateDetailsById
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
   “Template_id” : “66“
}
Response: 
{
  "ACHTemplates": [
	{
  "Template_id": "66",
	"TemplateName": "TestT1",
	"RequestType": "PPD (Prearranged Payment and Deposit)",
	"DebitAccount": "122963",
	"CreatedOn": "2022-06-16T16:44:40Z",
	"MaxAmount": "2",
	"TotalAmount": "2",
    "CreatedBy": "9263436669",
	"userName": "9263436669",
	"Status": "New",
	"TemplateRequestType_id": "1",
	"TemplateType_id": "1",
	"TemplateTypeValue": "ACH",
	"TemplateDescription": "TestT1",
	"softDelete": "0",
	"TransactionType_id": "1",
	"Company_id": "4276234185_190645",
	"TransactionTypeValue": "Collection",
	"AccountName": "Current Account",
	"Approver": "9263436669",
	"amICreator": "true",
	"amIApprover": "false"
	}
	],
	"opstatus": 0,
	"httpStatusCode": 0
	}
Error Code(s):
  • 12000 - Internal service error caused due to code exceptions.
  • 12001 - Unauthorized access.
  • 12025 - Missing Template Name.
  • 12026 - Missing Transaction Type ID.
  • 13502 - ACH Template Fetch preprocessor failed.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.FetchACHTemplateById

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
Template_id Templateid NA NA
 
Description: This APIis used to edit an ACH Template for a given Template ID.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/ACHTemplates/editACHTemplate
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
		"Template_id": "67",
		"TemplateName": "TestT1",
		"TemplateDescription": "TestT1",
		"TransactionType_id": "1",
		"TransactionTypeValue": "Collection",
		"TemplateRequestType_id": "1",
		"TemplateRequestTypeValue": "PPD Collection",
		"DebitAccount": "122963",
		"DebitAccountName": "TESTING - X2963",
		"MaxAmount": "2",
		"CreatedOn": "06/16/2022",
		"CreatedBy": {
		"text": "9263436669",
		"toolTip": "9263436669"
		},
		"Status": {},
		"TotalAmount": 2,
		"Records": "[{"Record_Name":"Test1","ToAccountNumber":"54678","ToAccountType":"1","ABATRCNumber":"234","Detail_id":"234","Amount":"2"}]"
}
Response: 
{
		"Success": "Successful",
		"Template_id": "68",
		"opstatus": 0,
		"httpStatusCode": 0
}
Error Code(s):
  • 12000 - Internal service error caused due to code exceptions.
  • 12001 - Unauthorized access.
  • 12025 - Missing Template Name.
  • 12026 - Missing Transaction Type ID.
  • 13502 - ACH Template Fetch preprocessor failed.
  • 21014 - ACH Template Edit failed.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.EditACHTemplate

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
DebitAccount DebitAccount NA NA
MaxAmount MaxAmount NA NA
Records Records NA NA
TotalAmount TotalAmount NA NA
TemplateDescription TemplateDescription NA NA
TemplateName TemplateName NA NA
TemplateRequestType_id TemplateRequestType_id NA NA
TemplateType_id TemplateType_id NA NA
TransactionType_id TransactionType_id NA NA
transactionId transactionId NA NA
 
Description: This APIis used to delete an ACH Template for a given Template ID.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/ACHTemplates/deleteACHTemplate
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
    “Template_id” : “69“
}
Response: 
{
		"Success": "Successful",
		"Template_id": "69",
		"opstatus": 0,
		"httpStatusCode": 0
}
Error Code(s):
  • 12000 - Internal service error caused due to code exceptions.
  • 12001 - Unauthorized access.
  • 12025 - Missing Template Name.
  • 12026 - Missing Transaction Type ID.
  • 13502 - ACH Template Fetch preprocessor failed.
  • 21013 - ACH Template Deletion failed.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.DeleteACHTemplate

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
Template_id Templateid NA NA
 
Description: This API is used to initiate an ACH Transaction.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/ACHTransactions/createACHTransaction
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
		"ConfirmationNumber": "",
		"DebitAccount": "",
		"EffectiveDate": "",
		"MaxAmount": "",
		"TotalAmount": "",
		"Records": "",
		"TemplateRequestType_id": "",
		"TemplateRequestTypeValue": "",
		"TemplateType_id": "",
		"TransactionType_id": "",
		"transactionId": "",
		"transactionAmount": "",
		"transactionCurrency": "",
		"serviceCharge": ""
}
Response: 
{
		"Transaction_id": "",
		"ReferenceId": "",
		"Status": "",
		"dbpErrCode": "",
		"dbpErrMsg": "",
		"opstatus": "",
		"httpStatusCode": "",
		"requestId": "",
		"totalAmount": "",
		"transactionAmount": "",
		"transactionCurrency": "",
		"serviceCharge": ""
}
Error Code(s):
  • 10139 - User not authorized to use the feature.
  • 12000 - Internal service error caused due to code exceptions.
  • 12001 - Unauthorized access.
  • 12021 - Missing Effective Date.
  • 12022 - Missing Debit Account.
  • 12026 - Missing Transaction Type ID.
  • 12027 - Missing Template Request ID.
  • 12028 - Missing Records.
  • 12029 - Missing Maximum Transfer Amount.
  • 12301 - Total Amount cannot be Zero.
  • 12302 - Total Amount greater than Max Amount.
  • 12306 - Transaction Type Not Found.
  • 21217 - Error in converting response for ACH transfer
  • 28021 - Error in parsing input records.
  • 29016 - Failed creating DBX entry.
  • 29017 - Backend pending transaction invocation failed.
  • 29018 - Failed validation for approvals.
  • 29019 - Error updating backend ID.
  • 29020 - Error Approving transaction at backend.
  • 10624 - Invalid Request Payload.
  • 12600 - Backend invocation failed.
  • 12601 - Transaction creation failed at backend.
  • 00000 - Error occurred at backend.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.createTransaction

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
ConfirmationNumber ConfirmationNumber NA NA
DebitAccount DebitAccount NA NA
EffectiveDate EffectiveDate NA NA
MaxAmount MaxAmount NA NA
Records Records NA NA
TotalAmount TotalAmount NA NA
TemplateDescription TemplateDescription NA NA
TemplateRequestType_id TemplateRequestType_id NA NA
TemplateRequestTypeValue TemplateRequestTypeValue NA NA
TemplateType_id TemplateType_id NA NA
TransactionType_id TransactionType_id NA NA
transactionId transactionId NA NA
transactionAmount transactionAmount NA NA
transactionCurrency transactionCurrency NA NA
serviceCharge serviceCharge NA NA
 
Description: This API is used to initiate an ACH Transaction using a template.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/ACHTemplates/Execute
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
		"Template_id": "70",
		"EffectiveDate": "2022-06-16",
		"Records": "[{"Amount":"10","TemplateRecord_id":"103","AdditionalInfo":"fsnjdgasdaf"}]"
}
Response: 
{
		"Status": "Sent",
		"TemplateRequestType_id": "4",
		"referenceId": "66769",
		"DebitAccount": "122998",
		"CreatedOn": "2022-06-17T01:38:36Z",
		"MaxAmount": "50",
		"TotalAmount": "23",
		"TemplateType_id": "1",
		"softDelete": "0",
		"TransactionType_id": "2",
		"Company_id": "4276234185_190649",
		"Createdby": "6665635354",
		"Transaction_id": "66769",
		"EffectiveDate": "2022-06-17T00:00:00Z",
		"TemplateName": "TestConsole123API",
		"ConfirmationNumber": "REF-null",
		"featureActionId": "ACH_PAYMENT_CREATE",
		"opstatus": 0,
		"httpStatusCode": 0
		}
Error Code(s):
  • 10139 - User not authorized to use the feature.
  • 12000 - Internal service error caused due to code exceptions.
  • 12001 - Unauthorized access.
  • 12021 - Missing Effective Date.
  • 12022 - Missing Debit Account.
  • 12026 - Missing Transaction Type ID.
  • 12027 - Missing Template Request ID.
  • 12028 - Missing Records.
  • 12029 - Missing Maximum Transfer Amount.
  • 12301 - Total Amount cannot be Zero.
  • 12302 - Total Amount greater than Max Amount.
  • 12306 - Transaction Type Not Found.
  • 21217 - Error in converting response for ACH transfer
  • 28021 - Error in parsing input records.
  • 29016 - Failed creating DBX entry.
  • 29017 - Backend pending transaction invocation failed.
  • 29018 - Failed validation for approvals.
  • 29019 - Error updating backend ID.
  • 29020 - Error Approving transaction at backend.
  • 10624 - Invalid Request Payload.
  • 12600 - Backend invocation failed.
  • 12601 - Transaction creation failed at backend.
  • 00000 - Error occurred at backend.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.createTransaction

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
ConfirmationNumber ConfirmationNumber NA NA
DebitAccount DebitAccount NA NA
EffectiveDate EffectiveDate NA NA
MaxAmount MaxAmount NA NA
Records Records NA NA
TotalAmount TotalAmount NA NA
TemplateDescription TemplateDescription NA NA
TemplateRequestType_id TemplateRequestType_id NA NA
TemplateRequestTypeValue TemplateRequestTypeValue NA NA
TemplateType_id TemplateType_id NA NA
TransactionType_id TransactionType_id NA NA
transactionId transactionId NA NA
transactionAmount transactionAmount NA NA
transactionCurrency transactionCurrency NA NA
serviceCharge serviceCharge NA NA
 
Description: This API is used to view an initiated ACH Transaction.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/ACHTransactions/getAllACHTransactions
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
		"searchString": "",
		"sortByParam": "createdts",
		"sortOrder": "DESC",
		"pageSize": 11,
		"pageOffset": 0,
		"filterByParam": "",
		"filterByValue": ""
}
Response: 
{
		"ACHTransactions": [
		{
		"Status": "Executed",
		"TemplateRequestType_id": "4",
										"userName": "9263436669",
										"DebitAccount": "122998",
										"CreatedOn": "2022-06-17T01:38:36Z",
										"MaxAmount": "50",
										"TotalAmount": "23",
										"TemplateType_id": "1",
										"RequestType": "CCD (Cash Concentration and Disbursement)",
										"TemplateTypeValue": "ACH",
										"softDelete": "0",
										"TransactionType_id": "2",
										"createdby": "9263436669",
										"Company_id": "4276234185_190649",
										"Createdby": "6665635354",
										"TransactionTypeValue": "Payment",
										"Transaction_id": "66769",
										"EffectiveDate": "2022-06-17 00:00:00.0",
										"TemplateName": "TestConsole123API",
										"ConfirmationNumber": "66769",
										"featureActionId": "ACH_PAYMENT_CREATE",
										"AccountName": "Current Account",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Status": "Executed",
										"TemplateRequestType_id": "4",
										"userName": "9263436669",
										"DebitAccount": "122998",
										"CreatedOn": "2022-06-17T00:22:19Z",
										"MaxAmount": "50",
										"TotalAmount": "23",
										"TemplateType_id": "1",
										"RequestType": "CCD (Cash Concentration and Disbursement)",
										"TemplateTypeValue": "ACH",
										"softDelete": "0",
										"TransactionType_id": "2",
										"createdby": "9263436669",
										"Company_id": "4276234185_190649",
										"Createdby": "6665635354",
										"TransactionTypeValue": "Payment",
										"Transaction_id": "70598",
										"EffectiveDate": "2022-06-17 00:00:00.0",
										"TemplateName": "TestConsole123API",
										"ConfirmationNumber": "70598",
										"featureActionId": "ACH_PAYMENT_CREATE",
										"AccountName": "Current Account",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Status": "Executed",
										"TemplateRequestType_id": "4",
										"userName": "9263436669",
										"DebitAccount": "122998",
										"CreatedOn": "2022-06-16T23:44:58Z",
										"MaxAmount": "50",
										"TotalAmount": "10",
										"TemplateType_id": "1",
										"RequestType": "CCD (Cash Concentration and Disbursement)",
										"TemplateTypeValue": "ACH",
										"softDelete": "0",
										"TransactionType_id": "2",
										"createdby": "9263436669",
										"Company_id": "4276234185_190649",
										"Createdby": "6665635354",
										"TransactionTypeValue": "Payment",
										"Transaction_id": "3976",
										"EffectiveDate": "2022-06-16 00:00:00.0",
										"TemplateName": "TestConsole123API",
										"ConfirmationNumber": "3976",
										"featureActionId": "ACH_PAYMENT_CREATE",
										"AccountName": "Current Account",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Status": "Pending",
										"TemplateRequestType_id": "8",
										"Request_id": "85",
										"userName": "9263436669",
										"DebitAccount": "122998",
										"CreatedOn": "2022-06-14T21:35:04Z",
										"MaxAmount": "4",
										"TotalAmount": "4",
										"TemplateType_id": "1",
										"RequestType": "Federal Tax",
										"TemplateTypeValue": "ACH",
										"softDelete": "0",
										"TransactionType_id": "2",
										"createdby": "9263436669",
										"Company_id": "4276234185_190649",
										"Createdby": "6665635354",
										"TransactionTypeValue": "Payment",
										"Transaction_id": "60905",
										"EffectiveDate": "2022-06-14 00:00:00.0",
										"TemplateName": "Tabftaxpay",
										"ConfirmationNumber": "60905",
										"featureActionId": "ACH_PAYMENT_CREATE",
										"AccountName": "Current Account",
										"receivedApprovals": "1",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Status": "Pending",
										"TemplateRequestType_id": "1",
										"Request_id": "82",
										"userName": "9263436669",
										"DebitAccount": "122955",
										"CreatedOn": "2022-06-14T21:16:49Z",
										"MaxAmount": "9",
										"TotalAmount": "2",
										"TemplateType_id": "1",
										"RequestType": "PPD (Prearranged Payment and Deposit)",
										"TemplateTypeValue": "ACH",
										"softDelete": "0",
										"TransactionType_id": "1",
										"createdby": "9263436669",
										"Company_id": "4276234185_190645",
										"Createdby": "6665635354",
										"TransactionTypeValue": "Collection",
										"Transaction_id": "61792",
										"EffectiveDate": "2022-06-14 00:00:00.0",
										"TemplateName": "No Template Used",
										"ConfirmationNumber": "61792",
										"featureActionId": "ACH_COLLECTION_CREATE",
										"AccountName": "Current Account",
										"receivedApprovals": "1",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Status": "Approved",
										"TemplateRequestType_id": "8",
										"Request_id": "74",
										"userName": "9263436669",
										"DebitAccount": "122998",
										"CreatedOn": "2022-06-13T21:43:47Z",
										"MaxAmount": "4",
										"TotalAmount": "4",
										"TemplateType_id": "1",
										"RequestType": "Federal Tax",
										"TemplateTypeValue": "ACH",
										"softDelete": "0",
										"TransactionType_id": "2",
										"createdby": "9263436669",
										"Company_id": "4276234185_190649",
										"Createdby": "6665635354",
										"TransactionTypeValue": "Payment",
										"Transaction_id": "88252",
										"EffectiveDate": "2022-06-13 00:00:00.0",
										"TemplateName": "Tabftaxpay",
										"ConfirmationNumber": "88252",
										"featureActionId": "ACH_PAYMENT_CREATE",
										"AccountName": "Current Account",
										"receivedApprovals": "2",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Status": "Rejected",
										"TemplateRequestType_id": "6",
										"Request_id": "72",
										"userName": "9263436669",
										"DebitAccount": "122955",
										"CreatedOn": "2022-06-13T21:36:18Z",
										"MaxAmount": "3",
										"TotalAmount": "3",
										"TemplateType_id": "1",
										"RequestType": "CTX (Corporate Trade Exchange)",
										"TemplateTypeValue": "ACH",
										"softDelete": "0",
										"TransactionType_id": "2",
										"createdby": "9263436669",
										"Company_id": "4276234185_190645",
										"Createdby": "6665635354",
										"TransactionTypeValue": "Payment",
										"Transaction_id": "39527",
										"EffectiveDate": "2022-06-13 00:00:00.0",
										"TemplateName": "Tabctxpay",
										"ConfirmationNumber": "39527",
										"featureActionId": "ACH_PAYMENT_CREATE",
										"AccountName": "Current Account",
										"receivedApprovals": "1",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Status": "Pending",
										"TemplateRequestType_id": "7",
										"Request_id": "71",
										"userName": "9263436669",
										"DebitAccount": "122955",
										"CreatedOn": "2022-06-13T21:03:59Z",
										"MaxAmount": "1.41",
										"TotalAmount": "1.41",
										"TemplateType_id": "1",
										"RequestType": "Web Collection",
										"TemplateTypeValue": "ACH",
										"softDelete": "0",
										"TransactionType_id": "1",
										"createdby": "9263436669",
										"Company_id": "4276234185_190645",
										"Createdby": "6665635354",
										"TransactionTypeValue": "Collection",
										"Transaction_id": "84006",
										"EffectiveDate": "2022-06-13 00:00:00.0",
										"TemplateName": "No Template Used",
										"ConfirmationNumber": "84006",
										"featureActionId": "ACH_COLLECTION_CREATE",
										"AccountName": "Current Account",
										"receivedApprovals": "1",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Status": "Pending",
										"TemplateRequestType_id": "5",
										"Request_id": "70",
										"userName": "9263436669",
										"DebitAccount": "122955",
										"CreatedOn": "2022-06-13T21:02:29Z",
										"MaxAmount": "1.3",
										"TotalAmount": "1.3",
										"TemplateType_id": "1",
										"RequestType": "CTX (Corporate Trade Exchange)",
										"TemplateTypeValue": "ACH",
										"softDelete": "0",
										"TransactionType_id": "1",
										"createdby": "9263436669",
										"Company_id": "4276234185_190645",
										"Createdby": "6665635354",
										"TransactionTypeValue": "Collection",
										"Transaction_id": "10003",
										"EffectiveDate": "2022-06-13 00:00:00.0",
										"TemplateName": "No Template Used",
										"ConfirmationNumber": "10003",
										"featureActionId": "ACH_COLLECTION_CREATE",
										"AccountName": "Current Account",
										"receivedApprovals": "1",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Status": "Pending",
										"TemplateRequestType_id": "3",
										"Request_id": "69",
										"userName": "9263436669",
										"DebitAccount": "122955",
										"CreatedOn": "2022-06-13T21:01:19Z",
										"MaxAmount": "1.2",
										"TotalAmount": "1.2",
										"TemplateType_id": "1",
										"RequestType": "CCD (Cash Concentration and Disbursement)",
										"TemplateTypeValue": "ACH",
										"softDelete": "0",
										"TransactionType_id": "1",
										"createdby": "9263436669",
										"Company_id": "4276234185_190645",
										"Createdby": "6665635354",
										"TransactionTypeValue": "Collection",
										"Transaction_id": "56442",
										"EffectiveDate": "2022-06-13 00:00:00.0",
										"TemplateName": "No Template Used",
										"ConfirmationNumber": "56442",
										"featureActionId": "ACH_COLLECTION_CREATE",
										"AccountName": "Current Account",
										"receivedApprovals": "1",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"Status": "Pending",
										"TemplateRequestType_id": "1",
										"Request_id": "68",
										"userName": "9263436669",
										"DebitAccount": "122955",
										"CreatedOn": "2022-06-13T21:00:07Z",
										"MaxAmount": "1.5",
										"TotalAmount": "1.5",
										"TemplateType_id": "1",
										"RequestType": "PPD (Prearranged Payment and Deposit)",
										"TemplateTypeValue": "ACH",
										"softDelete": "0",
										"TransactionType_id": "1",
										"createdby": "9263436669",
										"Company_id": "4276234185_190645",
										"Createdby": "6665635354",
										"TransactionTypeValue": "Collection",
										"Transaction_id": "61094",
										"EffectiveDate": "2022-06-13 00:00:00.0",
										"TemplateName": "No Template Used",
										"ConfirmationNumber": "61094",
										"featureActionId": "ACH_COLLECTION_CREATE",
										"AccountName": "Current Account",
										"receivedApprovals": "1",
										"amICreator": "true",
										"amIApprover": "false"
										}
										],
										"opstatus": 0,
										"httpStatusCode": 0
		}
Error Code(s):
  • 12000 - Internal service error caused due to code exceptions.
  • 12001 - Unauthorized access.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.FetchAllACHTransactions

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
sortByParam _sortByParam NA NA
queryType _queryType NA NA
searchString _searchString NA NA
sortOrder _sortOrder NA NA
pageSize _pageSize NA NA
filterByValue _filterByValue NA NA
filterByParam _filterByParam NA NA
pageOffset _pageOffset NA NA
Transaction_id _transaction_id NA NA
 
Description: This API allows the user to view an initiated ACH Transaction for a given Transaction ID.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/TransactionRecords/fetchTransactionRecordsById
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
		"Transaction_id": "60905"	
}
Response: 
{
		"TransactionRecords": [
		{
		"ToAccountTypeValue": "Savings",
		"Transaction_id": "95",
		"ABATRCNumber": "45566",
		"softDelete": "0",
		"TransactionRecord_id": "110",
		"Amount": "0",
		"ToAccountNumber": "123344",
		"IsZeroTaxDue": "1",
		"TaxType": "943 Employer’s Annual Federal Tax Return for Agricultural Employees",
		"EIN": "5666664",
		"TaxType_id": "10",
		"TemplateRequestTypeValue": "Federal Tax"
		}
		],
		"opstatus": 0,
		"httpStatusCode": 0
		}
Error Code(s):
  • 12000 - Internal service error caused due to code exceptions.
  • 12001 - Unauthorized access.
  • 12042 - Missing Transaction ID.
  • 12606 - Records do not exist.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.FetchACHTransactionById

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
sortBy _sortBy NA NA
queryType _queryType NA NA
searchString _searchString NA NA
sortOrder _sortOrder NA NA
pageSize _pageSize NA NA
pageOffset _pageOffset NA NA
Transaction_id _transaction_id NA NA
 
Description: This API is used to fetch all the ACH Files.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/ACHFile/UploadACHFile
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
		"FileName": "achFile1API.ach",
		"FileSize": 1054,
		"FileType": "ach",
		"Contents": "MTAxIDIwMjg4MTA2NiAxMzAwMDk3ODMyMDA0MjcyMzI4QjA5NDEwMUJhbmsgb2YgQW55IFRvd24gICAgICAgWW91ciBDb21wYW55ICAgICAgICAgICAwMDAwMDAwMA0KNTIwMFRlbWVub3MgQ29tcGFueSAgICAgICAgICAgICAgICAgICAgIDEzMDAwOTc4MyBQUERlUGF5MDAwMSAgMjIwOTExMjIwOTExICAgMTIwMjg4MTA2MDAwMDAwMQ0KNjIyMTAzMjUyOTU5MTcyNTA5MDEyICAgICAgICAwMDAwMDAwMTAwODQwNCAgICAgICAgICAgU3RhciBMb3JkICAgICAgICAgICAgICAgMDIwMjg4MTA2MDAwMDExNA0KNjIyMTAzMjUyOTU5MTcyNTA5MDEzICAgICAgICAwMDAwMDAwNTAwODQwNCAgICAgICAgICAgRHJheCAgICAgICAgICAgICAgICAgICAgMDIwMjg4MTA2MDAwMDExNQ0KNjI3MTU2NTMwNDY2MTIyOTYzICAgICAgICAgICAwMDAwMDAwNjAwICAgICAgICAgICAgICAgT0ZGU0VUICAgICAgICAgICAgICAgICAgMDIwMjg4MTA2MDAwMDExNg0KODIwMDAwMDAwMjAwMjU5NzgzNDEwMDAwMDAwMDIyMDAwMDAwMDAwMDIyMDAxMzAwMDk3ODMgICAgICAgICAgICAgICAgICAgICAgICAgIDIwMjg4MTA2MDAwMDAwMQ0KOTAwMDAwMTAwMDAxMDAwMDAwMDkyMTE0Mjc3NTY0MzAwMDA0NDY0OTQ2NjAwMDA0NDY0OTQ2NiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIA0KOTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OQ0KOTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OQ0KOTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OQ0KOTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OTk5OQ==",
		"FormatTypeID": "2"
}
Response: 
{
		"ACHFileID": "23177",
		"FileName": "achFile1SRC.ach",
		"TotalDebitAmount": "6",
		"UploadByID": "6665635354",
		"UpdatedDateAndTime": "2022-06-17T01:44:14Z",
		"FileRequestType": "PPD",
		"NumberOfCredits": "2",
		"NumberOfDebits": "0",
		"NumberOfPrenotes": "0",
		"TotalCreditAmount": "0",
		"NumberOfRecords": "2",
		"FormatTypeID": "2",
		"StatusId": "Sent",
		"FileStatus": "Sent",
		"CompanyID": "4276234185_190645",
		"debitAccounts": "122963",
		"opstatus": 0,
		"httpStatusCode": 0,
}
Error Code(s):
  • 12000 - Internal service error caused due to code exceptions.
  • 12001 - Unauthorized access.
  • 12046 - Null offset account details.
  • 12061 - Null accountDTO.
  • 12059 - Not authorized user.
  • 12050 - Authentication failed.
  • 21217 - Response conversion failed.
  • 29016 - Uploading ACH File failed
  • 29017 - Entry not happened in backend table
  • 12041 - File ID is missing.
  • 12606 - Record doesn’t exist.
  • 12304 - Null length
  • 12305 - Invalid file type.
  • 12111 - Invalid file name.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.UploadACHFile

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
FileName achFileName NA NA
Contents fileContents NA NA
FileSize fileSize NA NA
FormatTypeID fileTypeId NA NA
 
Description: This API is used to fetch ACH file details for a given ACH File ID.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/ACHFile/getFileDetailsByID
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
		""ACHFileID": "23177"
}
Response: 
		{
		"ACHFile": [								
		{
		"ACHFileID": "23177",
		"FileName": "achFile1SRC.ach",
		"TotalDebitAmount": "6",
		"UploadByID": "6665635354",
		"UpdatedDateAndTime": "2022-06-17T01:44:14Z",
		"FileRequestType": "PPD",
		"NumberOfCredits": "2",
		"NumberOfDebits": "0",
		"NumberOfPrenotes": "0",
		"TotalCreditAmount": "0",
		"NumberOfRecords": "2",
		"FormatTypeID": "2",
		"StatusId": "Executed",
		"FileStatus": "Executed",
		"CompanyID": "4276234185_190645",
		"userName": "9263436669",
		"FileFormatType": "NACHA",
		"debitAccounts": "122963",
		"amICreator": "true",
		"amIApprover": "false"
		}
		],
		"opstatus": 0,
		"httpStatusCode": 0,
}
Error Code(s):
  • 12000 - Internal service error caused due to code exceptions.
  • 12001 - Unauthorized access.
  • 12041 – File ID is missing
  • 12046 - Null offset account details.
  • 12061 - Null accountDTO.
  • 12059 - Not authorized user.
  • 12050 - Authentication failed.
  • 21217 - Response conversion failed.
  • 29016 - Uploading ACH File failed
  • 29017 - Entry not happened in backend table
  • 12606 - Record doesn’t exist.
  • 12304 - Null length
  • 12305 - Invalid file type.
  • 12111 - Invalid file name.
  • 12601 - Null reference ID.
  • 12040 - Null feature action ID.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.FetchACHFileById

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
ACHFileID achfile_id NA NA
 
Description: This API is used to fetch all the ACH Files.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/ACHFile/getAllACHFiles
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
	"searchString": "",
	"sortByParam": "",
	"sortOrder": "",
	"pageSize": 11,
	"pageOffset": 0,
	"filterByParam": "",
	"filterByValue": ""
}
Response: 
{
		"ACHFileID": "23177",
		"FileName": "achFile1SRC.ach",
		"TotalDebitAmount": "6",
		"UploadByID": "6665635354",
		"UpdatedDateAndTime": "2022-06-17T01:44:14Z",
		"FileRequestType": "PPD",
		"NumberOfCredits": "2",
		"NumberOfDebits": "0",
		"NumberOfPrenotes": "0",
		"TotalCreditAmount": "0",
		"NumberOfRecords": "2",
		"FormatTypeID": "2",
		"StatusId": "Executed",
		"FileStatus": "Executed",
		"CompanyID": "4276234185_190645",
										"userName": "9263436669",
										"FileFormatType": "NACHA",
										"debitAccounts": "122963",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"ACHFileID": "56610",
										"FileName": "achFile1SRC.ach",
										"TotalDebitAmount": "6",
										"UploadByID": "6665635354",
										"UpdatedDateAndTime": "2022-06-17T00:31:14Z",
										"FileRequestType": "PPD",
										"NumberOfCredits": "2",
										"NumberOfDebits": "0",
										"NumberOfPrenotes": "0",
										"TotalCreditAmount": "0",
										"NumberOfRecords": "2",
										"FormatTypeID": "2",
										"StatusId": "Executed",
										"FileStatus": "Executed",
										"CompanyID": "4276234185_190645",
										"userName": "9263436669",
										"FileFormatType": "NACHA",
										"debitAccounts": "122963",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"ACHFileID": "91409",
										"FileName": "ACHFile3.ach",
										"TotalDebitAmount": "2",
										"UploadByID": "6665635354",
										"UpdatedDateAndTime": "2022-06-14T16:59:14Z",
										"FileRequestType": "PPD",
										"NumberOfCredits": "1",
										"NumberOfDebits": "0",
										"NumberOfPrenotes": "0",
										"Request_id": "79",
										"TotalCreditAmount": "0",
										"NumberOfRecords": "1",
										"FormatTypeID": "2",
										"StatusId": "Rejected",
										"FileStatus": "Rejected",
										"CompanyID": "4276234185_190645",
										"receivedApprovals": "1",
										"userName": "9263436669",
										"FileFormatType": "NACHA",
										"debitAccounts": "122955",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"ACHFileID": "18329",
										"FileName": "ACHFile1.ach",
										"TotalDebitAmount": "260",
										"UploadByID": "6665635354",
										"UpdatedDateAndTime": "2022-06-14T16:58:55Z",
										"FileRequestType": "PPD",
										"NumberOfCredits": "4",
										"NumberOfDebits": "0",
										"NumberOfPrenotes": "0",
										"Request_id": "78",
										"TotalCreditAmount": "0",
										"NumberOfRecords": "4",
										"FormatTypeID": "2",
										"StatusId": "Approved",
										"FileStatus": "Approved",
										"CompanyID": "4276234185_190645",
										"receivedApprovals": "2",
										"userName": "9263436669",
										"FileFormatType": "NACHA",
										"debitAccounts": "122955",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"ACHFileID": "85638",
										"FileName": "ACHFile1.ach",
										"TotalDebitAmount": "260",
										"UploadByID": "6665635354",
										"UpdatedDateAndTime": "2022-06-10T23:29:48Z",
										"FileRequestType": "PPD",
										"NumberOfCredits": "4",
										"NumberOfDebits": "0",
										"NumberOfPrenotes": "0",
										"Request_id": "60",
										"TotalCreditAmount": "0",
										"NumberOfRecords": "4",
										"FormatTypeID": "2",
										"StatusId": "Approved",
										"FileStatus": "Approved",
										"CompanyID": "4276234185_190645",
										"receivedApprovals": "2",
										"userName": "9263436669",
										"FileFormatType": "NACHA",
										"debitAccounts": "122955",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"ACHFileID": "46220",
										"FileName": "CreditandDebit.ach",
										"TotalDebitAmount": "200",
										"UploadByID": "6665635354",
										"UpdatedDateAndTime": "2022-06-10T23:05:21Z",
										"FileRequestType": "PPD,CCD",
										"NumberOfCredits": "1",
										"NumberOfDebits": "6",
										"NumberOfPrenotes": "0",
										"Request_id": "59",
										"TotalCreditAmount": "8212",
										"NumberOfRecords": "7",
										"FormatTypeID": "2",
										"StatusId": "Rejected",
										"FileStatus": "Rejected",
										"CompanyID": "4276234185_190645",
										"receivedApprovals": "1",
										"userName": "9263436669",
										"FileFormatType": "NACHA",
										"debitAccounts": "122955",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"ACHFileID": "76115",
										"FileName": "sentACHFile11.ach",
										"TotalDebitAmount": "0",
										"UploadByID": "6665635354",
										"UpdatedDateAndTime": "2022-06-10T22:49:15Z",
										"FileRequestType": "PPD",
										"NumberOfCredits": "0",
										"NumberOfDebits": "1",
										"NumberOfPrenotes": "0",
										"TotalCreditAmount": "2",
										"NumberOfRecords": "1",
										"FormatTypeID": "2",
										"StatusId": "Executed",
										"FileStatus": "Executed",
										"CompanyID": "4276234185_190645",
										"userName": "9263436669",
										"FileFormatType": "NACHA",
										"debitAccounts": "122955",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"ACHFileID": "23739",
										"FileName": "ACHFile3.ach",
										"TotalDebitAmount": "2",
										"UploadByID": "6665635354",
										"UpdatedDateAndTime": "2022-06-10T22:48:56Z",
										"FileRequestType": "PPD",
										"NumberOfCredits": "1",
										"NumberOfDebits": "0",
										"NumberOfPrenotes": "0",
										"TotalCreditAmount": "0",
										"NumberOfRecords": "1",
										"FormatTypeID": "2",
										"StatusId": "Executed",
										"FileStatus": "Executed",
										"CompanyID": "4276234185_190645",
										"userName": "9263436669",
										"FileFormatType": "NACHA",
										"debitAccounts": "122955",
										"amICreator": "true",
										"amIApprover": "false"
										},
										{
										"ACHFileID": "46211",
										"FileName": "ACHFile1.ach",
										"TotalDebitAmount": "260",
										"UploadByID": "6665635354",
										"UpdatedDateAndTime": "2022-06-10T22:37:37Z",
										"FileRequestType": "PPD",
										"NumberOfCredits": "4",
										"NumberOfDebits": "0",
										"NumberOfPrenotes": "0",
										"TotalCreditAmount": "0",
										"NumberOfRecords": "4",
										"FormatTypeID": "2",
										"StatusId": "Executed",
										"FileStatus": "Executed",
										"CompanyID": "4276234185_190645",
										"userName": "9263436669",
										"FileFormatType": "NACHA",
										"debitAccounts": "122955",
										"amICreator": "true",
										"amIApprover": "false"
										}
										],
										"opstatus": 0,
										"httpStatusCode": 0
}
Error Code(s):
  • 12000 - Internal service error caused due to code exceptions.
  • 12001 - Unauthorized access.
  • 12046 - Null offset account details.
  • 12061 - Null accountDTO.
  • 12059 - Not authorized user.
  • 12050 - Authentication failed.
  • 21217 - Response conversion failed.
  • 29016 - Uploading ACH File failed
  • 29017 - Entry not happened in backend table
  • 12041 - File ID is missing.
  • 12606 - Record doesn’t exist.
  • 12304 - Null length
  • 12305 - Invalid file type.
  • 14005 – Empty file
  • 12111 - Invalid file name.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.FetchAllACHFiles

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
sortByParam _sortByParam NA NA
queryType _queryType NA NA
searchString _searchString NA NA
sortOrder _sortOrder NA NA
pageSize _pageSize NA NA
filterByValue _filterByValue NA NA
filterByParam _filterByParam NA NA
pageOffset _pageOffset NA NA
 
Description: This API is used to fetch ACH account types.
Method: GET
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/objects/ACHAccountTypes
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

 
Response: 
{
	"records": [
		{
	"Id": "1",
	"AccountType": "Savings"
	},
	{
	"Id": "3",
	"AccountType": "Checkings"
	}
	],
	"opstatus": 0,
	"httpStatusCode": 0
}
Error Code(s):

12000 - Internal service error caused due to code exceptions.
Enterprise Provider: Temenos Digital
Enterprise API: dbpBBJavaServices.FetchACHAccountTypes

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
ACHAccountTypes achaccountstype NA NA
Id id NA NA
AccountType accountType NA NA
 
Description: This API is used to fetch all the tax types.
Method: GET
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/objects/TaxType
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

 
Response: 
{
	"records": [
		{
	"Id": "1",
	"TaxType": "11-C - Occupational Tax and Registration Return for Wagering"
	},
	{
	"Id": "2",
	"TaxType": "706-GS (D) - Generation-Skipping Transfer Tax Return for Distributions"
	},
	{
	
										"Id": "3",
										"TaxType": "706-GS (T) - Generation-Skipping Transfer Tax Return for Terminations"
										},
										{
										"Id": "4",
										"TaxType": "709 - United States Gift (and Generation-Skipping Transfer) Tax Return"
										},
										{
										"Id": "5",
										"TaxType": "7200D - Branded Prescription Drug Fee"
										},
										{
										"Id": "6",
										"TaxType": "730 - Monthly Tax Return for Wagers"
										},
										{
										"Id": "7",
										"TaxType": "926 - Return by a U.S. Transferor of Property to a\nForeign Corporation"
										},
										{
										"Id": "8",
										"TaxType": "940 - Employer’s Annual Federal Unemployment (FUTA) Tax Return"
										},
										{
										"Id": "9",
										"TaxType": "941 - Employer’s Quarterly Federal Tax Return"
										},
										{
										"Id": "10",
										"TaxType": "943 Employer’s Annual Federal Tax Return for Agricultural Employees"
										},
										{
										"Id": "11",
										"TaxType": "944 Employer’s Annual Federal Tax Return"
										},
										{
										"Id": "12",
										"TaxType": "945 Annual Return of Withheld Federal Income Tax"
										},
										{
										"Id": "13",
										"TaxType": "990 Return of Organization Exempt from Income Tax"
										},
										{
										"Id": "14",
										"TaxType": "990-BL Information and Initial Excise Tax Return for Black Lung Benefit Trusts and Certain Related Persons"
										},
										{
										"Id": "15",
										"TaxType": "990-C U.S. Income Tax Return for Cooperative Associations"
										},
										{
										"Id": "16",
										"TaxType": "990-PF Return of Private Foundation or Section 4947(a)(1)  Nonexempt Charitable Trust Treated as a Private Foundation"
										},
										{
										"Id": "17",
										"TaxType": "990-T Exempt Organization Business Income Tax Return and proxy tax under section 6033(e)"
										},
										{
										"Id": "18",
										"TaxType": "1041 Income Tax Return for Estates and Trusts"
										},
										{
										"Id": "19",
										"TaxType": "1041-A U.S. Information Return Trust Accumulation of Charitable Amounts"
										},
										{
										"Id": "20",
										"TaxType": "1042 Annual Withholding Tax Return for U.S. Source Income of Foreign Persons"
										},
										{
										"Id": "21",
										"TaxType": "1065  U.S. Return of Partnership Income"
										},
										{
										"Id": "22",
										"TaxType": "1066 Real Estate Mortgage Investment Conduit (REMIC) Income Tax Return"
										},
										{
										"Id": "23",
										"TaxType": "1120 U.S. Corporation Income Tax Return"
										},
										{
										"Id": "24",
										"TaxType": "1120-IC-DISC Interest Charge Domestic International Sales Corporation Return"
										},
										{
										"Id": "25",
										"TaxType": "2290 Heavy Highway Vehicle Use Tax Return"
										},
										{
										"Id": "26",
										"TaxType": "2438 Undistributed Capital Gains Tax Return"
										},
										{
										"Id": "27",
										"TaxType": "3520 Annual Return To Report Transactions With Foreign Trusts and Receipt of Certain Foreign Gifts"
										},
										{
										"Id": "28",
										"TaxType": "4720 Return of Certain Excise Taxes Under Chapters 41 and 42 of the Internal Revenue Code"
										},
										{
										"Id": "29",
										"TaxType": "5227 Split-Interest Trust Information Return"
										},
										{
										"Id": "30",
										"TaxType": "5329 Additional Taxes on Qualified Plans (including IRAs) and Other Tax Favored Accounts"
										},
										{
										"Id": "31",
										"TaxType": "6069 Return of Excise Tax on Excess Contributions to Black Lung Benefit Trst-Section 4953 and Computation-Section 192 Deduction"
										},
										{
										"Id": "32",
										"TaxType": "8288 U.S. Withholding Tax Return for Dispositions by Foreign Persons of U.S. Real Estate Property Interests"
										},
										{
										"Id": "33",
										"TaxType": "8404 Interest Charge on DISC-Related Deferred Tax               "
										},
										{
										"Id": "34",
										"TaxType": "8612 Return of Excise Tax on Undistributed Income of Real Estate Investment Trusts           "
										},
										{
										"Id": "35",
										"TaxType": "8613 Return of Excise Tax on Undistributed Income of Regulated Investment Company     "
										},
										{
										"Id": "36",
										"TaxType": "8697 - Interest Computation Under the Look-Back Method  for Completed Long-Term Contracts               "
										},
										{
										"Id": "37",
										"TaxType": "8725 Excise Tax on Greenmail          "
										},
										{
										"Id": "38",
										"TaxType": "8752 Required Payment or Refund Under Section 7519"
										},
										{
										"Id": "39",
										"TaxType": "8804 Annual Return for Partnership Withholding Tax  (Section 1446)"
										},
										{
										"Id": "40",
										"TaxType": "8805 Foreign Partners Information Statement of Section 1446 Withholding Tax               "
										},
										{
										"Id": "41",
										"TaxType": "8813 Partnership Withholding Tax Payment Voucher  (Section 1446)"
										},
										{
										"Id": "42",
										"TaxType": "8831 Excise Taxes on Excess Inclusions of REMIC  Residual Interests "
										},
										{
										"Id": "43",
										"TaxType": "8876 Excise Tax on Structured Settlement Factoring Payment due with a return 88761 Transactions           "
										},
										{
										"Id": "44",
										"TaxType": "CT-1 - Employer’s Annual Railroad Retirement Tax Return"
										},
										{
										"Id": "45",
										"TaxType": "8038 Information Return for Tax Exempt Private Activity Bond-Issues"
										},
										{
										"Id": "46",
										"TaxType": "8963 - Insurance Provider Fee"
										}
										],				
	"opstatus": 0,
	"httpStatusCode": 0
}
Error Code(s):

12000 - Internal service error caused due to code exceptions.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.FetchACHTaxType

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
TaxType TaxType NA NA
Id id NA NA
 
Description: This API is used to fetch the tax sub types for a given Tax Type.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/TaxSubType/FetchTaxSubTypes
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
     "TaxType": "12"
}
Response: 
{
		"TaxSubType": [
		{
		"Id": "31",
		"TaxSubType": "09455 - Federal Tax Deposit",
		"TaxType": "12"
		},
		{
		"Id": "32",
		"TaxSubType": "09451 - Payment due with a return",
		"TaxType": "12"
		},
		{
		"Id": "33",
		"TaxSubType": "09457 - Payment due on an IRS notice",
		"TaxType": "12"
		}
		],
		"opstatus": 0,
		"httpStatusCode": 0
}
Error Code(s):

12000 - Internal service error caused due to code exceptions.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.FetchACHTaxSubType

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
TaxType taxType NA NA
TaxSubType TaxSubType NA NA
Id id NA NA
 
Description: This API is used to fetch all the Template Request Types.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/TemplateRequestTypes/FetchTemplateRequestTypes
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
     "TransactionType_id": "2"
}
Response: 
{
	{
	"TemplateRequestType": [
	{
	"TransactionType_id": "2",
	"TemplateRequestType_id": "2",
	"TemplateRequestTypeName": "PPD (Prearranged Payment and Deposit)"
	},
	{
	"TransactionType_id": "2",
	"TemplateRequestType_id": "4",
	"TemplateRequestTypeName": "CCD (Cash Concentration and Disbursement)"
	},
	{
	"TransactionType_id": "2",
	"TemplateRequestType_id": "6",
	"TemplateRequestTypeName": "CTX (Corporate Trade Exchange)"
	},
	{
	"TransactionType_id": "2",
	"TemplateRequestType_id": "8",
	"TemplateRequestTypeName": "Federal Tax"
	}
	],
	"opstatus": 0,
	"httpStatusCode": 0
}
Error Code(s):

12000 - Internal service error caused due to code exceptions.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.FetchACHTemplateRequestType

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
TransactionType_id transactionType_id NA NA
TemplateRequestType TemplateRequestType NA NA
TemplateRequestType_id templateRequestType_id NA NA
TemplateRequestTypeName templateRequestTypeName    
 
Description: This API is used to fetch all the Template Records for a given Template ID.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/TemplateRecords/fetchTemplateRecordById
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
     "Template_id": "68"
}
Response: 
{
	{
	"TemplateRecords": [
	{
	"ToAccountTypeValue": "Savings",
	"Template_id": "68",
	"ABATRCNumber": "234",
	"TemplateRecord_id": "101",
	"ToAccountNumber": "54678",
	"IsZeroTaxDue": "0",
	"Amount": "2",
	"Record_Name": "Test1",
	"softDelete": "0",
	"Detail_id": "234",
	"ToAccountType_id": "1",
	"TaxType_id": "0",
	"TemplateRequestTypeValue": "PPD (Prearranged Payment and Deposit)"
	}
	],
	"opstatus": 0,
	"httpStatusCode": 0
}
Error Code(s):

12000 - Internal service error caused due to code exceptions.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.FetchACHTemplateRecords

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
Template_id Templateid NA NA
ToAccountTypeValue accountType NA NA
ABATRCNumber ABATRCNumber NA NA
TemplateRecord_id templateRecord_id    
ToAccountNumber toAccountNumber    
IsZeroTaxDue isZeroTaxDue    
TaxType taxType    
EIN ein    
Amount amount    
AdditionalInfo additionalInfo    
AdditionalInfo record_Name    
softDelete softDelete    
Detail_id detail_id    
ToAccountType_id toAccountType    
TaxType_id taxType_id    
TemplateRequestTypeValue templateRequestTypeName    
 
Description: This API is used to get a list of all Template Types.
Method: GET
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/objects/TemplateTypes
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

 
Response: 
{
	"opstatus": 0,
	"httpStatusCode": 0,
	"records": [
	{
	"bbtemplatetype": [
	{
	"templateType_id": 1,
	"templateTypeName": "ACH"
	},
	{
	"templateType_id": 2,
	"templateTypeName": "Other"
	}
	]
	}
	]
}
Error Code(s):

12000 - Internal service error caused due to code exceptions.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.getACHTemplateType

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
TransactionTypeName transactionTypeName NA NA
TransactionType_id transactionType_id NA NA
 
Description: This API is used to get a list of all Transaction Types.
Method: GET
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/objects/TransactionTypes
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

 
Response: 
{
	"records": [
	{
	"TransactionTypeName": "Collection",
	"TransactionType_id": "1"
	},
	{
	"TransactionTypeName": "Payment",
	"TransactionType_id": "2"
	}
	],
	"opstatus": 0,
	"httpStatusCode": 0
}
Error Code(s):

12000 - Internal service error caused due to code exceptions.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.FetchACHTransactionTypes

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
TransactionTypeName transactionTypeName NA NA
TransactionType_id transactionType_id NA NA
 
Description: This API is used to list the acceptable ACH File formats.
Method: GET
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/objects/ACHFileFormats
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

 
Response: 
{
	"records": [
	{
	"Fileextension": "ach",
	"FileType": "NACHA",
	"MIMEtype": "application/octet-stream",
	"id": "2"
	}
	],
	"opstatus": 0,
	"httpStatusCode": 0
}
Error Code(s):
  • 12000 - Internal service error caused due to code exceptions.
  • 12046 - Null offset account details.
  • 12061 - Null accountDTO.
  • 12059 - Not authorized user.
  • 12050 - Authentication failed.
  • 21217 - Response conversion failed.
  • 29016 - Uploading ACH File failed.
  • 29017 - Entry not happened in backend table.

  • 12041 - File ID is missing.

  • 12606 - Record doesn’t exist.
  • 12304 - Null length
  • 12305 - Invalid file type.
  • 12111 - Invalid file name.
  • 12049 - Exception at fetching ACH file sub records.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.GetACHFileFormats

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
FileExtension fileextension NA NA
FileType fileType NA NA
MIMEtype mimetype NA NA
id id    
 
Description: This API is used to fetch ACH file records.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/ACHFileRecord/fetchACHFileRecords
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
     "achFileId": "91409"
}
Response: 
{
	"AchFileRecords": [
	{
	"offsetTransactionType": "Payment",
	"offsetAmount": 2,
	"requestType": "PPD",
	"totalCreditAmount": 0,
	"achFileId": "21",
	"achFileRecordId": "62",
	"totalDebitAmount": 2,
	"offsetAccountNumber": "122955"
	}
	],
	"opstatus": 0,
	"httpStatusCode": 0
}
Error Code(s):
  • 12000 - Internal service error caused due to code exceptions.
  • 12041 - Null file ID.
  • 12001 - Null feature action ID.
  • 12606 - Record doesn’t exist.
  • 12048 - Exception occured at fetching ACH file records.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.FetchACHFileRecords

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
achFileId achFileId NA NA
 
Description: This API is used to fetch ACH file sub records.
Method: POST
URL: {{FABRIC_HOST_URL}}/services/data/v1/ACH/operations/ACHFileSubRecord/fetchACHFileSubRecords
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request: 
{
     "achFileRecordId": "62"
}
Response: 
{
	"opstatus": 0,
	"AchFileSubrecords": [
	{
	"amount": 2,
	"receiverAccountType": "Checkings",
	"receiverName": "John Rolfe",
	"receiverTransactionType": "Collection",
	"achFileSubRecordId": "76",
	"receiverAccountNumber": "172509012",
	"achFileRecordId": "62"
	}
	],
	"httpStatusCode": 0
}
Error Code(s):
  • 12041 - File ID is missing.
  • 12040 - Null feature action ID.
  • 12049 - Exception occurred at fetching ACH file sub records.
  • 12000 - Internal service error caused due to code exceptions.
Enterprise Provider: Temenos Digital
Enterprise API: dbpACHServices.FetchACHFileSubRecords

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
achFileRecordId achFileRecordId NA NA

 

In this topic

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Sunday, March 23, 2025 3:08:24 PM IST