Package com.avoka.fc.core.service.payment

Interface IPaymentGatewayService

  • All Known Subinterfaces:
    IHostedPaymentService
    public interface IPaymentGatewayService
    Provides a generic payment service interface.

    • Field Detail

      • PAYMENT_SERVICE_CONFIG_UI_MAPPING_PARAMETER

        static final String PAYMENT_SERVICE_CONFIG_UI_MAPPING_PARAMETER
        The name of the service parameter containing the UI configuration mapping
        See Also:
        Constant Field Values

    • Method Detail

      • getPaymentServiceCode

        String getPaymentServiceCode()
        Returns the service name which can be used for logging and service identification.
        Returns:
        the service name, never null

      • performQuery

        Map<String,​String> performQuery​(PaymentLog paymentLog)
        Perform an adhoc payment gateway query against the given payment log.
        Parameters:
        paymentLog - the payment log
        Returns:
        map of query response parameters
        Since:
        4.0.0

      • isQuerySupported

        boolean isQuerySupported()
        Returns whether the payment gateway supports online queries against this payment service
        Returns:
        true if payment gateway online queries are supported
        Since:
        4.0.0

      • resolveOutstandingPayments

        void resolveOutstandingPayments()
        Resolve any outstanding payments against the payment gateway
        Since:
        4.0.0

      • resolveOutstandingPayments

        boolean resolveOutstandingPayments​(Submission submission)
        Resolve any outstanding payments against the payment gateway for this submission
        Parameters:
        submission - The submission to resolve payment transactions for
        Returns:
        true if the submission is now complete, false if the submission is still waiting for payment.
        Since:
        4.0.0