ACH Manager

Name Description Introduced In
executeTemplate This API allows the user to execute an ACH Template. All the transaction records that are part of the template are executed. 2020.04
createACHTranscation This API allows the user to create a ACH Transaction. The ACH transaction can be created with or without a template. 2020.04
getACHTransactionDataById This API allows the user to fetch the Request ID of the corresponding Transaction, if an ACH Transaction is in the Approval Queue. 2020.04
ClosedexecuteTemplate
 
Description: This API allows the user to create a ACH template.
Method: POST
URL: /services/data/v1/ACHObjects/operations/ACHTemplates/Execute
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

Template_id (Mandatory)

Specifies the unique Id of the Template..

EffectiveDate (Mandatory)

Specifies the date on which the transaction should be executed.

Records (Mandatory)

Specifies an array consisting of Transaction Record details (Amount, TemplateRecord_id) that are part of the template.

{
"Template_id": "183",
"EffectiveDate": "2020-09-30",
"Records": "[{\"Amount\":\"12\",\"TemplateRecord_id\":\"784\"}]"
}
Response:

Parameters

/status

Specifies the status of the transaction such as Sent, Executed, and so on.

/TemplateRequestType_id

Specifies a unique request type ID of the template.

/referenceId

Specifies a unique reference ID for the template execution.

/DebitAccount

Specifies the account number from which the amount is debited.

/CreatedOn

Specifies the date on which the transaction is created.

/MaxAmount

Specifies the maximum amount for a template.

/TotalAmount

Specifies the sum of all amounts for each transaction record in the template.

/TemplateType_id

Specifies a unique type ID of the template.

/softDelete

Specifies whether the soft delete option is available. This value is Boolean.

/TransactionType_id

Specifies the unique type ID of the transaction

/Company_id

Specifies the unique ID of the company.

/Createdby

Specifies the ID of the user who created the transaction.

/Transaction_id

Specifies the unique ID of the transaction that is executed by the template.

/EffectiveDate

Specifies the date on which the Transaction will be executed.

/TemplateName

Specifies the name of the template.

/featureActionId

Specifies the unique ID of the action for a feature.

