Outgoing Payments Admin

The Outgoing Payments Requests functionality lets you add, approve, and pay different payment requests, manually or automatically.

  • Entity FTOS_PYMT_Payment with all attributes

  • Entity FTOS_PYMT_OutgoingPayment with all attributes.

FTOS_PYMT_Payment_EditFormOutgoing Journey

General description:

This is a user journey aimed at implementing the Edit Outgoing Payment functionality, in order to manually allocate or deallocate an outgoing payment. This journey is connected to the FTOS_PYMT_Payment entity.

This form is used to manually allocate or deallocate an outgoing payment.

The user clicks Allocate to open the Payment Request Search grid. The user searches for the desired outgoing payments, inside the grid. For the search, the following parameters are available:

Search parameters: Description
referenceNo Reference No.
outgoingPaymentTypeSearchId Outgoing Payment Type
amountMin Payment Amount min
amountMax Payment Amount max
payerNameSearch Payment Beneficiary Name
ibanSearch IBAN
startDueDateFrom Start Due Date From
startDueDateTo Start Due Date To
NOTE  
At least one criteria has to be filled in. If not, a warning message is shown: "Warning! The fields should not be empty!".

In order to show the results, the following functions are used:

This function verifies if an input value is null or empty.

Input parameters: value.

Output parameters: true/ false.

This function gathers all the payment requests found based on the search criteria with the help of the FTOS_INSP_ManualAllocatePaymentRequestSearch automation script. It returns the results in a grid with the help of the generateCustomGrid(viewId, viewDataSource, viewColumns) function. The payment requests included in the results of the search comply with the following conditions:

  • are in Approved status;

  • have the same currency as the payment request;

  • have the same IBAN account.

Input parameters:

  • paymentCurrencyId – The payment currency.

  • paymentIban – The payment IBAN.

Output parameters: N/A.

This function allocates a payment request on an outgoing payment, using the automation script FTOS_PYMT_ManualOutgoingPaymentAllocation.

Input parameters: details – (Object) – The needed data from the generateCustomGrid(viewId, viewDataSource, viewColumns) function, to be used for manually allocating a payment.

Output parameters: N/A.

This function generates the results grid.

Input parameters:

viewId – The name of the CSS Id.

viewDataSource – The data result from the getPaymentRequestSearch(paymentCurrencyId, paymentIban) function.

viewColumns – The type of columns that are displayed in the grid.

Output parameters: N/A.

FTOS_PYMT_OutgoingPaymentFileReadOnly Form Journey

This is a user journey connected to the FTOS_PYMT_OutgoingPaymentFile entity.

The Default View allows the user to see a list of all the outgoing payments instruction files generated by the FTOS_PYMT_OutgoingPaymentInstructionFile scheduled job. From this view, the user can select a record, double-click on it to launch the FTOS_PYMT_OutgoingPaymentFileReadOnly Form, to see the file details. The form allows the user to see the details (file name and date of generation) of the outgoing payments instruction files generated by the FTOS_PYMT_OutgoingPaymentInstructionFile scheduled job. Also, the form allows the user to download the generated file.

On Demand Scripts

FTOS_PYMT_OutgoingPaymentInstructionFile - this script calls the runOutgoingPaymentInstructionFile function from the FTOS_PYMT_OutgoingPaymentFiles server side script library in order to generate the instructions file for outgoing payments.

Input parameters: N/A.

Output parameters: N/A.

Endpoints

The following endpoints are used for matching between outgoing payment requests and outgoing payments:

This endpoint calls the FTOS_INSP_ManualAllocatePaymentRequestSearch script to search the outgoing payment requests to be allocated on an outgoing payment.

This endpoint uses the FTOS_PYMT_OutgoingPaymentAllocation_manual library in the manual process of outgoing payment allocation.

Server Side Script Libraries

From the FTOS_PYMT_OutgoingPaymentAllocation_manual library, the PYMT_OutgoingPayment function is used. Inside this function, the following functions are used:

This function gets the payment amount, the allocated amount and the remaining payment amount for a payment.

Input parameters: paymentId - The unique identifier of the payment.

Output parameters: Returns the results of the fetch.

This function gets the payment amount, paid amount and the unpaid payment amount for an outgoing payment.

Input parameters: outgoingPaymentId - The unique identifier of the outgoing payment.

Output parameters: Returns the results of the fetch.

If the remaining payment amount is greater than 0, this function calls the insertOutgoingPaymentAllocation function, from the FTOS_PYMT_OutgoingPaymentAllocation library.

Input parameters:

  • paymentId - The unique identifier of the payment.

  • outgoingPaymentId - The unique identifier of the outgoing payment.

Output parameters:

Returns an error message (Error in allocation process!) if there is an error in the allocation process.

Returns an error message (Payment amount fully allocated!) if the payment amount was fully allocated.

From the FTOS_PYMT_OutgoingPaymentFiles library, the General function is used. This function wraps up other functions which perform actions on the FTOS_PYMT_OutgoingPaymentFile and FTOS_PYMT_OutgoingPaymentFileDetail entities, generate and validate some data or generate the necessary .txt file.

This function executes the following:

  • verifies that the outgoing payments instructions file can be generated according any defined rules - for example outgoing payments are in Approved status and their Scheduled date equals the current date.

  • generates the details needed for the outgoing payments instruction file.

  • saves the outgoingPaymentId and name in FTOS_PYMT_OutgoingPaymentFileDetail entity.

  • generate the outgoing payments instruction file (in .txt format).

  • saves the file in FTOS_PYMT_OutgoingPaymentFile entity.

  • saves the same file on the server OutgoingPayment folder.

The runOutgoingPaymentInstructionFile function uses all the functions mentioned below.

Input parameters: N/A.

Output parameters: N/A.

This function returns the outgoing payments to be included in the outgoing payments instruction file based on the following conditions: the businessStatus of the outgoing payment is Approved and the paymentScheduledDate is the Current Date.

Input parameters: N/A

Output parameters: resultOutgoingPayments - Returns the fetch.

This function executes the following:

  • processes the results of the getOutgoingPaymentDetails function.

  • insert details (outgoingPaymentId and name) into the FTOS_PYMT_OutgoingPaymentFileDetail entity.

  • populates CSVContentArray with all the details that are necessary for the outgoing payments instruction file.

  • changes the business status from the FTOS_PYMT_OutgoingPayment entity.

Input parameters:

  • result - The fetch result of the getOutgoingPaymentDetails function.

  • CSVContentArray - An empty array.

Output parameters: N/A.

This function executes the following:

  • generates the outgoing payments instruction file (in .txt format) based on the CSVContentArray populated by the processOutgoingPaymentsInstruction function,

  • saves the file into FTOS_PYMT_OutgoingPaymentFile entity,

  • saves the file on the OutgoingPayment folder from the portal.

Input parameters: CSVContentArray - An array with all the records for outgoing payments instructions.

Output parameters: idInstructionFile - The Id of the file inserted in FTOS_PYMT_OutgoingPaymentFile entity.

This function finds all the records from FTOS_PYMT_OutgoingPaymentFileDetail entity that have the outgoingPaymentFileId (the Id of the outgoing payments instruction file) with null values and updates that attribute with the Id of the newly generated outgoing payments instruction file.

Input parameters: instructionFileId - The Id of the newly generated outgoing payments instruction file.

Output parameters: N/A

Scheduled jobs

This job is scheduled to run every day at 5:00 AM to generate the outgoing payments instruction .txt file.

Schedule Services:

FTOS_PYMT_OutgoingPaymentInstructionFile - on demand Server Automation Script, see above.