UK Direct Debit

This function updates the directDebitMandateId processed attributes on a buffer that triggered an action for a mandate (deletion, modification or reactivation).

Input parameters:

• bufferId - The Id of the buffer on which the update needs to be made.

• mandateId - The Id of the mandate on which the buffer performed an action.

Output parameters: N/A.

This function detects the type of action that the buffer needs to perform on a mandate, based on the stageId that the buffer has. If there is no stageId set on the buffer, the function throws an exception, with an error message.

Input parameters:

• bufferObj - The object containing the data added in the buffer.

• isJob - (boolean) - Tells whether the function is called by a job or not.

Output parameters: mandateId - The Id of the mandate which was modified, cancelled, or reactivated.

This function updates the mandate business status.

Input parameters:

• mandateId - The mandate unique identifier.

• statusId - The business status unique identifier.

Output parameters: N/A.

This function returns the mandate details based on reference or account holder name and account number.

Input parameters: bufferObj - The object containing the following attributes reference, or accountHolder and accountNumber.

Output parameters: Returns the fetch.

This function returns the reason code details from FTOS_PYMT_ADDACSReasonType entity based on the reason code received as input.

Input parameters: reasonCode - The reason code (0, 1, 2, 3, B, C, D, E, R).

Output parameters: Returns the fetch.

This function makes status changes (canceling, modifying or reactivating) on the existing mandates.

Input parameters: N/A.

Output parameters: N/A.

This function executes the following:

• It updates the business status of the mandate to Cancelled.

• It updates the stageId attribute to the one received from the buffer.

• It calls the updateUKBufferMandateId function to update the directDebitMandateId and processed attributes of the buffer.

• If no mandate is found based on the reference, the function throws an error.

Input parameters:

• bufferObj - The object containing the data added in the buffer.

• isJob - (boolean) - Tells whether the function is called by a job or not.

Output parameters: mandateId - The Id of the cancelled mandate.

This function executes the following:

• It inserts a new mandate record, with the data received from the FTOS_PYMT_GenerateMandate endpoint.

• If there is already a mandate with the same reference from the data object, the function throws an error.

• It calls the updateUKBufferMandateId function to update the directDebitMandateId and processed attributes of the buffer.

Input parameters: bufferObj - The object containing the data received from FTOS_PYMT_GenerateMandate endpoint.

Output parameters: mandateId - The Id of the mandate which was created.

This function executes the following:

• Creates a new version for a mandate with a specific reference.

• Updates the mandate with the new data received from the buffer.

• If no mandate is found having the same reference as the one received from the data object, the function throws an error.

• After the insert and update, the function updates the business status of the old mandate version to versionClosed.

• Calls the updateUKBufferMandateId function to update the directDebitMandateId and processed attributes of the buffer.

Input parameters:

• bufferObj - The object containing the data added in the buffer.

• isJob - (boolean) - Tells whether the function is called by a job or not.

Output parameters: mandateId - The Id of the modified mandate.

This function executes the following:

• Reactivates a cancelled mandate based on a specific reference, received through the buffer object.

• If no cancelled mandate or no mandate is found having the same reference as the one received from the data object, the function throws an error.

• Calls the updateUKBufferMandateId function to update the directDebitMandateId and processed attributes of the buffer.

Input parameters:

• bufferObj - The object containing the data added in the buffer.

• isJob - (boolean) - Tells whether the function is called by a job or not.

Output parameters: mandateId - The Id of the modified mandate.

This function sets the Id of all three business statuses that the function needs. Next, by calling the updateFileMandateId() function, we update the directDebitMandateId attribute of the buffer records. Next, the function checks if the found mandate is in one of the two statuses - either Pending or Active, and changes its business status to cancelled.

Input parameters:

• bufferObj - The object containing the data added in the buffer.

• fileType - The type of the file that has been imported.

Output parameters: N/A

For a policy reference received as parameter, this function returns the statement in Generated or On Grace status and verifies if the payment method is set to direct debit.

Input parameters: policyNo - The policy number (string).

Output parameters: The result of the query.

This function returns all the mandates that are in Pending business status.

Input parameters: N/A.

Output parameters: The query object.

This function changes the business status for UK mandates.

Input parameters: N/A.

Output parameters: N/A.

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

Input parameters: value - The value that needs validation.

Output parameters:true/ false - The result of the validation.

This functions transforms the format of an input date to the ddmmyy format. Next, it adds a number of days to the received date.

Input parameters:

date

noOfDays - How many days to add to the date received as an input.

Output parameters: Date formated.

This function returns the static values stored in the FTOS_PYMT_DIDEProcessor processor.

Input parameters: setting - The processor’s object key name.

Output parameters: The object containing values from the processor:

• destinationSort

• destinationAcct

• destinationType

• usersName

• transaction

• freeFormat

• amount

This function executes the following:

• Verifies that the DIDE instruction file can be generated according the rules defined in the FTOS_PYMT_DIDEProcessor processor (runningOnBankHolidays, numberOfDaysInAdvance, and excludeWeekDays).

• Generates the details needed for the file type wanted.

• Saves the statementId and directDebitMandateId details into the FTOS_PYMT_DIDEDetail entity.

• Saves the directDebitMandateId details in FTOS_PYMT_DIDEMandateInstructionDetail entity, according to the file type.

• Generates the .txt file.

• Saves the file into the FTOS_PYMT_DIDE entity or into the FTOS_PYMT_DIDEMandateInstruction entity.

• It also saves the file on the server UploadEBS folder.

This function also uses all the functions mentioned below.

Input parameters: instructionFileType - Optional parameter. This parameter has two possible values:

1. statements - for files dealing with payments - DIDEPaymentsInstructionFile (for SEPA) and, respectively, DD_BACSPayments file (for UK).

