|
| 1 | + |
| 2 | +# GenerateUnifiedCheckoutV1CaptureContextRequest |
| 3 | + |
| 4 | +## Properties |
| 5 | +Name | Type | Description | Notes |
| 6 | +------------ | ------------- | ------------- | ------------- |
| 7 | +**clientVersion** | **String** | 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).<br><br> 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. | [optional] |
| 8 | +**targetOrigins** | **List<String>** | 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 (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<br><br> 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\" ]<br><br> 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.<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 via the uc/v1/sessions API request. | [optional] |
| 9 | +**allowedCardNetworks** | **List<String>** | 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<br><br> 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. | [optional] |
| 10 | +**allowedPaymentTypes** | **List<String>** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE - TMS_TOKEN<br><br> 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<br><br> 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 (GB): TINKPAYBYBANK<br><br> Unified Checkout supports the following Post-Pay Reference payment methods: - Konbini (JP): KONBINI<br><br> Unified Checkout supports the following wallet based payment methods: - PayPal v2: PAYPAL - Venmo: VENMO <br><br> Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY - PANENTRY <br><br> **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.<br><br> 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. | [optional] |
| 11 | +**paymentConfigurations** | [**Ucv1sessionsPaymentConfigurations**](Ucv1sessionsPaymentConfigurations.md) | | [optional] |
| 12 | +**appearance** | [**Ucv1sessionsAppearance**](Ucv1sessionsAppearance.md) | | [optional] |
| 13 | +**country** | **String** | Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard<br> Country must be in the format: ISO 3166 country code<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. | [optional] |
| 14 | +**locale** | **String** | 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. | [optional] |
| 15 | +**buttonType** | **String** | 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. <br><br> 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. | [optional] |
| 16 | +**captureMandate** | [**Ucv1sessionsCaptureMandate**](Ucv1sessionsCaptureMandate.md) | | [optional] |
| 17 | +**completeMandate** | [**Ucv1sessionsCompleteMandate**](Ucv1sessionsCompleteMandate.md) | | [optional] |
| 18 | +**transientTokenResponseOptions** | [**Ucv1sessionsTransientTokenResponseOptions**](Ucv1sessionsTransientTokenResponseOptions.md) | | [optional] |
| 19 | +**data** | [**Ucv1sessionsData**](Ucv1sessionsData.md) | | [optional] |
| 20 | + |
| 21 | + |
| 22 | + |
0 commit comments