Outgoing Payments Allocation
For Outgoing Payments Deallocation scroll down or click the link.
Server Automation Scripts
FTOS_PYMT_OutgoingPaymentAllocation - Server Automation Script
Here are the functions used:
Example of calling the function:automaticOutgoingPaymentAllocation(paymentId)
.
Based on the payment
and outgoing payment
, this function gets and prepares all the necessary data for inserting and updating the outgoing payment and the payment.
Input parameters: paymentId
- The Id of the payment.
Output parameters:
Example of calling the function: getPayment(paymentId)
.
This function gets and returns the payment details based on the Id of the payment.
Input parameters: paymentId
- The Id of the payment.
Output parameters: payment[0]
- The query result containing details of the payment requested through the input parameter.
Example of calling the function: findOutgoingPayments(payment, processor)
This function is meant to return all outgoing payments.
Input parameters: payment
and processor
.
Output parameters: outgoingPaymentList
- The list of outgoing payments that comply with the references contained in the processor.
Example of calling the function: getOutgoingPaymentReferenceValues(payment, processor)
This function returns an object containing all the references to be applied.
Input parameters: payment
and processor
.
Output parameters: result
.
Example of calling the function: getOutgoingPaymentsByConditions('paymentReferenceRule', referenceValues, processor)
.
Based on the payment type, reference rules and processor, this function returns a list of outgoing payments that are compliant with the references contained into the processor input parameter.
Input parameters:
-
type
- string, rule name -
whereValuesObj
- reference rules -
processor
Output parameters: outgoingPaymentList - The list of outgoing payments that comply with the references contained in the processor.
Example of calling the function: getOutgoingPaymentsByConditions('paymentReferenceRule', referenceValues, processor)
This function makes all the necessary updates for FTOS_PYMT_OutgoingPayment and FTOS_PYMT_Payment entities. It also inserts a record into FTOS_PYMT_OutgoingPaymentRequestXPayment entity - the relationship table between FTOS_PYMT_OutgoingPayment and FTOS_PYMT_Payment entities, and returns the Id of the inserted record.
Input parameters:
-
payment
-
outgoingPayment
Output parameters: outgoingPaymentRequestXPaymentId
Outgoing Payment Deallocation
Here are the functions used:
Example of calling the function: deallocateOutgoingPayment(outgoingPaymentId, paymentId)
.
This function updates the FTOS_PYMT_OutgoingPayment entity and changes the business status into Deleted for the FTOS_PYMT_OutgoingPaymentRequestXPayment item.
Input parameters:
-
outgoingPaymentId
- The Id of the outgoing payment. -
paymentId
- The Id of the payment.
Output parameters:
Example of calling the function: deallocatePayment(paymentId, paymentUpdateObj)
.
Use to update the FTOS_PYMT_Payment entity
Input parameters:
-
paymentId
- The Id of the payment. -
paymentUpdateObj
- An object containing the update.
Output parameters:
Example of calling the function: getOutgoingPaymentsRequestXPayment(outgoingPaymentId, paymentId)
.
This function gets and returns the outgoingPaymentRequestXPayment details in allocated status, based on the outgoingPaymentId
and paymentId
.
Input parameters:
-
outgoingPaymentId
- The Id of the outgoing payment. -
paymentId
- The Id of the payment.
Output parameters:
fetchResult[0]
- query result containing details of the outgoing payment requested through the input parameter.
Example of calling the function: getOutgoingPayment(outgoingPaymentId)
.
This function gets and returns the outgoing payment details based on the Id of the outgoing payment.
Input parameters: outgoingPaymentId
- The Id of the outgoing payment.
Output parameters: outgoingPayment[0]
- The query result containing details of the the outgoing payment, requested through the input parameter.
Example of calling the function: getPayment(paymentId)
.
Function meant to get and return the payment details based on the payment ID
Input parameters: paymentId
- The Id of the payment.
Output parameters:
payment[0]
- The query result containing details of the payment, requested through the input parameter.