Ucv1sessionsCaptureMandate (cybersource-rest-client-java 0.0.89 API)

java.lang.Object
- Model.Ucv1sessionsCaptureMandate

public class Ucv1sessionsCaptureMandate
extends Object

Ucv1sessionsCaptureMandate

Constructor Summary

Constructors
Constructor Description

Ucv1sessionsCaptureMandate()

Constructors
Constructor	Description
`Ucv1sessionsCaptureMandate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Ucv1sessionsCaptureMandate`	`addShipToCountriesItem(String shipToCountriesItem)`
`Ucv1sessionsCaptureMandate`	`billingType(String billingType)`
`Boolean`	`ComboCard()`	Configure Unified Checkout to display combo card at checkout.<br> A combo debit/credit card is a single card that functions both as a Debit/Credit card.
`Ucv1sessionsCaptureMandate`	`comboCard(Boolean comboCard)`
`Ucv1sessionsCaptureMandate`	`CPF(Ucv1sessionsCaptureMandateCPF CPF)`
`boolean`	`equals(Object o)`
`String`	`getBillingType()`	Configure Unified Checkout to capture billing address information.
`Ucv1sessionsCaptureMandateCPF`	`getCPF()`	Get CPF
`List<String>`	`getShipToCountries()`	List of countries available to ship to.
`int`	`hashCode()`
`Boolean`	`RequestEmail()`	Configure Unified Checkout to capture customer email address.
`Ucv1sessionsCaptureMandate`	`requestEmail(Boolean requestEmail)`
`Boolean`	`RequestPhone()`	Configure Unified Checkout to capture customer phone number.
`Ucv1sessionsCaptureMandate`	`requestPhone(Boolean requestPhone)`
`Boolean`	`RequestSaveCredentials()`	Configure Unified Checkout to display the \"Save card for future use\" checkbox.<br> Configurable check box that will show in a Manual card entry flow to allow a Cardholder to give consent to store their manually entered credential with the Merchant that they are paying.<br> Applicable when manually entering the details and not enrolling in Click to Pay.
`Ucv1sessionsCaptureMandate`	`requestSaveCredentials(Boolean requestSaveCredentials)`
`Boolean`	`RequestShipping()`	Configure Unified Checkout to capture customer shipping details.
`Ucv1sessionsCaptureMandate`	`requestShipping(Boolean requestShipping)`
`void`	`setBillingType(String billingType)`
`void`	`setComboCard(Boolean comboCard)`
`void`	`setCPF(Ucv1sessionsCaptureMandateCPF CPF)`
`void`	`setRequestEmail(Boolean requestEmail)`
`void`	`setRequestPhone(Boolean requestPhone)`
`void`	`setRequestSaveCredentials(Boolean requestSaveCredentials)`
`void`	`setRequestShipping(Boolean requestShipping)`
`void`	`setShipToCountries(List<String> shipToCountries)`
`void`	`setShowAcceptedNetworkIcons(Boolean showAcceptedNetworkIcons)`
`void`	`setShowConfirmationStep(Boolean showConfirmationStep)`
`Ucv1sessionsCaptureMandate`	`shipToCountries(List<String> shipToCountries)`
`Boolean`	`ShowAcceptedNetworkIcons()`	Configure Unified Checkout to display the list of accepted card networks beneath the payment button Possible values: - True - False<br><br> Optional field: This field can be configured through the Merchant Experience screens in the Business Center.
`Ucv1sessionsCaptureMandate`	`showAcceptedNetworkIcons(Boolean showAcceptedNetworkIcons)`
`Boolean`	`ShowConfirmationStep()`	Configure Unified Checkout to display the final confirmation screen when using Click to Pay.<br> Where 'BillingType'= NONE and 'requestShipping'= FALSE and the customer is using an existing Click to Pay card as their chosen payment method, a final confirmation screen can be removed allowing the customer to check out as soon as they have selected their payment method from within their Click to Pay card tray.
`Ucv1sessionsCaptureMandate`	`showConfirmationStep(Boolean showConfirmationStep)`
`String`	`toString()`

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

