Bulk Payment

Name Description Introduced In
UploadFile This API allows the user to upload the Bulk Payment File. 2020.10
fetchUploadedFiles This API allows the user to fetch the uploaded files. 2020.10
fetchOnGoingPayments This API allows the user to fetch the ongoing payments. 2020.10
fetchHistory This API allows the user to fetch the history of Bulk Payments. 2020.10
review This API allows the user to review the records. 2020.10
fetchRecordsWaitingForMyApproval This API allows the user to fetch the records that are in waiting for approval. 2020.10
fetchRecordsReviewedByMeAndInApprovalQueue This API allows the user to fetch the records that are reviewed and are in the approval queue. 2020.10
fetchRecordsHistoryActedByMe This API allows the user to fetch the history of Bulk Payments that have been executed out by the user. 2020.10
fetchRecordsHistoryReviewedByMe This API allows the user to fetch the history of Bulk Payments that have been reviewed by the user. 2020.10
approveBulkPaymentRecord This API allows the user to approve the Bulk Payments record. 2020.10
rejectBulkPaymentRecord This API allows the user to reject the Bulk Payments record. 2020.10
cancelBulkPaymentRecord This API allows the user to cancel the Bulk Payments record. 2020.10
updateBulkPaymentRecord This API allows the user to update the Bulk Payments record. 2020.10
addPaymentOrder This API allows the user to add the Payment order. 2020.10
editPaymentOrder This API allows the user to edit the Payment order. 2020.10
deletePaymentOrder This API allows the user to delete the Payment order. 2020.10
fetchSampleFiles This API allows the user to fetch the sample Bulk Payment files. 2020.10
fetchPaymentOrders This API allows the user to fetch the payment orders. 2020.10
ClosedUploadFile
 
Description: This API allows the user to upload the Bulk Payment File.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentFile/UploadFile
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

fileName

Specifies the name of the file that is to be uploaded.

description

Specifies the description of the file.

content

Specifies the content in the file.

{
  "fileName": "", 
  "description": "",
  "content":""
}
Response:

Parameters

confirmationNumber

Specifies the confirmation number that gets generated after uploading the file.