{
"Status": "Sent",
"TemplateRequestType_id": "1",
"referenceId": "34925",
"DebitAccount": "160128223241511",
"CreatedOn": "2020-09-29T23:12:07Z",
"MaxAmount": "122",
"TotalAmount": "12",
"TemplateType_id": "1",
"softDelete": "0",
"TransactionType_id": "1",
"Company_id": "2",
"Createdby": "11",
"Transaction_id": "339",
"EffectiveDate": "2020-09-30 00:00:00.0",
"TemplateName": "test",
"featureActionId": "ACH_COLLECTION_CREATE",
"opstatus": 0,
"httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12025
    Error Message: TemplateName is missing in the input. please provide valid TemplateName.
  • Error Code: 12021
    Error Message: EffectiveDate is missing in the input. please provide valid EffectiveDate(YYYY-MM-DD).
  • Error Code: 12028
    Error Message: Records is missing in the input. please provide valid Records.
  • Error Code: 12003
    Error Message: No matching records found
  • Error Code: 12000
    Error Message: Internal service error
Service Flow:
Integration Services Backend Services

executeTemplateOperation

  • URL: dbpACHServices/ExecuteTemplate

  • dbxdb.bbtemplate

    • Storage Name: DBX Database

  • dbxdb.fetch_achtemplaterecords_proc

    • Storage Name: DBX Database

  • dbxdb.fetch_achtemplatesubrecords_proc

    • Storage Name: DBX Database

  • dbxdb.achtransaction

    • Storage Name: DBX Database

  • dbxdb.ach_transaction_record_subrecord_create_proc

    • Storage Name: DBX Database
ClosedcreateACHTranscation
 
Description: This API allows the user to create a ACH Transaction. The ACH transaction can be created with or without a template.
Method: POST
URL: /services/data/v1/ACHObjects/operations/ACHTransactions/createACHTransaction
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

TemplateRequestType_id (Mandatory)

Specifies the unique ID of the Template Type.

TemplateRequestTypeValue (Mandatory)

Specifies the name of the Template Type.

TransactionType_id (Mandatory)

Specifies the unique ID of the Transaction Type.

DebitAccountName (Mandatory)

Specifies the name of the account from where the amount gets debited.

TransactionTypeValue (Mandatory)

Specifies the name of the Transaction Type.

TemplateName (Mandatory)

Specifies the name of the template that is being created.

TemplateDescription (Mandatory)

Specifies the description of the template.

{
"MaxAmount": "123",
"TemplateType_id": "1",
"TemplateRequestType_id": "3",
"TemplateRequestTypeValue": "CCD (Cash Concentration and Disbursement)",
"TransactionType_id": "1",
"TransactionTypeValue": "Collection",
"DebitAccount": "160128223241511",
"DebitAccountName": "Rewards Savings....1511",
"Records": "[{\"Record_Name\":\"test\",\"ToAccountNumber\":\"123123\" ,\"ToAccountType\":\"3\",\"ABATRCNumber\":\"123\",\"Detail_id\":\"12\",\"Amount\":\"11\",\"AdditionalInfo\":\"test\"}]",
"EffectiveDate": "2020-09-30",
"TotalAmount": 11
}
Response:

Parameters

/bbtemplate

Specifies an array with a JSON object that is a transaction record.

{
"Transaction_id": "340",
"ReferenceID": "11157",
"Status": "Sent",
"opstatus": 0,
"httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12001
    Error Message: Logged in User is not authorized to perform this action
  • Error Code: 12027
    Error Message: TemplateRequestType_id is missing in the input. please provide valid TemplateRequestType_id.
  • Error Code: 12026
    Error Message: TransactionType_id is missing in the input. please provide valid TransactionType_id.
  • Error Code: 12022
    Error Message: DebitAccount is missing in the input. please provide valid DebitAccount.
  • Error Code: 12028
    Error Message: Records is missing in the input. please provide valid Records.
  • Error Code: 12029
    Error Message: MaxAmount is missing in the input. please provide valid MaxAmount.
  • Error Code: 12021
    Error Message: EffectiveDate is missing in the input. please provide valid EffectiveDate(YYYY-MM-DD).
  • Error Code: 12306
    Error Message: Transaction type not found
  • Error Code: 10139
    Error Message: You are not authorized to use this application. Please contact the bank for more information.
  • Error Code: 12301
    Error Message: Total amount cannot be 0
  • Error Code: 12302
    Error Message: Total amount is greater than the Maximum amount
  • Error Code: 12104
    Error Message: Failed to create ACH Transaction
  • Error Code: 12600
    Error Message: Backend invocation failed to create Transcation
  • Error Code: 12601
    Error Message: transaction creation is failed at backend
  • Error Code: 12501
    Error Message: transaction is denied due to autodenial max limit
  • Error Code: 12502
    Error Message: transaction is denied due to autodenial daily limit
  • Error Code: 12503
    Error Message: transaction is denied due to autodenial weekly limit
  • Error Code: 12504
    Error Message: transaction is denied due to max transaction limit
  • Error Code: 12505
    Error Message: transaction is denied due to daily limit
  • Error Code: 12506
    Error Message: transaction is denied due to weekly limit
  • Error Code: 12507
    Error Message: Transaction cannot be executed. Please update the approval matrix of your organization and re-submit the transaction
  • Error Code: 12512
    Error Message: transaction is denied due to min transaction limit
  • Error Code: 12000
    Error Message: Internal service error
Service Flow:
Integration Services Backend Services
  • createTransactionOperation
    • URL: dbpACHServices/createTransaction

 

  • dbxdb.ach_transaction_record_subrecord_create_proc

    dbxdb.achtransaction

    • Storage Name: DBX Database
ClosedgetACHTransactionDataById
 
Description: This API allows the user to fetch the Request ID of the corresponding Transaction, if an ACH Transaction is in the Approval Queue.
Method: POST
URL: /services/data/v1/ACHObjects/operations/ACHTransactions/getACHTransactionDetailsById
Security Level: Autheticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

Transaction_id (Mandatory)

Specifies the unique ID of the ACH transaction.

{
  "UserImage": ""
}
Response:

Parameters

/ACHTransactions

Specifies an array of JSONObject that contains ACH transaction details as shown in the following sample code.

{
"ACHTransactions": [{
"Status": "Failed",
"TemplateRequestType_id": "2",
"Request_id": "241",
"userName": "Sasreg123SB",
"DebitAccount": "200929090225645",
"CreatedOn": "2020-09-29T20:02:36Z",
"MaxAmount": "1500",
"TotalAmount": "1500",
"TemplateType_id": "1",
"CompanyName": "Sugar Dough Bakers Inc._Sasreg123SB",
"RequestType": "PPD (Prearranged Payment and Deposit)",
"TemplateTypeValue": "ACH",
"softDelete": "0",
"TransactionType_id": "2",
"createdby": "Sasreg123SB",
"Company_id": "200929090225065",
"Createdby": "1384705407",
"TransactionTypeValue": "Payment",
"Transaction_id": "196",
"EffectiveDate": "2019-02-27 00:00:00.0",
"TemplateName": "No Template Used",
"featureActionId": "ACH_PAYMENT_CREATE",
"AccountName": "Progress Business Checking-X5645",
"requiredApprovals": "1",
"receivedApprovals": "1",
"amICreator": "true",
"amIApprover": "false"
}],
"opstatus": 0,
"httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12001
    Error Message: Logged in User is not authorized to perform this action
  • Error Code: 12042
    Error Message: Transaction_id is missing in the input. please provide valid Transaction_id.
  • Error Code: 12000
    Error Message: Internal service error
Service Flow:
Integration Services Backend Services

FetchACHTransactionByIdOperation

  • URL: dbpACHServices/FetchACHTransactionById

dbxdb.fetch_achtemplatesubrecords_proc

  • Storage Name: DBX Database

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?