- Constructor Detail
 - Ucv1sessionsCaptureMandate
```
public Ucv1sessionsCaptureMandate()
```
- Method Detail
 - billingType
```
public Ucv1sessionsCaptureMandate billingType(String billingType)
```
 - getBillingType
```
public String getBillingType()
```
 Configure Unified Checkout to capture billing address information. Possible values: - FULL: Capture complete billing address information. - PARTIAL: Capture first name, last name, country and postal/zip code only. - NONE: Capture only first name and last name. Optional field: This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
 
 Returns:
 
 billingType
 - setBillingType
```
public void setBillingType(String billingType)
```
 - requestEmail
```
public Ucv1sessionsCaptureMandate requestEmail(Boolean requestEmail)
```
 - RequestEmail
```
public Boolean RequestEmail()
```
 Configure Unified Checkout to capture customer email address. Possible values: - True - False Optional field: This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
 
 Returns:
 
 requestEmail
 - setRequestEmail
```
public void setRequestEmail(Boolean requestEmail)
```
 - requestPhone
```
public Ucv1sessionsCaptureMandate requestPhone(Boolean requestPhone)
```
 - RequestPhone
```
public Boolean RequestPhone()
```
 Configure Unified Checkout to capture customer phone number. Possible values: - True - False Optional field: This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
 
 Returns:
 
 requestPhone
 - setRequestPhone
```
public void setRequestPhone(Boolean requestPhone)
```
 - requestShipping
```
public Ucv1sessionsCaptureMandate requestShipping(Boolean requestShipping)
```
 - RequestShipping
```
public Boolean RequestShipping()
```
 Configure Unified Checkout to capture customer shipping details. Possible values: - True - False Optional field: This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
 
 Returns:
 
 requestShipping
 - setRequestShipping
```
public void setRequestShipping(Boolean requestShipping)
```
 - shipToCountries
```
public Ucv1sessionsCaptureMandate shipToCountries(List<String> shipToCountries)
```
 - addShipToCountriesItem
```
public Ucv1sessionsCaptureMandate addShipToCountriesItem(String shipToCountriesItem)
```
 - getShipToCountries
```
public List<String> getShipToCountries()
```
 List of countries available to ship to. Use the two-character ISO Standard Country Codes. Optional field: This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
 
 Returns:
 
 shipToCountries
 - setShipToCountries
```
public void setShipToCountries(List<String> shipToCountries)
```
 - showAcceptedNetworkIcons
```
public Ucv1sessionsCaptureMandate showAcceptedNetworkIcons(Boolean showAcceptedNetworkIcons)
```
 - ShowAcceptedNetworkIcons
```
public Boolean ShowAcceptedNetworkIcons()
```
 Configure Unified Checkout to display the list of accepted card networks beneath the payment button Possible values: - True - False Optional field: This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
 
 Returns:
 
 showAcceptedNetworkIcons
 - setShowAcceptedNetworkIcons
```
public void setShowAcceptedNetworkIcons(Boolean showAcceptedNetworkIcons)
```
 - showConfirmationStep
```
public Ucv1sessionsCaptureMandate showConfirmationStep(Boolean showConfirmationStep)
```
 - ShowConfirmationStep
```
public Boolean ShowConfirmationStep()
```
 Configure Unified Checkout to display the final confirmation screen when using Click to Pay. Where 'BillingType'= NONE and 'requestShipping'= FALSE and the customer is using an existing Click to Pay card as their chosen payment method, a final confirmation screen can be removed allowing the customer to check out as soon as they have selected their payment method from within their Click to Pay card tray. Possible values: - True - False Optional field: This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
 
 Returns:
 
 showConfirmationStep
 - setShowConfirmationStep