{
  "confirmationNumber": ",
  "opstatus": 0,
  "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 21228
    Error Message: Unauthorized user for bulkpayment upload
  • Error Code: 21219
    Error Message: Invalid filename
  • Error Code: 21204
    Error Message: empty content
  • Error Code: 21206
    Error Message: empty description
  • Error Code: 21200
    Error Message: Error occurred while parsing the file
  • Error Code: 21224
    Error Message: failed to store file at backend
  • Error Code: 12601
    Error Message: Transaction creation failed at backend
  • Error Code: 21204
    Error Message: Empty bulk payment file
Service Flow:
Integration Services Backend Services
uploadBulkPaymentFile

  • uploadBulkPaymentFile

    • Storage Name: dbxdb.bulkpaymentfilesmock
ClosedfetchUploadedFiles
 
Description: This API allows the user to fetch the uploaded files.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentFile/fetchUploadedFiles
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

sortByParam

Specifies the field name based on which the files must be sorted.

sortOrder

Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default, the value is set to ascending.

searchString

Specifies the string value to search a file based on field name.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from where the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

{
  "sortByParam":"",
  "sortOrder": "",
  "searchString":"",
  "pageSize":"",
  "pageOffset":"",
  "filterByParam":"",
  "filterByValue":""
}
Response:

Parameters

fileId

Specifies the unique ID of the Bulk Payment file.

fileName

Specifies the name of the Bulk Payment file.

description

Specifies the description of the Bulk Payment file.

confirmationNumber

Specifies the confirmation number after uploading the file.

uploadedDate

Specifies the date of uploading of the file.

status

Specifies the status of the operation.

fromAccount

Specifies the account from which the files are uploaded.

totalAmount

Specifies the total amount.

uploadedBy

Specifies the name of the user who uploaded the file.

totalTransactions

Specifies the total number of transactions.

companyId

Specifies the unique ID of the company.

requestId

Specifies the request ID.

amIAprover

Specifies whether the user is the approver. The value is Boolean.

amICreator

Specifies whether the user is the creator. The value is Boolean.

recievedApprovals

Specifies the number of requests that are received for approval.

requiredApprovals

Specifies the number of requests that require approvals.

approvers

Specifies the approvers.

[
{
"fileId":"",
"fileName":"",
"description":"",
"confirmationNumber":"",
"uploadedDate":"",
"status":"",
"fromAccount":"",
"totalAmount":"",
"uploadedBy":"",
"totalTransactions":"",
"companyId":"",
"requestId":"",
"amIAprover":"",
"amICreator":"",
"recievedApprovals":"",
"requiredApprovals":"",
"approvers":""
}
]
Error Code(s):
  • Error Code: 12001
    Error Message: Logged in User is not authorized to perform this action
  • Error Code: 21220
    Error Message: Failed to fetch bulk payment uploaded files
Service Flow:
Integration Services Backend Services
fetchUploadedFiles

  • fetchUploadedFiles

    • Storage Name: dbxdb.bulkpaymentfilesmock
ClosedfetchOnGoingPayments
 
Description: This API allows the user to fetch the ongoing payments.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchOnGoingPayments
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

sortByParam

Specifies the field name based on which the files must be sorted.

sortOrder

Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default the value is set to ascending.

searchString

Specifies the string value to search a file based on field name.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from where the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

{
"sortByParam":"",
"sortOrder": "",
"searchString":"",
"pageSize":"",
"pageOffset":"",
"filterByParam":"",
"filterByValue":""
}
Response:

Parameters

/onGoingPayments

Specifies an array of JSON object for the ongoing payments.

/onGoingPayments/recordId

Specifies the unique ID of the record.

/onGoingPayments/description

Specifies the description of the ongoing payment.

/onGoingPayments/paymentDate

Specifies the date for payment.

/onGoingPayments/scheduledDate

Specifies the date on when the scheduled transfer payment must occur.

/onGoingPayments/initiatedBy

Specifies the name of the person who initiated the transactions.

/onGoingPayments/fromAccount

Specifies the account from which the files are uploaded.

/onGoingPayments/totalAmount

Specifies the total amount.

/onGoingPayments/totalTransactions

Specifies the total number of transactions.

/onGoingPayments/companyId

Specifies the unique ID of the company.

{
"onGoingPayments":[
  {
    "recordId":"",
    "description":"",
    "paymentDate":"",
    "scheduledDate":"",
    "status":"",
    "initiatedBy": "",
    "fromAccount":"",
    "totalAmount":"",
    "totalTransactions":"",
    "companyId":"",
  }
]
"opstatus": 0,
"httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12001
    Error Message: Logged in User is not authorized to perform this action
  • Error Code: 21223
    Error Message: Failed to fetch ongoing payments
Service Flow:
Integration Services Backend Services
fetchOnGoingPayments

  • fetchOnGoingPayments

    • Storage Name: dbxdb.bulkpaymentrecordmock
ClosedfetchHistory
 
Description: This API allows the user to fetch the history of Bulk Payments.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchHistory
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

sortByParam

Specifies the field name based on which the files must be sorted.

sortOrder

Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default, the value is set to ascending.

searchString

Specifies the string value to search a file based on field name.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from where the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

{
"sortByParam":"",
"sortOrder": "",
"searchString":"",
"pageSize":"",
"pageOffset":"",
"filterByParam":"",
"filterByValue":""
}
Response:

Parameters

recordId

Specifies the unique ID of the record.

paymentId

Specifies the unique ID of the payment.

description

Specifies the description of the Bulk Payment file.

paymentDate

Specifies the date on which the payment has occurred.

scheduledDate

Specifies the date on when the scheduled transfer payment must occur.

status

Specifies the status of the operation.

fromAccount

Specifies the account from which the files are uploaded.

totalAmount

Specifies the total amount.

initiatedBy

Specifies the name of the user who initiated the transaction.

totalTransactions

Specifies the total number of transactions.

companyId

Specifies the unique ID of the company.

requestId

Specifies the request ID.

amIAprover

Specifies whether the user is the approver. The value is Boolean.

amICreator

Specifies whether the user is the creator. The value is Boolean.

recievedApprovals

Specifies the number of requests that are received for approval.

requiredApprovals

Specifies the number of requests that require approvals.

approvers

Specifies the approvers.

[
{
"recordId":"",
"paymentId":"",
"description":"",
"paymentDate":"",
"scheduledDate":"",
"status":"",
"fromAccount":"",
"totalAmount":"",
"initiatedby":"",
"totalTransactions":"",
"companyId":"",
"requestId":"",
"initiatedBy": "",
"amIAprover":"",
"amICreator":"",
"recievedApprovals":"",
"requiredApprovals":"",
"approvers":""
}
]
Error Code(s):
  • Error Code: 12001
    Error Message: Logged in User is not authorized to perform this action
  • Error Code: 21214
    Error Message: Failed to fetch Bulk Payment Record
  • Error Code: 21220
    Error Message: Failed to fetch bulk payment uploaded files
Service Flow:
Integration Services Backend Services
fetchHistory

  • fetchHistory

    • Storage Name: dbxdb.bulkpaymentrecordmock
Closedreview
 
Description: This API allows the user to review the records.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/review
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

recordId

Specifies the unique ID of the record.

{
"recordId":""
}
Response:

Parameters

confirmationNumber

Specifies the confirmation number.

status

Specifies the status of the review process.

{
"confirmationNumber":"",
"status":"",
"opstatus": 0,
"httpStatusCode": 0
}
Error Code(s):
  • Error Code: 10227
    Error Message: features are empty
  • Error Code: 21222/12001
    Error Message: Unauthorized user
  • Error Code: 21232
    Error Message: Invalid total amount
  • Error Code: 21213
    Error Message: failed to create bulk payment record
  • Error Code: 12600
    Error Message: Failed to invoke create Transaction
  • Error Code: 12601
    Error Message: Transaction creation 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: 21230
    Error Message: failed to fetch bulkpayment file from backend
  • Error Code: 21200
    Error Message: bulkpayment file parse error
Service Flow:
Integration Services Backend Services
reviewBulkPaymentRecord

  • Review

    • Storage Name: dbxdb.bulkpaymentrecordmock
ClosedfetchRecordsWaitingForMyApproval
 
Description: This API allows the user to fetch the records that are in waiting for approval.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchRecordsWaitingForMyApproval
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

sortByParam

Specifies the field name based on which the files must be sorted.

sortOrder

Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default, the value is set to ascending.

searchString

Specifies the string value to search a file based on field name.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from where the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

{
"sortByParam":"",
"sortOrder": "",
"searchString":"",
"pageSize":"",
"pageOffset":"",
"filterByParam":"",
"filterByValue":""
}
Response:

Parameters

/records

Specifies an array of JSON object of records and the corresponding details.

/records/recordId

Specifies the unique ID of the record.

/records/paymentId

Specifies the unique ID of the payment.

/records/description

Specifies the description of the Bulk Payment file.

/records/paymentDate

Specifies the date on which the payment has occurred.

/records/scheduledDate

Specifies the date on when the scheduled transfer payment must occur.

/records/status

Specifies the status of the operation.

/records/fromAccount

Specifies the account from which the files are uploaded.

/records/totalAmount

Specifies the total amount.

/records/totalTransactions

Specifies the total number of transactions.

/records/companyId

Specifies the unique ID of the company.

/records/requestId

Specifies the request ID.

/records/actedByMeAlready

Specifies whether the approval has been provided already.

/records/amIAprover

Specifies whether the user is the approver. The value is Boolean.

/records/amICreator

Specifies whether the user is the creator. The value is Boolean.

/records/recievedApprovals

Specifies the number of requests that are received for approval.

/records/requiredApprovals

Specifies the number of requests that require approvals.

{
"records" : [
 { 
  "recordId":"",
  "paymentId":"",
  "description":"",
  "paymentDate":"",
  "scheduledDate":"",
  "status":"",
  "fromAccount":"",
  "totalAmount":"",
  "totalTransactions":"",
  "companyId":"",
  "requestId":"",
  "actedByMeAlready": "",
  "amIApprover":"",
  "amICreator":"",
  "receivedApprovals":"",
  "requiredApprovals":"",
  }
  ],
  "opstatus": 0,
  "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 10227
    Error Message: features are empty
  • Error Code: 21220
    Error Message: failed to fetch bulkpayment file
  • Error Code: 21246
    Error Message: failed to fetch bulkpayment record
  • Error Code: 21230
    Error Message: failed to fetch bulkpayment file from backend
  • Error Code: 21200
  • Error Message: bulkpayment file parse error
Service Flow:
Integration Services Backend Services
fetchRequestHistory

  • fetchRecordsWaitingForMyApproval

    • Storage Name: dbxdb.bulkpaymentrecordmock
ClosedfetchRecordsReviewedByMeAndInApprovalQueue
 
Description: This API allows the user to fetch the records that are reviewed and are in the approval queue.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchRecordsReviewedByMeAndInApprovalQueue
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

sortByParam

Specifies the field name based on which the files must be sorted.

sortOrder

Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default, the value is set to ascending.

searchString

Specifies the string value to search a file based on field name.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from where the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

{
"sortByParam":"",
"sortOrder": "",
"searchString":"",
"pageSize":"",
"pageOffset":"",
"filterByParam":"",
"filterByValue":""
}
Response:

Parameters

/records

Specifies an array of JSON object of records and the corresponding details.

/records/recordId

Specifies the unique ID of the record.

/records/paymentId

Specifies the unique ID of the payment.

/records/description

Specifies the description of the Bulk Payment file.

/records/paymentDate

Specifies the date on which the payment has occurred.

/records/scheduledDate

Specifies the date on when the scheduled transfer payment must occur.

/records/status

Specifies the status of the operation.

/records/fromAccount

Specifies the account from which the files are uploaded.

/records/totalAmount

Specifies the total amount.

/records/totalTransactions

Specifies the total number of transactions.

/records/companyId

Specifies the unique ID of the company.

/records/requestId

Specifies the request ID.

/records/actedByMeAlready

Specifies whether the approval has been provided already.

/records/amIAprover

Specifies whether the user is the approver. The value is Boolean.

/records/amICreator

Specifies whether the user is the creator. The value is Boolean.

/records/recievedApprovals

Specifies the number of requests that are received for approval.

/records/requiredApprovals

Specifies the number of requests that require approvals.

{
"records" : [
 { 
  "recordId":"",
  "paymentId":"",
  "description":"",
  "paymentDate":"",
  "scheduledDate":"",
  "status":"",
  "fromAccount":"",
  "totalAmount":"",
  "totalTransactions":"",
  "companyId":"",
  "requestId":"",
  "actedByMeAlready": "",
  "amIApprover":"",
  "amICreator":"",
  "receivedApprovals":"",
  "requiredApprovals":"",
  }
  ],
  "opstatus": 0,
  "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 10227
    Error Message: features are empty
  • Error Code: 21220
    Error Message: failed to fetch bulkpayment file
  • Error Code: 21246
    Error Message: failed to fetch bulkpayment record
  • Error Code: 21230
    Error Message: failed to fetch bulkpayment file from backend
  • Error Code: 21200
  • Error Message: bulkpayment file parse error
Service Flow:
Integration Services Backend Services
fetchRequestHistory

  • fetchRecordsReviewedByMeAndInApprovalQueue

    • Storage Name: dbxdb.bulkpaymentrecordmock
ClosedfetchRecordsHistoryActedByMe
 
Description: This API allows the user to fetch the history of Bulk Payments that have been executed out by the user. All the records that have been approved or rejected will be fetched.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchRecordsHistoryActedByMe
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

sortByParam

Specifies the field name based on which the files must be sorted.

sortOrder

Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default, the value is set to ascending.

searchString

Specifies the string value to search a file based on field name.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from where the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

{
"sortByParam":"",
"sortOrder": "",
"searchString":"",
"pageSize":"",
"pageOffset":"",
"filterByParam":"",
"filterByValue":""
}
Response:

Parameters

/records

Specifies an array of JSON object of records and the corresponding details.

/records/recordId

Specifies the unique ID of the record.

/records/paymentId

Specifies the unique ID of the payment.

/records/description

Specifies the description of the Bulk Payment file.

/records/paymentDate

Specifies the date on which the payment has occurred.

/records/scheduledDate

Specifies the date on when the scheduled transfer payment must occur.

/records/status

Specifies the status of the operation.

/records/fromAccount

Specifies the account from which the files are uploaded.

/records/totalAmount

Specifies the total amount.

/records/totalTransactions

Specifies the total number of transactions.

/records/companyId

Specifies the unique ID of the company.

/records/requestId

Specifies the request ID.

/records/actedByMeAlready

Specifies whether the approval has been provided already.

/records/amIAprover

Specifies whether the user is the approver. The value is Boolean.

/records/amICreator

Specifies whether the user is the creator. The value is Boolean.

/records/recievedApprovals

Specifies the number of requests that are received for approval.

/records/requiredApprovals

Specifies the number of requests that require approvals.

{
"records" : [
 { 
  "recordId":"",
  "paymentId":"",
  "description":"",
  "paymentDate":"",
  "scheduledDate":"",
  "status":"",
  "fromAccount":"",
  "totalAmount":"",
  "totalTransactions":"",
  "companyId":"",
  "requestId":"",
  "actedByMeAlready": "",
  "amIApprover":"",
  "amICreator":"",
  "receivedApprovals":"",
  "requiredApprovals":"",
  }
  ],
  "opstatus": 0,
  "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 10227
    Error Message: features are empty
  • Error Code: 21220
    Error Message: failed to fetch bulkpayment file
  • Error Code: 21246
    Error Message: failed to fetch bulkpayment record
  • Error Code: 21230
    Error Message: failed to fetch bulkpayment file from backend
  • Error Code: 21200
  • Error Message: bulkpayment file parse error
Service Flow:
Integration Services Backend Services
fetchRequestHistory

  • FetchRecordsHistoryActedByMe

    • Storage Name: dbxdb.bulkpaymentrecordmock
ClosedfetchRecordsHistoryReviewedByMe
 
Description: This API allows the user to fetch the history of Bulk Payments that have been reviewed by the user.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchRecordsHistoryReviewedByMe
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

sortByParam

Specifies the field name based on which the files must be sorted.

sortOrder

Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default, the value is set to ascending.

searchString

Specifies the string value to search a file based on field name.

pageSize

Specifies the number of rows that must be returned in the result.

pageOffset

Specifies the row from where the data must be retrieved. The offset value is often used together with the limit.

filterByParam

Specifies the parameter based on which the fetched files must be filtered.

filterByValue

Specifies the value based on which the fetched files must be filtered.

{
"sortByParam":"",
"sortOrder": "",
"searchString":"",
"pageSize":"",
"pageOffset":"",
"filterByParam":"",
"filterByValue":""
}
Response:

Parameters

/records

Specifies an array of JSON object of records and the corresponding details.

/records/recordId

Specifies the unique ID of the record.

/records/paymentId

Specifies the unique ID of the payment.

/records/description

Specifies the description of the Bulk Payment file.

/records/paymentDate

Specifies the date on which the payment has occurred.

/records/scheduledDate

Specifies the date on when the scheduled transfer payment must occur.

/records/status

Specifies the status of the operation.

/records/fromAccount

Specifies the account from which the files are uploaded.

/records/totalAmount

Specifies the total amount.

/records/totalTransactions

Specifies the total number of transactions.

/records/companyId

Specifies the unique ID of the company.

/records/requestId

Specifies the request ID.

/records/actedByMeAlready

Specifies whether the approval has been provided already.

/records/amIAprover

Specifies whether the user is the approver. The value is Boolean.

/records/amICreator

Specifies whether the user is the creator. The value is Boolean.

/records/recievedApprovals

Specifies the number of requests that are received for approval.

/records/requiredApprovals

Specifies the number of requests that require approvals.

{
"records" : [
 { 
  "recordId":"",
  "paymentId":"",
  "description":"",
  "paymentDate":"",
  "scheduledDate":"",
  "status":"",
  "fromAccount":"",
  "totalAmount":"",
  "totalTransactions":"",
  "companyId":"",
  "requestId":"",
  "actedByMeAlready": "",
  "amIApprover":"",
  "amICreator":"",
  "receivedApprovals":"",
  "requiredApprovals":"",
  }
  ],
  "opstatus": 0,
  "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 10227
    Error Message: features are empty
  • Error Code: 21220
    Error Message: failed to fetch bulkpayment file
  • Error Code: 21246
    Error Message: failed to fetch bulkpayment record
  • Error Code: 21230
    Error Message: failed to fetch bulkpayment file from backend
  • Error Code: 21200
  • Error Message: bulkpayment file parse error
Service Flow:
Integration Services Backend Services
fetchRequestHistory

  • fetchRecordHistoryReviewedByMe

    • Storage Name: dbxdb.bulkpaymentrecordmock
ClosedapproveBulkPaymentRecord
 
Description: This API allows the user to approve the Bulk Payments record.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/approveBulkPaymentRecord
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

requestId

Specifies the unique ID of the request.

comments

Specifies the additional comments

{
  "requestId":"",
  "comments":""
}
Response:

Parameters

recordId

Specifies the unique ID of the record.

status

Specifies the status of the operation.

success

Specifies the success message.

actedBy

Specifies the name of the user who acted.

featureActionId

Specifies the unique ID of the feature.

{
"recordId":"",
"status":"",
"success":"",
"actedBy":"",
"featureActionId":""
}
Error Code(s):
  • Error Code: 21010
    Error Message: User has already approved the request
  • Error Code: 12000
    Error Message: Internal service error
Service Flow:
Integration Services Backend Services
approveBulkPaymentRecord

  • approveBulkPaymentOrder

    • Storage Name: dbxdb.bulkpaymentrecordmock
  • <Backend Service 2>
    • Storage Name: <>
ClosedrejectBulkPaymentRecord
 
Description: This API allows the user to reject the Bulk Payments record.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/rejectBulkPaymentRecord
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

requestId

Specifies the unique ID of the request.

comments

Specifies the additional comments

{
  "requestId":"",
  "comments":""
}
Response:

Parameters

recordId

Specifies the unique ID of the record.

status

Specifies the status of the operation.

actedBy

Specifies the name of the user who performed the action.

featureActionId

Specifies the unique ID of the feature.

{
"recordId":"",
"status":"",
"actedBy":"",
"featureActionId":""
}
Error Code(s):
  • Error Code: 12001
    Error Message: Logged in User is not authorized to perform this action
  • Error Code: 12000
    Error Message: Internal service error
  • Error Code: 21012
    Error Message: Cannot Reject the Transaction as it is not in Pending state
Service Flow:
Integration Services Backend Services
rejectBulkPaymentRecord

  • rejectBulkPaymentRecord

    • Storage Name: dbxdb.bulkpaymentrecordmock
ClosedcancelBulkPaymentRecord
 
Description: This API allows the user to cancel the Bulk Payments record.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/cancelBulkPaymentRecord
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

requestId

Specifies the unique ID of the request.

comments

Specifies the additional comments

{
  "requestId":"",
  "comments":""
}
Response:

Parameters

status

Specifies the status of the operation.

actedBy

Specifies the name of the user who acted.

featureActionId

Specifies the unique ID of the feature.

{
"status":"",
"actedBy":"",
"featureActionId":""
}
Error Code(s):
  • Error Code: 21227
    Error Message: Invalid payload
  • Error Code: 21230
    Error Message: Failed to fetch bulkpayment record
  • Error Code: 21236
    Error Message: Unauthorised user
  • Error Code: 21200
    Error Message: bulkpayment file parse error
  • Error Code: 21235
    Error Message: Error occurred while cancelling bulk payment record
Service Flow:
Integration Services Backend Services
cancelBulkPaymentRecord

  • cancelBulkPaymentRecord

    • Storage Name: dbxdb.bulkpaymentrecordmock
ClosedupdateBulkPaymentRecord
 
Description: This API allows the user to update the Bulk Payments record.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/updateBulkPaymentRecord
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

recordId

Specifies the unique ID of the record.

description

Specifies the description of the record.

fromAccount

Specifies the account from which the bulk payment transfer must occur.

{
  "recordId":"",
  "description":"",
  "fromAccount":""
}
Response:

Parameters

confirmationNumber

Specifies the confirmation number that gets generated.

{
  "confirmationNumber":"",
  "opstatus": 0,
  "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 21227
    Error Message: Invalid payload
  • Error Code: 21242
    Error Message: FromAccount is missing
  • Error Code: 21236
    Error Message: Unauthorised user
  • Error Code: 21216
    Error Message: Failed to edit BulkPaymentRecord
  • Error Code: 21237
    Error Message: Failed to update BulkPayment record
Service Flow:
Integration Services Backend Services
updateBulkPaymentRecord

  • updateBulkPaymentRecord

    • Storage Name: dbxdb.bulkpaymentrecordmock
ClosedaddPaymentOrder
 
Description: This API allows the user to add the Payment order.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/PaymentOrder/addPaymentOrder
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

recordId

Specifies the unique ID of the record.

recipientName

Specifies the name of the recipient.

accountNumber

Specifies the account number of the user.

bankName

Specifies the name of the bank.

swift

Specifies the swift code for international transactions.

currency

Specifies the currency code.

amount

Specifies the amount value for the Payment Order.

feesPaidBy

Specifies the fees paid by the user.

paymentReference

Specifies the reference number for the Payment Order Container.

{
"recordId":"",
"recipientName":"",
"accountNumber":"",
"bankName":"",
"swift":"",
"currency":"",
"amount":"",
"feesPaidBy":"",
"paymentReference":""
}
Response:

Parameters

paymentOrderId

Specifies the unique ID of the Payment Order Container.

{
"paymentOrderId": "",
"opstatus": ,
"httpStatusCode": 
}
Error Code(s):
  • Error Code: 12001
    Error Message: Logged in User is not authorized to perform this action
  • Error Code: 21227
    Error Message: Invalid Payload. Please provide valid details.
  • Error Code: 21233
    Error Message: Invalid Recipient Name. Please provide valid details.
  • Error Code: 12002
    Error Message: Invalid account number. please provide valid details.
  • Error Code: 21239
    Error Message: Invalid Currency. Please provide valid details.
  • Error Code: 21234
    Error Message: Invalid Amount. Please provide valid details.
  • Error Code: 21209
    Error Message: Failed to create payment order
Service Flow:
Integration Services Backend Services
addPaymentOrder

  • addPaymentOrder

    • Storage Name: dbxdb.bulkpaymentsubrecordmock
ClosededitPaymentOrder
 
Description: This API allows the user to edit the Payment order.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/PaymentOrder/editPaymentOrder
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

recordId

Specifies the unique ID of the record.

paymentOrderId

Specifies the unique ID of the Payment Order Container.

currency

Specifies the currency code.

amount

Specifies the amount value for the Payment Order.

feesPaidBy

Specifies the fees paid by the user.

paymentReference

Specifies the reference number for the Payment Order Container.

{
"recordId":"",
"paymentOrderId":"",
"currency":"",
"amount":"",
"feesPaidBy":"",
"paymentReference":""
}
Response:

Parameters

paymentOrderId

Specifies the unique ID of the Payment Order Container.

{
"paymentOrderId": "",
"opstatus": ,
"httpStatusCode": 
}
Error Code(s):
  • Error Code: 12001
    Error Message: Logged in User is not authorized to perform this action
  • Error Code: 21227
    Error Message: Invalid Payload. Please provide valid details.
  • Error Code: 21238
    Error Message: Invalid PaymentOrderId . Please provide valid details.
  • Error Code: 21239
    Error Message: Invalid Currency. Please provide valid details.
  • Error Code: 21234
    Error Message: Invalid Amount. Please provide valid details.
  • Error Code: 21212
    Error Message: Failed to edit payment order
Service Flow:
Integration Services Backend Services
editPaymentOrder

  • editPaymentOrder

    • Storage Name: dbxdb.bulkpaymentsubrecordmock
CloseddeletePaymentOrder
 
Description: This API allows the user to delete the Payment order.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/PaymentOrder/deletePaymentOrder
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

recordId

Specifies the unique ID of the record.

paymentOrderId

Specifies the unique ID of the Payment Order Container.

{
  "recordId":"",
  "paymentOrderId":""
}
Response:

Parameters

paymentOrderId

Specifies the unique ID of the Payment Order Container.

{
"paymentOrderId": "",
"opstatus": ,
"httpStatusCode": 
}
Error Code(s):
  • Error Code: 12001
    Error Message: Logged in User is not authorized to perform this action
  • Error Code: 21227
    Error Message: Invalid Payload. Please provide valid details.
  • Error Code: 21238
    Error Message: Invalid PaymentOrderId . Please provide valid details.
  • Error Code: 21211
    Error Message: Failed to delete the payment order
Service Flow:
Integration Services Backend Services
deletePaymentOrder

  • deletePaymentOrder

    • Storage Name: dbxdb.bulkpaymentsubrecordmock
ClosedfetchSampleFiles
 
Description: This API allows the user to fetch the sample Bulk Payment files.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/BulkPaymentFile/fetchSampleFiles
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

None
Response:

Parameters

fileName

Specifies the name of the sample file.

description

Specifies the description of the sample file.

fileId

Specifies the unique ID of the sample file.

content

Specifies the content in the sample file.

[
{
"fileName":"",
"description":"",
"fileId":"",
"content":""
}
]
Error Code(s):
  • Error Code: 12001
    Error Message: Logged in User is not authorized to perform this action
  • Error Code: 21218
    Error Message: Failed to filter response
Service Flow:
Integration Services Backend Services
fetchSampleFiles

  • getSampleFiles

    • Storage Name: dbxdb. bulkpaymentsamplefiles
ClosedfetchPaymentOrders
 
Description: This API allows the user to fetch the payment orders.
Method: POST
URL: services/data/v1/BulkPaymentObjects/operations/PaymentOrder/fetchPaymentOrders
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

recordId

Specifies the unique ID of the record.

{
  "recordId":"",
}
Response:

Parameters

paymentOrderId

Specifies the unique ID of the Payment Order Container.

recordId

Specifies the unique ID of the record.

recipientName

Specifies the name of the recipient.

accountNumber

Specifies the account number of the user.

bankName

Specifies the name of the bank.

swift

Specifies the swift code for international transactions.

currency

Specifies the currency code.

amount

Specifies the amount value for the Payment Order.

feesPaidBy

Specifies the fees paid by the user.

paymentReference

Specifies the reference number for the Payment Order Container.

{[
  {
    "paymentOrderId":"",
    "recordId":"",
    "recipientName":"",
    "accountNumber":"",
    "bankName":"",
    "switft":"",
    "currency":"",
    "amount":"",
    "feesPaidBy":"",
    "paymentReference":""
}],
"opstatus": ,
"httpStatusCode": 
 }
Error Code(s):
  • Error Code: 12001
    Error Message: Logged in User is not authorized to perform this action
  • Error Code: 21227
    Error Message: Invalid Payload. Please provide valid details.
  • Error Code: 21210
    Error Message: Failed to fetch payment orders
Service Flow:
Integration Services Backend Services
fetchPaymentOrders

  • fetchPaymentOrders

    • Storage Name: dbxdb.bulkpaymentsubrecordmock

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?