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

java.lang.Object
- Model.GenerateUnifiedCheckoutV1CaptureContextRequest

public class GenerateUnifiedCheckoutV1CaptureContextRequest
extends Object

GenerateUnifiedCheckoutV1CaptureContextRequest

Constructor Summary

Constructors
Constructor Description

GenerateUnifiedCheckoutV1CaptureContextRequest()

Constructors
Constructor	Description
`GenerateUnifiedCheckoutV1CaptureContextRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`addAllowedCardNetworksItem(String allowedCardNetworksItem)`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`addAllowedPaymentTypesItem(String allowedPaymentTypesItem)`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`addTargetOriginsItem(String targetOriginsItem)`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`allowedCardNetworks(List<String> allowedCardNetworks)`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`allowedPaymentTypes(List<String> allowedPaymentTypes)`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`appearance(Ucv1sessionsAppearance appearance)`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`buttonType(String buttonType)`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`captureMandate(Ucv1sessionsCaptureMandate captureMandate)`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`clientVersion(String clientVersion)`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`completeMandate(Ucv1sessionsCompleteMandate completeMandate)`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`country(String country)`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`data(Ucv1sessionsData data)`
`boolean`	`equals(Object o)`
`List<String>`	`getAllowedCardNetworks()`	The list of card networks you want to use for this Unified Checkout transaction.
`List<String>`	`getAllowedPaymentTypes()`	The payment types that are allowed for the merchant.
`Ucv1sessionsAppearance`	`getAppearance()`	Get appearance
`String`	`getButtonType()`	Changes the label on the payment button within Unified Checkout .<br><br> Possible values: - ADD_CARD - CARD_PAYMENT - CHECKOUT - CHECKOUT_AND_CONTINUE - DEBIT_CREDIT - DONATE - PAY - PAY_WITH_CARD - SAVE_CARD - SUBSCRIBE_WITH_CARD<br><br> The default value is CHECKOUT.
`Ucv1sessionsCaptureMandate`	`getCaptureMandate()`	Get captureMandate
`String`	`getClientVersion()`	This field is used to specify the Unified Checkout API version your integration should use.
`Ucv1sessionsCompleteMandate`	`getCompleteMandate()`	Get completeMandate
`String`	`getCountry()`	Country the purchase is originating from (e.g.
`Ucv1sessionsData`	`getData()`	Get data
`String`	`getLocale()`	Localization of the User experience conforming to the ISO 639 language standards and two-character ISO Standard Country Code.<br><br> Locale must be in the format: <ISO 639 language code>_<ISO 3166 region code> Please refer to list of [supported locales through Unified Checkout](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-appendix-languages.html)<br><br> Required field: This field cannot be configured through the Merchant Experience screens in the Business Center and must be provided on a per‑transaction basis in the uc/v1/sessions API request.
`Ucv1sessionsPaymentConfigurations`	`getPaymentConfigurations()`	Get paymentConfigurations
`List<String>`	`getTargetOrigins()`	The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Unified Checkout is defined by the scheme (protocol), hostname (domain) and port number (if used).
`Ucv1sessionsTransientTokenResponseOptions`	`getTransientTokenResponseOptions()`	Get transientTokenResponseOptions
`int`	`hashCode()`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`locale(String locale)`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`paymentConfigurations(Ucv1sessionsPaymentConfigurations paymentConfigurations)`
`void`	`setAllowedCardNetworks(List<String> allowedCardNetworks)`
`void`	`setAllowedPaymentTypes(List<String> allowedPaymentTypes)`
`void`	`setAppearance(Ucv1sessionsAppearance appearance)`
`void`	`setButtonType(String buttonType)`
`void`	`setCaptureMandate(Ucv1sessionsCaptureMandate captureMandate)`
`void`	`setClientVersion(String clientVersion)`
`void`	`setCompleteMandate(Ucv1sessionsCompleteMandate completeMandate)`
`void`	`setCountry(String country)`
`void`	`setData(Ucv1sessionsData data)`
`void`	`setLocale(String locale)`
`void`	`setPaymentConfigurations(Ucv1sessionsPaymentConfigurations paymentConfigurations)`
`void`	`setTargetOrigins(List<String> targetOrigins)`
`void`	`setTransientTokenResponseOptions(Ucv1sessionsTransientTokenResponseOptions transientTokenResponseOptions)`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`targetOrigins(List<String> targetOrigins)`
`String`	`toString()`
`GenerateUnifiedCheckoutV1CaptureContextRequest`	`transientTokenResponseOptions(Ucv1sessionsTransientTokenResponseOptions transientTokenResponseOptions)`

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

- Constructor Detail
 - GenerateUnifiedCheckoutV1CaptureContextRequest
```
public GenerateUnifiedCheckoutV1CaptureContextRequest()
```
- Method Detail
 - clientVersion
```
public GenerateUnifiedCheckoutV1CaptureContextRequest clientVersion(String clientVersion)
```
 - getClientVersion
```
public String getClientVersion()
```
 This field is used to specify the Unified Checkout API version your integration should use. The recommended approach is to omit this field from the uc/v1/sessions API request. When omitted, Unified Checkout automatically uses the latest available version, ensuring access to the most recent enhancements and updates without requiring integration changes. If included, the value must be provided in Major.Minor format (for example, 1.1 or 1.2). Optional field: This field cannot be configured through the Merchant Experience screens in the Business Center but can be provided in the uc/v1/sessions API request.
 
 Returns:
 
 clientVersion
 - setClientVersion
```
public void setClientVersion(String clientVersion)
```
 - targetOrigins
```
public GenerateUnifiedCheckoutV1CaptureContextRequest targetOrigins(List<String> targetOrigins)
```
 - addTargetOriginsItem
```
public GenerateUnifiedCheckoutV1CaptureContextRequest addTargetOriginsItem(String targetOriginsItem)
```
 - getTargetOrigins
```
public List<String> getTargetOrigins()
```
 The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Unified Checkout is defined by the scheme (protocol), hostname (domain) and port number (if used). You must use https://hostname. The following is NOT supported: http://localhost Wildcards are NOT supported. Ensure that subdomains are included. Any valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc) Examples: - https://example.com - https://subdomain.example.com - https://example.com:8080 If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example: targetOrigins: [ \"https://example.com\", \"https://basket.example.com\", \"https://ecom.example.com\" ] You can supply up to seven origins within the targetOrigins field for nested iframes. If the list of origins exceeds five ensure that you: - Compare the list of origins in the v1/sessions targetOrigins field against the location.ancestorOrigins of the browser. - Ensure that the count of origins and their content matches in both. If any origins are absent or mismatched, the system will prevent Unified Checkout from loading and display a client-side error message. Required field: This field cannot be configured through the Merchant Experience Screens in the Business Center and must be provided on a per transaction basis via the uc/v1/sessions API request.
 
 Returns:
 
 targetOrigins
 - setTargetOrigins
```
public void setTargetOrigins(List<String> targetOrigins)
```
 - allowedCardNetworks
```
public GenerateUnifiedCheckoutV1CaptureContextRequest allowedCardNetworks(List<String> allowedCardNetworks)
```
 - addAllowedCardNetworksItem
```
public GenerateUnifiedCheckoutV1CaptureContextRequest addAllowedCardNetworksItem(String allowedCardNetworksItem)
```
 - getAllowedCardNetworks
```
public List<String> getAllowedCardNetworks()
```
 The list of card networks you want to use for this Unified Checkout transaction. Unified Checkout currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JAYWAN - JCB - JCREW - KCP - MADA - MAESTRO - MEEZA - PAYPAK - UATP 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:
 
 allowedCardNetworks
 - setAllowedCardNetworks
```
public void setAllowedCardNetworks(List<String> allowedCardNetworks)
```
 - allowedPaymentTypes
```
public GenerateUnifiedCheckoutV1CaptureContextRequest allowedPaymentTypes(List<String> allowedPaymentTypes)
```
 - addAllowedPaymentTypesItem
```
public GenerateUnifiedCheckoutV1CaptureContextRequest addAllowedPaymentTypesItem(String allowedPaymentTypesItem)
```
 - getAllowedPaymentTypes
```
public List<String> getAllowedPaymentTypes()
```
 The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE - TMS_TOKEN Unified Checkout supports the following wallet based payment methods: - PayPal v2: PAYPAL - Venmo: VENMO Unified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods: - Cash App Afterpay (US): AFTERPAY - Clearpay (GB): AFTERPAY - Afterpay (CA, AU, NZ): AFTERPAY Unified Checkout supports the following Online Bank Transfer payment methods: - Bancontact (BE): BANCONTACT - DragonPay (PH): DRAGONPAY - iDEAL (NL): IDEAL - Multibanco (PT): MULTIBANCO - MyBank (IT, BE, PT, ES): MYBANK - Przelewy24|P24 (PL): PRZELEWY24 - Tink Pay By Bank (DE, ES, FR, GB, IE, NL): TINKPAYBYBANK Unified Checkout supports the following Post-Pay Reference payment methods: - Konbini (JP): KONBINI Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY - PANENTRY **Important:** - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field. 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:
 
 allowedPaymentTypes
 - setAllowedPaymentTypes
```
public void setAllowedPaymentTypes(List<String> allowedPaymentTypes)
```
 - paymentConfigurations
```
public GenerateUnifiedCheckoutV1CaptureContextRequest paymentConfigurations(Ucv1sessionsPaymentConfigurations paymentConfigurations)
```
 - getPaymentConfigurations
```
public Ucv1sessionsPaymentConfigurations getPaymentConfigurations()
```
 Get paymentConfigurations
 
 Returns:
 
 paymentConfigurations
 - setPaymentConfigurations
```
public void setPaymentConfigurations(Ucv1sessionsPaymentConfigurations paymentConfigurations)
```
 - appearance
```
public GenerateUnifiedCheckoutV1CaptureContextRequest appearance(Ucv1sessionsAppearance appearance)
```
 - getAppearance
```
public Ucv1sessionsAppearance getAppearance()
```
 Get appearance
 
 Returns:
 
 appearance
 - setAppearance
```
public void setAppearance(Ucv1sessionsAppearance appearance)
```
 - country
```
public GenerateUnifiedCheckoutV1CaptureContextRequest country(String country)
```
 - getCountry
```
public String getCountry()
```
 Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard Country must be in the format: ISO 3166 country code Required field: This field cannot be configured through the Merchant Experience screens in the Business Center and must be provided on a per‑transaction basis in the uc/v1/sessions API request.
 
 Returns:
 
 country
 - setCountry
```
public void setCountry(String country)
```
 - locale
```
public GenerateUnifiedCheckoutV1CaptureContextRequest locale(String locale)
```
 - getLocale
```
public String getLocale()
```
 Localization of the User experience conforming to the ISO 639 language standards and two-character ISO Standard Country Code. Locale must be in the format: <ISO 639 language code>_<ISO 3166 region code> Please refer to list of [supported locales through Unified Checkout](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-appendix-languages.html) Required field: This field cannot be configured through the Merchant Experience screens in the Business Center and must be provided on a per‑transaction basis in the uc/v1/sessions API request.
 
 Returns:
 
 locale
 - setLocale
```
public void setLocale(String locale)
```
 - buttonType
```
public GenerateUnifiedCheckoutV1CaptureContextRequest buttonType(String buttonType)
```
 - getButtonType
```
public String getButtonType()
```
 Changes the label on the payment button within Unified Checkout . Possible values: - ADD_CARD - CARD_PAYMENT - CHECKOUT - CHECKOUT_AND_CONTINUE - DEBIT_CREDIT - DONATE - PAY - PAY_WITH_CARD - SAVE_CARD - SUBSCRIBE_WITH_CARD The default value is 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:
 
 buttonType
 - setButtonType
```
public void setButtonType(String buttonType)
```
 - captureMandate
```
public GenerateUnifiedCheckoutV1CaptureContextRequest captureMandate(Ucv1sessionsCaptureMandate captureMandate)
```
 - getCaptureMandate
```
public Ucv1sessionsCaptureMandate getCaptureMandate()
```
 Get captureMandate
 
 Returns:
 
 captureMandate
 - setCaptureMandate
```
public void setCaptureMandate(Ucv1sessionsCaptureMandate captureMandate)
```
 - completeMandate
```
public GenerateUnifiedCheckoutV1CaptureContextRequest completeMandate(Ucv1sessionsCompleteMandate completeMandate)
```
 - getCompleteMandate
```
public Ucv1sessionsCompleteMandate getCompleteMandate()
```
 Get completeMandate
 
 Returns:
 
 completeMandate
 - setCompleteMandate
```
public void setCompleteMandate(Ucv1sessionsCompleteMandate completeMandate)
```
 - transientTokenResponseOptions
```
public GenerateUnifiedCheckoutV1CaptureContextRequest transientTokenResponseOptions(Ucv1sessionsTransientTokenResponseOptions transientTokenResponseOptions)
```
 - getTransientTokenResponseOptions
```
public Ucv1sessionsTransientTokenResponseOptions getTransientTokenResponseOptions()
```
 Get transientTokenResponseOptions
 
 Returns:
 
 transientTokenResponseOptions
 - setTransientTokenResponseOptions
```
public void setTransientTokenResponseOptions(Ucv1sessionsTransientTokenResponseOptions transientTokenResponseOptions)
```
 - data
```
public GenerateUnifiedCheckoutV1CaptureContextRequest data(Ucv1sessionsData data)
```
 - getData
```
public Ucv1sessionsData getData()
```
 Get data
 
 Returns:
 
 data
 - setData
```
public void setData(Ucv1sessionsData data)
```
 - 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 GenerateUnifiedCheckoutV1CaptureContextRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GenerateUnifiedCheckoutV1CaptureContextRequest

Method Detail

clientVersion

getClientVersion

setClientVersion

targetOrigins

addTargetOriginsItem

getTargetOrigins

setTargetOrigins

allowedCardNetworks

addAllowedCardNetworksItem

getAllowedCardNetworks

setAllowedCardNetworks

allowedPaymentTypes

addAllowedPaymentTypesItem

getAllowedPaymentTypes

setAllowedPaymentTypes

paymentConfigurations

getPaymentConfigurations

setPaymentConfigurations

appearance

getAppearance

setAppearance

country

getCountry

setCountry

locale

getLocale

setLocale

buttonType

getButtonType

setButtonType

captureMandate

getCaptureMandate

setCaptureMandate

completeMandate

getCompleteMandate

setCompleteMandate

transientTokenResponseOptions

getTransientTokenResponseOptions

setTransientTokenResponseOptions

data

getData

setData

equals

hashCode

toString