Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

February 2025 #180

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ The API Reference Guide provides examples of what information is needed for a pa
To learn more about how to use CyberSource's REST API SDKs, please use [Developer Center REST API SDKs](https://developer.cybersource.com/hello-world/rest-api-sdks.html)
.

## Security Guidance

* It is strongly recommended to use HTTPS for any proxy servers in your environment to protect secrets during transit.


### Example using Sample Code Application

* Add the [CyberSource REST client as a dependency](https://github.com/CyberSource/cybersource-rest-samples-java/blob/a34f25a384e1fa982f5bb336225e3e37ca3e245d/pom.xml#L20C3-L24C16) in your java project.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**parentProfileId** | **String** | Specify the Vault ID to which transacting MID needs to be assigned.Provide Vault ID as seen on EBC Vault management page. If not provided , transacting MID will be assigned to the existing default Vault at merchant's level. If there are no Vaults at merchant level , a new Vault will be created and transacting MID will be assigned to it. | [optional]
**vault** | [**CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault**](CommerceSolutionsProductsTokenManagementConfigurationInformationConfigurationsVault.md) | | [optional]
**networkTokenEnrollment** | [**NetworkTokenEnrollment**](NetworkTokenEnrollment.md) | | [optional]



3 changes: 2 additions & 1 deletion docs/GenerateCaptureContextRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**clientVersion** | **String** | Specify the version of Microform that you want to use. | [optional]
**targetOrigins** | **List<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\" ] | [optional]
**allowedCardNetworks** | **List<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 **Important:** - When integrating Microform (Accept Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (Accept Check) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Accept Card) and Microform (Accept Check) at least one card network should be specified in the allowedCardNetworks field in the capture context request. | [optional]
**allowedCardNetworks** | **List<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 **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]
**allowedPaymentTypes** | **List<String>** | The payment types that are allowed for the merchant. Possible values when launching Microform: - CARD - CHECK <br><br> | [optional]
**transientTokenResponseOptions** | [**Microformv2sessionsTransientTokenResponseOptions**](Microformv2sessionsTransientTokenResponseOptions.md) | | [optional]



1 change: 1 addition & 0 deletions docs/GenerateUnifiedCheckoutCaptureContextRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Name | Type | Description | Notes
**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]
**captureMandate** | [**Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) | | [optional]
**orderInformation** | [**Upv1capturecontextsOrderInformation**](Upv1capturecontextsOrderInformation.md) | | [optional]
**transientTokenResponseOptions** | [**Microformv2sessionsTransientTokenResponseOptions**](Microformv2sessionsTransientTokenResponseOptions.md) | | [optional]



10 changes: 10 additions & 0 deletions docs/Microformv2sessionsTransientTokenResponseOptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

# Microformv2sessionsTransientTokenResponseOptions

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**includeCardPrefix** | **Boolean** | Use the transientTokenResponseOptions.includeCardPrefix field to choose your preferred card number prefix length: 6-digit, 8-digit, or no card number prefix. Possible values: - True - False<br><br> To select the type of card number prefix: - No field included: A 6-digit prefix is returned (default) - True: An 8-digit prefix is returned - False: No prefix is returned<br><br> The following conditions apply: - 8-digit card number prefixes only apply to Discover, JCB, Mastercard, UnionPay, and Visa brands with 16-digit card numbers or more. - Any card with less than 16-digit numbers will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true. - Any card brand other than Discover, JCB, Mastercard, UnionPay, or Visa will return a 6-digit prefix even when the transientTokenResponseOptions.includeCardPrefix field is set to true. - If any card brand is co-branded with Discover, JCB, Mastercard, UnionPay, or Visa, an 8-digit prefix will be returned if the transientTokenResponseOptions.includeCardPrefix field is set to true.<br><br> **Important:** If your application does NOT require a card number prefix for routing or identification purposes, set the transientTokenResponseOptions.includeCardPrefix field to False. This will minimize your personal data exposure. | [optional]



11 changes: 11 additions & 0 deletions docs/NetworkTokenEnrollment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

# NetworkTokenEnrollment

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**businessInformation** | [**TmsBusinessInformation**](TmsBusinessInformation.md) | | [optional]
**networkTokenServices** | [**NetworkTokenServicesEnablement**](NetworkTokenServicesEnablement.md) | | [optional]



11 changes: 11 additions & 0 deletions docs/NetworkTokenServicesEnablement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

# NetworkTokenServicesEnablement

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**visaTokenService** | [**NetworkTokenServicesEnablementVisaTokenService**](NetworkTokenServicesEnablementVisaTokenService.md) | | [optional]
**mastercardDigitalEnablementService** | [**NetworkTokenServicesEnablementMastercardDigitalEnablementService**](NetworkTokenServicesEnablementMastercardDigitalEnablementService.md) | | [optional]



Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

# NetworkTokenServicesEnablementMastercardDigitalEnablementService

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enrollment** | **Boolean** | Indicates if an enrollment to create a TRID for the MasterCard card association should be attempted | [optional]



10 changes: 10 additions & 0 deletions docs/NetworkTokenServicesEnablementVisaTokenService.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@

# NetworkTokenServicesEnablementVisaTokenService

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enrollment** | **Boolean** | Indicates if an enrollment to create a TRID for the Visa card association should be attempted | [optional]



16 changes: 16 additions & 0 deletions docs/TmsBusinessInformation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

# TmsBusinessInformation

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of the network token merchant. | [optional]
**doingBusinessAs** | **String** | Name the network token merchant does business as | [optional]
**address** | [**TmsBusinessInformationAddress**](TmsBusinessInformationAddress.md) | | [optional]
**websiteUrl** | **String** | Website of network token merchant. | [optional]
**businessIdentificationType** | **String** | The Identifier associated with the business type; required unless both acquirerId and acquirerMerchantId are provided. | [optional]
**businessIdentificationValue** | **String** | The value associated with the business identifier type; required unless both acquirerId and acquirerMerchantId are provided. | [optional]
**acquirer** | [**TmsBusinessInformationAcquirer**](TmsBusinessInformationAcquirer.md) | | [optional]



11 changes: 11 additions & 0 deletions docs/TmsBusinessInformationAcquirer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

# TmsBusinessInformationAcquirer

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**acquirerId** | **String** | Acquirer ID; required unless both businessIdentificationType and businessIdentificationValue are provided. | [optional]
**acquirerMerchantId** | **String** | Acquirer merchant ID; required unless both businessIdentificationType and businessIdentificationValue are provided. | [optional]



11 changes: 11 additions & 0 deletions docs/TmsBusinessInformationAddress.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

# TmsBusinessInformationAddress

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**country** | **String** | Country of network token merchant. | [optional]
**locality** | **String** | City of network token merchant. | [optional]



2 changes: 2 additions & 0 deletions docs/Upv1capturecontextsCaptureMandate.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Name | Type | Description | Notes
**requestShipping** | **Boolean** | Configure Unified Checkout to capture customer shipping details. Possible values: - True - False | [optional]
**shipToCountries** | **List<String>** | List of countries available to ship to. Use the two-character ISO Standard Country Codes. | [optional]
**showAcceptedNetworkIcons** | **Boolean** | Configure Unified Checkout to display the list of accepted card networks beneath the payment button Possible values: - True - False | [optional]
**requestSaveCard** | **Boolean** | 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. Possible values: - True - False<br><br> **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.<br><br> **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]
**comboCard** | **Boolean** | 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. 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<br><br> **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 <br><br> **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]



Loading