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 an 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 will verify 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 will allocate 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.

Server Side Scripts

This script fetches the results for the payment requests search made on the FTOS_PYMT_Payment_EditFormOutgoing form, when clicking Search.

This script contains the following functions:

This function creates the fetch for the payment request results from the FTOS_PYMT_OutgoingPayment entity, joined BWStatus and the FTOS_CMB_Currency entity. Also, the results are in Approved status.

Input parameters: N/A.

Output parameters: Returns the fetch.

This function adds search conditions (referenceNo, outgoingPaymentTypeSearchId, amountMin, amountMax, payerNameSearch, ibanSearch, startDueDateFrom, startDueDateTo, paymentCurrencyId, paymentIban) to the fetch created by the getPaymentRequestSearch() function.

Input parameters: searchObj – This object contains the search values selected by the user.

Output parameters: Returns the fetch with the newly added conditions.

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.