```
public void setShowConfirmationStep(Boolean showConfirmationStep)
```
 - requestSaveCredentials
```
public Ucv1sessionsCaptureMandate requestSaveCredentials(Boolean requestSaveCredentials)
```
 - RequestSaveCredentials
```
public Boolean RequestSaveCredentials()
```
 Configure Unified Checkout to display the \"Save card for future use\" checkbox. Configurable check box that will show in a Manual card entry flow to allow a Cardholder to give consent to store their manually entered credential with the Merchant that they are paying. Applicable when manually entering the details and not enrolling in Click to Pay. Possible values: - True - False **Use Cases:** **Offer consumers option to save their card in Unified Checkout:** - Include the captureMandate.requestSaveCard field in the capture context request and set it to true. - When set to true, this will show a checkbox with the message 'Save card for future use' in Unified Checkout. - When selected this provides a response in both the Transient Token and Get Credentials API response. **Do not offer consumers the option to save their card in Unified Checkout:** - Include the captureMandate.requestSaveCard field in the capture context request and set it to false OR omit the field from the capture context request. - When set to false, the save card option is not shown to consumers when manually entering card details. Optional field: This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
 
 Returns:
 
 requestSaveCredentials
 - setRequestSaveCredentials
```
public void setRequestSaveCredentials(Boolean requestSaveCredentials)
```
 - comboCard
```
public Ucv1sessionsCaptureMandate comboCard(Boolean comboCard)
```
 - ComboCard
```
public Boolean ComboCard()
```
 Configure Unified Checkout to display combo card at checkout. A combo debit/credit card is a single card that functions both as a Debit/Credit card. Unified Checkout / Click to Pay Drop-in UI allows the Cardholder to choose whether they would like the transaction to be paid for using either debit or credit card. **Important:** This is applicable to Visa cards only. Possible values: - True - False **Use Cases:** **Offer Combo Card at Checkout:** - Include the captureMandate.comboCard field in the capture context request and set it to true. - When set to true, Combo Card selection is shown at checkout **Do not offer Combo Card at Checkout:** - Include the captureMandate.comboCard field in the capture context request and set it to false OR omit the field from the capture context request. - The Combo Card selection is not shown at checkout. Optional field: This field can be configured through the Merchant Experience screens in the Business Center. The configured value may be overridden on a per‑transaction basis in the uc/v1/sessions API request.
 
 Returns:
 
 comboCard
 - setComboCard
```
public void setComboCard(Boolean comboCard)
```
 - CPF
```
public Ucv1sessionsCaptureMandate CPF(Ucv1sessionsCaptureMandateCPF CPF)
```
 - getCPF
```
public Ucv1sessionsCaptureMandateCPF getCPF()
```
 Get CPF
 
 Returns:
 
 CPF
 - setCPF
```
public void setCPF(Ucv1sessionsCaptureMandateCPF CPF)
```
 - equals
```
public boolean equals(Object o)
```
 Overrides:
 
 equals in class Object
 - hashCode
```
public int hashCode()
```
 Overrides:
 
 hashCode in class Object
 - toString
```
public String toString()
```
 Overrides:
 
 toString in class Object

Class Ucv1sessionsCaptureMandate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Ucv1sessionsCaptureMandate

Method Detail

billingType

getBillingType

setBillingType

requestEmail

RequestEmail

setRequestEmail

requestPhone

RequestPhone

setRequestPhone

requestShipping

RequestShipping

setRequestShipping

shipToCountries

addShipToCountriesItem

getShipToCountries

setShipToCountries

showAcceptedNetworkIcons

ShowAcceptedNetworkIcons

setShowAcceptedNetworkIcons

showConfirmationStep

ShowConfirmationStep

setShowConfirmationStep

requestSaveCredentials

RequestSaveCredentials

setRequestSaveCredentials

comboCard

ComboCard

setComboCard

CPF

getCPF

setCPF

equals

hashCode

toString