Batch Payments Service

Overview

The Batch Payments Service processes queued customer payments on a fixed timer. On each cycle it reads the pending payment batch from SBN, submits each payment to the configured payment processor, and records the result back against the originating batch and invoice. The service runs continuously, picking up newly queued payments each cycle.

For each payment the service sends the cardholder name, card type, masked card token, expiration date, amount, and currency to the processor. Payments that are missing a card type or cardholder name, or whose card has expired, are skipped and flagged rather than submitted. When a payment is approved, the originating record is marked paid; declined or errored payments are flagged with the reason so they can be reviewed.

When a confirmation email is configured and the payer has an email address on file, the service sends a receipt summarising the account, amount, card type, and cardholder name after a successful payment.

The service requires a working SBN data-server connection and a valid, compatible connection to the payment-processing API; if either cannot be established at start-up, the service logs the reason and stops.

Service Manager

Instructions for installing and interacting with this service is found here.

Service Properties

Only properties specific to this service are listed here. Common service properties (SBN Server connection, Logging, SMTP) are found here.

Timer (In Seconds)

How often the service runs a payment-processing pass. The service waits this many seconds between cycles, then processes any payments waiting in the queue.

Processing Method

Selects which payment processor the service submits payments to. This determines how payments are sent and which connection settings on the APIEngine tab are used.