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 Summary

Constructors
Constructor Description

ExternalPaymentProperties()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getAuthorizeAndCaptureUri()`	The URI path for executing an authorize and capture transaction.
`String`	`getAuthorizeUri()`	The URI path for executing an authorize transaction.
`String`	`getBlockCustomerMutabilityForPaymentsUri()`	The URI path for blocking customer mutability for payments in checkout.
`String`	`getClaimTransactionsForRequestUri()`	The URI path to reset payment transaction reversal state.
`String`	`getFinalizePaymentsUri()`	Deprecated. in favor of `blockCustomerMutabilityForPaymentsUri` for more accurate naming
`String`	`getLockAndRetrievePaymentsUri()`	The URI path for locking multiple payments and include their `PaymentSummaries` in the response.
`String`	`getLockPaymentsUri()`	The URI path for locking multiple payments.
`String`	`getLookup3dsTransactionResultUri()`	The URI path to lookup 3DS payment transaction results from the gateway.
`String`	`getPaymentsUri()`	The URI path for basic CRUD operations on payments.
`String`	`getPaymentTransactionsUri()`	The URI path for basic CRUD operations on payment transactions.
`String`	`getServiceClient()`	The service client to use when calling payment transaction services.
`String`	`getTransferCsrPaymentsToCustomerUri()`	The URI path for transferring a CSR payment to a customer.
`String`	`getTransferCustomerPaymentsToCsrUri()`	The URI path for transferring a customer payment to a CSR.
`String`	`getUnlockPaymentsUri()`	The URI path for locking multiple payments.
`String`	`getUrl()`	The base url for an external payment transaction service.
`void`	`setAuthorizeAndCaptureUri(String authorizeAndCaptureUri)`	The URI path for executing an authorize and capture transaction.
`void`	`setAuthorizeUri(String authorizeUri)`	The URI path for executing an authorize transaction.
`void`	`setBlockCustomerMutabilityForPaymentsUri(String blockCustomerMutabilityForPaymentsUri)`	The URI path for blocking customer mutability for payments in checkout.
`void`	`setClaimTransactionsForRequestUri(String claimTransactionsForRequestUri)`	The URI path to reset payment transaction reversal state.
`void`	`setFinalizePaymentsUri(String finalizePaymentsUri)`	Deprecated. in favor of `blockCustomerMutabilityForPaymentsUri` for more accurate naming
`void`	`setLockAndRetrievePaymentsUri(String lockAndRetrievePaymentsUri)`	The URI path for locking multiple payments and include their `PaymentSummaries` in the response.
`void`	`setLockPaymentsUri(String lockPaymentsUri)`	The URI path for locking multiple payments.
`void`	`setLookup3dsTransactionResultUri(String lookup3dsTransactionResultUri)`	The URI path to lookup 3DS payment transaction results from the gateway.
`void`	`setPaymentsUri(String paymentsUri)`	The URI path for basic CRUD operations on payments.
`void`	`setPaymentTransactionsUri(String paymentTransactionsUri)`	The URI path for basic CRUD operations on payment transactions.
`void`	`setServiceClient(String serviceClient)`	The service client to use when calling payment transaction services.
`void`	`setTransferCsrPaymentsToCustomerUri(String transferCsrPaymentsToCustomerUri)`	The URI path for transferring a CSR payment to a customer.
`void`	`setTransferCustomerPaymentsToCsrUri(String transferCustomerPaymentsToCsrUri)`	The URI path for transferring a customer payment to a CSR.
`void`	`setUnlockPaymentsUri(String unlockPaymentsUri)`	The URI path for locking multiple payments.
`void`	`setUrl(String url)`	The base url for an external payment transaction service.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ExternalPaymentProperties
```
public ExternalPaymentProperties()
```
- Method Detail
  - 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.
  - 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.
  - 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.
  - 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.
  - setServiceClient
```
public void setServiceClient(String serviceClient)
```
    The service client to use when calling payment transaction services. Default is "cartopsclient".

Class ExternalPaymentProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExternalPaymentProperties

Method Detail

getUrl

getPaymentsUri

getPaymentTransactionsUri

getLockPaymentsUri

getLockAndRetrievePaymentsUri

getUnlockPaymentsUri

getAuthorizeUri

getAuthorizeAndCaptureUri

getFinalizePaymentsUri

getBlockCustomerMutabilityForPaymentsUri

getTransferCustomerPaymentsToCsrUri

getTransferCsrPaymentsToCustomerUri

getClaimTransactionsForRequestUri

getLookup3dsTransactionResultUri

getServiceClient

setUrl

setPaymentsUri

setPaymentTransactionsUri

setLockPaymentsUri

setLockAndRetrievePaymentsUri

setUnlockPaymentsUri

setAuthorizeUri

setAuthorizeAndCaptureUri

setFinalizePaymentsUri

setBlockCustomerMutabilityForPaymentsUri

setTransferCustomerPaymentsToCsrUri

setTransferCsrPaymentsToCustomerUri

setClaimTransactionsForRequestUri

setLookup3dsTransactionResultUri

setServiceClient