Package com.broadleafcommerce.vendor.chasepayment.service.orbital.external.provider

Interface OrbitalGatewayProvider

All Known Implementing Classes:
DefaultOrbitalGatewayProvider
public interface OrbitalGatewayProvider
Service component responsible for interacting with Chase's Orbital Gateway APIs.

  • Method Details

    • executeAuthorize

      OrbitalCreatePaymentResponse executeAuthorize(OrbitalCreatePaymentRequest requestPayload, OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)
      Execute an DefaultTransactionTypes.AUTHORIZE transaction against the Orbital Gateway.
      Parameters:
      requestPayload - a request payload that can be sent to the Orbital API, already populated with details from orbitalPaymentRequestWrapper
      orbitalPaymentRequestWrapper - the original payment request details containing additional context about the request
      Returns:
      the response payload received from the Orbital API
      Throws:
      MissingRequiredConfigurationException - if key system configuration elements were not found
      ProviderApiException - if something goes wrong

    • executeAuthorizeAndCapture

      OrbitalCreatePaymentResponse executeAuthorizeAndCapture(OrbitalCreatePaymentRequest requestPayload, OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)
      Execute an DefaultTransactionTypes.AUTHORIZE_AND_CAPTURE transaction against the Orbital Gateway.
      Parameters:
      requestPayload - a request payload that can be sent to the Orbital API, already populated with details from orbitalPaymentRequestWrapper
      orbitalPaymentRequestWrapper - the original payment request details containing additional context about the request
      Returns:
      the response payload received from the Orbital API
      Throws:
      MissingRequiredConfigurationException - if key system configuration elements were not found
      ProviderApiException - if something goes wrong

    • executeCapture

      OrbitalCaptureResponse executeCapture(OrbitalCaptureRequest requestPayload, OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)
      Execute a DefaultTransactionTypes.CAPTURE transaction against the Orbital Gateway.
      Parameters:
      requestPayload - a request payload that can be sent to the Orbital API, already populated with details from orbitalPaymentRequestWrapper
      orbitalPaymentRequestWrapper - the original payment request details containing additional context about the request
      Returns:
      the response payload received from the Orbital API
      Throws:
      MissingRequiredConfigurationException - if key system configuration elements were not found
      ProviderApiException - if something goes wrong

    • executeRefund

      OrbitalRefundResponse executeRefund(OrbitalRefundRequest requestPayload, OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)
      Execute a DefaultTransactionTypes.REFUND transaction against the Orbital Gateway.
      Parameters:
      requestPayload - a request payload that can be sent to the Orbital API, already populated with details from orbitalPaymentRequestWrapper
      orbitalPaymentRequestWrapper - the original payment request details containing additional context about the request
      Returns:
      the response payload received from the Orbital API
      Throws:
      MissingRequiredConfigurationException - if key system configuration elements were not found
      ProviderApiException - if something goes wrong

    • executeReversal

      OrbitalReversalResponse executeReversal(OrbitalReversalRequest requestPayload, OrbitalPaymentRequestWrapper orbitalPaymentRequestWrapper)
      Execute a DefaultTransactionTypes.REVERSE_AUTH transaction against the Orbital Gateway.
      Parameters:
      requestPayload - a request payload that can be sent to the Orbital API, already populated with details from orbitalPaymentRequestWrapper
      orbitalPaymentRequestWrapper - the original payment request details containing additional context about the request
      Returns:
      the response payload received from the Orbital API
      Throws:
      MissingRequiredConfigurationException - if key system configuration elements were not found
      ProviderApiException - if something goes wrong