Temenos Digital
R24 AMR | Min(s) read
Bulk Payment MicroApp API Connectors
The following are the modules and sub-modules of the Bulk Payment MA:
Bulk Payment - Manage Bulk Payment - Payment Status tab
| Module | Sub-Module | Feature | Description | Visualizer Micro app | Experience API | Microservice | MS API | Transact API |
|---|---|---|---|---|---|---|---|---|
| Bulk Payment | Manage Bulk Payment - Payment Status tab | View the details of the submitted Bulk Request | This feature displays the details submitted for the bulk request under the "Payment Status" tab. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchBulkPaymentRecordDetailsById | NA | NA |
{Base_URL}/api/v2.0.0/order/bulkPayments/{bulkTransferId} |
| Bulk Payment | Manage Bulk Payment - Payment Status tab | View the details in rejected request | This features displays the details of bulk requests that are rejected by approver under the "Payment Status" tab. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchBulkPaymentRecordDetailsById | NA | NA | {Base_URL}/api/v2.0.0/order/bulkPayments/{bulkTransferId} |
| Bulk Payment | Manage Bulk Payment - Payment Status tab | View the details on the cancelled bulk status | This feature displays the details of the bulk requests that are marked as "Cancelled" under the "Payment Status" tab. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchBulkPaymentRecordDetailsById | NA | NA | {Base_URL}/api/v2.0.0/order/bulkPayments/{bulkTransferId} |
| Bulk Payment | Manage Bulk Payment - Payment Status tab | Click Review Payment for a Bulk Payment in Ready for Review status | It indicates the request has been created in the processing application and it is ready to be reviewed and submitted for approval or execution. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/PaymentOrder/fetchPaymentOrders | NA | NA | {Base_URL}/api/v2.1.0/order/paymentOrders |
| Bulk Payment | Manage Bulk Payment - Payment Status tab | Click View Payment on a Bulk Payment in Pending for Approval status | It indicates the request has been submitted for approval and it is pending for authorization. The uploaded user can only view the request. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/PaymentOrder/fetchPaymentOrders | NA | NA | {Base_URL}/api/v2.1.0/order/paymentOrders |
| Bulk Payment | Manage Bulk Payment - Payment Status tab | Click Review Payment on a Bulk Payment in Rejected by Approver status | The user can review the rejected bulk payment request and re-submit for authorization. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/PaymentOrder/fetchPaymentOrders | NA | NA | {Base_URL}/api/v2.1.0/order/paymentOrders |
| Bulk Payment | Manage Bulk Payment - Payment Status tab | Click View Payment on a Bulk Payment in Processing Payments status | This feature displays the "Payment Summary" and "Payment Details" for review. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/PaymentOrder/fetchPaymentOrders | NA | NA | {Base_URL}/api/v2.1.0/order/paymentOrders |
| Bulk Payment | Manage Bulk Payment - Payment Status tab | Click View Payment on a Bulk Payment in Cancelled status | Use this feature to view the updated payment status as "Canceled" along with the cancellation reason. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/PaymentOrder/fetchPaymentOrders | NA | NA | {Base_URL}/api/v2.1.0/order/paymentOrders |
| Bulk Payment | Manage Bulk Payment - Payment Status tab | Click View Payment on a Bulk Payment in Scheduled status | The scheduled status feature specifies that the request has been submitted for a future date and the user can cancel the request if required. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/PaymentOrder/fetchPaymentOrders | NA | NA | {Base_URL}/api/v2.1.0/order/paymentOrders |
Bulk Payment - Upload Bulk File
| Module | Sub-Module | Feature | Description | Visualizer Micro app | Experience API | Microservice | MS API | Transact API |
|---|---|---|---|---|---|---|---|---|
| Bulk Payment | Upload Bulk File | Upload Bulk Payment File | To initiate a bulk payments transaction by uploading an XML or a CSV file that has the details of payments in 2 processing modes i.e., Single and Multiple. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentFile/UploadFile | NA | NA |
{Base_URL}/api/v2.0.0/order/bulkPayments/uploads/files |
Bulk Payment - Manage Bulk Payment Uploads
| Module | Sub-Module | Feature | Description | Visualizer Micro app | Experience API | Microservice | MS API | Transact API |
|---|---|---|---|---|---|---|---|---|
| Bulk Payment | Manage Bulk Payment Uploads | View list of uploaded files | Use the feature to view the list of uploaded files (to create requests) and track the status of the uploaded files. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentFile/fetchUploadedFiles | NA | NA |
{Base_URL}/api/v2.0.0/order/bulkPayments/uploads/files |
Bulk Payment - Manage Bulk Payments
| Module | Sub-Module | Feature | Description | Visualizer Micro app | Experience API | Microservice | MS API | Transact API |
|---|---|---|---|---|---|---|---|---|
| Bulk Payment | Manage Bulk Payments | View list of Bulk Payment Requests being processed | Indicates the request has been created in the processing application and it is ready to be reviewed and submitted for approval or execution. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchOnGoingPayments | NA | NA | {Base_URL}/api/v2.0.0/order/bulkPayments/status |
| Bulk Payment | Manage Bulk Payments | View details of a Bulk Payment request | The request has been submitted for approval and it is pending for authorization. The uploaded user can only view the request. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/PaymentOrder/fetchPaymentOrders | NA | NA | {Base_URL}/api/v2.1.0/order/paymentOrders |
| Bulk Payment | Manage Bulk Payments | Cancel Bulk Payment - List Cancellation Reasons | On cancellation, the confirmation pop-up that appears, select a reason from the Cancellation Reason list. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchCancellationReasons | NA | NA | {Base_URL}/api/v1.0.0/reference/lookups |
| Bulk Payment | Manage Bulk Payments | Cancel Bulk Payment | Click this to cancel the bulk payment to cancel the request. On cancellation, the user can only view the request. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/cancelBulkPaymentRecord | NA | NA | {Base_URL}/api/v2.0.0/order/bulkPayments/{bulkTransferId} |
| Bulk Payment | Manage Bulk Payments | Add new payment record to the bulk payment | This feature enables the user to add a new payment order to the bulk payment request. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/PaymentOrder/addPaymentOrder | NA | NA | {Base_URL}/api/v2.1.0/order/paymentOrders |
| Bulk Payment | Manage Bulk Payments | Edit a payment record in the bulk payment | The user can edit the payment details by expanding the "Existing beneficiary". | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/PaymentOrder/editPaymentOrder | NA | NA | {Base_URL}/api/v2.1.0/order/paymentOrders/{paymentOrderId} |
| Bulk Payment | Manage Bulk Payments | Remove a payment record from the bulk payment | This is to remove existing beneficiaries. Click Remove to delete the beneficiaries as required. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/PaymentOrder/deletePaymentOrder | NA | NA | {Base_URL}/api/v2.1.0/order/paymentOrders/{paymentOrderId} |
| Bulk Payment | Manage Bulk Payments | View bulk payment details after adding/ editing/ removing payment | This features faciliates the user to view the edited payment details from Upload Status tab. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchBulkPaymentRecordDetailsById | NA | NA | {Base_URL}/api/v2.0.0/order/bulkPayments/{bulkTransferId} |
| Bulk Payment | Manage Bulk Payments | View list of completed Bulk Payment Requests | On clicking View Details after the extraction is successful and the bulk file in Completed status, the application redirects to Payment History tab with the expanded view of Bulk File Reference ID. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchHistory | NA | NA | {Base_URL}/api/v2.0.0/order/bulkPayments/status |
| Bulk Payment | Manage Bulk Payments | View updated Bulk Payment details after adding new payment | Add New Payment feature allows the user to add the new payment details in the payment review screen. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchBulkPaymentRecordDetailsById | NA | NA | {Base_URL}/api/v2.0.0/order/bulkPayments/{bulkTransferId} |
Bulk Payment - Submit Bulk Payments
| Module | Sub-Module | Feature | Description | Visualizer Micro app | Experience API | Microservice | MS API | Transact API |
|---|---|---|---|---|---|---|---|---|
| Bulk Payment | Submit Bulk Payment | Submit the uploaded file for payment processing | This feature is to submit the bulk payment request by uploading the file. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/review | NA | NA | {Base_URL}/api/v2.0.0/order/bulkPayments/{bulkTransferId} |
| Bulk Payment | Submit Bulk Payment | Download Ack file | Use this feature to download the bulk payment acknowledgment PDF file. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentFile/initiateDownloadBulkPaymentAck | NA | NA | {Base_URL}/api/v2.1.0/order/paymentOrders, {Base_URL}/api/v2.0.0/order/bulkPayments/{bulkTransferId} |
Bulk Payment - Manage Bulk Payment - Upload Status tab
| Module | Sub-Module | Feature | Description | Visualizer Micro app | Experience API | Microservice | MS API | Transact API |
|---|---|---|---|---|---|---|---|---|
| Bulk Payment | Manage Bulk Payment - Upload Status tab | Click View Details on a Bulk Payment | On clicking View Details after the extraction is successful, the application redirects to the Payment Status tab with the expanded view of the Bulk File Reference ID. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchOnGoingPayments | NA | NA | {Base_URL}/api/v2.0.0/order/bulkPayments/status |
Bulk Payment - Manage Bulk Payment - Payment History tab
| Module | Sub-Module | Feature | Description | Visualizer Micro app | Experience API | Microservice | MS API | Transact API |
|---|---|---|---|---|---|---|---|---|
| Bulk Payment | Manage Bulk Payment - Payment History tab | View Payments in a bulk payment record | Use this feature to view bulk payment record under "Payment History" tab. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/PaymentOrder/fetchPaymentOrders | NA | NA | {Base_URL}/api/v2.1.0/order/paymentOrders |
Bulk Payment - Approval Dashboard
| Module | Sub-Module | Feature | Description | Visualizer Micro app | Experience API | Microservice | MS API | Transact API |
|---|---|---|---|---|---|---|---|---|
| Bulk Payment | Approval Dashboard | Approve bulk Payment request | The approvers can approve and initiate the payment request. Once the request is approved, the request goes for processing and until all payments are processed, the request is listed on the Payment Status tab. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/approveBulkPaymentRecord | NA | NA | {Base_URL}/api/v2.0.0/order/bulkMasterApprovals/{bulkTransferId} |
| Bulk Payment | Approval Dashboard | Rejection of bulk Payment request by approver - Choose a reject reason | Approver chooses the reason for rejecting the bulk payment which has been submitted by the user from a drop down. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/fetchCancellationReasons | NA | NA | {Base_URL}/api/v1.0.0/reference/lookups |
| Bulk Payment | Approval Dashboard | Rejection of bulk Payment request by approver | Approver rejects the bulk payment which has been submitted by the user. | Bulk Payment | services/data/v1/BulkPaymentObjects/operations/BulkPaymentRecord/rejectBulkPaymentRecord | NA | NA | {Base_URL}/api/v2.0.0/order/bulkMasterApprovals/{bulkTransferId} |
In this topic