You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**clientVersion** | **String** | Specify the version of Microform that you want to use. | [optional]
7
7
**targetOrigins** | **[String]** | 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<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 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. | [optional]
8
-
**allowedCardNetworks** | **[String]** | 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 - PAYPAK **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. | [optional]
8
+
**allowedCardNetworks** | **[String]** | 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 - JAYWAN - JCB - JCREW - KCP - MADA - MAESTRO - MEEZA - PAYPAK - UATP**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. | [optional]
9
9
**allowedPaymentTypes** | **[String]** | The payment types that are allowed for the merchant. Possible values when launching Microform: - CARD - CHECK <br><br> | [optional]
**clientVersion** | **String** | Specify the version of Unified Checkout that you want to use. | [optional]
7
7
**targetOrigins** | **[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\" ] | [optional]
8
-
**allowedCardNetworks** | **[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 - JCB - JCREW - MADA - MAESTRO - MEEZA - PAYPAK | [optional]
9
-
**allowedPaymentTypes** | **[String]** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Unified Checkout also supports the following Alternative Payments: - AFTERPAY<br><br> Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <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> **Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.<br><br> **Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa<br><br> If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. | [optional]
8
+
**allowedCardNetworks** | **[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 | [optional]
9
+
**allowedPaymentTypes** | **[String]** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Unified Checkout supports the following Buy Now, Pay Later (BNPL) payment methods: - AFTERPAY<br><br> Unified Checkout supports the following Online Bank Transfer payment methods: - Bancontact (BE) - DragonPay (PH) - iDEAL (NL) - Multibanco (PT) - MyBank (IT, BE, PT, ES) - Przelewy24|P24 (PL) - Tink Pay By Bank (GB) Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <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> **Managing Google Pay Authentication Types** When you enable Google Pay on Unified Checkout you can specify optional parameters that define the types of card authentication you receive from Google Pay.<br><br> **Managing Google Pay Authentication Types** Where Click to Pay is the payment type selected by the customer and the customer manually enters their card, the option to enroll their card in Click to Pay will be auto-checked if this field is set to \"true\". This is only available where the merchant and cardholder are based in the following countries and the billing type is set to \"FULL\" or \"PARTIAL\". - UAE - Argentina - Brazil - Chile - Colombia - Kuwait - Mexico - Peru - Qatar - Saudi Arabia - Ukraine - South Africa<br><br> If false, this is not present or not supported in the market. Enrollment in Click to Pay is not checked for the customer when completing manual card entry. | [optional]
10
10
**country** | **String** | Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard | [optional]
11
11
**locale** | **String** | Localization of the User experience conforming to the ISO 639-1 language standards and two-character ISO Standard Country 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) | [optional]
**id** | **String** | Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid |
8
+
**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`**Example**`2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. |
9
+
**status** | **String** | Message describing the status of the currency conversion request. Values: - `PENDING` - `DECLINED` - `INVALID_REQUEST` - `SERVER_ERROR` - `OFFER_DECLINED` - `AUTHORIZED` - `AUTHORIZATION_DECLINED` - `AUTHORIZATION_FAILURE` - `REVERSED` - `CAPTURED` - `REFUNDED` - `CANCELLED` |
**code** | **String** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. | [optional]
7
+
**applicationName** | **String** | The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource. | [optional]
8
+
**applicationVersion** | **String** | Version of the CyberSource application or integration used for a transaction. | [optional]
9
+
**applicationUser** | **String** | The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method. | [optional]
**id** | **String** | Request ID generated by Cybersource. This was sent in the header on the request. Echo value from x-requestid |
8
+
**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`**Example**`2023-05-17T22:47:57Z` equals May 17, 2023, at 22:47:57 (10:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC. |
9
+
**status** | **String** | Message describing the status of the currency conversion request. Possible values: - PENDING - DECLINED - SERVER_ERROR |
**code** | **String** | Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. | [optional]
**reason** | **String** | Only required when offer cannot be made. The reason of the status. Possible values: - 'INVALID_MERCHANT_CONFIGURATION' - 'NOT_ELIGIBLE' - 'CURRENCY_NOT_CONFIGURED' - 'BIN_UNKNOWN' - 'CURRENCY_MATCH' - 'CURRENCY_NOT_ALLOWED' - 'LOOKUP_FAILED' - 'EXCHANGE_RATE_NOT_FOUND' - 'CARD_TYPE_NOT_ACCEPTED' - 'INVALID_AMOUNT' - 'INVALID_CARD' - 'INVALID_CURRENCY' - 'INVALID_TERMINAL' - 'INVALID_ACQUIRER' - 'SERVICE_DISABLED' - 'DUPLICATE_REQUEST' - 'UNKNOWN' - 'PROCESSOR_ERROR' | [optional]
7
+
**message** | **String** | Only required when the requested action cannot be performed. Descriptive message to add more detail to the status E.g. not all cards are eligible for DCC, so it is not possible for DCC to be offered. | [optional]
**type** | **String** | Valid Values: - `DCC`: Dynamic Currency Conversion - `MCP`: Multi-Currency Pricing This should be echo'd from the request | [optional]
7
+
**reconciliationId** | **String** | Unique identifier generated by the DCC provider. |
8
+
**offer** | [**[InlineResponse2018OrderInformationCurrencyConversionOffer]**](InlineResponse2018OrderInformationCurrencyConversionOffer.md) | When type is DCC this is a single item. When type is MCP this is an array that repeats for each currency that's configured by the currency conversion provider for the merchant. | [optional]
9
+
**disclaimer** | **String** | This text is intended to inform customers about their opt-in choices. It should include details such as the amount, exchange rate, currency, mark-up, and any other regulated requirements, such as the mark-up over the ECB rate, if applicable. It is mandatory for DCC (Dynamic Currency Conversion) and optional otherwise. This information will be displayed on the screen and printed on the receipt without modification. | [optional]
0 commit comments