Skip to content

Daily Terminal Management

For efficient operation and transaction management, it's important for clients to follow specific best practices at the start and end of each day. This ensures that no transactions are left unprocessed and that device parameters are up to date.

Device Configuration and Setup

Clients will receive a terminal configured according to pre-agreed integration preferences and settings, ensuring consistency in device operation. Device configurations are controlled via the Device Management System (DMS) and can be retrieved in a read-only manner using the getConfig method.

Key Concepts

  • BatchFile:
    A BatchFile is a collection of transactions that have not yet been processed to the Gateway (Deposited) or to the Bank/Processor (Settled). The device contains one and only one batch file at any given time.
    • Settlement: When a settlement request is made, all transactions in the batch file are processed to the processor.
    • Deposit: Relevant only for terminals using a payment gateway. The deposit request moves transactions to the gateway's batch file, marking them as processed and no longer under the device's responsibility.

Difference Between Settlement and Deposit

  • Settlement:
    Settlement processes all transactions in the batch file as a single unit. The result applies to all transactions collectively. If an error occurs during settlement, none of the transactions are processed, and they all remain in the batch file.
  • Deposit:
    Deposit processes transactions one by one. Each transaction is deposited individually, and the result is provided for each transaction separately. If an error occurs during deposit, only the failed transaction remains unprocessed, while the others are successfully deposited.
  • Deposit:
    The Deposit operation is relevant only for terminals that work with a payment gateway. Once a deposit request is made, the transactions are moved from the device’s batch file to the gateway’s batch file, making them no longer the device's responsibility. This ensures that transactions are fully processed by the gateway.

  • Settlement:
    The Settlement operation performs two main tasks:

    1. Updates device parameters: Ensures that the device configuration is up-to-date.
    2. Batches the batch file to the processor: If the terminal does not use a payment gateway, the settlement operation batches all the transactions in the device's batch file and sends them to the processor for final processing.
  • Auto Settlement:
    The Auto Settlement configuration automatically triggers the settlement process at a specified time during the day. and batches transactions automatically. For most terminals working directly with processors, this configuration is not as useful, as they expect to receive the settlement result (the report) from the processor. However, it is particularly useful for terminals working with gateways because it only updates the terminal parameters.

  • Auto Deposit:
    The autoDeposit configuration ensures that transactions are automatically deposited to the gateway immediately after they are executed, during the transaction processing request. This helps ensure timely processing and avoids manual intervention.

  • Decline Failed Deposit:
    The declineFailedDeposit configuration ensures that if a transaction cannot be deposited due to a connection error, it will be reversed and declined. This setting applies only when the deposit is done during the transaction processing via Auto Deposit. When used in combination with Auto Deposit, it ensures that the batch file is emptied after each transaction is processed.

Warning

If there is a connection error during a separate deposit request, the transaction will not be reversed.

Start of Day Practices

At the start of the day, the terminal should verify the terminalId. Ensure that the terminalId matches the expected value using the getTerminalStatus method. This ensures the terminal is correctly identified and ready for processing.

End of Day Best Practices

It is a good practice to check the BatchFile using getBatchFileStatus at the end of the day to ensure all transactions have been processed. However, this is not mandatory in all cases, as other operations may achieve the same result.

  1. For Terminals Working with Gateways:

    • Calling Deposit as a Substitute for Checking the BatchFile:
      Instead of explicitly calling the getBatchFileStatus method, you can call the deposit method. If there are any transactions in the batch file, they will be deposited during this request, and the response will include the batch file with the deposit result for each transaction. This ensures that all transactions are processed without requiring a separate batch file status check.
    • Calling Settlement to Update Parameters:
      While it is a good practice to call the settlement method to update device parameters, this can also be done at the start of the day when working with gateways. This ensures the terminal is ready for the next day's transactions.
  2. For Terminals Working Directly with Processors:

    • Consider Auto Settlement Preferences:
      If Auto Settlement is enabled, the settlement process will automatically finalize the batch file at a specified time. However, if Auto Settlement is disabled, you must manually trigger the settlement process from the ECR.
    • Call the Settlement Method at the End of the Day:
      It is crucial to call the Settlement method at the end of the day to finalize the batch file and update device parameters. This ensures that all transactions are processed and the terminal is ready for the next day's operations.

Final Notes

  • Consistency: By following these practices every day, you ensure that your device is ready for the next day's transactions without any pending transactions or outdated configurations.
  • Configuration Awareness: Always ensure that key configurations like Auto Deposit and DeclineFailedDeposit are correctly set based on the terminal’s operational needs.