Package com.broadleafcommerce.cartoperation.service.provider.external.payments

Class ExternalPaymentProperties

java.lang.Object
com.broadleafcommerce.cartoperation.service.provider.external.payments.ExternalPaymentProperties
@ConfigurationProperties("broadleaf.cartoperation.paymentprovider") public class ExternalPaymentProperties extends Object
Properties for interacting with an external payment transaction service.
Author:
Dima Myroniuk (dmyroniuk)

  • Constructor Details

    • ExternalPaymentProperties

      public ExternalPaymentProperties()

  • Method Details

    • getUrl

      public String getUrl()
      The base url for an external payment transaction service.

    • getPaymentsUri

      public String getPaymentsUri()
      The URI path for basic CRUD operations on payments.

    • getPaymentTransactionsUri

      public String getPaymentTransactionsUri()
      The URI path for basic CRUD operations on payment transactions.

    • getLockPaymentsUri

      public String getLockPaymentsUri()
      The URI path for locking multiple payments.

    • getLockAndRetrievePaymentsUri

      public String getLockAndRetrievePaymentsUri()
      The URI path for locking multiple payments and include their PaymentSummaries in the response.

    • getUnlockPaymentsUri

      public String getUnlockPaymentsUri()
      The URI path for locking multiple payments.

    • getAuthorizeUri

      public String getAuthorizeUri()
      The URI path for executing an authorize transaction.

    • getAuthorizeAndCaptureUri

      public String getAuthorizeAndCaptureUri()
      The URI path for executing an authorize and capture transaction.

    • getFinalizePaymentsUri

      @Deprecated public String getFinalizePaymentsUri()
      Deprecated.
      in favor of blockCustomerMutabilityForPaymentsUri for more accurate naming
      The URI path for finalizing payments after checkout.

    • getBlockCustomerMutabilityForPaymentsUri

      public String getBlockCustomerMutabilityForPaymentsUri()
      The URI path for blocking customer mutability for payments in checkout.

    • getBlockCustomerMutabilityForPaymentFinalizationUri

      public String getBlockCustomerMutabilityForPaymentFinalizationUri()
      The URI path for blocking customer mutability for payments in checkout that require finalization.

    • getRemoveCustomerMutabilityBlockForPaymentFinalizationUri

      public String getRemoveCustomerMutabilityBlockForPaymentFinalizationUri()
      The URI path for removing customer mutability blocks for payments in checkout.

    • getTransferCustomerPaymentsToCsrUri

      public String getTransferCustomerPaymentsToCsrUri()
      The URI path for transferring a customer payment to a CSR.

    • getTransferCsrPaymentsToCustomerUri

      public String getTransferCsrPaymentsToCustomerUri()
      The URI path for transferring a CSR payment to a customer.

    • getClaimTransactionsForRequestUri

      public String getClaimTransactionsForRequestUri()
      The URI path to reset payment transaction reversal state.

    • getLookup3dsTransactionResultUri

      public String getLookup3dsTransactionResultUri()
      The URI path to lookup 3DS payment transaction results from the gateway.

    • getLookupExternalTransactionResultUri

      public String getLookupExternalTransactionResultUri()
      The URI path to lookup external payment transaction results from the gateway.

    • getHandleExternalTransactionResultUri

      public String getHandleExternalTransactionResultUri()
      The URI path to lookup external payment transaction results & record them to the relevant transaction.

    • getValidatePaymentCallbackTokenUri

      public String getValidatePaymentCallbackTokenUri()
      The URI path to validate the payment callback request based on the token

    • getServiceClient

      public String getServiceClient()
      The service client to use when calling payment transaction services. Default is "cartopsclient".

    • setUrl

      public void setUrl(String url)
      The base url for an external payment transaction service.

    • setPaymentsUri

      public void setPaymentsUri(String paymentsUri)
      The URI path for basic CRUD operations on payments.

    • setPaymentTransactionsUri

      public void setPaymentTransactionsUri(String paymentTransactionsUri)
      The URI path for basic CRUD operations on payment transactions.

    • setLockPaymentsUri

      public void setLockPaymentsUri(String lockPaymentsUri)
      The URI path for locking multiple payments.

    • setLockAndRetrievePaymentsUri

      public void setLockAndRetrievePaymentsUri(String lockAndRetrievePaymentsUri)
      The URI path for locking multiple payments and include their PaymentSummaries in the response.

    • setUnlockPaymentsUri

      public void setUnlockPaymentsUri(String unlockPaymentsUri)
      The URI path for locking multiple payments.

    • setAuthorizeUri

      public void setAuthorizeUri(String authorizeUri)
      The URI path for executing an authorize transaction.

    • setAuthorizeAndCaptureUri

      public void setAuthorizeAndCaptureUri(String authorizeAndCaptureUri)
      The URI path for executing an authorize and capture transaction.

    • setFinalizePaymentsUri

      @Deprecated public void setFinalizePaymentsUri(String finalizePaymentsUri)
      Deprecated.
      in favor of blockCustomerMutabilityForPaymentsUri for more accurate naming
      The URI path for finalizing payments after checkout.

    • setBlockCustomerMutabilityForPaymentsUri

      public void setBlockCustomerMutabilityForPaymentsUri(String blockCustomerMutabilityForPaymentsUri)
      The URI path for blocking customer mutability for payments in checkout.

    • setBlockCustomerMutabilityForPaymentFinalizationUri

      public void setBlockCustomerMutabilityForPaymentFinalizationUri(String blockCustomerMutabilityForPaymentFinalizationUri)
      The URI path for blocking customer mutability for payments in checkout that require finalization.

    • setRemoveCustomerMutabilityBlockForPaymentFinalizationUri

      public void setRemoveCustomerMutabilityBlockForPaymentFinalizationUri(String removeCustomerMutabilityBlockForPaymentFinalizationUri)
      The URI path for removing customer mutability blocks for payments in checkout.

    • setTransferCustomerPaymentsToCsrUri

      public void setTransferCustomerPaymentsToCsrUri(String transferCustomerPaymentsToCsrUri)
      The URI path for transferring a customer payment to a CSR.

    • setTransferCsrPaymentsToCustomerUri

      public void setTransferCsrPaymentsToCustomerUri(String transferCsrPaymentsToCustomerUri)
      The URI path for transferring a CSR payment to a customer.

    • setClaimTransactionsForRequestUri

      public void setClaimTransactionsForRequestUri(String claimTransactionsForRequestUri)
      The URI path to reset payment transaction reversal state.

    • setLookup3dsTransactionResultUri

      public void setLookup3dsTransactionResultUri(String lookup3dsTransactionResultUri)
      The URI path to lookup 3DS payment transaction results from the gateway.

    • setLookupExternalTransactionResultUri

      public void setLookupExternalTransactionResultUri(String lookupExternalTransactionResultUri)
      The URI path to lookup external payment transaction results from the gateway.

    • setHandleExternalTransactionResultUri

      public void setHandleExternalTransactionResultUri(String handleExternalTransactionResultUri)
      The URI path to lookup external payment transaction results & record them to the relevant transaction.

    • setValidatePaymentCallbackTokenUri

      public void setValidatePaymentCallbackTokenUri(String validatePaymentCallbackTokenUri)
      The URI path to validate the payment callback request based on the token

    • setServiceClient

      public void setServiceClient(String serviceClient)
      The service client to use when calling payment transaction services. Default is "cartopsclient".