2. mandates - for files dealing with creation of new DIDE mandates - NEW_DIDE_Mandates_BACSInstructions file (for UK).

Output parameters: N/A.

This function gets the configuration details of a processor.

Input parameters:

• flowSettingsName - The name of the flow setting.

• processorSettingsType - The type of the Digital Processor Type.

• processorSettingsName - The name of the processor setting.

Output parameters: processorDetails - An object containing the processor settings runningOnBankHolidays, excludeWeekDays and numberOfDaysInAdvance.

This function returns the name of a weekday (ex. Monday).

Input parameters: date - The date parameter.

Output parameters: dayName - The name of the week day.

This function verifies if the current day is a bank holiday or a day defined in the FTOS_PYMT_DIDEProcessor. If one condition is meet the function returns a true value.

Input parameters: settings - The object with the processor settings - runningOnBankHolidays, excludeWeekDays and numberOfDaysInAdvance.

Output parameters: True or false.

This function returns all the UK direct debit mandates in Draft status.

Input parameters: mandateTypeUk - The mandateTypeId has the UK value.

Output parameters: Returns the query result.

This function imports the FTOS_PYMT_GetPolicyDataAPI library in order to call the FTOS_GetPolicyData_API API. The function sends an object containing a list of policies as mandates references (where the reference is the policy number) and receives the information about the specified policies, in return. This function also parses the result.

Input parameters: mandateObj - The list of policies.

Output parameters: Information result about the specified policies.

This function returns statements (invoices) to be included in the DIDE instruction file, based on the following conditions:

• businessStatus of the statement = Generated

• paymentType of the statement = directDebit

• businessStatus of the direct debit mandate = active

• scheduledDate of the statement = null

• dueDate of the statement <= current date + numberOfDaysInAdvance

• businessStatus of the policy = Enforced or Suspended

• mandateTypeId = SEPA or UK

Input parameters:

• numberOfDaysInAdvance - The number of days in advance for generating an invoice (for a policy installment), before the due date for the payment.

• mandateTypeId = SEPA or UK

Output parameters: resultStatements - Returns the fetch.

This function is specific for SEPA direct debit. This function executes the following:

• Inspects the results of the getStatementsDetails function.

• Inserts the statementId, directDebitMandateId, and name details into the FTOS_PYMT_DIDEDetail entity.

• Populates the CSVContentArray with all the details necessary for the generation of the DIDE instruction file.

• Updates the scheduledDate from the FTOS_PYMT_Statement entity.

Input parameters:

• result - The fetch result of the getStatementsDetails (numberOfDaysInAdvance, mandateTypeId) function.

• CSVContentArray - An empty array.

Output parameters: N/A.

This function executes the following:

• Inspects the results of mandates returned by the query.

• Inserts the directDebitMandateId details into the FTOS_PYMT_DIDEMandateInstructionDetail entity.

• Populates the CSVContentArray with all the details necessary for generating the mandate instruction file.

• Sets the beginDate on the specified mandates.

• Sets the status on the mandates to Active.

In the CSVContentArray file, the information is concatenated as follows:

• First column: destination sort + destination acct + destination type + transaction + bank Sort Code + account number.

• Second column: free format + amount + users name.

• Third column: reference + payer last name.

• Fourth column: BACS Processing day.

Input parameters:

• resultMandates - The mandates that respect all conditions for being included in the file.

• CSVContentArray - An empty array.

Output parameters: N/A.

This function executes the following:

• Inspects the results of the getStatementsDetails function.

• Inserts the statementId, directDebitMandateId, and name details into the FTOS_PYMT_DIDEDetail entity.

• Populates the CSVContentArray with all the details necessary for the generation of the UK_DIDE instruction file.

• Updates the scheduledDate from the FTOS_PYMT_Statement entity

In the CSVContentArray file, the information is concatenated as follows:

• First column: destination sort + destination acct + destination type + transaction + bank Sort Code + account number.

• Second column: free format.

• Third column: amount + users name.

• Fourth column: reference + payer last name.

• Fifth column: BACS Processing day.

Input parameters:

• result - The fetch result of the getStatementsDetails (numberOfDaysInAdvance, mandateTypeId) function.

• CSVContentArray - An empty array.

Output parameters: N/A.

This function returns the installment number for an invoice reference, received as parameter.

Input parameters: statementReference - The invoice reference.

Output parameters: Returns the query result.

This function executes the following:

• Generates the .txt DIDE instruction file based on csvContentArray populated by the processPaymentsInstruction(result, csvContentArray) function.

• Saves the file into FTOS_PYMT_DIDE entity.

• Saves the file on the UploadEBS folder from the portal.

Input parameters:

csvContentArray - The array with all the records for direct debit instructions.

instructionFileType - Optional parameter, with two possible values: 1. statements for DIDEPaymentsInstructionFile (SEPA) and DD_BACSPayments (UK) file and 2. mandates for NEW_DIDE_Mandates_BACSInstructions file (UK).

Output parameters:

idInstructionFile - The Id of the new file inserted in FTOS_PYMT_DIDE entity or FTOS_PYMT_DIDEMandateInstruction entity.

entityName - FTOS_PYMT_DIDE - for DIDEPaymentsInstructionFile (SEPA) and DD_BACSPayments (UK) file OR FTOS_PYMT_DIDEMandateInstruction for the NEW_DIDE_Mandates_BACSInstructions file (UK).

This function searches all the records from FTOS_PYMT_DIDEDetail or FTOS_PYMT_DIDEMandateInstructionDetail entities (depending on the file type) which have dideId (id of the file) with nullvalues and updates them with the id of the recently generated file.

Input parameters:

• instructionFileObj -

• instructionFileId - The id of the new generated file and entityName - the name of the entity.

Output parameters: N/A