GenerateCaptureContextRequest (cybersource-rest-client-java 0.0.76 API)

java.lang.Object
- Model.GenerateCaptureContextRequest

```
public class GenerateCaptureContextRequest
extends Object
```
This is a server-to-server API request to generate the capture context that can be used to initiate an instance of Microform on an acceptance page. The capture context is a digitally signed JWT that provides authentication, one-time keys, and the target origin to the Microform Integration application.

Constructor Summary

Constructors
Constructor and Description

GenerateCaptureContextRequest()

Constructors
Constructor and Description
`GenerateCaptureContextRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GenerateCaptureContextRequest`	`addAllowedCardNetworksItem(String allowedCardNetworksItem)`
`GenerateCaptureContextRequest`	`addAllowedPaymentTypesItem(String allowedPaymentTypesItem)`
`GenerateCaptureContextRequest`	`addTargetOriginsItem(String targetOriginsItem)`
`GenerateCaptureContextRequest`	`allowedCardNetworks(List<String> allowedCardNetworks)`
`GenerateCaptureContextRequest`	`allowedPaymentTypes(List<String> allowedPaymentTypes)`
`GenerateCaptureContextRequest`	`clientVersion(String clientVersion)`
`boolean`	`equals(Object o)`
`List<String>`	`getAllowedCardNetworks()` The list of card networks you want to use for this Microform transaction.
`List<String>`	`getAllowedPaymentTypes()` The payment types that are allowed for the merchant.
`String`	`getClientVersion()` Specify the version of Microform that you want to use.
`List<String>`	`getTargetOrigins()` The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Microform is defined by the scheme (protocol), hostname (domain) and port number (if used).
`Microformv2sessionsTransientTokenResponseOptions`	`getTransientTokenResponseOptions()` Get transientTokenResponseOptions
`int`	`hashCode()`
`void`	`setAllowedCardNetworks(List<String> allowedCardNetworks)`
`void`	`setAllowedPaymentTypes(List<String> allowedPaymentTypes)`
`void`	`setClientVersion(String clientVersion)`
`void`	`setTargetOrigins(List<String> targetOrigins)`
`void`	`setTransientTokenResponseOptions(Microformv2sessionsTransientTokenResponseOptions transientTokenResponseOptions)`
`GenerateCaptureContextRequest`	`targetOrigins(List<String> targetOrigins)`
`String`	`toString()`
`GenerateCaptureContextRequest`	`transientTokenResponseOptions(Microformv2sessionsTransientTokenResponseOptions transientTokenResponseOptions)`

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

- Constructor Detail
 - GenerateCaptureContextRequest
```
public GenerateCaptureContextRequest()
```
- Method Detail
 - clientVersion
```
public GenerateCaptureContextRequest clientVersion(String clientVersion)
```
 - getClientVersion
```
public String getClientVersion()
```
 Specify the version of Microform that you want to use.
 
 Returns:
 
 clientVersion
 - setClientVersion
```
public void setClientVersion(String clientVersion)
```
 - targetOrigins
```
public GenerateCaptureContextRequest targetOrigins(List<String> targetOrigins)
```
 - addTargetOriginsItem
```
public GenerateCaptureContextRequest 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 Microform is defined by the scheme (protocol), hostname (domain) and port number (if used). You must use https://hostname (unless you use 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 nine 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 v2/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 Microform from loading and display a client-side error message.
 
 Returns:
 
 targetOrigins
 - setTargetOrigins
```
public void setTargetOrigins(List<String> targetOrigins)
```
 - allowedCardNetworks
```
public GenerateCaptureContextRequest allowedCardNetworks(List<String> allowedCardNetworks)
```
 - addAllowedCardNetworksItem
```
public GenerateCaptureContextRequest addAllowedCardNetworksItem(String allowedCardNetworksItem)
```
 - getAllowedCardNetworks
```
public List<String> getAllowedCardNetworks()
```
 The list of card networks you want to use for this Microform transaction. Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA **Important:** - When integrating Microform (Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (ACH/eCheck) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Card) and Microform (ACH/eCheck) at least one card network should be specified in the allowedCardNetworks field in the capture context request.
 
 Returns:
 
 allowedCardNetworks
 - setAllowedCardNetworks
```
public void setAllowedCardNetworks(List<String> allowedCardNetworks)
```
 - allowedPaymentTypes
```
public GenerateCaptureContextRequest allowedPaymentTypes(List<String> allowedPaymentTypes)
```
 - addAllowedPaymentTypesItem
```
public GenerateCaptureContextRequest addAllowedPaymentTypesItem(String allowedPaymentTypesItem)
```
 - getAllowedPaymentTypes
```
public List<String> getAllowedPaymentTypes()
```
 The payment types that are allowed for the merchant. Possible values when launching Microform: - CARD - CHECK 
 
 Returns:
 
 allowedPaymentTypes
 - setAllowedPaymentTypes
```
public void setAllowedPaymentTypes(List<String> allowedPaymentTypes)
```
 - transientTokenResponseOptions
```
public GenerateCaptureContextRequest transientTokenResponseOptions(Microformv2sessionsTransientTokenResponseOptions transientTokenResponseOptions)
```
 - getTransientTokenResponseOptions
```
public Microformv2sessionsTransientTokenResponseOptions getTransientTokenResponseOptions()
```
 Get transientTokenResponseOptions
 
 Returns:
 
 transientTokenResponseOptions
 - setTransientTokenResponseOptions
```
public void setTransientTokenResponseOptions(Microformv2sessionsTransientTokenResponseOptions transientTokenResponseOptions)
```
 - 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 GenerateCaptureContextRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GenerateCaptureContextRequest

Method Detail

clientVersion

getClientVersion

setClientVersion

targetOrigins

addTargetOriginsItem

getTargetOrigins

setTargetOrigins

allowedCardNetworks

addAllowedCardNetworksItem

getAllowedCardNetworks

setAllowedCardNetworks

allowedPaymentTypes

addAllowedPaymentTypesItem

getAllowedPaymentTypes

setAllowedPaymentTypes

transientTokenResponseOptions

getTransientTokenResponseOptions

setTransientTokenResponseOptions

equals

hashCode

toString