diff --git a/docs/Body.md b/docs/Body.md deleted file mode 100644 index 04e75776f..000000000 --- a/docs/Body.md +++ /dev/null @@ -1,32 +0,0 @@ - -# Body - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**Tmsv1instrumentidentifiersLinks**](Tmsv1instrumentidentifiersLinks.md) | | [optional] -**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional] -**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. | [optional] -**state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] -**card** | [**Tmsv1instrumentidentifiersCard**](Tmsv1instrumentidentifiersCard.md) | | [optional] -**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional] -**processingInformation** | [**Tmsv1instrumentidentifiersProcessingInformation**](Tmsv1instrumentidentifiersProcessingInformation.md) | | [optional] -**metadata** | [**Tmsv1instrumentidentifiersMetadata**](Tmsv1instrumentidentifiersMetadata.md) | | [optional] - - - -## Enum: ObjectEnum -Name | Value ----- | ----- -INSTRUMENTIDENTIFIER | "instrumentIdentifier" - - - -## Enum: StateEnum -Name | Value ----- | ----- -ACTIVE | "ACTIVE" -CLOSED | "CLOSED" - - - diff --git a/docs/Body1.md b/docs/Body1.md deleted file mode 100644 index f4b1ab745..000000000 --- a/docs/Body1.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Body1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**processingInformation** | [**Tmsv1instrumentidentifiersProcessingInformation**](Tmsv1instrumentidentifiersProcessingInformation.md) | | [optional] - - - diff --git a/docs/Body2.md b/docs/Body2.md deleted file mode 100644 index 9c5183ad0..000000000 --- a/docs/Body2.md +++ /dev/null @@ -1,36 +0,0 @@ - -# Body2 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**Tmsv1instrumentidentifiersLinks**](Tmsv1instrumentidentifiersLinks.md) | | [optional] -**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional] -**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. | [optional] -**state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] -**bankAccount** | [**Tmsv1paymentinstrumentsBankAccount**](Tmsv1paymentinstrumentsBankAccount.md) | | [optional] -**card** | [**Tmsv1paymentinstrumentsCard**](Tmsv1paymentinstrumentsCard.md) | | [optional] -**buyerInformation** | [**Tmsv1paymentinstrumentsBuyerInformation**](Tmsv1paymentinstrumentsBuyerInformation.md) | | [optional] -**billTo** | [**Tmsv1paymentinstrumentsBillTo**](Tmsv1paymentinstrumentsBillTo.md) | | [optional] -**processingInformation** | [**Tmsv1paymentinstrumentsProcessingInformation**](Tmsv1paymentinstrumentsProcessingInformation.md) | | [optional] -**merchantInformation** | [**Tmsv1paymentinstrumentsMerchantInformation**](Tmsv1paymentinstrumentsMerchantInformation.md) | | [optional] -**metaData** | [**Tmsv1instrumentidentifiersMetadata**](Tmsv1instrumentidentifiersMetadata.md) | | [optional] -**instrumentIdentifier** | [**Tmsv1paymentinstrumentsInstrumentIdentifier**](Tmsv1paymentinstrumentsInstrumentIdentifier.md) | | [optional] - - - -## Enum: ObjectEnum -Name | Value ----- | ----- -PAYMENTINSTRUMENT | "paymentInstrument" - - - -## Enum: StateEnum -Name | Value ----- | ----- -ACTIVE | "ACTIVE" -CLOSED | "CLOSED" - - - diff --git a/docs/Body3.md b/docs/Body3.md deleted file mode 100644 index c2cc56e20..000000000 --- a/docs/Body3.md +++ /dev/null @@ -1,36 +0,0 @@ - -# Body3 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**Tmsv1instrumentidentifiersLinks**](Tmsv1instrumentidentifiersLinks.md) | | [optional] -**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional] -**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. | [optional] -**state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] -**bankAccount** | [**Tmsv1paymentinstrumentsBankAccount**](Tmsv1paymentinstrumentsBankAccount.md) | | [optional] -**card** | [**Tmsv1paymentinstrumentsCard**](Tmsv1paymentinstrumentsCard.md) | | [optional] -**buyerInformation** | [**Tmsv1paymentinstrumentsBuyerInformation**](Tmsv1paymentinstrumentsBuyerInformation.md) | | [optional] -**billTo** | [**Tmsv1paymentinstrumentsBillTo**](Tmsv1paymentinstrumentsBillTo.md) | | [optional] -**processingInformation** | [**Tmsv1paymentinstrumentsProcessingInformation**](Tmsv1paymentinstrumentsProcessingInformation.md) | | [optional] -**merchantInformation** | [**Tmsv1paymentinstrumentsMerchantInformation**](Tmsv1paymentinstrumentsMerchantInformation.md) | | [optional] -**metaData** | [**Tmsv1instrumentidentifiersMetadata**](Tmsv1instrumentidentifiersMetadata.md) | | [optional] -**instrumentIdentifier** | [**Tmsv1paymentinstrumentsInstrumentIdentifier**](Tmsv1paymentinstrumentsInstrumentIdentifier.md) | | [optional] - - - -## Enum: ObjectEnum -Name | Value ----- | ----- -PAYMENTINSTRUMENT | "paymentInstrument" - - - -## Enum: StateEnum -Name | Value ----- | ----- -ACTIVE | "ACTIVE" -CLOSED | "CLOSED" - - - diff --git a/docs/CardInfo.md b/docs/CardInfo.md deleted file mode 100644 index 3806e3dbd..000000000 --- a/docs/CardInfo.md +++ /dev/null @@ -1,13 +0,0 @@ - -# CardInfo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cardNumber** | **String** | Encrypted or plain text card number. If the encryption type of “None” was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders’ device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request. | [optional] -**cardExpirationMonth** | **String** | Two digit expiration month | [optional] -**cardExpirationYear** | **String** | Four digit expiration year | [optional] -**cardType** | **String** | Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types. | [optional] - - - diff --git a/docs/ConversionDetailsApi.md b/docs/ConversionDetailsApi.md index a735003fd..40f58c92d 100644 --- a/docs/ConversionDetailsApi.md +++ b/docs/ConversionDetailsApi.md @@ -23,8 +23,8 @@ Get conversion detail of transactions for a merchant. ConversionDetailsApi apiInstance = new ConversionDetailsApi(); -DateTime startTime = new DateTime(); // DateTime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX -DateTime endTime = new DateTime(); // DateTime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX +DateTime startTime = new DateTime(); // DateTime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) +DateTime endTime = new DateTime(); // DateTime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) String organizationId = "organizationId_example"; // String | Valid Cybersource Organization Id try { ReportingV3ConversionDetailsGet200Response result = apiInstance.getConversionDetail(startTime, endTime, organizationId); @@ -39,8 +39,8 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **startTime** | **DateTime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX | - **endTime** | **DateTime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX | + **startTime** | **DateTime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | + **endTime** | **DateTime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | **organizationId** | **String**| Valid Cybersource Organization Id | [optional] ### Return type diff --git a/docs/CreateDecisionManagerCaseRequest.md b/docs/CreateDecisionManagerCaseRequest.md new file mode 100644 index 000000000..b514dbeb1 --- /dev/null +++ b/docs/CreateDecisionManagerCaseRequest.md @@ -0,0 +1,19 @@ + +# CreateDecisionManagerCaseRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**clientReferenceInformation** | [**Riskv1decisionsClientReferenceInformation**](Riskv1decisionsClientReferenceInformation.md) | | [optional] +**processorInformation** | [**Riskv1decisionsProcessorInformation**](Riskv1decisionsProcessorInformation.md) | | [optional] +**paymentInformation** | [**Riskv1decisionsPaymentInformation**](Riskv1decisionsPaymentInformation.md) | | [optional] +**orderInformation** | [**Riskv1decisionsOrderInformation**](Riskv1decisionsOrderInformation.md) | | [optional] +**buyerInformation** | [**Riskv1decisionsBuyerInformation**](Riskv1decisionsBuyerInformation.md) | | [optional] +**deviceInformation** | [**Riskv1decisionsDeviceInformation**](Riskv1decisionsDeviceInformation.md) | | [optional] +**cardVerification** | [**Riskv1decisionsCardVerification**](Riskv1decisionsCardVerification.md) | | [optional] +**riskInformation** | [**Riskv1decisionsRiskInformation**](Riskv1decisionsRiskInformation.md) | | [optional] +**travelInformation** | [**Riskv1decisionsTravelInformation**](Riskv1decisionsTravelInformation.md) | | [optional] +**merchantDefinedInformation** | [**List<Riskv1decisionsMerchantDefinedInformation>**](Riskv1decisionsMerchantDefinedInformation.md) | | [optional] + + + diff --git a/docs/CreateInstrumentIdentifierRequest.md b/docs/CreateInstrumentIdentifierRequest.md new file mode 100644 index 000000000..3067fb0af --- /dev/null +++ b/docs/CreateInstrumentIdentifierRequest.md @@ -0,0 +1,12 @@ + +# CreateInstrumentIdentifierRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **String** | Type of Card | [optional] +**card** | [**Tmsv1instrumentidentifiersCard**](Tmsv1instrumentidentifiersCard.md) | | [optional] +**billTo** | [**Tmsv1instrumentidentifiersBillTo**](Tmsv1instrumentidentifiersBillTo.md) | | [optional] + + + diff --git a/docs/CreatePaymentInstrumentRequest.md b/docs/CreatePaymentInstrumentRequest.md new file mode 100644 index 000000000..b21607cb6 --- /dev/null +++ b/docs/CreatePaymentInstrumentRequest.md @@ -0,0 +1,36 @@ + +# CreatePaymentInstrumentRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**TmsV1InstrumentIdentifiersPost200ResponseLinks**](TmsV1InstrumentIdentifiersPost200ResponseLinks.md) | | [optional] +**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional] +**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. | [optional] +**state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] +**bankAccount** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.md) | | [optional] +**card** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.md) | | [optional] +**buyerInformation** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.md) | | [optional] +**billTo** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.md) | | [optional] +**processingInformation** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.md) | | [optional] +**merchantInformation** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.md) | | [optional] +**metaData** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional] +**instrumentIdentifier** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.md) | | [optional] + + + +## Enum: ObjectEnum +Name | Value +---- | ----- +PAYMENTINSTRUMENT | "paymentInstrument" + + + +## Enum: StateEnum +Name | Value +---- | ----- +ACTIVE | "ACTIVE" +CLOSED | "CLOSED" + + + diff --git a/docs/TssV2TransactionsPostResponse.md b/docs/CreateSearchRequest.md similarity index 95% rename from docs/TssV2TransactionsPostResponse.md rename to docs/CreateSearchRequest.md index 6ab882fef..d2b7d7ee9 100644 --- a/docs/TssV2TransactionsPostResponse.md +++ b/docs/CreateSearchRequest.md @@ -1,5 +1,5 @@ -# TssV2TransactionsPostResponse +# CreateSearchRequest ## Properties Name | Type | Description | Notes diff --git a/docs/DecisionManagerApi.md b/docs/DecisionManagerApi.md new file mode 100644 index 000000000..02ccd1b38 --- /dev/null +++ b/docs/DecisionManagerApi.md @@ -0,0 +1,54 @@ +# DecisionManagerApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createDecisionManagerCase**](DecisionManagerApi.md#createDecisionManagerCase) | **POST** /risk/v1/decisions | Create Decision Manager case + + + +# **createDecisionManagerCase** +> RiskV1DecisionsPost201Response createDecisionManagerCase(createDecisionManagerCaseRequest) + +Create Decision Manager case + +This is the combined request to the Decision Manager Service for a transaction sent to Cybersource. Decision Manager will return a decision based on the request values. + +### Example +```java +// Import classes: +//import Invokers.ApiException; +//import Api.DecisionManagerApi; + + +DecisionManagerApi apiInstance = new DecisionManagerApi(); +CreateDecisionManagerCaseRequest createDecisionManagerCaseRequest = new CreateDecisionManagerCaseRequest(); // CreateDecisionManagerCaseRequest | +try { + RiskV1DecisionsPost201Response result = apiInstance.createDecisionManagerCase(createDecisionManagerCaseRequest); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling DecisionManagerApi#createDecisionManagerCase"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **createDecisionManagerCaseRequest** | [**CreateDecisionManagerCaseRequest**](CreateDecisionManagerCaseRequest.md)| | + +### Return type + +[**RiskV1DecisionsPost201Response**](RiskV1DecisionsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json;charset=utf-8 + diff --git a/docs/DefaultApi.md b/docs/DefaultApi.md deleted file mode 100644 index 0e470324d..000000000 --- a/docs/DefaultApi.md +++ /dev/null @@ -1,53 +0,0 @@ -# DefaultApi - -All URIs are relative to *https://api.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**octCreatePayment**](DefaultApi.md#octCreatePayment) | **POST** /v2/payouts/ | Process a Payout - - - -# **octCreatePayment** -> octCreatePayment(octCreatePaymentRequest) - -Process a Payout - -Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using an Original Credit Transaction (OCT). - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.DefaultApi; - - -DefaultApi apiInstance = new DefaultApi(); -OctCreatePaymentRequest octCreatePaymentRequest = new OctCreatePaymentRequest(); // OctCreatePaymentRequest | -try { - apiInstance.octCreatePayment(octCreatePaymentRequest); -} catch (ApiException e) { - System.err.println("Exception when calling DefaultApi#octCreatePayment"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **octCreatePaymentRequest** | [**OctCreatePaymentRequest**](OctCreatePaymentRequest.md)| | - -### Return type - -null (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - diff --git a/docs/DerPublicKey.md b/docs/DerPublicKey.md deleted file mode 100644 index 0dadbae9d..000000000 --- a/docs/DerPublicKey.md +++ /dev/null @@ -1,12 +0,0 @@ - -# DerPublicKey - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** | **String** | Specifies the format of the public key; currently X.509. | [optional] -**algorithm** | **String** | Algorithm used to encrypt the public key. | [optional] -**publicKey** | **String** | Base64 encoded public key value. | [optional] - - - diff --git a/docs/Error.md b/docs/Error.md deleted file mode 100644 index 7eb4d21bf..000000000 --- a/docs/Error.md +++ /dev/null @@ -1,11 +0,0 @@ - -# Error - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**responseStatus** | [**InlineResponseDefaultResponseStatus**](InlineResponseDefaultResponseStatus.md) | | [optional] -**links** | [**ErrorLinks**](ErrorLinks.md) | | [optional] - - - diff --git a/docs/ErrorLinks.md b/docs/ErrorLinks.md deleted file mode 100644 index 7f0007872..000000000 --- a/docs/ErrorLinks.md +++ /dev/null @@ -1,12 +0,0 @@ - -# ErrorLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**self** | [**InlineResponseDefaultLinksNext**](InlineResponseDefaultLinksNext.md) | | [optional] -**documentation** | [**List<InlineResponseDefaultLinksNext>**](InlineResponseDefaultLinksNext.md) | | [optional] -**next** | [**List<InlineResponseDefaultLinksNext>**](InlineResponseDefaultLinksNext.md) | | [optional] - - - diff --git a/docs/ErrorResponse.md b/docs/ErrorResponse.md deleted file mode 100644 index 4769209c9..000000000 --- a/docs/ErrorResponse.md +++ /dev/null @@ -1,11 +0,0 @@ - -# ErrorResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**responseStatus** | [**InlineResponseDefaultResponseStatus**](InlineResponseDefaultResponseStatus.md) | | [optional] -**links** | [**InlineResponseDefaultLinks**](InlineResponseDefaultLinks.md) | | [optional] - - - diff --git a/docs/FlexTokenApi.md b/docs/FlexTokenApi.md deleted file mode 100644 index 4909f6b39..000000000 --- a/docs/FlexTokenApi.md +++ /dev/null @@ -1,54 +0,0 @@ -# FlexTokenApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**tokenize**](FlexTokenApi.md#tokenize) | **POST** /flex/v1/tokens/ | Flex Tokenize card - - - -# **tokenize** -> FlexV1TokensPost200Response tokenize(tokenizeRequest) - -Flex Tokenize card - -Returns a token representing the supplied card details. The token replaces card data and can be used as the Subscription ID in the CyberSource Simple Order API or SCMP API. This is an unauthenticated call that you should initiate from your customer’s device or browser. - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.FlexTokenApi; - - -FlexTokenApi apiInstance = new FlexTokenApi(); -TokenizeRequest tokenizeRequest = new TokenizeRequest(); // TokenizeRequest | -try { - FlexV1TokensPost200Response result = apiInstance.tokenize(tokenizeRequest); - System.out.println(result); -} catch (ApiException e) { - System.err.println("Exception when calling FlexTokenApi#tokenize"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **tokenizeRequest** | [**TokenizeRequest**](TokenizeRequest.md)| | [optional] - -### Return type - -[**FlexV1TokensPost200Response**](FlexV1TokensPost200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json - diff --git a/docs/Flexv1tokensCardInfo.md b/docs/Flexv1tokensCardInfo.md index d6abffd80..f44ac787d 100644 --- a/docs/Flexv1tokensCardInfo.md +++ b/docs/Flexv1tokensCardInfo.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cardNumber** | **String** | Encrypted or plain text card number. If the encryption type of “None” was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders’ device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request. | [optional] +**cardNumber** | **String** | Encrypted or plain text card number. If the encryption type of “None” was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders’ device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request. | **cardExpirationMonth** | **String** | Two digit expiration month | [optional] **cardExpirationYear** | **String** | Four digit expiration year | [optional] -**cardType** | **String** | Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types. | [optional] +**cardType** | **String** | Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types. | diff --git a/docs/GeneratePublicKeyRequest.md b/docs/GeneratePublicKeyRequest.md index 3a7d17a23..4be3fdf2a 100644 --- a/docs/GeneratePublicKeyRequest.md +++ b/docs/GeneratePublicKeyRequest.md @@ -5,12 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **encryptionType** | **String** | How the card number should be encrypted in the subsequent Tokenize Card request. Possible values are RsaOaep256 or None (if using this value the card number must be in plain text when included in the Tokenize Card request). The Tokenize Card request uses a secure connection (TLS 1.2+) regardless of what encryption type is specified. | -**targetOrigin** | **String** | This should only be used if using the Microform implementation. This is the protocol, URL, and if used, port number of the page that will host the Microform. Unless using http://localhost, the protocol must be https://. For example, if serving Microform on example.com, the targetOrigin is https://example.com The value is used to restrict the frame ancestor of the Microform. If there is a mismatch between this value and the frame ancestor, the Microfrom will not load. | [optional] -**unmaskedLeft** | **Integer** | Specifies the number of card number digits to be returned un-masked from the left. For example, setting this value to 6 will return: 411111XXXXXXXXXX Default value: 6 Maximum value: 6 | [optional] -**unmaskedRight** | **Integer** | Specifies the number of card number digits to be returned un-masked from the right. For example, setting this value to 4 will return: 411111XXXXXX1111 Default value: 4 Maximum value: 4 | [optional] -**enableBillingAddress** | **Boolean** | Specifies whether or not 'dummy' address data should be specified in the create token request. If you have 'Relaxed AVS' enabled for your MID, this value can be set to False.Default value: true | [optional] -**currency** | **String** | Three character ISO currency code to be associated with the token. Required for legacy integrations. Default value: USD. | [optional] -**enableAutoAuth** | **Boolean** | Specifies whether or not an account verification authorization ($0 Authorization) is carried out on token creation. Default is false, as it is assumed a full or zero amount authorization will be carried out in a separate call from your server. | [optional] diff --git a/docs/InlineResponse200.md b/docs/InlineResponse200.md index be4140347..c76411960 100644 --- a/docs/InlineResponse200.md +++ b/docs/InlineResponse200.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**keyId** | **String** | Unique identifier for the generated token. Used in the subsequent Tokenize Card request from your customer’s device or browser. | [optional] -**der** | [**InlineResponse200Der**](InlineResponse200Der.md) | | [optional] -**jwk** | [**InlineResponse200Jwk**](InlineResponse200Jwk.md) | | [optional] +**startTime** | [**DateTime**](DateTime.md) | | [optional] +**endTime** | [**DateTime**](DateTime.md) | | [optional] +**paymentBatchSummaries** | [**List<InlineResponse200PaymentBatchSummaries>**](InlineResponse200PaymentBatchSummaries.md) | | [optional] diff --git a/docs/InlineResponse2001.md b/docs/InlineResponse2001.md deleted file mode 100644 index 642b09107..000000000 --- a/docs/InlineResponse2001.md +++ /dev/null @@ -1,17 +0,0 @@ - -# InlineResponse2001 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keyId** | **String** | The Key ID. | [optional] -**token** | **String** | The generated token. The token replaces card data and is used as the Subscription ID in the CyberSource Simple Order API or SCMP API. | [optional] -**maskedPan** | **String** | The masked card number displaying the first 6 digits and the last 4 digits. | [optional] -**cardType** | **String** | The card type. | [optional] -**timestamp** | **Long** | The UTC date and time in milliseconds at which the signature was generated. | [optional] -**signedFields** | **String** | Indicates which fields from the response make up the data that is used when verifying the response signature. See the [sample code] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/java/com/cybersource/flex/application/CheckoutController.java) on how to verify the signature. | [optional] -**signature** | **String** | Flex-generated digital signature. To ensure the values have not been tampered with while passing through the client, verify this server-side using the public key generated from the /keys resource. | [optional] -**discoverableServices** | **Map<String, Object>** | | [optional] - - - diff --git a/docs/InlineResponse2002.md b/docs/InlineResponse2002.md deleted file mode 100644 index bbecd87ab..000000000 --- a/docs/InlineResponse2002.md +++ /dev/null @@ -1,34 +0,0 @@ - -# InlineResponse2002 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse201Links**](InlineResponse201Links.md) | | [optional] -**embedded** | [**InlineResponse201Embedded**](InlineResponse201Embedded.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] -**errorInformation** | [**InlineResponse201ErrorInformation**](InlineResponse201ErrorInformation.md) | | [optional] -**clientReferenceInformation** | [**InlineResponse201ClientReferenceInformation**](InlineResponse201ClientReferenceInformation.md) | | [optional] -**processingInformation** | [**InlineResponse2002ProcessingInformation**](InlineResponse2002ProcessingInformation.md) | | [optional] -**processorInformation** | [**InlineResponse2002ProcessorInformation**](InlineResponse2002ProcessorInformation.md) | | [optional] -**paymentInformation** | [**InlineResponse2002PaymentInformation**](InlineResponse2002PaymentInformation.md) | | [optional] -**orderInformation** | [**InlineResponse2002OrderInformation**](InlineResponse2002OrderInformation.md) | | [optional] -**buyerInformation** | [**InlineResponse2002BuyerInformation**](InlineResponse2002BuyerInformation.md) | | [optional] -**merchantInformation** | [**InlineResponse2002MerchantInformation**](InlineResponse2002MerchantInformation.md) | | [optional] -**deviceInformation** | [**InlineResponse2002DeviceInformation**](InlineResponse2002DeviceInformation.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -AUTHORIZED | "AUTHORIZED" -PARTIAL_AUTHORIZED | "PARTIAL_AUTHORIZED" -AUTHORIZED_PENDING_REVIEW | "AUTHORIZED_PENDING_REVIEW" -DECLINED | "DECLINED" - - - diff --git a/docs/InlineResponse2002BuyerInformation.md b/docs/InlineResponse2002BuyerInformation.md deleted file mode 100644 index 6a2dd4f8c..000000000 --- a/docs/InlineResponse2002BuyerInformation.md +++ /dev/null @@ -1,14 +0,0 @@ - -# InlineResponse2002BuyerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchantCustomerId** | **String** | Your identifier for the customer. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**dateOfBirth** | **String** | Recipient’s date of birth. **Format**: `YYYYMMDD`. This field is a pass-through, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] -**vatRegistrationNumber** | **String** | Customer’s government-assigned tax identification number. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**personalIdentification** | [**List<V2paymentsBuyerInformationPersonalIdentification>**](V2paymentsBuyerInformationPersonalIdentification.md) | | [optional] -**taxId** | **String** | TBD | [optional] - - - diff --git a/docs/InlineResponse2002DeviceInformation.md b/docs/InlineResponse2002DeviceInformation.md deleted file mode 100644 index 796e67c14..000000000 --- a/docs/InlineResponse2002DeviceInformation.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InlineResponse2002DeviceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | TBD | [optional] -**fingerprintId** | **String** | TBD | [optional] -**ipAddress** | **String** | IP address of the customer. | [optional] - - - diff --git a/docs/InlineResponse2002MerchantInformation.md b/docs/InlineResponse2002MerchantInformation.md deleted file mode 100644 index 399e1270b..000000000 --- a/docs/InlineResponse2002MerchantInformation.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InlineResponse2002MerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**categoryCode** | **Integer** | Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**vatRegistrationNumber** | **String** | Your government-assigned tax identification number. For CtV processors, the maximum length is 20. For other processor-specific information, see the merchant_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**merchantDescriptor** | [**V2paymentsMerchantInformationMerchantDescriptor**](V2paymentsMerchantInformationMerchantDescriptor.md) | | [optional] - - - diff --git a/docs/InlineResponse2002OrderInformation.md b/docs/InlineResponse2002OrderInformation.md deleted file mode 100644 index 108ae3c00..000000000 --- a/docs/InlineResponse2002OrderInformation.md +++ /dev/null @@ -1,15 +0,0 @@ - -# InlineResponse2002OrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amountDetails** | [**InlineResponse2002OrderInformationAmountDetails**](InlineResponse2002OrderInformationAmountDetails.md) | | [optional] -**billTo** | [**InlineResponse2002OrderInformationBillTo**](InlineResponse2002OrderInformationBillTo.md) | | [optional] -**shipTo** | [**InlineResponse2002OrderInformationShipTo**](InlineResponse2002OrderInformationShipTo.md) | | [optional] -**lineItems** | [**List<InlineResponse2002OrderInformationLineItems>**](InlineResponse2002OrderInformationLineItems.md) | | [optional] -**invoiceDetails** | [**InlineResponse2002OrderInformationInvoiceDetails**](InlineResponse2002OrderInformationInvoiceDetails.md) | | [optional] -**shippingDetails** | [**V2paymentsOrderInformationShippingDetails**](V2paymentsOrderInformationShippingDetails.md) | | [optional] - - - diff --git a/docs/InlineResponse2002OrderInformationAmountDetails.md b/docs/InlineResponse2002OrderInformationAmountDetails.md deleted file mode 100644 index ea2526f8f..000000000 --- a/docs/InlineResponse2002OrderInformationAmountDetails.md +++ /dev/null @@ -1,18 +0,0 @@ - -# InlineResponse2002OrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**authorizedAmount** | **String** | Amount that was authorized. | [optional] -**totalAmount** | **String** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] -**discountAmount** | **String** | Total discount amount applied to the order. For processor-specific information, see the order_discount_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**dutyAmount** | **String** | Total charges for any import or export duties included in the order. For processor-specific information, see the duty_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxAmount** | **String** | Total tax amount for all the items in the order. For processor-specific information, see the total_tax_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**nationalTaxIncluded** | **String** | Flag that indicates whether a national tax is included in the order total. Possible values: - **0**: national tax not included - **1**: national tax included For processor-specific information, see the national_tax_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**freightAmount** | **String** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxDetails** | [**List<V2paymentsOrderInformationAmountDetailsTaxDetails>**](V2paymentsOrderInformationAmountDetailsTaxDetails.md) | | [optional] - - - diff --git a/docs/InlineResponse2002OrderInformationBillTo.md b/docs/InlineResponse2002OrderInformationBillTo.md deleted file mode 100644 index 78b4d6981..000000000 --- a/docs/InlineResponse2002OrderInformationBillTo.md +++ /dev/null @@ -1,21 +0,0 @@ - -# InlineResponse2002OrderInformationBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**firstName** | **String** | Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**lastName** | **String** | Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**company** | **String** | Name of the customer’s company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**address1** | **String** | First line of the billing street address as it appears on the credit card issuer’s records. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**address2** | **String** | Additional address information. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**locality** | **String** | City of the billing address. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**administrativeArea** | **String** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**county** | **String** | TBD | [optional] -**country** | **String** | Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**email** | **String** | Customer's email address, including the full domain name. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**phoneNumber** | **String** | Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] - - - diff --git a/docs/InlineResponse2002OrderInformationInvoiceDetails.md b/docs/InlineResponse2002OrderInformationInvoiceDetails.md deleted file mode 100644 index 171bc6a37..000000000 --- a/docs/InlineResponse2002OrderInformationInvoiceDetails.md +++ /dev/null @@ -1,17 +0,0 @@ - -# InlineResponse2002OrderInformationInvoiceDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**purchaseOrderNumber** | **String** | Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. For processor-specific information, see the user_po field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**purchaseOrderDate** | **String** | Date the order was processed. `Format: YYYY-MM-DD`. For processor-specific information, see the purchaser_order_date field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxable** | **Boolean** | Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0. If you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include _invoiceDetails.taxable_ in the data it sends to the processor. For processor-specific information, see the tax_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**vatInvoiceReferenceNumber** | **String** | VAT invoice number associated with the transaction. For processor-specific information, see the vat_invoice_ref_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**commodityCode** | **String** | International description code of the overall order’s goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. For processor-specific information, see the summary_commodity_code field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**merchandiseCode** | [**BigDecimal**](BigDecimal.md) | Identifier for the merchandise. Possible value: - 1000: Gift card This field is supported only for **American Express Direct**. | [optional] -**transactionAdviceAddendum** | [**List<V2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum>**](V2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.md) | | [optional] -**level3TransmissionStatus** | **Boolean** | Indicates whether CyberSource sent the Level III information to the processor. The possible values are: If your account is not enabled for Level III data or if you did not include the purchasing level field in your request, CyberSource does not include the Level III data in the request sent to the processor. For processor-specific information, see the bill_purchasing_level3_enabled field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] - - - diff --git a/docs/InlineResponse2002OrderInformationLineItems.md b/docs/InlineResponse2002OrderInformationLineItems.md deleted file mode 100644 index cc6008fa3..000000000 --- a/docs/InlineResponse2002OrderInformationLineItems.md +++ /dev/null @@ -1,26 +0,0 @@ - -# InlineResponse2002OrderInformationLineItems - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**productCode** | **String** | Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. | [optional] -**productName** | **String** | For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the values related to shipping and handling. | [optional] -**productSku** | **String** | Identification code for the product. For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the values related to shipping and/or handling. | [optional] -**quantity** | [**BigDecimal**](BigDecimal.md) | For a payment or capture, this field is required when _productCode_ is not **default** or one of the values related to shipping and handling. | [optional] -**unitPrice** | **String** | Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**unitOfMeasure** | **String** | Unit of measure, or unit of measure code, for the item. | [optional] -**totalAmount** | **String** | Total amount for the item. Normally calculated as the unit price x quantity. | [optional] -**taxAmount** | **String** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. This field is frequently used for Level II and Level III transactions. | [optional] -**taxRate** | **String** | Tax rate applied to the item. See \"Numbered Elements,\" page 14. Visa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). Mastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). | [optional] -**taxTypeCode** | **String** | Type of tax being applied to the item. Possible values: Below values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle** - 0000: unknown tax type - 0001: federal/national sales tax - 0002: state sales tax - 0003: city sales tax - 0004: local sales tax - 0005: municipal sales tax - 0006: other tax - 0010: value-added tax - 0011: goods and services tax - 0012: provincial sales tax - 0013: harmonized sales tax - 0014: Quebec sales tax (QST) - 0020: room tax - 0021: occupancy tax - 0022: energy tax - Blank: Tax not supported on line item. | [optional] -**amountIncludesTax** | **Boolean** | Flag that indicates whether the tax amount is included in the Line Item Total. | [optional] -**commodityCode** | **String** | Commodity code or International description code used to classify the item. Contact your acquirer for a list of codes. | [optional] -**discountAmount** | **String** | Discount applied to the item. | [optional] -**discountApplied** | **Boolean** | Flag that indicates whether the amount is discounted. If you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets this field to **true**. | [optional] -**discountRate** | **String** | Rate the item is discounted. Maximum of 2 decimal places. Example 5.25 (=5.25%) | [optional] -**invoiceNumber** | **String** | Field to support an invoice number for a transaction. You must specify the number of line items that will include an invoice number. By default, the first line item will include an invoice number field. The invoice number field can be included for up to 10 line items. | [optional] -**taxDetails** | [**List<V2paymentsOrderInformationAmountDetailsTaxDetails>**](V2paymentsOrderInformationAmountDetailsTaxDetails.md) | | [optional] - - - diff --git a/docs/InlineResponse2002PaymentInformation.md b/docs/InlineResponse2002PaymentInformation.md deleted file mode 100644 index 6d97c1d98..000000000 --- a/docs/InlineResponse2002PaymentInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse2002PaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**InlineResponse2002PaymentInformationCard**](InlineResponse2002PaymentInformationCard.md) | | [optional] -**tokenizedCard** | [**InlineResponse2002PaymentInformationTokenizedCard**](InlineResponse2002PaymentInformationTokenizedCard.md) | | [optional] - - - diff --git a/docs/InlineResponse2002PaymentInformationCard.md b/docs/InlineResponse2002PaymentInformationCard.md deleted file mode 100644 index 2fb3f0c39..000000000 --- a/docs/InlineResponse2002PaymentInformationCard.md +++ /dev/null @@ -1,13 +0,0 @@ - -# InlineResponse2002PaymentInformationCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**suffix** | **String** | Last four digits of the cardholder’s account number. This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder. | [optional] -**expirationMonth** | **String** | Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationYear** | **String** | Four-digit year in which the credit card expires. `Format: YYYY`. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover | [optional] - - - diff --git a/docs/InlineResponse2002PaymentInformationTokenizedCard.md b/docs/InlineResponse2002PaymentInformationTokenizedCard.md deleted file mode 100644 index 7db64f50c..000000000 --- a/docs/InlineResponse2002PaymentInformationTokenizedCard.md +++ /dev/null @@ -1,14 +0,0 @@ - -# InlineResponse2002PaymentInformationTokenizedCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**prefix** | **String** | First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] -**suffix** | **String** | Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] -**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover | [optional] -**expirationMonth** | **String** | Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12. | [optional] -**expirationYear** | **String** | Four-digit year in which the payment network token expires. `Format: YYYY`. | [optional] - - - diff --git a/docs/InlineResponse2002ProcessingInformation.md b/docs/InlineResponse2002ProcessingInformation.md deleted file mode 100644 index 60c1e11e4..000000000 --- a/docs/InlineResponse2002ProcessingInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2002ProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**paymentSolution** | **String** | Type of digital payment solution that is being used for the transaction. Possible Values: - **visacheckout**: Visa Checkout. - **001**: Apple Pay. - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct. - **006**: Android Pay. - **008**: Samsung Pay. | [optional] - - - diff --git a/docs/InlineResponse2002ProcessorInformation.md b/docs/InlineResponse2002ProcessorInformation.md deleted file mode 100644 index 4da7a3753..000000000 --- a/docs/InlineResponse2002ProcessorInformation.md +++ /dev/null @@ -1,13 +0,0 @@ - -# InlineResponse2002ProcessorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**approvalCode** | **String** | Authorization code. Returned only when the processor returns this value. | [optional] -**cardVerification** | [**InlineResponse2002ProcessorInformationCardVerification**](InlineResponse2002ProcessorInformationCardVerification.md) | | [optional] -**avs** | [**InlineResponse2002ProcessorInformationAvs**](InlineResponse2002ProcessorInformationAvs.md) | | [optional] -**transactionId** | **String** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. | [optional] - - - diff --git a/docs/InlineResponse2002ProcessorInformationAvs.md b/docs/InlineResponse2002ProcessorInformationAvs.md deleted file mode 100644 index fff881e5b..000000000 --- a/docs/InlineResponse2002ProcessorInformationAvs.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2002ProcessorInformationAvs - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **String** | AVS result code. | [optional] - - - diff --git a/docs/InlineResponse2002ProcessorInformationCardVerification.md b/docs/InlineResponse2002ProcessorInformationCardVerification.md deleted file mode 100644 index b3a929429..000000000 --- a/docs/InlineResponse2002ProcessorInformationCardVerification.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2002ProcessorInformationCardVerification - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**resultCode** | **String** | CVN result code. | [optional] - - - diff --git a/docs/InlineResponse2003.md b/docs/InlineResponse2003.md deleted file mode 100644 index 59ffba406..000000000 --- a/docs/InlineResponse2003.md +++ /dev/null @@ -1,24 +0,0 @@ - -# InlineResponse2003 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse201EmbeddedCaptureLinks**](InlineResponse201EmbeddedCaptureLinks.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] -**clientReferenceInformation** | [**InlineResponse201ClientReferenceInformation**](InlineResponse201ClientReferenceInformation.md) | | [optional] -**processorInformation** | [**InlineResponse2011ProcessorInformation**](InlineResponse2011ProcessorInformation.md) | | [optional] -**reversalAmountDetails** | [**InlineResponse2011ReversalAmountDetails**](InlineResponse2011ReversalAmountDetails.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -REVERSED | "REVERSED" - - - diff --git a/docs/InlineResponse2004.md b/docs/InlineResponse2004.md deleted file mode 100644 index 91d98cd7b..000000000 --- a/docs/InlineResponse2004.md +++ /dev/null @@ -1,31 +0,0 @@ - -# InlineResponse2004 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse2012Links**](InlineResponse2012Links.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] -**clientReferenceInformation** | [**InlineResponse201ClientReferenceInformation**](InlineResponse201ClientReferenceInformation.md) | | [optional] -**processingInformation** | [**InlineResponse2004ProcessingInformation**](InlineResponse2004ProcessingInformation.md) | | [optional] -**processorInformation** | [**InlineResponse2012ProcessorInformation**](InlineResponse2012ProcessorInformation.md) | | [optional] -**orderInformation** | [**InlineResponse2004OrderInformation**](InlineResponse2004OrderInformation.md) | | [optional] -**buyerInformation** | [**V2paymentsidcapturesBuyerInformation**](V2paymentsidcapturesBuyerInformation.md) | | [optional] -**merchantInformation** | [**InlineResponse2002MerchantInformation**](InlineResponse2002MerchantInformation.md) | | [optional] -**deviceInformation** | [**InlineResponse2004DeviceInformation**](InlineResponse2004DeviceInformation.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -PENDING | "PENDING" -TRANSMITTED | "TRANSMITTED" -BATCH_ERROR | "BATCH_ERROR" -VOIDED | "VOIDED" - - - diff --git a/docs/InlineResponse2004DeviceInformation.md b/docs/InlineResponse2004DeviceInformation.md deleted file mode 100644 index d9e26246d..000000000 --- a/docs/InlineResponse2004DeviceInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2004DeviceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ipAddress** | **String** | IP address of the customer. | [optional] - - - diff --git a/docs/InlineResponse2004OrderInformation.md b/docs/InlineResponse2004OrderInformation.md deleted file mode 100644 index 5dc1ebeb7..000000000 --- a/docs/InlineResponse2004OrderInformation.md +++ /dev/null @@ -1,15 +0,0 @@ - -# InlineResponse2004OrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amountDetails** | [**InlineResponse2004OrderInformationAmountDetails**](InlineResponse2004OrderInformationAmountDetails.md) | | [optional] -**billTo** | [**InlineResponse2002OrderInformationBillTo**](InlineResponse2002OrderInformationBillTo.md) | | [optional] -**shipTo** | [**InlineResponse2004OrderInformationShipTo**](InlineResponse2004OrderInformationShipTo.md) | | [optional] -**lineItems** | [**List<InlineResponse2002OrderInformationLineItems>**](InlineResponse2002OrderInformationLineItems.md) | | [optional] -**invoiceDetails** | [**InlineResponse2004OrderInformationInvoiceDetails**](InlineResponse2004OrderInformationInvoiceDetails.md) | | [optional] -**shippingDetails** | [**V2paymentsidcapturesOrderInformationShippingDetails**](V2paymentsidcapturesOrderInformationShippingDetails.md) | | [optional] - - - diff --git a/docs/InlineResponse2004OrderInformationAmountDetails.md b/docs/InlineResponse2004OrderInformationAmountDetails.md deleted file mode 100644 index f9b878a5f..000000000 --- a/docs/InlineResponse2004OrderInformationAmountDetails.md +++ /dev/null @@ -1,17 +0,0 @@ - -# InlineResponse2004OrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] -**discountAmount** | **String** | Total discount amount applied to the order. For processor-specific information, see the order_discount_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**dutyAmount** | **String** | Total charges for any import or export duties included in the order. For processor-specific information, see the duty_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxAmount** | **String** | Total tax amount for all the items in the order. For processor-specific information, see the total_tax_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**nationalTaxIncluded** | **String** | Flag that indicates whether a national tax is included in the order total. Possible values: - **0**: national tax not included - **1**: national tax included For processor-specific information, see the national_tax_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**freightAmount** | **String** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxDetails** | [**List<V2paymentsOrderInformationAmountDetailsTaxDetails>**](V2paymentsOrderInformationAmountDetailsTaxDetails.md) | | [optional] - - - diff --git a/docs/InlineResponse2004OrderInformationInvoiceDetails.md b/docs/InlineResponse2004OrderInformationInvoiceDetails.md deleted file mode 100644 index d512ff0ea..000000000 --- a/docs/InlineResponse2004OrderInformationInvoiceDetails.md +++ /dev/null @@ -1,16 +0,0 @@ - -# InlineResponse2004OrderInformationInvoiceDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**purchaseOrderNumber** | **String** | Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. For processor-specific information, see the user_po field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**purchaseOrderDate** | **String** | Date the order was processed. `Format: YYYY-MM-DD`. For processor-specific information, see the purchaser_order_date field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxable** | **Boolean** | Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0. If you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include _invoiceDetails.taxable_ in the data it sends to the processor. For processor-specific information, see the tax_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**vatInvoiceReferenceNumber** | **String** | VAT invoice number associated with the transaction. For processor-specific information, see the vat_invoice_ref_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**commodityCode** | **String** | International description code of the overall order’s goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. For processor-specific information, see the summary_commodity_code field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**transactionAdviceAddendum** | [**List<V2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum>**](V2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.md) | | [optional] -**level3TransmissionStatus** | **Boolean** | Indicates whether CyberSource sent the Level III information to the processor. The possible values are: If your account is not enabled for Level III data or if you did not include the purchasing level field in your request, CyberSource does not include the Level III data in the request sent to the processor. For processor-specific information, see the bill_purchasing_level3_enabled field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] - - - diff --git a/docs/InlineResponse2004OrderInformationShipTo.md b/docs/InlineResponse2004OrderInformationShipTo.md deleted file mode 100644 index 0cd1f64db..000000000 --- a/docs/InlineResponse2004OrderInformationShipTo.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InlineResponse2004OrderInformationShipTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**administrativeArea** | **String** | State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] -**postalCode** | **String** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 | [optional] -**country** | **String** | Country of the shipping address. Use the two character ISO Standard Country Codes. | [optional] - - - diff --git a/docs/InlineResponse2004ProcessingInformation.md b/docs/InlineResponse2004ProcessingInformation.md deleted file mode 100644 index 59856dd05..000000000 --- a/docs/InlineResponse2004ProcessingInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse2004ProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**paymentSolution** | **String** | Type of digital payment solution that is being used for the transaction. Possible Values: - **visacheckout**: Visa Checkout. - **001**: Apple Pay. - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct. - **006**: Android Pay. - **008**: Samsung Pay. | [optional] -**authorizationOptions** | [**InlineResponse2004ProcessingInformationAuthorizationOptions**](InlineResponse2004ProcessingInformationAuthorizationOptions.md) | | [optional] - - - diff --git a/docs/InlineResponse2004ProcessingInformationAuthorizationOptions.md b/docs/InlineResponse2004ProcessingInformationAuthorizationOptions.md deleted file mode 100644 index 88c080a88..000000000 --- a/docs/InlineResponse2004ProcessingInformationAuthorizationOptions.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2004ProcessingInformationAuthorizationOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**verbalAuthCode** | **String** | Authorization code. **Forced Capture** Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. **Verbal Authorization** Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the auth_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] - - - diff --git a/docs/InlineResponse2005.md b/docs/InlineResponse2005.md deleted file mode 100644 index d366c9c87..000000000 --- a/docs/InlineResponse2005.md +++ /dev/null @@ -1,26 +0,0 @@ - -# InlineResponse2005 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse2013Links**](InlineResponse2013Links.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] -**clientReferenceInformation** | [**InlineResponse201ClientReferenceInformation**](InlineResponse201ClientReferenceInformation.md) | | [optional] -**refundAmountDetails** | [**InlineResponse2013RefundAmountDetails**](InlineResponse2013RefundAmountDetails.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -PENDING | "PENDING" -TRANSMITTED | "TRANSMITTED" -BATCH_ERROR | "BATCH_ERROR" -VOIDED | "VOIDED" - - - diff --git a/docs/InlineResponse2006.md b/docs/InlineResponse2006.md deleted file mode 100644 index 8f6eb9cb3..000000000 --- a/docs/InlineResponse2006.md +++ /dev/null @@ -1,26 +0,0 @@ - -# InlineResponse2006 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse2013Links**](InlineResponse2013Links.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] -**clientReferenceInformation** | [**InlineResponse201ClientReferenceInformation**](InlineResponse201ClientReferenceInformation.md) | | [optional] -**creditAmountDetails** | [**InlineResponse2014CreditAmountDetails**](InlineResponse2014CreditAmountDetails.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -PENDING | "PENDING" -TRANSMITTED | "TRANSMITTED" -BATCH_ERROR | "BATCH_ERROR" -VOIDED | "VOIDED" - - - diff --git a/docs/InlineResponse2007.md b/docs/InlineResponse2007.md deleted file mode 100644 index 064da8fc6..000000000 --- a/docs/InlineResponse2007.md +++ /dev/null @@ -1,32 +0,0 @@ - -# InlineResponse2007 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InstrumentidentifiersLinks**](InstrumentidentifiersLinks.md) | | [optional] -**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional] -**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. | [optional] -**state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] -**card** | [**InstrumentidentifiersCard**](InstrumentidentifiersCard.md) | | [optional] -**bankAccount** | [**InstrumentidentifiersBankAccount**](InstrumentidentifiersBankAccount.md) | | [optional] -**processingInformation** | [**InstrumentidentifiersProcessingInformation**](InstrumentidentifiersProcessingInformation.md) | | [optional] -**metadata** | [**InstrumentidentifiersMetadata**](InstrumentidentifiersMetadata.md) | | [optional] - - - -## Enum: ObjectEnum -Name | Value ----- | ----- -INSTRUMENTIDENTIFIER | "instrumentIdentifier" - - - -## Enum: StateEnum -Name | Value ----- | ----- -ACTIVE | "ACTIVE" -CLOSED | "CLOSED" - - - diff --git a/docs/InlineResponse2008.md b/docs/InlineResponse2008.md deleted file mode 100644 index 3c8ab32ae..000000000 --- a/docs/InlineResponse2008.md +++ /dev/null @@ -1,23 +0,0 @@ - -# InlineResponse2008 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse2008Links**](InlineResponse2008Links.md) | | [optional] -**object** | [**ObjectEnum**](#ObjectEnum) | Shows the response is a collection of objects. | [optional] -**offset** | **String** | The offset parameter supplied in the request. | [optional] -**limit** | **String** | The limit parameter supplied in the request. | [optional] -**count** | **String** | The number of Payment Instruments returned in the array. | [optional] -**total** | **String** | The total number of Payment Instruments associated with the Instrument Identifier in the zero-based dataset. | [optional] -**embedded** | **Object** | Array of Payment Instruments returned for the supplied Instrument Identifier. | [optional] - - - -## Enum: ObjectEnum -Name | Value ----- | ----- -COLLECTION | "collection" - - - diff --git a/docs/InlineResponse2008Links.md b/docs/InlineResponse2008Links.md deleted file mode 100644 index e3b874ef8..000000000 --- a/docs/InlineResponse2008Links.md +++ /dev/null @@ -1,14 +0,0 @@ - -# InlineResponse2008Links - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**self** | [**InlineResponse2008LinksSelf**](InlineResponse2008LinksSelf.md) | | [optional] -**first** | [**InlineResponse2008LinksFirst**](InlineResponse2008LinksFirst.md) | | [optional] -**prev** | [**InlineResponse2008LinksPrev**](InlineResponse2008LinksPrev.md) | | [optional] -**next** | [**InlineResponse2008LinksNext**](InlineResponse2008LinksNext.md) | | [optional] -**last** | [**InlineResponse2008LinksLast**](InlineResponse2008LinksLast.md) | | [optional] - - - diff --git a/docs/InlineResponse2008LinksFirst.md b/docs/InlineResponse2008LinksFirst.md deleted file mode 100644 index 3c28b13df..000000000 --- a/docs/InlineResponse2008LinksFirst.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2008LinksFirst - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **String** | A link to the collection starting at offset zero for the supplied limit. | [optional] - - - diff --git a/docs/InlineResponse2008LinksLast.md b/docs/InlineResponse2008LinksLast.md deleted file mode 100644 index f4abf54b4..000000000 --- a/docs/InlineResponse2008LinksLast.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2008LinksLast - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **String** | A link to the last collection containing the remaining objects. | [optional] - - - diff --git a/docs/InlineResponse2008LinksNext.md b/docs/InlineResponse2008LinksNext.md deleted file mode 100644 index c2724ddd0..000000000 --- a/docs/InlineResponse2008LinksNext.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2008LinksNext - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **String** | A link to the next collection starting at the supplied offset plus the supplied limit. | [optional] - - - diff --git a/docs/InlineResponse2008LinksPrev.md b/docs/InlineResponse2008LinksPrev.md deleted file mode 100644 index 9ff528001..000000000 --- a/docs/InlineResponse2008LinksPrev.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2008LinksPrev - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **String** | | [optional] - - - diff --git a/docs/InlineResponse2008LinksSelf.md b/docs/InlineResponse2008LinksSelf.md deleted file mode 100644 index ee7c7bd1d..000000000 --- a/docs/InlineResponse2008LinksSelf.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2008LinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **String** | A link to the current requested collection. | [optional] - - - diff --git a/docs/InlineResponse200Der.md b/docs/InlineResponse200Der.md deleted file mode 100644 index f277955a6..000000000 --- a/docs/InlineResponse200Der.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InlineResponse200Der - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**format** | **String** | Specifies the format of the public key; currently X.509. | [optional] -**algorithm** | **String** | Algorithm used to encrypt the public key. | [optional] -**publicKey** | **String** | Base64 encoded public key value. | [optional] - - - diff --git a/docs/InlineResponse200Jwk.md b/docs/InlineResponse200Jwk.md deleted file mode 100644 index 4893e41c4..000000000 --- a/docs/InlineResponse200Jwk.md +++ /dev/null @@ -1,14 +0,0 @@ - -# InlineResponse200Jwk - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**kty** | **String** | Algorithm used to encrypt the public key. | [optional] -**use** | **String** | Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc. | [optional] -**kid** | **String** | The key ID in JWK format. | [optional] -**n** | **String** | JWK RSA Modulus | [optional] -**e** | **String** | JWK RSA Exponent | [optional] - - - diff --git a/docs/InlineResponse200PaymentBatchSummaries.md b/docs/InlineResponse200PaymentBatchSummaries.md new file mode 100644 index 000000000..a21022ec5 --- /dev/null +++ b/docs/InlineResponse200PaymentBatchSummaries.md @@ -0,0 +1,21 @@ + +# InlineResponse200PaymentBatchSummaries + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currencyCode** | **String** | | [optional] +**paymentSubTypeDescription** | **String** | | [optional] +**startTime** | [**DateTime**](DateTime.md) | | [optional] +**endTime** | [**DateTime**](DateTime.md) | | [optional] +**salesCount** | **Integer** | | [optional] +**salesAmount** | **String** | | [optional] +**creditCount** | **Integer** | | [optional] +**creditAmount** | **String** | | [optional] +**accountName** | **String** | | [optional] +**accountId** | **String** | | [optional] +**merchantId** | **String** | | [optional] +**merchantName** | **String** | | [optional] + + + diff --git a/docs/InlineResponse201.md b/docs/InlineResponse201.md deleted file mode 100644 index 98bc45d26..000000000 --- a/docs/InlineResponse201.md +++ /dev/null @@ -1,31 +0,0 @@ - -# InlineResponse201 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse201Links**](InlineResponse201Links.md) | | [optional] -**embedded** | [**InlineResponse201Embedded**](InlineResponse201Embedded.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] -**errorInformation** | [**InlineResponse201ErrorInformation**](InlineResponse201ErrorInformation.md) | | [optional] -**clientReferenceInformation** | [**InlineResponse201ClientReferenceInformation**](InlineResponse201ClientReferenceInformation.md) | | [optional] -**processorInformation** | [**InlineResponse201ProcessorInformation**](InlineResponse201ProcessorInformation.md) | | [optional] -**paymentInformation** | [**InlineResponse201PaymentInformation**](InlineResponse201PaymentInformation.md) | | [optional] -**orderInformation** | [**InlineResponse201OrderInformation**](InlineResponse201OrderInformation.md) | | [optional] -**pointOfSaleInformation** | [**InlineResponse201PointOfSaleInformation**](InlineResponse201PointOfSaleInformation.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -AUTHORIZED | "AUTHORIZED" -PARTIAL_AUTHORIZED | "PARTIAL_AUTHORIZED" -AUTHORIZED_PENDING_REVIEW | "AUTHORIZED_PENDING_REVIEW" -DECLINED | "DECLINED" - - - diff --git a/docs/InlineResponse2011.md b/docs/InlineResponse2011.md deleted file mode 100644 index 19fa94a69..000000000 --- a/docs/InlineResponse2011.md +++ /dev/null @@ -1,26 +0,0 @@ - -# InlineResponse2011 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse201EmbeddedCaptureLinks**](InlineResponse201EmbeddedCaptureLinks.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] -**clientReferenceInformation** | [**InlineResponse201ClientReferenceInformation**](InlineResponse201ClientReferenceInformation.md) | | [optional] -**reversalAmountDetails** | [**InlineResponse2011ReversalAmountDetails**](InlineResponse2011ReversalAmountDetails.md) | | [optional] -**processorInformation** | [**InlineResponse2011ProcessorInformation**](InlineResponse2011ProcessorInformation.md) | | [optional] -**authorizationInformation** | [**InlineResponse2011AuthorizationInformation**](InlineResponse2011AuthorizationInformation.md) | | [optional] -**pointOfSaleInformation** | [**V2paymentsidreversalsPointOfSaleInformation**](V2paymentsidreversalsPointOfSaleInformation.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -REVERSED | "REVERSED" - - - diff --git a/docs/InlineResponse2011AuthorizationInformation.md b/docs/InlineResponse2011AuthorizationInformation.md deleted file mode 100644 index c99a959f6..000000000 --- a/docs/InlineResponse2011AuthorizationInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse2011AuthorizationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**approvalCode** | **String** | The authorization code returned by the processor. | [optional] -**reasonCode** | **String** | Reply flag for the original transaction. | [optional] - - - diff --git a/docs/InlineResponse2011ProcessorInformation.md b/docs/InlineResponse2011ProcessorInformation.md deleted file mode 100644 index 79edb5ceb..000000000 --- a/docs/InlineResponse2011ProcessorInformation.md +++ /dev/null @@ -1,15 +0,0 @@ - -# InlineResponse2011ProcessorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transactionId** | **String** | Processor transaction ID. This value identifies the transaction on a host system. This value is supported only for Moneris. It contains this information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. Example For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] -**responseCode** | **String** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. Important Do not use this field to evaluate the result of the authorization. | [optional] -**responseCategoryCode** | **String** | Processor-defined response category code. The associated detail error code is in the auth_auth_response field or the auth_reversal_auth_ response field depending on which service you requested. This field is supported only for: - Japanese issuers - Domestic transactions in Japan - Comercio Latino—processor transaction ID required for troubleshooting **Maximum length for processors**: - Comercio Latino: 32 - All other processors: 3 | [optional] -**forwardedAcquirerCode** | **String** | Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway. Please contact the CyberSource Japan Support Group for more information. | [optional] -**masterCardServiceCode** | **String** | Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service | [optional] -**masterCardServiceReplyCode** | **String** | Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource. Possible values: - **C**: Service completed successfully. - **F**: One of the following: - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or authorization reversal. - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request. - Token requestor ID is missing or formatted incorrectly. - **I**: One of the following: - Invalid token requestor ID. - Suspended or deactivated token. - Invalid token (not in mapping table). - **T**: Invalid combination of token requestor ID and token. - **U**: Expired token. - **W**: Primary account number (PAN) listed in electronic warning bulletin. Note This field is returned only for **CyberSource through VisaNet**. | [optional] - - - diff --git a/docs/InlineResponse2011ReversalAmountDetails.md b/docs/InlineResponse2011ReversalAmountDetails.md deleted file mode 100644 index 2e0d6af60..000000000 --- a/docs/InlineResponse2011ReversalAmountDetails.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InlineResponse2011ReversalAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reversedAmount** | **String** | Total reversed amount. | [optional] -**originalTransactionAmount** | **String** | Amount of the original transaction. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] - - - diff --git a/docs/InlineResponse2012.md b/docs/InlineResponse2012.md deleted file mode 100644 index 7b0caddb9..000000000 --- a/docs/InlineResponse2012.md +++ /dev/null @@ -1,24 +0,0 @@ - -# InlineResponse2012 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse2012Links**](InlineResponse2012Links.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] -**clientReferenceInformation** | [**InlineResponse201ClientReferenceInformation**](InlineResponse201ClientReferenceInformation.md) | | [optional] -**processorInformation** | [**InlineResponse2012ProcessorInformation**](InlineResponse2012ProcessorInformation.md) | | [optional] -**orderInformation** | [**InlineResponse2012OrderInformation**](InlineResponse2012OrderInformation.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -PENDING | "PENDING" - - - diff --git a/docs/InlineResponse2012Links.md b/docs/InlineResponse2012Links.md deleted file mode 100644 index dab22558b..000000000 --- a/docs/InlineResponse2012Links.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InlineResponse2012Links - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**self** | [**InlineResponse201LinksSelf**](InlineResponse201LinksSelf.md) | | [optional] -**_void** | [**InlineResponse201LinksSelf**](InlineResponse201LinksSelf.md) | | [optional] -**refund** | [**InlineResponse201LinksSelf**](InlineResponse201LinksSelf.md) | | [optional] - - - diff --git a/docs/InlineResponse2012OrderInformation.md b/docs/InlineResponse2012OrderInformation.md deleted file mode 100644 index 3449c6399..000000000 --- a/docs/InlineResponse2012OrderInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse2012OrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amountDetails** | [**InlineResponse2012OrderInformationAmountDetails**](InlineResponse2012OrderInformationAmountDetails.md) | | [optional] -**invoiceDetails** | [**InlineResponse201OrderInformationInvoiceDetails**](InlineResponse201OrderInformationInvoiceDetails.md) | | [optional] - - - diff --git a/docs/InlineResponse2012OrderInformationAmountDetails.md b/docs/InlineResponse2012OrderInformationAmountDetails.md deleted file mode 100644 index f8ced4a2b..000000000 --- a/docs/InlineResponse2012OrderInformationAmountDetails.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse2012OrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**totalAmount** | **String** | Amount you requested for the capture. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] - - - diff --git a/docs/InlineResponse2012ProcessorInformation.md b/docs/InlineResponse2012ProcessorInformation.md deleted file mode 100644 index 9d6b926ef..000000000 --- a/docs/InlineResponse2012ProcessorInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2012ProcessorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transactionId** | **String** | Processor transaction ID. This value identifies the transaction on a host system. This value is supported only for Moneris. It contains this information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. Example For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] - - - diff --git a/docs/InlineResponse2013.md b/docs/InlineResponse2013.md deleted file mode 100644 index d358c37fe..000000000 --- a/docs/InlineResponse2013.md +++ /dev/null @@ -1,25 +0,0 @@ - -# InlineResponse2013 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse2013Links**](InlineResponse2013Links.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] -**clientReferenceInformation** | [**InlineResponse201ClientReferenceInformation**](InlineResponse201ClientReferenceInformation.md) | | [optional] -**refundAmountDetails** | [**InlineResponse2013RefundAmountDetails**](InlineResponse2013RefundAmountDetails.md) | | [optional] -**processorInformation** | [**InlineResponse2013ProcessorInformation**](InlineResponse2013ProcessorInformation.md) | | [optional] -**orderInformation** | [**InlineResponse2013OrderInformation**](InlineResponse2013OrderInformation.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -PENDING | "PENDING" - - - diff --git a/docs/InlineResponse2013Links.md b/docs/InlineResponse2013Links.md deleted file mode 100644 index 36887a1af..000000000 --- a/docs/InlineResponse2013Links.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse2013Links - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**self** | [**InlineResponse201LinksSelf**](InlineResponse201LinksSelf.md) | | [optional] -**_void** | [**InlineResponse201LinksSelf**](InlineResponse201LinksSelf.md) | | [optional] - - - diff --git a/docs/InlineResponse2013OrderInformation.md b/docs/InlineResponse2013OrderInformation.md deleted file mode 100644 index 55265c4cc..000000000 --- a/docs/InlineResponse2013OrderInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse2013OrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**invoiceDetails** | [**InlineResponse201OrderInformationInvoiceDetails**](InlineResponse201OrderInformationInvoiceDetails.md) | | [optional] - - - diff --git a/docs/InlineResponse2013ProcessorInformation.md b/docs/InlineResponse2013ProcessorInformation.md deleted file mode 100644 index ce6dee8f0..000000000 --- a/docs/InlineResponse2013ProcessorInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse2013ProcessorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transactionId** | **String** | Processor transaction ID. This value identifies the transaction on a host system. This value is supported only for Moneris. It contains this information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. Example For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional] -**forwardedAcquirerCode** | **String** | Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway. Please contact the CyberSource Japan Support Group for more information. | [optional] - - - diff --git a/docs/InlineResponse2013RefundAmountDetails.md b/docs/InlineResponse2013RefundAmountDetails.md deleted file mode 100644 index eef6749aa..000000000 --- a/docs/InlineResponse2013RefundAmountDetails.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse2013RefundAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**refundAmount** | **String** | Total amount of the refund. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] - - - diff --git a/docs/InlineResponse2014.md b/docs/InlineResponse2014.md deleted file mode 100644 index 9ac3834d3..000000000 --- a/docs/InlineResponse2014.md +++ /dev/null @@ -1,25 +0,0 @@ - -# InlineResponse2014 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse2013Links**](InlineResponse2013Links.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] -**clientReferenceInformation** | [**InlineResponse201ClientReferenceInformation**](InlineResponse201ClientReferenceInformation.md) | | [optional] -**creditAmountDetails** | [**InlineResponse2014CreditAmountDetails**](InlineResponse2014CreditAmountDetails.md) | | [optional] -**processorInformation** | [**InlineResponse2013ProcessorInformation**](InlineResponse2013ProcessorInformation.md) | | [optional] -**orderInformation** | [**InlineResponse2013OrderInformation**](InlineResponse2013OrderInformation.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -PENDING | "PENDING" - - - diff --git a/docs/InlineResponse2014CreditAmountDetails.md b/docs/InlineResponse2014CreditAmountDetails.md deleted file mode 100644 index 165504081..000000000 --- a/docs/InlineResponse2014CreditAmountDetails.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse2014CreditAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**creditAmount** | **String** | Total amount of the credit. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] - - - diff --git a/docs/InlineResponse2015.md b/docs/InlineResponse2015.md deleted file mode 100644 index 21aae1bc8..000000000 --- a/docs/InlineResponse2015.md +++ /dev/null @@ -1,22 +0,0 @@ - -# InlineResponse2015 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse201EmbeddedCaptureLinks**](InlineResponse201EmbeddedCaptureLinks.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**clientReferenceInformation** | [**InlineResponse201ClientReferenceInformation**](InlineResponse201ClientReferenceInformation.md) | | [optional] -**voidAmountDetails** | [**InlineResponse2015VoidAmountDetails**](InlineResponse2015VoidAmountDetails.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -VOIDED | "VOIDED" - - - diff --git a/docs/InlineResponse2015VoidAmountDetails.md b/docs/InlineResponse2015VoidAmountDetails.md deleted file mode 100644 index 0f63a087c..000000000 --- a/docs/InlineResponse2015VoidAmountDetails.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InlineResponse2015VoidAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**voidAmount** | **String** | Total amount of the void. | [optional] -**originalTransactionAmount** | **String** | Amount of the original transaction. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] - - - diff --git a/docs/InlineResponse2016.md b/docs/InlineResponse2016.md deleted file mode 100644 index dc6b9d557..000000000 --- a/docs/InlineResponse2016.md +++ /dev/null @@ -1,36 +0,0 @@ - -# InlineResponse2016 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InstrumentidentifiersLinks**](InstrumentidentifiersLinks.md) | | [optional] -**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional] -**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. | [optional] -**state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] -**bankAccount** | [**PaymentinstrumentsBankAccount**](PaymentinstrumentsBankAccount.md) | | [optional] -**card** | [**PaymentinstrumentsCard**](PaymentinstrumentsCard.md) | | [optional] -**buyerInformation** | [**PaymentinstrumentsBuyerInformation**](PaymentinstrumentsBuyerInformation.md) | | [optional] -**billTo** | [**PaymentinstrumentsBillTo**](PaymentinstrumentsBillTo.md) | | [optional] -**processingInformation** | [**PaymentinstrumentsProcessingInformation**](PaymentinstrumentsProcessingInformation.md) | | [optional] -**merchantInformation** | [**PaymentinstrumentsMerchantInformation**](PaymentinstrumentsMerchantInformation.md) | | [optional] -**metaData** | [**InstrumentidentifiersMetadata**](InstrumentidentifiersMetadata.md) | | [optional] -**instrumentIdentifier** | [**PaymentinstrumentsInstrumentIdentifier**](PaymentinstrumentsInstrumentIdentifier.md) | | [optional] - - - -## Enum: ObjectEnum -Name | Value ----- | ----- -PAYMENTINSTRUMENT | "paymentInstrument" - - - -## Enum: StateEnum -Name | Value ----- | ----- -ACTIVE | "ACTIVE" -CLOSED | "CLOSED" - - - diff --git a/docs/InlineResponse201ClientReferenceInformation.md b/docs/InlineResponse201ClientReferenceInformation.md deleted file mode 100644 index 6b0e598fd..000000000 --- a/docs/InlineResponse201ClientReferenceInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse201ClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. | [optional] - - - diff --git a/docs/InlineResponse201Embedded.md b/docs/InlineResponse201Embedded.md deleted file mode 100644 index 6ffb24407..000000000 --- a/docs/InlineResponse201Embedded.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse201Embedded - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**capture** | [**InlineResponse201EmbeddedCapture**](InlineResponse201EmbeddedCapture.md) | | [optional] - - - diff --git a/docs/InlineResponse201EmbeddedCapture.md b/docs/InlineResponse201EmbeddedCapture.md deleted file mode 100644 index 128e8caf0..000000000 --- a/docs/InlineResponse201EmbeddedCapture.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse201EmbeddedCapture - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | **String** | The status of the submitted transaction. | [optional] -**links** | [**InlineResponse201EmbeddedCaptureLinks**](InlineResponse201EmbeddedCaptureLinks.md) | | [optional] - - - diff --git a/docs/InlineResponse201EmbeddedCaptureLinks.md b/docs/InlineResponse201EmbeddedCaptureLinks.md deleted file mode 100644 index 36096fe3e..000000000 --- a/docs/InlineResponse201EmbeddedCaptureLinks.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse201EmbeddedCaptureLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**self** | [**InlineResponse201LinksSelf**](InlineResponse201LinksSelf.md) | | [optional] - - - diff --git a/docs/InlineResponse201ErrorInformation.md b/docs/InlineResponse201ErrorInformation.md deleted file mode 100644 index ce7524ca6..000000000 --- a/docs/InlineResponse201ErrorInformation.md +++ /dev/null @@ -1,33 +0,0 @@ - -# InlineResponse201ErrorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. | [optional] -**message** | **String** | The detail message related to the status and reason listed above. | [optional] -**details** | [**List<InlineResponse201ErrorInformationDetails>**](InlineResponse201ErrorInformationDetails.md) | | [optional] - - - -## Enum: ReasonEnum -Name | Value ----- | ----- -AVS_FAILED | "AVS_FAILED" -CONTACT_PROCESSOR | "CONTACT_PROCESSOR" -CV_FAILED | "CV_FAILED" -EXPIRED_CARD | "EXPIRED_CARD" -PROCESSOR_DECLINED | "PROCESSOR_DECLINED" -INSUFFICIENT_FUND | "INSUFFICIENT_FUND" -STOLEN_LOST_CARD | "STOLEN_LOST_CARD" -ISSUER_UNAVAILABLE | "ISSUER_UNAVAILABLE" -UNAUTHORIZED_CARD | "UNAUTHORIZED_CARD" -CVN_NOT_MATCH | "CVN_NOT_MATCH" -EXCEEDS_CREDIT_LIMIT | "EXCEEDS_CREDIT_LIMIT" -INVALID_CVN | "INVALID_CVN" -PAYMENT_REFUSED | "PAYMENT_REFUSED" -INVALID_ACCOUNT | "INVALID_ACCOUNT" -GENERAL_DECLINE | "GENERAL_DECLINE" - - - diff --git a/docs/InlineResponse201ErrorInformationDetails.md b/docs/InlineResponse201ErrorInformationDetails.md deleted file mode 100644 index b1c77b8c5..000000000 --- a/docs/InlineResponse201ErrorInformationDetails.md +++ /dev/null @@ -1,19 +0,0 @@ - -# InlineResponse201ErrorInformationDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**field** | **String** | This is the flattened JSON object field name/path that is either missing or invalid. | [optional] -**reason** | [**ReasonEnum**](#ReasonEnum) | Possible reasons for the error. | [optional] - - - -## Enum: ReasonEnum -Name | Value ----- | ----- -MISSING_FIELD | "MISSING_FIELD" -INVALID_DATA | "INVALID_DATA" - - - diff --git a/docs/InlineResponse201Links.md b/docs/InlineResponse201Links.md deleted file mode 100644 index a9b391fa8..000000000 --- a/docs/InlineResponse201Links.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InlineResponse201Links - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**self** | [**InlineResponse201LinksSelf**](InlineResponse201LinksSelf.md) | | [optional] -**reversal** | [**InlineResponse201LinksSelf**](InlineResponse201LinksSelf.md) | | [optional] -**capture** | [**InlineResponse201LinksSelf**](InlineResponse201LinksSelf.md) | | [optional] - - - diff --git a/docs/InlineResponse201LinksSelf.md b/docs/InlineResponse201LinksSelf.md deleted file mode 100644 index ecf6e98f8..000000000 --- a/docs/InlineResponse201LinksSelf.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse201LinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **String** | URL | [optional] -**method** | **String** | HTTP method applied to above URL | [optional] - - - diff --git a/docs/InlineResponse201OrderInformation.md b/docs/InlineResponse201OrderInformation.md deleted file mode 100644 index 127c3b912..000000000 --- a/docs/InlineResponse201OrderInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse201OrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amountDetails** | [**InlineResponse201OrderInformationAmountDetails**](InlineResponse201OrderInformationAmountDetails.md) | | [optional] -**invoiceDetails** | [**InlineResponse201OrderInformationInvoiceDetails**](InlineResponse201OrderInformationInvoiceDetails.md) | | [optional] - - - diff --git a/docs/InlineResponse201OrderInformationAmountDetails.md b/docs/InlineResponse201OrderInformationAmountDetails.md deleted file mode 100644 index b3790a5b4..000000000 --- a/docs/InlineResponse201OrderInformationAmountDetails.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InlineResponse201OrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**totalAmount** | **String** | Amount you requested for the payment or capture. This value is returned for partial authorizations. | [optional] -**authorizedAmount** | **String** | Amount that was authorized. | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] - - - diff --git a/docs/InlineResponse201OrderInformationInvoiceDetails.md b/docs/InlineResponse201OrderInformationInvoiceDetails.md deleted file mode 100644 index 2e8a8ec48..000000000 --- a/docs/InlineResponse201OrderInformationInvoiceDetails.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse201OrderInformationInvoiceDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**level3TransmissionStatus** | **Boolean** | Indicates whether CyberSource sent the Level III information to the processor. The possible values are: If your account is not enabled for Level III data or if you did not include the purchasing level field in your request, CyberSource does not include the Level III data in the request sent to the processor. For processor-specific information, see the bill_purchasing_level3_enabled field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] - - - diff --git a/docs/InlineResponse201PaymentInformation.md b/docs/InlineResponse201PaymentInformation.md deleted file mode 100644 index 501554cbd..000000000 --- a/docs/InlineResponse201PaymentInformation.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InlineResponse201PaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**InlineResponse201PaymentInformationCard**](InlineResponse201PaymentInformationCard.md) | | [optional] -**tokenizedCard** | [**InlineResponse201PaymentInformationTokenizedCard**](InlineResponse201PaymentInformationTokenizedCard.md) | | [optional] -**accountFeatures** | [**InlineResponse201PaymentInformationAccountFeatures**](InlineResponse201PaymentInformationAccountFeatures.md) | | [optional] - - - diff --git a/docs/InlineResponse201PaymentInformationAccountFeatures.md b/docs/InlineResponse201PaymentInformationAccountFeatures.md deleted file mode 100644 index 03e5f45e8..000000000 --- a/docs/InlineResponse201PaymentInformationAccountFeatures.md +++ /dev/null @@ -1,34 +0,0 @@ - -# InlineResponse201PaymentInformationAccountFeatures - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**accountType** | **String** | Type of account. This value is returned only if you requested a balance inquiry. Possible values: - **00**: Not applicable or not specified - **10**: Savings account - **20**: Checking account - **30**: Credit card account - **40**: Universal account | [optional] -**accountStatus** | **String** | Possible values: - **N**: Nonregulated - **R**: Regulated `Note` This field is returned only for CyberSource through VisaNet. | [optional] -**balanceAmount** | **String** | Remaining balance on the account. | [optional] -**balanceAmountType** | **String** | Type of amount. This value is returned only if you requested a balance inquiry. The issuer determines the value that is returned. Possible values for deposit accounts: - **01**: Current ledger (posted) balance. - **02**: Current available balance, which is typically the ledger balance less outstanding authorizations. Some depository institutions also include pending deposits and the credit or overdraft line associated with the account. Possible values for credit card accounts: - **01**: Credit amount remaining for customer (open to buy). - **02**: Credit limit. | [optional] -**currency** | **String** | Currency of the remaining balance on the account. For the possible values, see the ISO Standard Currency Codes. | [optional] -**balanceSign** | [**BalanceSignEnum**](#BalanceSignEnum) | Sign for the remaining balance on the account. Returned only when the processor returns this value. Possible values: | [optional] -**affluenceIndicator** | **String** | **Chase Paymentech Solutions** Indicates whether a customer has high credit limits. This information enables you to market high cost items to these customers and to understand the kinds of cards that high income customers are using. This field is supported for Visa, Mastercard, Discover, and Diners Club. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown **Litle** Flag that indicates that a Visa cardholder or Mastercard cardholder is in one of the affluent categories. Possible values: - **AFFLUENT**: High income customer with high spending pattern (>100k USD annual income and >40k USD annual card usage). - **MASS AFFLUENT**: High income customer (>100k USD annual income). **Processor specific maximum length**: - Chase Paymentech Solutions: 1 - Litle: 13 | [optional] -**category** | **String** | **CyberSource through VisaNet** Visa product ID. **GPN** Visa or Mastercard product ID. **Litle** Type of card used in the transaction. The only possible value is: - PREPAID: Prepaid Card **RBS WorldPay Atlanta** Type of card used in the transaction. Possible values: - **B**: Business Card - **O**: Noncommercial Card - **R**: Corporate Card - **S**: Purchase Card - **Blank**: Purchase card not supported **Maximum length for processors**: - CyberSource through VisaNet: 3 - GPN: 3 - Litle: 7 - RBS WorldPay Atlanta: 1 | [optional] -**commercial** | **String** | Indicates whether the card is a commercial card, which enables you to include Level II data in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown | [optional] -**group** | **String** | Type of commercial card. This field is supported only for CyberSource through VisaNet. Possible values: - **B**: Business card - **R**: Corporate card - **S**: Purchasing card - **0**: Noncommercial card | [optional] -**healthCare** | **String** | Indicates whether the card is a healthcare card. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown | [optional] -**payroll** | **String** | Indicates whether the card is a payroll card. This field is supported for Visa, Discover, Diners Club, and JCB on **Chase Paymentech Solutions**. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown | [optional] -**level3Eligible** | **String** | Indicates whether the card is eligible for Level III interchange fees, which enables you to include Level III data in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown | [optional] -**pinlessDebit** | **String** | Indicates whether the card is a PINless debit card. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown | [optional] -**signatureDebit** | **String** | Indicates whether the card is a signature debit card. This information enables you to alter the way an order is processed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might want to perform reversals promptly for a signature debit card. This field is supported for Visa, Mastercard, and Maestro (International) on Chase Paymentech Solutions. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown | [optional] -**prepaid** | **String** | Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or prepaid card is presented for use when establishing a new recurring, installment, or deferred billing relationship. This field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions. Possible values: - **Y**: Yes - **N**: No - **X**: Not applicable / Unknown | [optional] -**regulated** | **String** | Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card issuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions. Possible values: - **Y**: Yes (assets greater than 10B USD) - **N**: No (assets less than 10B USD) - **X**: Not applicable / Unknown | [optional] - - - -## Enum: BalanceSignEnum -Name | Value ----- | ----- -PLUS | "+" -MINUS | "-" - - - diff --git a/docs/InlineResponse201PaymentInformationCard.md b/docs/InlineResponse201PaymentInformationCard.md deleted file mode 100644 index b5b86f282..000000000 --- a/docs/InlineResponse201PaymentInformationCard.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse201PaymentInformationCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**suffix** | **String** | Last four digits of the cardholder’s account number. This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder. | [optional] - - - diff --git a/docs/InlineResponse201PaymentInformationTokenizedCard.md b/docs/InlineResponse201PaymentInformationTokenizedCard.md deleted file mode 100644 index b2331dbf8..000000000 --- a/docs/InlineResponse201PaymentInformationTokenizedCard.md +++ /dev/null @@ -1,16 +0,0 @@ - -# InlineResponse201PaymentInformationTokenizedCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**prefix** | **String** | First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] -**suffix** | **String** | Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] -**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover | [optional] -**assuranceLevel** | **String** | Confidence level of the tokenization. This value is assigned by the token service provider. `Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. | [optional] -**expirationMonth** | **String** | Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12. | [optional] -**expirationYear** | **String** | Four-digit year in which the payment network token expires. `Format: YYYY`. | [optional] -**requestorId** | **String** | Value that identifies your business and indicates that the cardholder’s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider’s database. `Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. | [optional] - - - diff --git a/docs/InlineResponse201PointOfSaleInformation.md b/docs/InlineResponse201PointOfSaleInformation.md deleted file mode 100644 index e72a3e3f9..000000000 --- a/docs/InlineResponse201PointOfSaleInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse201PointOfSaleInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**emv** | [**InlineResponse201PointOfSaleInformationEmv**](InlineResponse201PointOfSaleInformationEmv.md) | | [optional] -**amexCapnData** | **String** | Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. | [optional] - - - diff --git a/docs/InlineResponse201PointOfSaleInformationEmv.md b/docs/InlineResponse201PointOfSaleInformationEmv.md deleted file mode 100644 index 805da744d..000000000 --- a/docs/InlineResponse201PointOfSaleInformationEmv.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse201PointOfSaleInformationEmv - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tags** | **String** | EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. `Important` The following tags contain sensitive information and **must not** be included in this field: - **56**: Track 1 equivalent data - **57**: Track 2 equivalent data - **5A**: Application PAN - **5F20**: Cardholder name - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six) - **99**: Transaction PIN - **9F0B**: Cardholder name (extended) - **9F1F**: Track 1 discretionary data - **9F20**: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. `Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - **95**: Terminal verification results - **9F10**: Issuer application data - **9F26**: Application cryptogram | [optional] - - - diff --git a/docs/InlineResponse201ProcessorInformation.md b/docs/InlineResponse201ProcessorInformation.md deleted file mode 100644 index 1f8acf6e7..000000000 --- a/docs/InlineResponse201ProcessorInformation.md +++ /dev/null @@ -1,34 +0,0 @@ - -# InlineResponse201ProcessorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**approvalCode** | **String** | Authorization code. Returned only when the processor returns this value. | [optional] -**transactionId** | **String** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. | [optional] -**networkTransactionId** | **String** | TBD | [optional] -**providerTransactionId** | **String** | TBD | [optional] -**responseCode** | **String** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. Important Do not use this field to evaluate the result of the authorization. | [optional] -**responseCodeSource** | **String** | Used by Visa only and contains the response source/reason code that identifies the source of the response decision. | [optional] -**responseDetails** | **String** | This field might contain information about a decline. This field is supported only for **CyberSource through VisaNet**. | [optional] -**responseCategoryCode** | **String** | Processor-defined response category code. The associated detail error code is in the auth_auth_response field or the auth_reversal_auth_ response field depending on which service you requested. This field is supported only for: - Japanese issuers - Domestic transactions in Japan - Comercio Latino—processor transaction ID required for troubleshooting **Maximum length for processors**: - Comercio Latino: 32 - All other processors: 3 | [optional] -**forwardedAcquirerCode** | **String** | Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway. Please contact the CyberSource Japan Support Group for more information. | [optional] -**avs** | [**InlineResponse201ProcessorInformationAvs**](InlineResponse201ProcessorInformationAvs.md) | | [optional] -**cardVerification** | [**InlineResponse201ProcessorInformationCardVerification**](InlineResponse201ProcessorInformationCardVerification.md) | | [optional] -**merchantAdvice** | [**InlineResponse201ProcessorInformationMerchantAdvice**](InlineResponse201ProcessorInformationMerchantAdvice.md) | | [optional] -**electronicVerificationResults** | [**InlineResponse201ProcessorInformationElectronicVerificationResults**](InlineResponse201ProcessorInformationElectronicVerificationResults.md) | | [optional] -**customer** | [**InlineResponse201ProcessorInformationCustomer**](InlineResponse201ProcessorInformationCustomer.md) | | [optional] -**consumerAuthenticationResponse** | [**InlineResponse201ProcessorInformationConsumerAuthenticationResponse**](InlineResponse201ProcessorInformationConsumerAuthenticationResponse.md) | | [optional] -**issuer** | [**InlineResponse201ProcessorInformationIssuer**](InlineResponse201ProcessorInformationIssuer.md) | | [optional] -**systemTraceAuditNumber** | **String** | This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. **American Express Direct** System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. **CyberSource through VisaNet** System trace number that must be printed on the customer’s receipt. | [optional] -**paymentAccountReferenceNumber** | **String** | Visa-generated reference number that identifies a card-present transaction for which youprovided one of the following: - Visa primary account number (PAN) - Visa-generated token for a PAN This reference number serves as a link to the cardholder account and to all transactions for that account. | [optional] -**transactionIntegrityCode** | **String** | Transaction integrity classification provided by Mastercard. This value specifies Mastercard’s evaluation of the transaction’s safety and security. This field is returned only for **CyberSource through VisaNet**. For card-present transactions, possible values: - **A1**: EMV or token in a secure, trusted environment - **B1**: EMV or chip equivalent - **C1**: Magnetic stripe - **E1**: Key entered - **U0**: Unclassified For card-not-present transactions, possible values: - **A2**: Digital transactions - **B2**: Authenticated checkout - **C2**: Transaction validation - **D2**: Enhanced data - **E2**: Generic messaging - **U0**: Unclassified For information about these values, contact Mastercard or your acquirer. | [optional] -**amexVerbalAuthReferenceNumber** | **String** | Referral response number for a verbal authorization with FDMS Nashville when using an American Express card. Give this number to American Express when you call them for the verbal authorization. | [optional] -**salesSlipNumber** | [**BigDecimal**](BigDecimal.md) | Transaction identifier that CyberSource generates. You have the option of printing the sales slip number on the receipt. This field is supported only for **JCN Gateway**. | [optional] -**masterCardServiceCode** | **String** | Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service | [optional] -**masterCardServiceReplyCode** | **String** | Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource. Possible values: - **C**: Service completed successfully. - **F**: One of the following: - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or authorization reversal. - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request. - Token requestor ID is missing or formatted incorrectly. - **I**: One of the following: - Invalid token requestor ID. - Suspended or deactivated token. - Invalid token (not in mapping table). - **T**: Invalid combination of token requestor ID and token. - **U**: Expired token. - **W**: Primary account number (PAN) listed in electronic warning bulletin. Note This field is returned only for **CyberSource through VisaNet**. | [optional] -**masterCardAuthenticationType** | **String** | Type of authentication for which the transaction qualifies as determined by the Mastercard authentication service, which confirms the identity of the cardholder. Mastercard provides this value to CyberSource. Possible values: - **1**: Transaction qualifies for Mastercard authentication type 1. - **2**: Transaction qualifies for Mastercard authentication type 2. | [optional] -**name** | **String** | Name of the Processor. | [optional] - - - diff --git a/docs/InlineResponse201ProcessorInformationAvs.md b/docs/InlineResponse201ProcessorInformationAvs.md deleted file mode 100644 index 7d9c9db1b..000000000 --- a/docs/InlineResponse201ProcessorInformationAvs.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse201ProcessorInformationAvs - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **String** | AVS result code. | [optional] -**codeRaw** | **String** | AVS result code sent directly from the processor. Returned only when the processor returns this value. Important Do not use this field to evaluate the result of AVS. Use for debugging purposes only. | [optional] - - - diff --git a/docs/InlineResponse201ProcessorInformationCardVerification.md b/docs/InlineResponse201ProcessorInformationCardVerification.md deleted file mode 100644 index a9c5ddd07..000000000 --- a/docs/InlineResponse201ProcessorInformationCardVerification.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse201ProcessorInformationCardVerification - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**resultCode** | **String** | CVN result code. | [optional] -**resultCodeRaw** | **String** | CVN result code sent directly from the processor. Returned only when the processor returns this value. `Important` Do not use this field to evaluate the result of card verification. Use for debugging purposes only. | [optional] - - - diff --git a/docs/InlineResponse201ProcessorInformationConsumerAuthenticationResponse.md b/docs/InlineResponse201ProcessorInformationConsumerAuthenticationResponse.md deleted file mode 100644 index 8154b0521..000000000 --- a/docs/InlineResponse201ProcessorInformationConsumerAuthenticationResponse.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse201ProcessorInformationConsumerAuthenticationResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **String** | Mapped response code for Verified by Visa and American Express SafeKey: | [optional] -**codeRaw** | **String** | Raw response code sent directly from the processor for Verified by Visa and American Express SafeKey: | [optional] - - - diff --git a/docs/InlineResponse201ProcessorInformationCustomer.md b/docs/InlineResponse201ProcessorInformationCustomer.md deleted file mode 100644 index 2e842e52e..000000000 --- a/docs/InlineResponse201ProcessorInformationCustomer.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse201ProcessorInformationCustomer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**personalIdResult** | **String** | Personal identifier result. This field is supported only for Redecard in Brazil for CyberSource Latin American Processing. If you included _buyerInformation.personalIdentification[].ID_ in the request, this value indicates whether or not _buyerInformation.personalIdentification[].ID_ matched a value in a record on file. Returned only when the personal ID result is returned by the processor. Possible values: - **Y**: Match - **N**: No match - **K**: Not supported - **U**: Unknown - **Z**: No response returned | [optional] - - - diff --git a/docs/InlineResponse201ProcessorInformationElectronicVerificationResults.md b/docs/InlineResponse201ProcessorInformationElectronicVerificationResults.md deleted file mode 100644 index ee113cb8d..000000000 --- a/docs/InlineResponse201ProcessorInformationElectronicVerificationResults.md +++ /dev/null @@ -1,21 +0,0 @@ - -# InlineResponse201ProcessorInformationElectronicVerificationResults - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **String** | Mapped Electronic Verification response code for the customer’s name. | [optional] -**codeRaw** | **String** | Raw Electronic Verification response code from the processor for the customer’s last name | [optional] -**email** | **String** | Mapped Electronic Verification response code for the customer’s email address. | [optional] -**emailRaw** | **String** | Raw Electronic Verification response code from the processor for the customer’s email address. | [optional] -**phoneNumber** | **String** | Mapped Electronic Verification response code for the customer’s phone number. | [optional] -**phoneNumberRaw** | **String** | Raw Electronic Verification response code from the processor for the customer’s phone number. | [optional] -**postalCode** | **String** | Mapped Electronic Verification response code for the customer’s postal code. | [optional] -**postalCodeRaw** | **String** | Raw Electronic Verification response code from the processor for the customer’s postal code. | [optional] -**street** | **String** | Mapped Electronic Verification response code for the customer’s street address. | [optional] -**streetRaw** | **String** | Raw Electronic Verification response code from the processor for the customer’s street address. | [optional] -**name** | **String** | TODO | [optional] -**nameRaw** | **String** | TODO | [optional] - - - diff --git a/docs/InlineResponse201ProcessorInformationIssuer.md b/docs/InlineResponse201ProcessorInformationIssuer.md deleted file mode 100644 index 1fd183dd0..000000000 --- a/docs/InlineResponse201ProcessorInformationIssuer.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse201ProcessorInformationIssuer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**country** | **String** | Country in which the card was issued. This information enables you to determine whether the card was issued domestically or internationally. Use the two-character ISO Standard Country Codes. This field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase Paymentech Solutions. | [optional] -**discretionaryData** | **String** | Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. | [optional] - - - diff --git a/docs/InlineResponse201ProcessorInformationMerchantAdvice.md b/docs/InlineResponse201ProcessorInformationMerchantAdvice.md deleted file mode 100644 index d31c56305..000000000 --- a/docs/InlineResponse201ProcessorInformationMerchantAdvice.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InlineResponse201ProcessorInformationMerchantAdvice - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **String** | Reason the recurring payment transaction was declined. For some processors, this field is used only for Mastercard. For other processors, this field is used for Visa and Mastercard. And for other processors, this field is not implemented. Possible values: - **00**: Response not provided. - **01**: New account information is available. Obtain the new information. - **02**: Try again later. - **03**: Do not try again. Obtain another type of payment from the customer. - **04**: Problem with a token or a partial shipment indicator. - **21**: Recurring payment cancellation service. - **99**: An unknown value was returned from the processor. | [optional] -**codeRaw** | **String** | Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. For processor-specific information, see the auth_merchant_advice_code_raw field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] - - - diff --git a/docs/InlineResponse4002.md b/docs/InlineResponse4002.md deleted file mode 100644 index f24e89f69..000000000 --- a/docs/InlineResponse4002.md +++ /dev/null @@ -1,36 +0,0 @@ - -# InlineResponse4002 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. | [optional] -**message** | **String** | The detail message related to the status and reason listed above. | [optional] -**details** | [**List<InlineResponse201ErrorInformationDetails>**](InlineResponse201ErrorInformationDetails.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -REQUEST | "INVALID_REQUEST" - - - -## Enum: ReasonEnum -Name | Value ----- | ----- -MISSING_FIELD | "MISSING_FIELD" -INVALID_DATA | "INVALID_DATA" -DUPLICATE_REQUEST | "DUPLICATE_REQUEST" -INVALID_MERCHANT_CONFIGURATION | "INVALID_MERCHANT_CONFIGURATION" -EXCEEDS_AUTH_AMOUNT | "EXCEEDS_AUTH_AMOUNT" -AUTH_ALREADY_REVERSED | "AUTH_ALREADY_REVERSED" -TRANSACTION_ALREADY_SETTLED | "TRANSACTION_ALREADY_SETTLED" -MISSING_AUTH | "MISSING_AUTH" -TRANSACTION_ALREADY_REVERSED_OR_SETTLED | "TRANSACTION_ALREADY_REVERSED_OR_SETTLED" - - - diff --git a/docs/InlineResponse4003.md b/docs/InlineResponse4003.md deleted file mode 100644 index 4898de1bb..000000000 --- a/docs/InlineResponse4003.md +++ /dev/null @@ -1,34 +0,0 @@ - -# InlineResponse4003 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. | [optional] -**message** | **String** | The detail message related to the status and reason listed above. | [optional] -**details** | [**List<InlineResponse201ErrorInformationDetails>**](InlineResponse201ErrorInformationDetails.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -REQUEST | "INVALID_REQUEST" - - - -## Enum: ReasonEnum -Name | Value ----- | ----- -MISSING_FIELD | "MISSING_FIELD" -INVALID_DATA | "INVALID_DATA" -DUPLICATE_REQUEST | "DUPLICATE_REQUEST" -INVALID_CARD | "INVALID_CARD" -INVALID_MERCHANT_CONFIGURATION | "INVALID_MERCHANT_CONFIGURATION" -CAPTURE_ALREADY_VOIDED | "CAPTURE_ALREADY_VOIDED" -ACCOUNT_NOT_ALLOWED_CREDIT | "ACCOUNT_NOT_ALLOWED_CREDIT" - - - diff --git a/docs/InlineResponse4004.md b/docs/InlineResponse4004.md deleted file mode 100644 index c9d8e1c40..000000000 --- a/docs/InlineResponse4004.md +++ /dev/null @@ -1,32 +0,0 @@ - -# InlineResponse4004 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. | [optional] -**message** | **String** | The detail message related to the status and reason listed above. | [optional] -**details** | [**List<InlineResponse201ErrorInformationDetails>**](InlineResponse201ErrorInformationDetails.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -REQUEST | "INVALID_REQUEST" - - - -## Enum: ReasonEnum -Name | Value ----- | ----- -MISSING_FIELD | "MISSING_FIELD" -INVALID_DATA | "INVALID_DATA" -DUPLICATE_REQUEST | "DUPLICATE_REQUEST" -INVALID_MERCHANT_CONFIGURATION | "INVALID_MERCHANT_CONFIGURATION" -NOT_VOIDABLE | "NOT_VOIDABLE" - - - diff --git a/docs/InlineResponse4005.md b/docs/InlineResponse4005.md deleted file mode 100644 index 017d528ae..000000000 --- a/docs/InlineResponse4005.md +++ /dev/null @@ -1,26 +0,0 @@ - -# InlineResponse4005 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | **String** | The status of the submitted transaction. | [optional] -**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. | [optional] -**message** | **String** | The detail message related to the status and reason listed above. Possible value is: - Your aggregator or acquirer is not accepting transactions from you at this time. - Your aggregator or acquirer is not accepting this transaction. - CyberSource declined the request because the credit card has expired. You might also receive this value if the expiration date you provided does not match the date the issuing bank has on file. - The bank declined the transaction. - The merchant reference number for this authorization request matches the merchant reference number of another authorization request that you sent within the past 15 minutes. Resend the request with a unique merchant reference number. - The credit card number did not pass CyberSource basic checks. - Data provided is not consistent with the request. For example, you requested a product with negative cost. - The request is missing a required field. | [optional] -**details** | [**List<InlineResponse201ErrorInformationDetails>**](InlineResponse201ErrorInformationDetails.md) | | [optional] - - - -## Enum: ReasonEnum -Name | Value ----- | ----- -MISSING_FIELD | "MISSING_FIELD" -INVALID_DATA | "INVALID_DATA" -DUPLICATE_REQUEST | "DUPLICATE_REQUEST" -INVALID_MERCHANT_CONFIGURATION | "INVALID_MERCHANT_CONFIGURATION" -INVALID_AMOUNT | "INVALID_AMOUNT" -DEBIT_CARD_USEAGE_EXCEEDD_LIMIT | "DEBIT_CARD_USEAGE_EXCEEDD_LIMIT" - - - diff --git a/docs/InlineResponse4006.md b/docs/InlineResponse4006.md deleted file mode 100644 index 75e01d79b..000000000 --- a/docs/InlineResponse4006.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InlineResponse4006 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **String** | | [optional] -**message** | **String** | The detailed message related to the type stated above. | [optional] -**details** | [**InstrumentidentifiersDetails**](InstrumentidentifiersDetails.md) | | [optional] - - - diff --git a/docs/InlineResponse409.md b/docs/InlineResponse409.md deleted file mode 100644 index d656cdaac..000000000 --- a/docs/InlineResponse409.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse409 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InlineResponse409Links**](InlineResponse409Links.md) | | [optional] - - - diff --git a/docs/InlineResponse409Links.md b/docs/InlineResponse409Links.md deleted file mode 100644 index 85fd0c10b..000000000 --- a/docs/InlineResponse409Links.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse409Links - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**paymentInstruments** | [**InlineResponse409LinksPaymentInstruments**](InlineResponse409LinksPaymentInstruments.md) | | [optional] - - - diff --git a/docs/InlineResponse409LinksPaymentInstruments.md b/docs/InlineResponse409LinksPaymentInstruments.md deleted file mode 100644 index 64a4ac828..000000000 --- a/docs/InlineResponse409LinksPaymentInstruments.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InlineResponse409LinksPaymentInstruments - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **String** | | [optional] - - - diff --git a/docs/InlineResponse502.md b/docs/InlineResponse502.md deleted file mode 100644 index 3a9443496..000000000 --- a/docs/InlineResponse502.md +++ /dev/null @@ -1,30 +0,0 @@ - -# InlineResponse502 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. | [optional] -**message** | **String** | The detail message related to the status and reason listed above. | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -ERROR | "SERVER_ERROR" - - - -## Enum: ReasonEnum -Name | Value ----- | ----- -SYSTEM_ERROR | "SYSTEM_ERROR" -SERVER_TIMEOUT | "SERVER_TIMEOUT" -SERVICE_TIMEOUT | "SERVICE_TIMEOUT" -PROCESSOR_TIMEOUT | "PROCESSOR_TIMEOUT" - - - diff --git a/docs/InstrumentIdentifierApi.md b/docs/InstrumentIdentifierApi.md index 0841fccf5..9fca9cd64 100644 --- a/docs/InstrumentIdentifierApi.md +++ b/docs/InstrumentIdentifierApi.md @@ -4,14 +4,61 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**tmsV1InstrumentidentifiersTokenIdDelete**](InstrumentIdentifierApi.md#tmsV1InstrumentidentifiersTokenIdDelete) | **DELETE** /tms/v1/instrumentidentifiers/{tokenId} | Delete an Instrument Identifier -[**tmsV1InstrumentidentifiersTokenIdGet**](InstrumentIdentifierApi.md#tmsV1InstrumentidentifiersTokenIdGet) | **GET** /tms/v1/instrumentidentifiers/{tokenId} | Retrieve an Instrument Identifier -[**tmsV1InstrumentidentifiersTokenIdPatch**](InstrumentIdentifierApi.md#tmsV1InstrumentidentifiersTokenIdPatch) | **PATCH** /tms/v1/instrumentidentifiers/{tokenId} | Update a Instrument Identifier +[**createInstrumentIdentifier**](InstrumentIdentifierApi.md#createInstrumentIdentifier) | **POST** /tms/v1/instrumentidentifiers | Create an Instrument Identifier +[**deleteInstrumentIdentifier**](InstrumentIdentifierApi.md#deleteInstrumentIdentifier) | **DELETE** /tms/v1/instrumentidentifiers/{tokenId} | Delete an Instrument Identifier +[**getAllPaymentInstruments**](InstrumentIdentifierApi.md#getAllPaymentInstruments) | **GET** /tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments | Retrieve all Payment Instruments associated with an Instrument Identifier +[**getInstrumentIdentifier**](InstrumentIdentifierApi.md#getInstrumentIdentifier) | **GET** /tms/v1/instrumentidentifiers/{tokenId} | Retrieve an Instrument Identifier +[**updateInstrumentIdentifier**](InstrumentIdentifierApi.md#updateInstrumentIdentifier) | **PATCH** /tms/v1/instrumentidentifiers/{tokenId} | Update a Instrument Identifier - -# **tmsV1InstrumentidentifiersTokenIdDelete** -> tmsV1InstrumentidentifiersTokenIdDelete(profileId, tokenId) + +# **createInstrumentIdentifier** +> TmsV1InstrumentIdentifiersPost200Response createInstrumentIdentifier(profileId, createInstrumentIdentifierRequest) + +Create an Instrument Identifier + +### Example +```java +// Import classes: +//import Invokers.ApiException; +//import Api.InstrumentIdentifierApi; + + +InstrumentIdentifierApi apiInstance = new InstrumentIdentifierApi(); +String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. +CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest = new CreateInstrumentIdentifierRequest(); // CreateInstrumentIdentifierRequest | Please specify either a Card, Bank Account or Enrollable Card +try { + TmsV1InstrumentIdentifiersPost200Response result = apiInstance.createInstrumentIdentifier(profileId, createInstrumentIdentifierRequest); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling InstrumentIdentifierApi#createInstrumentIdentifier"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profileId** | **String**| The id of a profile containing user specific TMS configuration. | + **createInstrumentIdentifierRequest** | [**CreateInstrumentIdentifierRequest**](CreateInstrumentIdentifierRequest.md)| Please specify either a Card, Bank Account or Enrollable Card | + +### Return type + +[**TmsV1InstrumentIdentifiersPost200Response**](TmsV1InstrumentIdentifiersPost200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json;charset=utf-8 + + +# **deleteInstrumentIdentifier** +> deleteInstrumentIdentifier(profileId, tokenId) Delete an Instrument Identifier @@ -26,9 +73,9 @@ InstrumentIdentifierApi apiInstance = new InstrumentIdentifierApi(); String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. String tokenId = "tokenId_example"; // String | The TokenId of an Instrument Identifier. try { - apiInstance.tmsV1InstrumentidentifiersTokenIdDelete(profileId, tokenId); + apiInstance.deleteInstrumentIdentifier(profileId, tokenId); } catch (ApiException e) { - System.err.println("Exception when calling InstrumentIdentifierApi#tmsV1InstrumentidentifiersTokenIdDelete"); + System.err.println("Exception when calling InstrumentIdentifierApi#deleteInstrumentIdentifier"); e.printStackTrace(); } ``` @@ -53,9 +100,58 @@ No authorization required - **Content-Type**: application/json;charset=utf-8 - **Accept**: application/json;charset=utf-8 - -# **tmsV1InstrumentidentifiersTokenIdGet** -> TmsV1InstrumentidentifiersPost200Response tmsV1InstrumentidentifiersTokenIdGet(profileId, tokenId) + +# **getAllPaymentInstruments** +> TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response getAllPaymentInstruments(profileId, tokenId, offset, limit) + +Retrieve all Payment Instruments associated with an Instrument Identifier + +### Example +```java +// Import classes: +//import Invokers.ApiException; +//import Api.InstrumentIdentifierApi; + + +InstrumentIdentifierApi apiInstance = new InstrumentIdentifierApi(); +String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. +String tokenId = "tokenId_example"; // String | The TokenId of an Instrument Identifier. +Long offset = 0L; // Long | Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. +Long limit = 20L; // Long | The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. +try { + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response result = apiInstance.getAllPaymentInstruments(profileId, tokenId, offset, limit); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling InstrumentIdentifierApi#getAllPaymentInstruments"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **profileId** | **String**| The id of a profile containing user specific TMS configuration. | + **tokenId** | **String**| The TokenId of an Instrument Identifier. | + **offset** | **Long**| Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. | [optional] [default to 0] + **limit** | **Long**| The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. | [optional] [default to 20] + +### Return type + +[**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json;charset=utf-8 + + +# **getInstrumentIdentifier** +> TmsV1InstrumentIdentifiersPost200Response getInstrumentIdentifier(profileId, tokenId) Retrieve an Instrument Identifier @@ -70,10 +166,10 @@ InstrumentIdentifierApi apiInstance = new InstrumentIdentifierApi(); String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. String tokenId = "tokenId_example"; // String | The TokenId of an Instrument Identifier. try { - TmsV1InstrumentidentifiersPost200Response result = apiInstance.tmsV1InstrumentidentifiersTokenIdGet(profileId, tokenId); + TmsV1InstrumentIdentifiersPost200Response result = apiInstance.getInstrumentIdentifier(profileId, tokenId); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling InstrumentIdentifierApi#tmsV1InstrumentidentifiersTokenIdGet"); + System.err.println("Exception when calling InstrumentIdentifierApi#getInstrumentIdentifier"); e.printStackTrace(); } ``` @@ -87,7 +183,7 @@ Name | Type | Description | Notes ### Return type -[**TmsV1InstrumentidentifiersPost200Response**](TmsV1InstrumentidentifiersPost200Response.md) +[**TmsV1InstrumentIdentifiersPost200Response**](TmsV1InstrumentIdentifiersPost200Response.md) ### Authorization @@ -98,9 +194,9 @@ No authorization required - **Content-Type**: application/json;charset=utf-8 - **Accept**: application/json;charset=utf-8 - -# **tmsV1InstrumentidentifiersTokenIdPatch** -> TmsV1InstrumentidentifiersPost200Response tmsV1InstrumentidentifiersTokenIdPatch(profileId, tokenId, body) + +# **updateInstrumentIdentifier** +> TmsV1InstrumentIdentifiersPost200Response updateInstrumentIdentifier(profileId, tokenId, updateInstrumentIdentifierRequest) Update a Instrument Identifier @@ -114,12 +210,12 @@ Update a Instrument Identifier InstrumentIdentifierApi apiInstance = new InstrumentIdentifierApi(); String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. String tokenId = "tokenId_example"; // String | The TokenId of an Instrument Identifier. -Body1 body = new Body1(); // Body1 | Please specify the previous transaction Id to update. +UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest = new UpdateInstrumentIdentifierRequest(); // UpdateInstrumentIdentifierRequest | Specify the previous transaction ID to update. try { - TmsV1InstrumentidentifiersPost200Response result = apiInstance.tmsV1InstrumentidentifiersTokenIdPatch(profileId, tokenId, body); + TmsV1InstrumentIdentifiersPost200Response result = apiInstance.updateInstrumentIdentifier(profileId, tokenId, updateInstrumentIdentifierRequest); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling InstrumentIdentifierApi#tmsV1InstrumentidentifiersTokenIdPatch"); + System.err.println("Exception when calling InstrumentIdentifierApi#updateInstrumentIdentifier"); e.printStackTrace(); } ``` @@ -130,11 +226,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **profileId** | **String**| The id of a profile containing user specific TMS configuration. | **tokenId** | **String**| The TokenId of an Instrument Identifier. | - **body** | [**Body1**](Body1.md)| Please specify the previous transaction Id to update. | + **updateInstrumentIdentifierRequest** | [**UpdateInstrumentIdentifierRequest**](UpdateInstrumentIdentifierRequest.md)| Specify the previous transaction ID to update. | ### Return type -[**TmsV1InstrumentidentifiersPost200Response**](TmsV1InstrumentidentifiersPost200Response.md) +[**TmsV1InstrumentIdentifiersPost200Response**](TmsV1InstrumentIdentifiersPost200Response.md) ### Authorization diff --git a/docs/InstrumentIdentifiersApi.md b/docs/InstrumentIdentifiersApi.md deleted file mode 100644 index 30682a79c..000000000 --- a/docs/InstrumentIdentifiersApi.md +++ /dev/null @@ -1,54 +0,0 @@ -# InstrumentIdentifiersApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**tmsV1InstrumentidentifiersPost**](InstrumentIdentifiersApi.md#tmsV1InstrumentidentifiersPost) | **POST** /tms/v1/instrumentidentifiers | Create an Instrument Identifier - - - -# **tmsV1InstrumentidentifiersPost** -> TmsV1InstrumentidentifiersPost200Response tmsV1InstrumentidentifiersPost(profileId, body) - -Create an Instrument Identifier - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.InstrumentIdentifiersApi; - - -InstrumentIdentifiersApi apiInstance = new InstrumentIdentifiersApi(); -String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. -Body body = new Body(); // Body | Please specify either a Card or Bank Account. -try { - TmsV1InstrumentidentifiersPost200Response result = apiInstance.tmsV1InstrumentidentifiersPost(profileId, body); - System.out.println(result); -} catch (ApiException e) { - System.err.println("Exception when calling InstrumentIdentifiersApi#tmsV1InstrumentidentifiersPost"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **profileId** | **String**| The id of a profile containing user specific TMS configuration. | - **body** | [**Body**](Body.md)| Please specify either a Card or Bank Account. | - -### Return type - -[**TmsV1InstrumentidentifiersPost200Response**](TmsV1InstrumentidentifiersPost200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - diff --git a/docs/InstrumentidentifiersCard.md b/docs/InstrumentidentifiersCard.md deleted file mode 100644 index 5dfb10df4..000000000 --- a/docs/InstrumentidentifiersCard.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InstrumentidentifiersCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**number** | **String** | Credit card number (PAN). | [optional] - - - diff --git a/docs/InstrumentidentifiersDetails.md b/docs/InstrumentidentifiersDetails.md deleted file mode 100644 index 790b13b22..000000000 --- a/docs/InstrumentidentifiersDetails.md +++ /dev/null @@ -1,11 +0,0 @@ - -# InstrumentidentifiersDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | The name of the field that threw the error. | [optional] -**location** | **String** | The location of the field that threw the error. | [optional] - - - diff --git a/docs/InstrumentidentifiersLinks.md b/docs/InstrumentidentifiersLinks.md deleted file mode 100644 index 8a614c5f9..000000000 --- a/docs/InstrumentidentifiersLinks.md +++ /dev/null @@ -1,12 +0,0 @@ - -# InstrumentidentifiersLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**self** | [**InstrumentidentifiersLinksSelf**](InstrumentidentifiersLinksSelf.md) | | [optional] -**ancestor** | [**InstrumentidentifiersLinksSelf**](InstrumentidentifiersLinksSelf.md) | | [optional] -**successor** | [**InstrumentidentifiersLinksSelf**](InstrumentidentifiersLinksSelf.md) | | [optional] - - - diff --git a/docs/InstrumentidentifiersLinksSelf.md b/docs/InstrumentidentifiersLinksSelf.md deleted file mode 100644 index 1abc778b1..000000000 --- a/docs/InstrumentidentifiersLinksSelf.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InstrumentidentifiersLinksSelf - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **String** | | [optional] - - - diff --git a/docs/InstrumentidentifiersProcessingInformation.md b/docs/InstrumentidentifiersProcessingInformation.md deleted file mode 100644 index 5f90de4bb..000000000 --- a/docs/InstrumentidentifiersProcessingInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InstrumentidentifiersProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**authorizationOptions** | [**InstrumentidentifiersProcessingInformationAuthorizationOptions**](InstrumentidentifiersProcessingInformationAuthorizationOptions.md) | | [optional] - - - diff --git a/docs/InstrumentidentifiersProcessingInformationAuthorizationOptions.md b/docs/InstrumentidentifiersProcessingInformationAuthorizationOptions.md deleted file mode 100644 index 94ec01cd0..000000000 --- a/docs/InstrumentidentifiersProcessingInformationAuthorizationOptions.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InstrumentidentifiersProcessingInformationAuthorizationOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**initiator** | [**InstrumentidentifiersProcessingInformationAuthorizationOptionsInitiator**](InstrumentidentifiersProcessingInformationAuthorizationOptionsInitiator.md) | | [optional] - - - diff --git a/docs/InstrumentidentifiersProcessingInformationAuthorizationOptionsInitiator.md b/docs/InstrumentidentifiersProcessingInformationAuthorizationOptionsInitiator.md deleted file mode 100644 index f1d278f86..000000000 --- a/docs/InstrumentidentifiersProcessingInformationAuthorizationOptionsInitiator.md +++ /dev/null @@ -1,10 +0,0 @@ - -# InstrumentidentifiersProcessingInformationAuthorizationOptionsInitiator - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchantInitiatedTransaction** | [**InstrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction**](InstrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md) | | [optional] - - - diff --git a/docs/JsonWebKey.md b/docs/JsonWebKey.md deleted file mode 100644 index fa97d26d5..000000000 --- a/docs/JsonWebKey.md +++ /dev/null @@ -1,14 +0,0 @@ - -# JsonWebKey - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**kty** | **String** | Algorithm used to encrypt the public key. | [optional] -**use** | **String** | Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc. | [optional] -**kid** | **String** | The key ID in JWK format. | [optional] -**n** | **String** | JWK RSA Modulus | [optional] -**e** | **String** | JWK RSA Exponent | [optional] - - - diff --git a/docs/KeyGenerationApi.md b/docs/KeyGenerationApi.md index d5261a575..0a4815038 100644 --- a/docs/KeyGenerationApi.md +++ b/docs/KeyGenerationApi.md @@ -4,7 +4,7 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**generatePublicKey**](KeyGenerationApi.md#generatePublicKey) | **POST** /flex/v1/keys/ | Generate Key +[**generatePublicKey**](KeyGenerationApi.md#generatePublicKey) | **POST** /flex/v1/keys | Generate Key @@ -37,7 +37,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **generatePublicKeyRequest** | [**GeneratePublicKeyRequest**](GeneratePublicKeyRequest.md)| | [optional] + **generatePublicKeyRequest** | [**GeneratePublicKeyRequest**](GeneratePublicKeyRequest.md)| | ### Return type diff --git a/docs/KeyParameters.md b/docs/KeyParameters.md deleted file mode 100644 index 188c78d8a..000000000 --- a/docs/KeyParameters.md +++ /dev/null @@ -1,10 +0,0 @@ - -# KeyParameters - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**encryptionType** | **String** | How the card number should be encrypted in the subsequent Tokenize Card request. Possible values are RsaOaep256 or None (if using this value the card number must be in plain text when included in the Tokenize Card request). The Tokenize Card request uses a secure connection (TLS 1.2+) regardless of what encryption type is specified. | [optional] - - - diff --git a/docs/KeyResult.md b/docs/KeyResult.md deleted file mode 100644 index 1965f916e..000000000 --- a/docs/KeyResult.md +++ /dev/null @@ -1,12 +0,0 @@ - -# KeyResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keyId** | **String** | Unique identifier for the generated token. Used in the subsequent Tokenize Card request from your customer’s device or browser. | [optional] -**der** | [**FlexV1KeysPost200ResponseDer**](FlexV1KeysPost200ResponseDer.md) | | [optional] -**jwk** | [**FlexV1KeysPost200ResponseJwk**](FlexV1KeysPost200ResponseJwk.md) | | [optional] - - - diff --git a/docs/Link.md b/docs/Link.md deleted file mode 100644 index 7c58c99ad..000000000 --- a/docs/Link.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Link - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**href** | **String** | URI of the linked resource. | [optional] -**title** | **String** | Label of the linked resource. | [optional] -**method** | **String** | HTTP method of the linked resource. | [optional] - - - diff --git a/docs/Links.md b/docs/Links.md deleted file mode 100644 index 94fb8223f..000000000 --- a/docs/Links.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Links - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**self** | [**InlineResponseDefaultLinksNext**](InlineResponseDefaultLinksNext.md) | | [optional] -**documentation** | [**List<InlineResponseDefaultLinksNext>**](InlineResponseDefaultLinksNext.md) | | [optional] -**next** | [**List<InlineResponseDefaultLinksNext>**](InlineResponseDefaultLinksNext.md) | | [optional] - - - diff --git a/docs/MitReversalRequest.md b/docs/MitReversalRequest.md new file mode 100644 index 000000000..3568ce118 --- /dev/null +++ b/docs/MitReversalRequest.md @@ -0,0 +1,14 @@ + +# MitReversalRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**clientReferenceInformation** | [**Ptsv2paymentsClientReferenceInformation**](Ptsv2paymentsClientReferenceInformation.md) | | [optional] +**reversalInformation** | [**Ptsv2paymentsidreversalsReversalInformation**](Ptsv2paymentsidreversalsReversalInformation.md) | | [optional] +**processingInformation** | [**Ptsv2paymentsidreversalsProcessingInformation**](Ptsv2paymentsidreversalsProcessingInformation.md) | | [optional] +**orderInformation** | [**Ptsv2paymentsidreversalsOrderInformation**](Ptsv2paymentsidreversalsOrderInformation.md) | | [optional] +**pointOfSaleInformation** | [**Ptsv2paymentsidreversalsPointOfSaleInformation**](Ptsv2paymentsidreversalsPointOfSaleInformation.md) | | [optional] + + + diff --git a/docs/MitVoidRequest.md b/docs/MitVoidRequest.md new file mode 100644 index 000000000..47c774d28 --- /dev/null +++ b/docs/MitVoidRequest.md @@ -0,0 +1,10 @@ + +# MitVoidRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**clientReferenceInformation** | [**Ptsv2paymentsClientReferenceInformation**](Ptsv2paymentsClientReferenceInformation.md) | | [optional] + + + diff --git a/docs/NetFundingsApi.md b/docs/NetFundingsApi.md index 5649f20a2..648f9f684 100644 --- a/docs/NetFundingsApi.md +++ b/docs/NetFundingsApi.md @@ -4,12 +4,12 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**getNetFundingInfo**](NetFundingsApi.md#getNetFundingInfo) | **GET** /reporting/v3/net-fundings | Get Netfunding information for an account or a merchant +[**getNetFundingDetails**](NetFundingsApi.md#getNetFundingDetails) | **GET** /reporting/v3/net-fundings | Get Netfunding information for an account or a merchant - -# **getNetFundingInfo** -> ReportingV3NetFundingsGet200Response getNetFundingInfo(startTime, endTime, organizationId, groupName) + +# **getNetFundingDetails** +> ReportingV3NetFundingsGet200Response getNetFundingDetails(startTime, endTime, organizationId, groupName) Get Netfunding information for an account or a merchant @@ -23,15 +23,15 @@ Get Netfunding information for an account or a merchant. NetFundingsApi apiInstance = new NetFundingsApi(); -DateTime startTime = new DateTime(); // DateTime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX -DateTime endTime = new DateTime(); // DateTime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX +DateTime startTime = new DateTime(); // DateTime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) +DateTime endTime = new DateTime(); // DateTime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) String organizationId = "organizationId_example"; // String | Valid Cybersource Organization Id String groupName = "groupName_example"; // String | Valid CyberSource Group Name. try { - ReportingV3NetFundingsGet200Response result = apiInstance.getNetFundingInfo(startTime, endTime, organizationId, groupName); + ReportingV3NetFundingsGet200Response result = apiInstance.getNetFundingDetails(startTime, endTime, organizationId, groupName); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling NetFundingsApi#getNetFundingInfo"); + System.err.println("Exception when calling NetFundingsApi#getNetFundingDetails"); e.printStackTrace(); } ``` @@ -40,8 +40,8 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **startTime** | **DateTime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX | - **endTime** | **DateTime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX | + **startTime** | **DateTime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | + **endTime** | **DateTime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | **organizationId** | **String**| Valid Cybersource Organization Id | [optional] **groupName** | **String**| Valid CyberSource Group Name. | [optional] diff --git a/docs/NotificationOfChangesApi.md b/docs/NotificationOfChangesApi.md index fcbd8d8f5..a9fa9ae9d 100644 --- a/docs/NotificationOfChangesApi.md +++ b/docs/NotificationOfChangesApi.md @@ -23,8 +23,8 @@ Download the Notification of Change report. This report shows eCheck-related fie NotificationOfChangesApi apiInstance = new NotificationOfChangesApi(); -DateTime startTime = new DateTime(); // DateTime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX -DateTime endTime = new DateTime(); // DateTime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX +DateTime startTime = new DateTime(); // DateTime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) +DateTime endTime = new DateTime(); // DateTime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) try { ReportingV3NotificationofChangesGet200Response result = apiInstance.getNotificationOfChangeReport(startTime, endTime); System.out.println(result); @@ -38,8 +38,8 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **startTime** | **DateTime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX | - **endTime** | **DateTime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX | + **startTime** | **DateTime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | + **endTime** | **DateTime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | ### Return type diff --git a/docs/OctCreatePaymentRequest.md b/docs/OctCreatePaymentRequest.md index 842787cb2..fcf39dd45 100644 --- a/docs/OctCreatePaymentRequest.md +++ b/docs/OctCreatePaymentRequest.md @@ -4,13 +4,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**clientReferenceInformation** | [**InlineResponse201ClientReferenceInformation**](InlineResponse201ClientReferenceInformation.md) | | [optional] -**orderInformation** | [**V2payoutsOrderInformation**](V2payoutsOrderInformation.md) | | [optional] -**merchantInformation** | [**V2payoutsMerchantInformation**](V2payoutsMerchantInformation.md) | | [optional] -**recipientInformation** | [**V2payoutsRecipientInformation**](V2payoutsRecipientInformation.md) | | [optional] -**senderInformation** | [**V2payoutsSenderInformation**](V2payoutsSenderInformation.md) | | [optional] -**processingInformation** | [**V2payoutsProcessingInformation**](V2payoutsProcessingInformation.md) | | [optional] -**paymentInformation** | [**V2payoutsPaymentInformation**](V2payoutsPaymentInformation.md) | | [optional] +**clientReferenceInformation** | [**Ptsv2payoutsClientReferenceInformation**](Ptsv2payoutsClientReferenceInformation.md) | | [optional] +**orderInformation** | [**Ptsv2payoutsOrderInformation**](Ptsv2payoutsOrderInformation.md) | | [optional] +**merchantInformation** | [**Ptsv2payoutsMerchantInformation**](Ptsv2payoutsMerchantInformation.md) | | [optional] +**recipientInformation** | [**Ptsv2payoutsRecipientInformation**](Ptsv2payoutsRecipientInformation.md) | | [optional] +**senderInformation** | [**Ptsv2payoutsSenderInformation**](Ptsv2payoutsSenderInformation.md) | | [optional] +**processingInformation** | [**Ptsv2payoutsProcessingInformation**](Ptsv2payoutsProcessingInformation.md) | | [optional] +**paymentInformation** | [**Ptsv2payoutsPaymentInformation**](Ptsv2payoutsPaymentInformation.md) | | [optional] diff --git a/docs/PaymentApi.md b/docs/PaymentApi.md deleted file mode 100644 index ef0e066e3..000000000 --- a/docs/PaymentApi.md +++ /dev/null @@ -1,100 +0,0 @@ -# PaymentApi - -All URIs are relative to *https://api.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**createPayment**](PaymentApi.md#createPayment) | **POST** /v2/payments/ | Process a Payment -[**getPayment**](PaymentApi.md#getPayment) | **GET** /v2/payments/{id} | Retrieve a Payment - - - -# **createPayment** -> InlineResponse201 createPayment(createPaymentRequest) - -Process a Payment - -Authorize the payment for the transaction. - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.PaymentApi; - - -PaymentApi apiInstance = new PaymentApi(); -CreatePaymentRequest createPaymentRequest = new CreatePaymentRequest(); // CreatePaymentRequest | -try { - InlineResponse201 result = apiInstance.createPayment(createPaymentRequest); - System.out.println(result); -} catch (ApiException e) { - System.err.println("Exception when calling PaymentApi#createPayment"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **createPaymentRequest** | [**CreatePaymentRequest**](CreatePaymentRequest.md)| | - -### Return type - -[**InlineResponse201**](InlineResponse201.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -# **getPayment** -> InlineResponse2002 getPayment(id) - -Retrieve a Payment - -Include the payment ID in the GET request to retrieve the payment details. - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.PaymentApi; - - -PaymentApi apiInstance = new PaymentApi(); -String id = "id_example"; // String | The payment ID returned from a previous payment request. -try { - InlineResponse2002 result = apiInstance.getPayment(id); - System.out.println(result); -} catch (ApiException e) { - System.err.println("Exception when calling PaymentApi#getPayment"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **id** | **String**| The payment ID returned from a previous payment request. | - -### Return type - -[**InlineResponse2002**](InlineResponse2002.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - diff --git a/docs/PaymentBatchSummariesApi.md b/docs/PaymentBatchSummariesApi.md new file mode 100644 index 000000000..49455f81e --- /dev/null +++ b/docs/PaymentBatchSummariesApi.md @@ -0,0 +1,64 @@ +# PaymentBatchSummariesApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getPaymentBatchSummary**](PaymentBatchSummariesApi.md#getPaymentBatchSummary) | **GET** /reporting/v3/payment-batch-summaries | Get payment batch summary data + + + +# **getPaymentBatchSummary** +> InlineResponse200 getPaymentBatchSummary(startTime, endTime, organizationId, rollUp, breakdown, startDayOfWeek) + +Get payment batch summary data + +Scope can be either account/merchant or reseller. + +### Example +```java +// Import classes: +//import Invokers.ApiException; +//import Api.PaymentBatchSummariesApi; + + +PaymentBatchSummariesApi apiInstance = new PaymentBatchSummariesApi(); +DateTime startTime = new DateTime(); // DateTime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) +DateTime endTime = new DateTime(); // DateTime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) +String organizationId = "organizationId_example"; // String | Valid Cybersource Organization Id +String rollUp = "rollUp_example"; // String | Conditional - RollUp for data for DAY/WEEK/MONTH. Required while getting breakdown data for a Merchant +String breakdown = "breakdown_example"; // String | Conditional - Breakdown on account_rollup/allMerchants/selectedMerchant. Required while getting breakdown data for a Merchant. +Integer startDayOfWeek = 56; // Integer | Optional - Start day of week to breakdown data for weeks in a month +try { + InlineResponse200 result = apiInstance.getPaymentBatchSummary(startTime, endTime, organizationId, rollUp, breakdown, startDayOfWeek); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling PaymentBatchSummariesApi#getPaymentBatchSummary"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **startTime** | **DateTime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | + **endTime** | **DateTime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | + **organizationId** | **String**| Valid Cybersource Organization Id | [optional] + **rollUp** | **String**| Conditional - RollUp for data for DAY/WEEK/MONTH. Required while getting breakdown data for a Merchant | [optional] [enum: day, week, month] + **breakdown** | **String**| Conditional - Breakdown on account_rollup/allMerchants/selectedMerchant. Required while getting breakdown data for a Merchant. | [optional] [enum: account_rollup, all_merchant, selected_merchant] + **startDayOfWeek** | **Integer**| Optional - Start day of week to breakdown data for weeks in a month | [optional] + +### Return type + +[**InlineResponse200**](InlineResponse200.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json + diff --git a/docs/PaymentInstrumentApi.md b/docs/PaymentInstrumentApi.md index 189f3f605..c21ca9d7c 100644 --- a/docs/PaymentInstrumentApi.md +++ b/docs/PaymentInstrumentApi.md @@ -1,18 +1,18 @@ # PaymentInstrumentApi -All URIs are relative to *https://api.cybersource.com* +All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**paymentinstrumentsPost**](PaymentInstrumentApi.md#paymentinstrumentsPost) | **POST** /paymentinstruments | Create a Payment Instrument -[**paymentinstrumentsTokenIdDelete**](PaymentInstrumentApi.md#paymentinstrumentsTokenIdDelete) | **DELETE** /paymentinstruments/{tokenId} | Delete a Payment Instrument -[**paymentinstrumentsTokenIdGet**](PaymentInstrumentApi.md#paymentinstrumentsTokenIdGet) | **GET** /paymentinstruments/{tokenId} | Retrieve a Payment Instrument -[**paymentinstrumentsTokenIdPatch**](PaymentInstrumentApi.md#paymentinstrumentsTokenIdPatch) | **PATCH** /paymentinstruments/{tokenId} | Update a Payment Instrument +[**createPaymentInstrument**](PaymentInstrumentApi.md#createPaymentInstrument) | **POST** /tms/v1/paymentinstruments | Create a Payment Instrument +[**deletePaymentInstrument**](PaymentInstrumentApi.md#deletePaymentInstrument) | **DELETE** /tms/v1/paymentinstruments/{tokenId} | Delete a Payment Instrument +[**getPaymentInstrument**](PaymentInstrumentApi.md#getPaymentInstrument) | **GET** /tms/v1/paymentinstruments/{tokenId} | Retrieve a Payment Instrument +[**updatePaymentInstrument**](PaymentInstrumentApi.md#updatePaymentInstrument) | **PATCH** /tms/v1/paymentinstruments/{tokenId} | Update a Payment Instrument - -# **paymentinstrumentsPost** -> InlineResponse2016 paymentinstrumentsPost(profileId, body) + +# **createPaymentInstrument** +> TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments createPaymentInstrument(profileId, createPaymentInstrumentRequest) Create a Payment Instrument @@ -25,12 +25,12 @@ Create a Payment Instrument PaymentInstrumentApi apiInstance = new PaymentInstrumentApi(); String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. -Body2 body = new Body2(); // Body2 | Please specify the customers payment details for card or bank account. +CreatePaymentInstrumentRequest createPaymentInstrumentRequest = new CreatePaymentInstrumentRequest(); // CreatePaymentInstrumentRequest | Specify the customer's payment details for card or bank account. try { - InlineResponse2016 result = apiInstance.paymentinstrumentsPost(profileId, body); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments result = apiInstance.createPaymentInstrument(profileId, createPaymentInstrumentRequest); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling PaymentInstrumentApi#paymentinstrumentsPost"); + System.err.println("Exception when calling PaymentInstrumentApi#createPaymentInstrument"); e.printStackTrace(); } ``` @@ -40,11 +40,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **profileId** | **String**| The id of a profile containing user specific TMS configuration. | - **body** | [**Body2**](Body2.md)| Please specify the customers payment details for card or bank account. | + **createPaymentInstrumentRequest** | [**CreatePaymentInstrumentRequest**](CreatePaymentInstrumentRequest.md)| Specify the customer's payment details for card or bank account. | ### Return type -[**InlineResponse2016**](InlineResponse2016.md) +[**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.md) ### Authorization @@ -52,12 +52,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json;charset=utf-8 - -# **paymentinstrumentsTokenIdDelete** -> paymentinstrumentsTokenIdDelete(profileId, tokenId) + +# **deletePaymentInstrument** +> deletePaymentInstrument(profileId, tokenId) Delete a Payment Instrument @@ -72,9 +72,9 @@ PaymentInstrumentApi apiInstance = new PaymentInstrumentApi(); String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. String tokenId = "tokenId_example"; // String | The TokenId of a Payment Instrument. try { - apiInstance.paymentinstrumentsTokenIdDelete(profileId, tokenId); + apiInstance.deletePaymentInstrument(profileId, tokenId); } catch (ApiException e) { - System.err.println("Exception when calling PaymentInstrumentApi#paymentinstrumentsTokenIdDelete"); + System.err.println("Exception when calling PaymentInstrumentApi#deletePaymentInstrument"); e.printStackTrace(); } ``` @@ -96,12 +96,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json;charset=utf-8 - -# **paymentinstrumentsTokenIdGet** -> InlineResponse2016 paymentinstrumentsTokenIdGet(profileId, tokenId) + +# **getPaymentInstrument** +> TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments getPaymentInstrument(profileId, tokenId) Retrieve a Payment Instrument @@ -116,10 +116,10 @@ PaymentInstrumentApi apiInstance = new PaymentInstrumentApi(); String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. String tokenId = "tokenId_example"; // String | The TokenId of a Payment Instrument. try { - InlineResponse2016 result = apiInstance.paymentinstrumentsTokenIdGet(profileId, tokenId); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments result = apiInstance.getPaymentInstrument(profileId, tokenId); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling PaymentInstrumentApi#paymentinstrumentsTokenIdGet"); + System.err.println("Exception when calling PaymentInstrumentApi#getPaymentInstrument"); e.printStackTrace(); } ``` @@ -133,7 +133,7 @@ Name | Type | Description | Notes ### Return type -[**InlineResponse2016**](InlineResponse2016.md) +[**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.md) ### Authorization @@ -141,12 +141,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json;charset=utf-8 - -# **paymentinstrumentsTokenIdPatch** -> InlineResponse2016 paymentinstrumentsTokenIdPatch(profileId, tokenId, body) + +# **updatePaymentInstrument** +> TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments updatePaymentInstrument(profileId, tokenId, updatePaymentInstrumentRequest) Update a Payment Instrument @@ -160,12 +160,12 @@ Update a Payment Instrument PaymentInstrumentApi apiInstance = new PaymentInstrumentApi(); String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. String tokenId = "tokenId_example"; // String | The TokenId of a Payment Instrument. -Body3 body = new Body3(); // Body3 | Please specify the customers payment details. +UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest = new UpdatePaymentInstrumentRequest(); // UpdatePaymentInstrumentRequest | Specify the customer's payment details. try { - InlineResponse2016 result = apiInstance.paymentinstrumentsTokenIdPatch(profileId, tokenId, body); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments result = apiInstance.updatePaymentInstrument(profileId, tokenId, updatePaymentInstrumentRequest); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling PaymentInstrumentApi#paymentinstrumentsTokenIdPatch"); + System.err.println("Exception when calling PaymentInstrumentApi#updatePaymentInstrument"); e.printStackTrace(); } ``` @@ -176,11 +176,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **profileId** | **String**| The id of a profile containing user specific TMS configuration. | **tokenId** | **String**| The TokenId of a Payment Instrument. | - **body** | [**Body3**](Body3.md)| Please specify the customers payment details. | + **updatePaymentInstrumentRequest** | [**UpdatePaymentInstrumentRequest**](UpdatePaymentInstrumentRequest.md)| Specify the customer's payment details. | ### Return type -[**InlineResponse2016**](InlineResponse2016.md) +[**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.md) ### Authorization @@ -188,6 +188,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json;charset=utf-8 diff --git a/docs/PaymentInstrumentsApi.md b/docs/PaymentInstrumentsApi.md deleted file mode 100644 index 69ff69d05..000000000 --- a/docs/PaymentInstrumentsApi.md +++ /dev/null @@ -1,243 +0,0 @@ -# PaymentInstrumentsApi - -All URIs are relative to *https://apitest.cybersource.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet**](PaymentInstrumentsApi.md#tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet) | **GET** /tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments | Retrieve all Payment Instruments associated with an Instrument Identifier -[**tmsV1PaymentinstrumentsPost**](PaymentInstrumentsApi.md#tmsV1PaymentinstrumentsPost) | **POST** /tms/v1/paymentinstruments | Create a Payment Instrument -[**tmsV1PaymentinstrumentsTokenIdDelete**](PaymentInstrumentsApi.md#tmsV1PaymentinstrumentsTokenIdDelete) | **DELETE** /tms/v1/paymentinstruments/{tokenId} | Delete a Payment Instrument -[**tmsV1PaymentinstrumentsTokenIdGet**](PaymentInstrumentsApi.md#tmsV1PaymentinstrumentsTokenIdGet) | **GET** /tms/v1/paymentinstruments/{tokenId} | Retrieve a Payment Instrument -[**tmsV1PaymentinstrumentsTokenIdPatch**](PaymentInstrumentsApi.md#tmsV1PaymentinstrumentsTokenIdPatch) | **PATCH** /tms/v1/paymentinstruments/{tokenId} | Update a Payment Instrument - - - -# **tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet** -> TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet(profileId, tokenId, offset, limit) - -Retrieve all Payment Instruments associated with an Instrument Identifier - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.PaymentInstrumentsApi; - - -PaymentInstrumentsApi apiInstance = new PaymentInstrumentsApi(); -String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. -String tokenId = "tokenId_example"; // String | The TokenId of an Instrument Identifier. -String offset = "offset_example"; // String | Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. -String limit = "20"; // String | The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. -try { - TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response result = apiInstance.tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet(profileId, tokenId, offset, limit); - System.out.println(result); -} catch (ApiException e) { - System.err.println("Exception when calling PaymentInstrumentsApi#tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **profileId** | **String**| The id of a profile containing user specific TMS configuration. | - **tokenId** | **String**| The TokenId of an Instrument Identifier. | - **offset** | **String**| Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. | [optional] - **limit** | **String**| The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. | [optional] [default to 20] - -### Return type - -[**TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response**](TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - - -# **tmsV1PaymentinstrumentsPost** -> TmsV1PaymentinstrumentsPost201Response tmsV1PaymentinstrumentsPost(profileId, body) - -Create a Payment Instrument - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.PaymentInstrumentsApi; - - -PaymentInstrumentsApi apiInstance = new PaymentInstrumentsApi(); -String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. -Body2 body = new Body2(); // Body2 | Please specify the customers payment details for card or bank account. -try { - TmsV1PaymentinstrumentsPost201Response result = apiInstance.tmsV1PaymentinstrumentsPost(profileId, body); - System.out.println(result); -} catch (ApiException e) { - System.err.println("Exception when calling PaymentInstrumentsApi#tmsV1PaymentinstrumentsPost"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **profileId** | **String**| The id of a profile containing user specific TMS configuration. | - **body** | [**Body2**](Body2.md)| Please specify the customers payment details for card or bank account. | - -### Return type - -[**TmsV1PaymentinstrumentsPost201Response**](TmsV1PaymentinstrumentsPost201Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - - -# **tmsV1PaymentinstrumentsTokenIdDelete** -> tmsV1PaymentinstrumentsTokenIdDelete(profileId, tokenId) - -Delete a Payment Instrument - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.PaymentInstrumentsApi; - - -PaymentInstrumentsApi apiInstance = new PaymentInstrumentsApi(); -String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. -String tokenId = "tokenId_example"; // String | The TokenId of a Payment Instrument. -try { - apiInstance.tmsV1PaymentinstrumentsTokenIdDelete(profileId, tokenId); -} catch (ApiException e) { - System.err.println("Exception when calling PaymentInstrumentsApi#tmsV1PaymentinstrumentsTokenIdDelete"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **profileId** | **String**| The id of a profile containing user specific TMS configuration. | - **tokenId** | **String**| The TokenId of a Payment Instrument. | - -### Return type - -null (empty response body) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - - -# **tmsV1PaymentinstrumentsTokenIdGet** -> TmsV1PaymentinstrumentsGet200Response tmsV1PaymentinstrumentsTokenIdGet(profileId, tokenId) - -Retrieve a Payment Instrument - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.PaymentInstrumentsApi; - - -PaymentInstrumentsApi apiInstance = new PaymentInstrumentsApi(); -String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. -String tokenId = "tokenId_example"; // String | The TokenId of a Payment Instrument. -try { - TmsV1PaymentinstrumentsGet200Response result = apiInstance.tmsV1PaymentinstrumentsTokenIdGet(profileId, tokenId); - System.out.println(result); -} catch (ApiException e) { - System.err.println("Exception when calling PaymentInstrumentsApi#tmsV1PaymentinstrumentsTokenIdGet"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **profileId** | **String**| The id of a profile containing user specific TMS configuration. | - **tokenId** | **String**| The TokenId of a Payment Instrument. | - -### Return type - -[**TmsV1PaymentinstrumentsGet200Response**](TmsV1PaymentinstrumentsGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - - -# **tmsV1PaymentinstrumentsTokenIdPatch** -> TmsV1PaymentinstrumentsGet200Response tmsV1PaymentinstrumentsTokenIdPatch(profileId, tokenId, body) - -Update a Payment Instrument - -### Example -```java -// Import classes: -//import Invokers.ApiException; -//import Api.PaymentInstrumentsApi; - - -PaymentInstrumentsApi apiInstance = new PaymentInstrumentsApi(); -String profileId = "profileId_example"; // String | The id of a profile containing user specific TMS configuration. -String tokenId = "tokenId_example"; // String | The TokenId of a Payment Instrument. -Body3 body = new Body3(); // Body3 | Please specify the customers payment details. -try { - TmsV1PaymentinstrumentsGet200Response result = apiInstance.tmsV1PaymentinstrumentsTokenIdPatch(profileId, tokenId, body); - System.out.println(result); -} catch (ApiException e) { - System.err.println("Exception when calling PaymentInstrumentsApi#tmsV1PaymentinstrumentsTokenIdPatch"); - e.printStackTrace(); -} -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **profileId** | **String**| The id of a profile containing user specific TMS configuration. | - **tokenId** | **String**| The TokenId of a Payment Instrument. | - **body** | [**Body3**](Body3.md)| Please specify the customers payment details. | - -### Return type - -[**TmsV1PaymentinstrumentsGet200Response**](TmsV1PaymentinstrumentsGet200Response.md) - -### Authorization - -No authorization required - -### HTTP request headers - - - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/json;charset=utf-8 - diff --git a/docs/PaymentinstrumentsBankAccount.md b/docs/PaymentinstrumentsBankAccount.md deleted file mode 100644 index 26e0cd4c3..000000000 --- a/docs/PaymentinstrumentsBankAccount.md +++ /dev/null @@ -1,10 +0,0 @@ - -# PaymentinstrumentsBankAccount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **String** | Type of Bank Account. | [optional] - - - diff --git a/docs/PaymentinstrumentsBillTo.md b/docs/PaymentinstrumentsBillTo.md deleted file mode 100644 index 25fb9670f..000000000 --- a/docs/PaymentinstrumentsBillTo.md +++ /dev/null @@ -1,20 +0,0 @@ - -# PaymentinstrumentsBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**firstName** | **String** | Bill to First Name. | [optional] -**lastName** | **String** | Bill to Last Name. | [optional] -**company** | **String** | Bill to Company. | [optional] -**address1** | **String** | Bill to Address Line 1. | [optional] -**address2** | **String** | Bill to Address Line 2. | [optional] -**locality** | **String** | Bill to City. | [optional] -**administrativeArea** | **String** | Bill to State. | [optional] -**postalCode** | **String** | Bill to Postal Code. | [optional] -**country** | **String** | Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2 | [optional] -**email** | **String** | Valid Bill to Email. | [optional] -**phoneNumber** | **String** | Bill to Phone Number. | [optional] - - - diff --git a/docs/PaymentinstrumentsBuyerInformation.md b/docs/PaymentinstrumentsBuyerInformation.md deleted file mode 100644 index bdc85c846..000000000 --- a/docs/PaymentinstrumentsBuyerInformation.md +++ /dev/null @@ -1,13 +0,0 @@ - -# PaymentinstrumentsBuyerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**companyTaxID** | **String** | Company Tax ID. | [optional] -**currency** | **String** | Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha | [optional] -**dateOBirth** | **String** | Date of birth YYYY-MM-DD. | [optional] -**personalIdentification** | [**List<PaymentinstrumentsBuyerInformationPersonalIdentification>**](PaymentinstrumentsBuyerInformationPersonalIdentification.md) | | [optional] - - - diff --git a/docs/PaymentinstrumentsBuyerInformationIssuedBy.md b/docs/PaymentinstrumentsBuyerInformationIssuedBy.md deleted file mode 100644 index 8181ea133..000000000 --- a/docs/PaymentinstrumentsBuyerInformationIssuedBy.md +++ /dev/null @@ -1,10 +0,0 @@ - -# PaymentinstrumentsBuyerInformationIssuedBy - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**administrativeArea** | **String** | State or province where the identification was issued. | [optional] - - - diff --git a/docs/PaymentinstrumentsBuyerInformationPersonalIdentification.md b/docs/PaymentinstrumentsBuyerInformationPersonalIdentification.md deleted file mode 100644 index 590cb93be..000000000 --- a/docs/PaymentinstrumentsBuyerInformationPersonalIdentification.md +++ /dev/null @@ -1,12 +0,0 @@ - -# PaymentinstrumentsBuyerInformationPersonalIdentification - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | Identification Number. | [optional] -**type** | **String** | Type of personal identification. | [optional] -**issuedBy** | [**PaymentinstrumentsBuyerInformationIssuedBy**](PaymentinstrumentsBuyerInformationIssuedBy.md) | | [optional] - - - diff --git a/docs/PaymentinstrumentsCard.md b/docs/PaymentinstrumentsCard.md deleted file mode 100644 index d8a0665e4..000000000 --- a/docs/PaymentinstrumentsCard.md +++ /dev/null @@ -1,76 +0,0 @@ - -# PaymentinstrumentsCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**expirationMonth** | **String** | Credit card expiration month. | [optional] -**expirationYear** | **String** | Credit card expiration year. | [optional] -**type** | [**TypeEnum**](#TypeEnum) | Credit card brand. | [optional] -**issueNumber** | **String** | Credit card issue number. | [optional] -**startMonth** | **String** | Credit card start month. | [optional] -**startYear** | **String** | Credit card start year. | [optional] -**useAs** | **String** | Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens. | [optional] - - - -## Enum: TypeEnum -Name | Value ----- | ----- -VISA | "visa" -MASTERCARD | "mastercard" -AMERICAN_EXPRESS | "american express" -DISCOVER | "discover" -DINERS_CLUB | "diners club" -CARTE_BLANCHE | "carte blanche" -JCB | "jcb" -OPTIMA | "optima" -TWINPAY_CREDIT | "twinpay credit" -TWINPAY_DEBIT | "twinpay debit" -WALMART | "walmart" -ENROUTE | "enroute" -LOWES_CONSUMER | "lowes consumer" -HOME_DEPOT_CONSUMER | "home depot consumer" -MBNA | "mbna" -DICKS_SPORTSWEAR | "dicks sportswear" -CASUAL_CORNER | "casual corner" -SEARS | "sears" -JAL | "jal" -DISNEY | "disney" -MAESTRO_UK_DOMESTIC | "maestro uk domestic" -SAMS_CLUB_CONSUMER | "sams club consumer" -SAMS_CLUB_BUSINESS | "sams club business" -NICOS | "nicos" -BILL_ME_LATER | "bill me later" -BEBE | "bebe" -RESTORATION_HARDWARE | "restoration hardware" -DELTA_ONLINE | "delta online" -SOLO | "solo" -VISA_ELECTRON | "visa electron" -DANKORT | "dankort" -LASER | "laser" -CARTE_BLEUE | "carte bleue" -CARTA_SI | "carta si" -PINLESS_DEBIT | "pinless debit" -ENCODED_ACCOUNT | "encoded account" -UATP | "uatp" -HOUSEHOLD | "household" -MAESTRO_INTERNATIONAL | "maestro international" -GE_MONEY_UK | "ge money uk" -KOREAN_CARDS | "korean cards" -STYLE | "style" -JCREW | "jcrew" -PAYEASE_CHINA_PROCESSING_EWALLET | "payease china processing ewallet" -PAYEASE_CHINA_PROCESSING_BANK_TRANSFER | "payease china processing bank transfer" -MEIJER_PRIVATE_LABEL | "meijer private label" -HIPERCARD | "hipercard" -AURA | "aura" -REDECARD | "redecard" -ORICO | "orico" -ELO | "elo" -CAPITAL_ONE_PRIVATE_LABEL | "capital one private label" -SYNCHRONY_PRIVATE_LABEL | "synchrony private label" -CHINA_UNION_PAY | "china union pay" - - - diff --git a/docs/PaymentinstrumentsInstrumentIdentifier.md b/docs/PaymentinstrumentsInstrumentIdentifier.md deleted file mode 100644 index 8a0f91ac3..000000000 --- a/docs/PaymentinstrumentsInstrumentIdentifier.md +++ /dev/null @@ -1,32 +0,0 @@ - -# PaymentinstrumentsInstrumentIdentifier - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InstrumentidentifiersLinks**](InstrumentidentifiersLinks.md) | | [optional] -**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. | [optional] -**state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] -**id** | **String** | The id of the existing instrument identifier to be linked to the newly created payment instrument. | [optional] -**card** | [**InstrumentidentifiersCard**](InstrumentidentifiersCard.md) | | [optional] -**bankAccount** | [**InstrumentidentifiersBankAccount**](InstrumentidentifiersBankAccount.md) | | [optional] -**processingInformation** | [**InstrumentidentifiersProcessingInformation**](InstrumentidentifiersProcessingInformation.md) | | [optional] -**metadata** | [**InstrumentidentifiersMetadata**](InstrumentidentifiersMetadata.md) | | [optional] - - - -## Enum: ObjectEnum -Name | Value ----- | ----- -INSTRUMENTIDENTIFIER | "instrumentIdentifier" - - - -## Enum: StateEnum -Name | Value ----- | ----- -ACTIVE | "ACTIVE" -CLOSED | "CLOSED" - - - diff --git a/docs/PaymentinstrumentsMerchantInformation.md b/docs/PaymentinstrumentsMerchantInformation.md deleted file mode 100644 index fbdee1ca1..000000000 --- a/docs/PaymentinstrumentsMerchantInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# PaymentinstrumentsMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchantDescriptor** | [**PaymentinstrumentsMerchantInformationMerchantDescriptor**](PaymentinstrumentsMerchantInformationMerchantDescriptor.md) | | [optional] - - - diff --git a/docs/PaymentinstrumentsProcessingInformation.md b/docs/PaymentinstrumentsProcessingInformation.md deleted file mode 100644 index 2d535849f..000000000 --- a/docs/PaymentinstrumentsProcessingInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# PaymentinstrumentsProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**billPaymentProgramEnabled** | **Boolean** | Bill Payment Program Enabled. | [optional] -**bankTransferOptions** | [**PaymentinstrumentsProcessingInformationBankTransferOptions**](PaymentinstrumentsProcessingInformationBankTransferOptions.md) | | [optional] - - - diff --git a/docs/PaymentinstrumentsProcessingInformationBankTransferOptions.md b/docs/PaymentinstrumentsProcessingInformationBankTransferOptions.md deleted file mode 100644 index d53122c95..000000000 --- a/docs/PaymentinstrumentsProcessingInformationBankTransferOptions.md +++ /dev/null @@ -1,10 +0,0 @@ - -# PaymentinstrumentsProcessingInformationBankTransferOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**seCCode** | **String** | Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB). | [optional] - - - diff --git a/docs/Paymentsflexv1tokensCardInfo.md b/docs/Paymentsflexv1tokensCardInfo.md deleted file mode 100644 index de46c762c..000000000 --- a/docs/Paymentsflexv1tokensCardInfo.md +++ /dev/null @@ -1,13 +0,0 @@ - -# Paymentsflexv1tokensCardInfo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cardNumber** | **String** | Encrypted or plain text card number. If the encryption type of “None” was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders’ device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request. | [optional] -**cardExpirationMonth** | **String** | Two digit expiration month | [optional] -**cardExpirationYear** | **String** | Four digit expiration year | [optional] -**cardType** | **String** | Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types. | [optional] - - - diff --git a/docs/ProcessAPayoutApi.md b/docs/PayoutsApi.md similarity index 67% rename from docs/ProcessAPayoutApi.md rename to docs/PayoutsApi.md index 86f7ff901..0e8dc1ac3 100644 --- a/docs/ProcessAPayoutApi.md +++ b/docs/PayoutsApi.md @@ -1,10 +1,10 @@ -# ProcessAPayoutApi +# PayoutsApi All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**octCreatePayment**](ProcessAPayoutApi.md#octCreatePayment) | **POST** /pts/v2/payouts/ | Process a Payout +[**octCreatePayment**](PayoutsApi.md#octCreatePayment) | **POST** /pts/v2/payouts | Process a Payout @@ -19,16 +19,16 @@ Send funds from a selected funding source to a designated credit/debit card acco ```java // Import classes: //import Invokers.ApiException; -//import Api.ProcessAPayoutApi; +//import Api.PayoutsApi; -ProcessAPayoutApi apiInstance = new ProcessAPayoutApi(); -PtsV2PayoutsPostResponse octCreatePaymentRequest = new PtsV2PayoutsPostResponse(); // PtsV2PayoutsPostResponse | +PayoutsApi apiInstance = new PayoutsApi(); +OctCreatePaymentRequest octCreatePaymentRequest = new OctCreatePaymentRequest(); // OctCreatePaymentRequest | try { PtsV2PayoutsPost201Response result = apiInstance.octCreatePayment(octCreatePaymentRequest); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling ProcessAPayoutApi#octCreatePayment"); + System.err.println("Exception when calling PayoutsApi#octCreatePayment"); e.printStackTrace(); } ``` @@ -37,7 +37,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **octCreatePaymentRequest** | [**PtsV2PayoutsPostResponse**](PtsV2PayoutsPostResponse.md)| | + **octCreatePaymentRequest** | [**OctCreatePaymentRequest**](OctCreatePaymentRequest.md)| | ### Return type diff --git a/docs/PtsV1TransactionBatchesGet200Response.md b/docs/PtsV1TransactionBatchesGet200Response.md index 648c1ae8f..9598da93f 100644 --- a/docs/PtsV1TransactionBatchesGet200Response.md +++ b/docs/PtsV1TransactionBatchesGet200Response.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **transactionBatches** | [**List<PtsV1TransactionBatchesGet200ResponseTransactionBatches>**](PtsV1TransactionBatchesGet200ResponseTransactionBatches.md) | | [optional] **links** | [**PtsV1TransactionBatchesGet200ResponseLinks**](PtsV1TransactionBatchesGet200ResponseLinks.md) | | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] diff --git a/docs/PtsV1TransactionBatchesGet400Response.md b/docs/PtsV1TransactionBatchesGet400Response.md index 1436c3f06..cf1a1b5d6 100644 --- a/docs/PtsV1TransactionBatchesGet400Response.md +++ b/docs/PtsV1TransactionBatchesGet400Response.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errorInformation** | [**PtsV1TransactionBatchesGet400ResponseErrorInformation**](PtsV1TransactionBatchesGet400ResponseErrorInformation.md) | | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] diff --git a/docs/PtsV1TransactionBatchesGet500Response.md b/docs/PtsV1TransactionBatchesGet500Response.md index b7b32dc3f..ceb5fff7a 100644 --- a/docs/PtsV1TransactionBatchesGet500Response.md +++ b/docs/PtsV1TransactionBatchesGet500Response.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errorInformation** | [**PtsV1TransactionBatchesGet500ResponseErrorInformation**](PtsV1TransactionBatchesGet500ResponseErrorInformation.md) | | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] diff --git a/docs/PtsV2CreditsPost201Response.md b/docs/PtsV2CreditsPost201Response.md index 94a9549e3..33d94f3b4 100644 --- a/docs/PtsV2CreditsPost201Response.md +++ b/docs/PtsV2CreditsPost201Response.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**PtsV2PaymentsRefundPost201ResponseLinks**](PtsV2PaymentsRefundPost201ResponseLinks.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - PENDING | [optional] **reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] **clientReferenceInformation** | [**PtsV2PaymentsPost201ResponseClientReferenceInformation**](PtsV2PaymentsPost201ResponseClientReferenceInformation.md) | | [optional] diff --git a/docs/PtsV2PaymentsCapturesPost201Response.md b/docs/PtsV2PaymentsCapturesPost201Response.md index d97f43770..a5132e972 100644 --- a/docs/PtsV2PaymentsCapturesPost201Response.md +++ b/docs/PtsV2PaymentsCapturesPost201Response.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**PtsV2PaymentsCapturesPost201ResponseLinks**](PtsV2PaymentsCapturesPost201ResponseLinks.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - PENDING | [optional] **reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] **clientReferenceInformation** | [**PtsV2PaymentsPost201ResponseClientReferenceInformation**](PtsV2PaymentsPost201ResponseClientReferenceInformation.md) | | [optional] diff --git a/docs/PtsV2PaymentsCapturesPost400Response.md b/docs/PtsV2PaymentsCapturesPost400Response.md index dec78b715..7e8a0cc11 100644 --- a/docs/PtsV2PaymentsCapturesPost400Response.md +++ b/docs/PtsV2PaymentsCapturesPost400Response.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] **reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_MERCHANT_CONFIGURATION - EXCEEDS_AUTH_AMOUNT - AUTH_ALREADY_REVERSED - TRANSACTION_ALREADY_SETTLED - INVALID_AMOUNT - MISSING_AUTH - TRANSACTION_ALREADY_REVERSED_OR_SETTLED | [optional] **message** | **String** | The detail message related to the status and reason listed above. | [optional] diff --git a/docs/PtsV2PaymentsPost201Response.md b/docs/PtsV2PaymentsPost201Response.md index 8ce308938..d2560ea63 100644 --- a/docs/PtsV2PaymentsPost201Response.md +++ b/docs/PtsV2PaymentsPost201Response.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**PtsV2PaymentsPost201ResponseLinks**](PtsV2PaymentsPost201ResponseLinks.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - AUTHORIZED - PARTIAL_AUTHORIZED - AUTHORIZED_PENDING_REVIEW - DECLINED - INVALID_REQUEST | [optional] **reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] **errorInformation** | [**PtsV2PaymentsPost201ResponseErrorInformation**](PtsV2PaymentsPost201ResponseErrorInformation.md) | | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseClientReferenceInformation.md b/docs/PtsV2PaymentsPost201ResponseClientReferenceInformation.md index f3f7f05a4..3475320dd 100644 --- a/docs/PtsV2PaymentsPost201ResponseClientReferenceInformation.md +++ b/docs/PtsV2PaymentsPost201ResponseClientReferenceInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API. **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] +**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] **submitLocalDateTime** | **String** | Date and time at your physical location. Format: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds | [optional] **ownerMerchantId** | **String** | Merchant ID that was used to create the subscription or customer profile for which the service was requested. If your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using subscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. See the subscription sharing information in Recurring Billing Using the Simple Order API. If your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using profile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID. See the profile sharing information in Payment Tokenization Using the Simple Order API. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseErrorInformation.md b/docs/PtsV2PaymentsPost201ResponseErrorInformation.md index c9597350a..c0e10ed5a 100644 --- a/docs/PtsV2PaymentsPost201ResponseErrorInformation.md +++ b/docs/PtsV2PaymentsPost201ResponseErrorInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. Possible values: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - DECLINED_CHECK - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION | [optional] +**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. Possible values: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - DECLINED_CHECK - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION - DECISION_PROFILE_REJECT - SCORE_EXCEEDS_THRESHOLD | [optional] **message** | **String** | The detail message related to the status and reason listed above. | [optional] **details** | [**List<PtsV2PaymentsPost201ResponseErrorInformationDetails>**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) | | [optional] @@ -28,6 +28,8 @@ INVALID_CVN | "INVALID_CVN" PAYMENT_REFUSED | "PAYMENT_REFUSED" INVALID_ACCOUNT | "INVALID_ACCOUNT" GENERAL_DECLINE | "GENERAL_DECLINE" +DECISION_PROFILE_REJECT | "DECISION_PROFILE_REJECT" +SCORE_EXCEEDS_THRESHOLD | "SCORE_EXCEEDS_THRESHOLD" diff --git a/docs/PtsV2PaymentsPost201ResponseLinksSelf.md b/docs/PtsV2PaymentsPost201ResponseLinksSelf.md index 09fe600a4..622b1ab5e 100644 --- a/docs/PtsV2PaymentsPost201ResponseLinksSelf.md +++ b/docs/PtsV2PaymentsPost201ResponseLinksSelf.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**href** | **String** | URL | [optional] -**method** | **String** | HTTP method applied to above URL | [optional] +**href** | **String** | This is the endpoint of the resource that was created by the successful request. | [optional] +**method** | **String** | `method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.md b/docs/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.md index c9cccb021..94b8ebddf 100644 --- a/docs/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.md +++ b/docs/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **prefix** | **String** | First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] **suffix** | **String** | Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. | [optional] -**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover | [optional] +**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) | [optional] **assuranceLevel** | **String** | Confidence level of the tokenization. This value is assigned by the token service provider. `Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. | [optional] **expirationMonth** | **String** | Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] **expirationYear** | **String** | Four-digit year in which the payment network token expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md b/docs/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md index 171d05d6d..30e133318 100644 --- a/docs/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md +++ b/docs/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resultCode** | **String** | CVN result code. | [optional] +**resultCode** | **String** | Result of card verification. Returned by the authorization service in the `processorInformation.cardVerification.resultCode` reply field. If ics_auth and ics_score are requested at the same time, the value is automatically passed from ics_auth to ics_score. For more information on using this field, see \"\"Sending the Results of Address and Card Verification Tests,\"\" page 16. The field contains one of the following values: - `I`: Card verification number failed processor's data validation check. - `M`: Card verification number matched. - `N`: Card verification number not matched. - `P`: Card verification number not processed. - `S`: Card verification number is on the card but was not included in the request. - `U`: Card verification is not supported by the issuing bank. - `X`: Card verification is not supported by the payment card company. - Space Character: Deprecated. Ignore this value. - `1`: CyberSource does not support card verification for this processor or card type. - `2`: Processor returned value unrecognized for card verification response. - `3`: Processor did not return card verification result code. | [optional] **resultCodeRaw** | **String** | CVN result code sent directly from the processor. Returned only when the processor returns this value. `Important` Do not use this field to evaluate the result of card verification. Use for debugging purposes only. | [optional] diff --git a/docs/PtsV2PaymentsPost400Response.md b/docs/PtsV2PaymentsPost400Response.md index 6db060c87..6e9cc3d72 100644 --- a/docs/PtsV2PaymentsPost400Response.md +++ b/docs/PtsV2PaymentsPost400Response.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] **reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_CARD - CARD_TYPE_NOT_ACCEPTED - INVALID_MERCHANT_CONFIGURATION - PROCESSOR_UNAVAILABLE - INVALID_AMOUNT - INVALID_CARD_TYPE - INVALID_PAYMENT_ID - DEBIT_CARD_USEAGE_EXCEEDD_LIMIT | [optional] **message** | **String** | The detail message related to the status and reason listed above. | [optional] diff --git a/docs/PtsV2PaymentsPost502Response.md b/docs/PtsV2PaymentsPost502Response.md index a27fc2a2a..8b916d4be 100644 --- a/docs/PtsV2PaymentsPost502Response.md +++ b/docs/PtsV2PaymentsPost502Response.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - SERVER_ERROR | [optional] **reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. Possible values: - SYSTEM_ERROR - SERVER_TIMEOUT - SERVICE_TIMEOUT - INVALID_OR_MISSING_CONFIG - PROCESSOR_TIMEOUT | [optional] **message** | **String** | The detail message related to the status and reason listed above. | [optional] @@ -24,6 +24,7 @@ Name | Value SYSTEM_ERROR | "SYSTEM_ERROR" SERVER_TIMEOUT | "SERVER_TIMEOUT" SERVICE_TIMEOUT | "SERVICE_TIMEOUT" +INVALID_OR_MISSING_CONFIG | "INVALID_OR_MISSING_CONFIG" PROCESSOR_TIMEOUT | "PROCESSOR_TIMEOUT" diff --git a/docs/PtsV2PaymentsRefundPost201Response.md b/docs/PtsV2PaymentsRefundPost201Response.md index 5a09ee7ca..3a3412093 100644 --- a/docs/PtsV2PaymentsRefundPost201Response.md +++ b/docs/PtsV2PaymentsRefundPost201Response.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**PtsV2PaymentsRefundPost201ResponseLinks**](PtsV2PaymentsRefundPost201ResponseLinks.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - PENDING | [optional] **reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] **clientReferenceInformation** | [**PtsV2PaymentsPost201ResponseClientReferenceInformation**](PtsV2PaymentsPost201ResponseClientReferenceInformation.md) | | [optional] diff --git a/docs/PtsV2PaymentsRefundPost400Response.md b/docs/PtsV2PaymentsRefundPost400Response.md index f5924da50..3eab28c22 100644 --- a/docs/PtsV2PaymentsRefundPost400Response.md +++ b/docs/PtsV2PaymentsRefundPost400Response.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] **reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_CARD - INVALID_MERCHANT_CONFIGURATION - INVALID_AMOUNT - CAPTURE_ALREADY_VOIDED - ACCOUNT_NOT_ALLOWED_CREDIT | [optional] **message** | **String** | The detail message related to the status and reason listed above. | [optional] diff --git a/docs/PtsV2PaymentsReversalsPost201Response.md b/docs/PtsV2PaymentsReversalsPost201Response.md index 25dad179b..902f0449f 100644 --- a/docs/PtsV2PaymentsReversalsPost201Response.md +++ b/docs/PtsV2PaymentsReversalsPost201Response.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**PtsV2PaymentsReversalsPost201ResponseLinks**](PtsV2PaymentsReversalsPost201ResponseLinks.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - REVERSED | [optional] **reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] **clientReferenceInformation** | [**PtsV2PaymentsPost201ResponseClientReferenceInformation**](PtsV2PaymentsPost201ResponseClientReferenceInformation.md) | | [optional] diff --git a/docs/PtsV2PaymentsReversalsPost400Response.md b/docs/PtsV2PaymentsReversalsPost400Response.md index 41c4afaa7..e2085aa32 100644 --- a/docs/PtsV2PaymentsReversalsPost400Response.md +++ b/docs/PtsV2PaymentsReversalsPost400Response.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] **reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_MERCHANT_CONFIGURATION - PROCESSOR_UNAVAILABLE - AUTH_ALREADY_REVERSED - TRANSACTION_ALREADY_SETTLED - INVALID_AMOUNT - MISSING_AUTH - TRANSACTION_ALREADY_REVERSED_OR_SETTLED | [optional] **message** | **String** | The detail message related to the status and reason listed above. | [optional] diff --git a/docs/PtsV2PaymentsVoidsPost201Response.md b/docs/PtsV2PaymentsVoidsPost201Response.md index 542767aa3..cbe1030dd 100644 --- a/docs/PtsV2PaymentsVoidsPost201Response.md +++ b/docs/PtsV2PaymentsVoidsPost201Response.md @@ -5,8 +5,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**PtsV2PaymentsReversalsPost201ResponseLinks**](PtsV2PaymentsReversalsPost201ResponseLinks.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - VOIDED | [optional] **clientReferenceInformation** | [**PtsV2PaymentsPost201ResponseClientReferenceInformation**](PtsV2PaymentsPost201ResponseClientReferenceInformation.md) | | [optional] **voidAmountDetails** | [**PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails**](PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.md) | | [optional] diff --git a/docs/PtsV2PaymentsVoidsPost400Response.md b/docs/PtsV2PaymentsVoidsPost400Response.md index aa40ca318..e14f1c735 100644 --- a/docs/PtsV2PaymentsVoidsPost400Response.md +++ b/docs/PtsV2PaymentsVoidsPost400Response.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] **reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_MERCHANT_CONFIGURATION - NOT_VOIDABLE | [optional] **message** | **String** | The detail message related to the status and reason listed above. | [optional] diff --git a/docs/PtsV2PayoutsPost201Response.md b/docs/PtsV2PayoutsPost201Response.md index 001028e59..375c47bea 100644 --- a/docs/PtsV2PayoutsPost201Response.md +++ b/docs/PtsV2PayoutsPost201Response.md @@ -5,13 +5,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**PtsV2PaymentsReversalsPost201ResponseLinks**](PtsV2PaymentsReversalsPost201ResponseLinks.md) | | [optional] -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] +**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] **submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] +**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - ACCEPTED - DECLINED - INVALID_REQUEST | [optional] **reconciliationId** | **String** | Cybersource or merchant generated transaction reference number. This is sent to the processor and is echoed back in the response to the merchant. This is This value is used for reconciliation purposes. | [optional] -**statusInformation** | [**PtsV2PayoutsPost201ResponseStatusInformation**](PtsV2PayoutsPost201ResponseStatusInformation.md) | | [optional] **errorInformation** | [**PtsV2PayoutsPost201ResponseErrorInformation**](PtsV2PayoutsPost201ResponseErrorInformation.md) | | [optional] -**clientReferenceInformation** | [**Ptsv2payoutsClientReferenceInformation**](Ptsv2payoutsClientReferenceInformation.md) | | [optional] +**clientReferenceInformation** | [**PtsV2PaymentsPost201ResponseClientReferenceInformation**](PtsV2PaymentsPost201ResponseClientReferenceInformation.md) | | [optional] **merchantInformation** | [**PtsV2PayoutsPost201ResponseMerchantInformation**](PtsV2PayoutsPost201ResponseMerchantInformation.md) | | [optional] **orderInformation** | [**PtsV2PayoutsPost201ResponseOrderInformation**](PtsV2PayoutsPost201ResponseOrderInformation.md) | | [optional] **processorInformation** | [**PtsV2PayoutsPost201ResponseProcessorInformation**](PtsV2PayoutsPost201ResponseProcessorInformation.md) | | [optional] @@ -24,6 +23,7 @@ Name | Value ---- | ----- ACCEPTED | "ACCEPTED" DECLINED | "DECLINED" +INVALID_REQUEST | "INVALID_REQUEST" diff --git a/docs/PtsV2PayoutsPost201ResponseErrorInformation.md b/docs/PtsV2PayoutsPost201ResponseErrorInformation.md index be2b54c38..3cf34e262 100644 --- a/docs/PtsV2PayoutsPost201ResponseErrorInformation.md +++ b/docs/PtsV2PayoutsPost201ResponseErrorInformation.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. | [optional] +**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. Possible values: - EXPIRED_CARD - PROCESSOR_DECLINED - STOLEN_LOST_CARD - UNAUTHORIZED_CARD - CVN_NOT_MATCH - INVALID_CVN - BLACKLISTED_CUSTOMER - INVALID_ACCOUNT - GENERAL_DECLINE - RISK_CONTROL_DECLINE - PROCESSOR_RISK_CONTROL_DECLINE | [optional] **message** | **String** | The detail message related to the status and reason listed above. | [optional] -**details** | [**List<PtsV2PayoutsPost201ResponseErrorInformationDetails>**](PtsV2PayoutsPost201ResponseErrorInformationDetails.md) | | [optional] +**details** | [**List<PtsV2PaymentsPost201ResponseErrorInformationDetails>**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) | | [optional] diff --git a/docs/PtsV2PayoutsPost201ResponseErrorInformationDetails.md b/docs/PtsV2PayoutsPost201ResponseErrorInformationDetails.md deleted file mode 100644 index 116f4c1a9..000000000 --- a/docs/PtsV2PayoutsPost201ResponseErrorInformationDetails.md +++ /dev/null @@ -1,19 +0,0 @@ - -# PtsV2PayoutsPost201ResponseErrorInformationDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**field** | **String** | This is the flattened JSON object field name/path that is either missing or invalid. | [optional] -**reason** | [**ReasonEnum**](#ReasonEnum) | Possible reasons for the error. | [optional] - - - -## Enum: ReasonEnum -Name | Value ----- | ----- -MISSING_FIELD | "MISSING_FIELD" -INVALID_DATA | "INVALID_DATA" - - - diff --git a/docs/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md b/docs/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md index da4a7a494..933ccdb0f 100644 --- a/docs/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md +++ b/docs/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:  Table 15, \"Authorization Information for Specific Processors,\" on page 43  Table 19, \"Capture Information for Specific Processors,\" on page 58  Table 23, \"Credit Information for Specific Processors,\" on page 75 If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247. **DCC with a Third-Party Provider**\\ Set this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. | [optional] **settlementAmount** | **String** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder’s account. | [optional] **settlementCurrency** | **String** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. | [optional] diff --git a/docs/PtsV2PayoutsPost201ResponseStatusInformation.md b/docs/PtsV2PayoutsPost201ResponseStatusInformation.md deleted file mode 100644 index d2b822e21..000000000 --- a/docs/PtsV2PayoutsPost201ResponseStatusInformation.md +++ /dev/null @@ -1,19 +0,0 @@ - -# PtsV2PayoutsPost201ResponseStatusInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. | [optional] -**message** | **String** | The detail message related to the status and reason listed above. Possible value is: - Transaction was successful. - You must call the issuing bank to proceed with the transaction. | [optional] - - - -## Enum: ReasonEnum -Name | Value ----- | ----- -SUCCESS | "SUCCESS" -CONTACT_PROCESSOR | "CONTACT_PROCESSOR" - - - diff --git a/docs/PtsV2PayoutsPost400Response.md b/docs/PtsV2PayoutsPost400Response.md index 50e62bcf7..de9b8b31c 100644 --- a/docs/PtsV2PayoutsPost400Response.md +++ b/docs/PtsV2PayoutsPost400Response.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] **status** | **String** | The status of the submitted transaction. | [optional] -**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. | [optional] -**message** | **String** | The detail message related to the status and reason listed above. Possible value is: - Your aggregator or acquirer is not accepting transactions from you at this time. - Your aggregator or acquirer is not accepting this transaction. - CyberSource declined the request because the credit card has expired. You might also receive this value if the expiration date you provided does not match the date the issuing bank has on file. - The bank declined the transaction. - The merchant reference number for this authorization request matches the merchant reference number of another authorization request that you sent within the past 15 minutes. Resend the request with a unique merchant reference number. - The credit card number did not pass CyberSource basic checks. - Data provided is not consistent with the request. For example, you requested a product with negative cost. - The request is missing a required field. | [optional] -**details** | [**List<PtsV2PayoutsPost201ResponseErrorInformationDetails>**](PtsV2PayoutsPost201ResponseErrorInformationDetails.md) | | [optional] +**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_CARD - INVALID_MERCHANT_CONFIGURATION - INVALID_AMOUNT - DEBIT_CARD_USEAGE_EXCEEDD_LIMIT | [optional] +**message** | **String** | The detail message related to the status and reason listed above. | [optional] +**details** | [**List<PtsV2PaymentsPost201ResponseErrorInformationDetails>**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) | | [optional] @@ -18,6 +18,7 @@ Name | Value MISSING_FIELD | "MISSING_FIELD" INVALID_DATA | "INVALID_DATA" DUPLICATE_REQUEST | "DUPLICATE_REQUEST" +INVALID_CARD | "INVALID_CARD" INVALID_MERCHANT_CONFIGURATION | "INVALID_MERCHANT_CONFIGURATION" INVALID_AMOUNT | "INVALID_AMOUNT" DEBIT_CARD_USEAGE_EXCEEDD_LIMIT | "DEBIT_CARD_USEAGE_EXCEEDD_LIMIT" diff --git a/docs/PtsV2PayoutsPost502Response.md b/docs/PtsV2PayoutsPost502Response.md deleted file mode 100644 index c884b87b1..000000000 --- a/docs/PtsV2PayoutsPost502Response.md +++ /dev/null @@ -1,30 +0,0 @@ - -# PtsV2PayoutsPost502Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. | [optional] -**message** | **String** | The detail message related to the status and reason listed above. | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -ERROR | "SERVER_ERROR" - - - -## Enum: ReasonEnum -Name | Value ----- | ----- -SYSTEM_ERROR | "SYSTEM_ERROR" -SERVER_TIMEOUT | "SERVER_TIMEOUT" -SERVICE_TIMEOUT | "SERVICE_TIMEOUT" -PROCESSOR_TIMEOUT | "PROCESSOR_TIMEOUT" - - - diff --git a/docs/PtsV2PayoutsPostResponse.md b/docs/PtsV2PayoutsPostResponse.md deleted file mode 100644 index 91ec4f663..000000000 --- a/docs/PtsV2PayoutsPostResponse.md +++ /dev/null @@ -1,16 +0,0 @@ - -# PtsV2PayoutsPostResponse - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**clientReferenceInformation** | [**Ptsv2payoutsClientReferenceInformation**](Ptsv2payoutsClientReferenceInformation.md) | | [optional] -**orderInformation** | [**Ptsv2payoutsOrderInformation**](Ptsv2payoutsOrderInformation.md) | | [optional] -**merchantInformation** | [**Ptsv2payoutsMerchantInformation**](Ptsv2payoutsMerchantInformation.md) | | [optional] -**recipientInformation** | [**Ptsv2payoutsRecipientInformation**](Ptsv2payoutsRecipientInformation.md) | | [optional] -**senderInformation** | [**Ptsv2payoutsSenderInformation**](Ptsv2payoutsSenderInformation.md) | | [optional] -**processingInformation** | [**Ptsv2payoutsProcessingInformation**](Ptsv2payoutsProcessingInformation.md) | | [optional] -**paymentInformation** | [**Ptsv2payoutsPaymentInformation**](Ptsv2payoutsPaymentInformation.md) | | [optional] - - - diff --git a/docs/Ptsv2paymentsBuyerInformationPersonalIdentification.md b/docs/Ptsv2paymentsBuyerInformationPersonalIdentification.md index 97d8d26c8..d48436351 100644 --- a/docs/Ptsv2paymentsBuyerInformationPersonalIdentification.md +++ b/docs/Ptsv2paymentsBuyerInformationPersonalIdentification.md @@ -4,17 +4,21 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | [**TypeEnum**](#TypeEnum) | The type of the indentification. Possible values: - **NATIONAL** - **CPF** - **CURP** - **SSN** - **DRIVER_LICENSE** This field is supported only on the processors listed in this description. **ComercioLatino**\\ Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing**\\ Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] -**id** | **String** | Personal Identifier for the customer based on various type. This field is supported only on the processors listed in this description. **ComercioLatino** Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing** Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the personal_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**issuedBy** | **String** | If type = DRIVER_LICENSE, this is the State or province where the customer’s driver’s license was issued. Use the twocharacter State, Province, and Territory Codes for the United States and Canada. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used. | [optional] +**type** | [**TypeEnum**](#TypeEnum) | The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` This field is supported only on the following processors. **ComercioLatino**\\ Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing**\\ Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**id** | **String** | The value of the identification type. This field is supported only on the following processors. **ComercioLatino** Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing** Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the personal_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If type = PASSPORT, this is the cardholder's passport number. Recommended for Discover ProtectBuy. | [optional] +**issuedBy** | **String** | If type = DRIVER_LICENSE, this is the State or province where the customer’s driver’s license was issued. Use the two-character State, Province, and Territory Codes for the United States and Canada. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used. If type = PASSPORT, this is the Issuing country for the cardholder’s passport. Recommended for Discover ProtectBuy. | [optional] ## Enum: TypeEnum Name | Value ---- | ----- -SSN | "ssn" -DRIVERLICENSE | "driverlicense" +NATIONAL | "NATIONAL" +CPF | "CPF" +CPNJ | "CPNJ" +CURP | "CURP" +SSN | "SSN" +DRIVER_LICENSE | "DRIVER_LICENSE" diff --git a/docs/Ptsv2paymentsClientReferenceInformation.md b/docs/Ptsv2paymentsClientReferenceInformation.md index bd3d2d189..2ed22e542 100644 --- a/docs/Ptsv2paymentsClientReferenceInformation.md +++ b/docs/Ptsv2paymentsClientReferenceInformation.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API. **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] -**transactionId** | **String** | Identifier that you assign to the transaction. **Note** Use this field only if you want to support merchant-initiated reversal and void operations . See \"Merchant-Initiated Reversals and Voids,\" page 176. | [optional] +**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] +**transactionId** | **String** | Identifier that you assign to the transaction. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. See page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf) | [optional] **comments** | **String** | Comments | [optional] **partner** | [**Ptsv2paymentsClientReferenceInformationPartner**](Ptsv2paymentsClientReferenceInformationPartner.md) | | [optional] diff --git a/docs/Ptsv2paymentsDeviceInformation.md b/docs/Ptsv2paymentsDeviceInformation.md index 9a11f1bf4..e451d381b 100644 --- a/docs/Ptsv2paymentsDeviceInformation.md +++ b/docs/Ptsv2paymentsDeviceInformation.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**hostName** | **String** | DNS resolved hostname from above _ipAddress_. | [optional] -**ipAddress** | **String** | IP address of the customer. | [optional] +**hostName** | **String** | Host name reported by the customer’s browser to your Web server identified via the HTTP header. | [optional] +**ipAddress** | **String** | Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information. | [optional] **userAgent** | **String** | Customer’s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies the Netscape browser. | [optional] diff --git a/docs/Ptsv2paymentsOrderInformationLineItems.md b/docs/Ptsv2paymentsOrderInformationLineItems.md index 36f581a4f..a2b89990c 100644 --- a/docs/Ptsv2paymentsOrderInformationLineItems.md +++ b/docs/Ptsv2paymentsOrderInformationLineItems.md @@ -4,13 +4,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productCode** | **String** | Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. | [optional] -**productName** | **String** | For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false` respectively), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. | [optional] -**productSku** | **String** | Identification code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. | [optional] -**quantity** | [**BigDecimal**](BigDecimal.md) | For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. | [optional] +**productCode** | **String** | Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. | [optional] +**productName** | **String** | For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. | [optional] +**productSku** | **String** | Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. | [optional] +**quantity** | [**BigDecimal**](BigDecimal.md) | Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased. | [optional] **unitPrice** | **String** | Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in: - Table 12, \"Authorization Information for Specific Processors,\" on page 36 - Table 16, \"Capture Information for Specific Processors,\" on page 51 - Table 20, \"Credit Information for Specific Processors,\" on page 65 **DCC for First Data**\\ This value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36. **Zero Amount Authorizations**\\ If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220. | [optional] **unitOfMeasure** | **String** | Unit of measure, or unit of measure code, for the item. | [optional] -**totalAmount** | **String** | Total amount for the item. Normally calculated as the unit price x quantity. | [optional] +**totalAmount** | **String** | Total amount for the item. Normally calculated as the unit price x quantity. When orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD= 123 | [optional] **taxAmount** | **String** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. If you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. This field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API. | [optional] **taxRate** | **String** | Tax rate applied to the item. See \"Numbered Elements,\" page 14. Visa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). Mastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). | [optional] **taxAppliedAfterDiscount** | **String** | Flag to indicate how you handle discount at the line item level. - 0: no line level discount provided - 1: tax was calculated on the post-discount line item total - 2: tax was calculated on the pre-discount line item total `Note` Visa will inset 0 (zero) if an invalid value is included in this field. This field relates to the value in the _lineItems[].discountAmount_ field. | [optional] diff --git a/docs/Ptsv2paymentsOrderInformationShipTo.md b/docs/Ptsv2paymentsOrderInformationShipTo.md index 5e38390ba..689beb3f8 100644 --- a/docs/Ptsv2paymentsOrderInformationShipTo.md +++ b/docs/Ptsv2paymentsOrderInformationShipTo.md @@ -11,10 +11,10 @@ Name | Type | Description | Notes **locality** | **String** | City of the shipping address. | [optional] **administrativeArea** | **String** | State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] **postalCode** | **String** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 **American Express Direct**\\ Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. | [optional] -**country** | **String** | Country of the shipping address. Use the two character ISO Standard Country Codes. | [optional] +**country** | **String** | Country of the shipping address. Use the two-character ISO Standard Country Codes. | [optional] **district** | **String** | Neighborhood, community, or region within a city or municipality. | [optional] **buildingNumber** | **String** | Building number in the street address. For example, the building number is 187 in the following address: Rua da Quitanda 187 | [optional] -**phoneNumber** | **String** | Phone number for the shipping address. | [optional] +**phoneNumber** | **String** | Phone number associated with the shipping address. | [optional] **company** | **String** | Name of the customer’s company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] diff --git a/docs/Ptsv2paymentsOrderInformationShippingDetails.md b/docs/Ptsv2paymentsOrderInformationShippingDetails.md index 4d5e021cb..586754247 100644 --- a/docs/Ptsv2paymentsOrderInformationShippingDetails.md +++ b/docs/Ptsv2paymentsOrderInformationShippingDetails.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**giftWrap** | **Boolean** | The description for this field is not available. | [optional] +**giftWrap** | **String** | Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - `yes`: The customer requested gift wrapping. - `no`: The customer did not request gift wrapping. | [optional] **shippingMethod** | **String** | Shipping method for the product. Possible values: - `lowcost`: Lowest-cost service - `sameday`: Courier or same-day service - `oneday`: Next-day or overnight service - `twoday`: Two-day service - `threeday`: Three-day service - `pickup`: Store pick-up - `other`: Other shipping method - `none`: No shipping method because product is a service or subscription | [optional] **shipFromPostalCode** | **String** | Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is the postal code associated with your CyberSource account. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: `[5 digits][dash][4 digits]` Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: `[alpha][numeric][alpha][space] [numeric][alpha][numeric]` Example A1B 2C3 This field is frequently used for Level II and Level III transactions. | [optional] diff --git a/docs/Ptsv2paymentsPaymentInformationCard.md b/docs/Ptsv2paymentsPaymentInformationCard.md index da67a98cd..e280de368 100644 --- a/docs/Ptsv2paymentsPaymentInformationCard.md +++ b/docs/Ptsv2paymentsPaymentInformationCard.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**number** | **String** | Customer’s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field for the encoded account number. For processor-specific information, see the customer_cc_number field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationMonth** | **String** | Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationYear** | **String** | Four-digit year in which the credit card expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover | [optional] +**number** | **String** | The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expirationMonth** | **String** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expirationYear** | **String** | Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) | [optional] **useAs** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. **Cielo** and **Comercio Latino** Possible values: - CREDIT: Credit card - DEBIT: Debit card This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. | [optional] **sourceAccountType** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for Visa Platform Connect (VPC). **Note**\\ Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - **CHECKING**: Checking account - **CREDIT**: Credit card account - **SAVING**: Saving account - **LINE_OF_CREDIT**: Line of credit or credit portion of combo card - **PREPAID**: Prepaid card account or prepaid portion of combo card - **UNIVERSAL**: Universal account | [optional] **securityCode** | **String** | Card Verification Number. **Ingenico ePayments** Do not include this field when _commerceIndicator=recurring_. **Note** Ingenico ePayments was previously called Global Collect. | [optional] diff --git a/docs/Ptsv2paymentsPaymentInformationTokenizedCard.md b/docs/Ptsv2paymentsPaymentInformationTokenizedCard.md index 6a28c2b6c..69cb08262 100644 --- a/docs/Ptsv2paymentsPaymentInformationTokenizedCard.md +++ b/docs/Ptsv2paymentsPaymentInformationTokenizedCard.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **number** | **String** | Customer’s payment network token value. | [optional] **expirationMonth** | **String** | Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] **expirationYear** | **String** | Four-digit year in which the payment network token expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover | [optional] +**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) | [optional] **cryptogram** | **String** | This field is used internally. | [optional] **requestorId** | **String** | Value that identifies your business and indicates that the cardholder’s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider’s database. `Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. | [optional] **transactionType** | **String** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Set the value for this field to 1. An application on the customer’s mobile device provided the token data. | [optional] diff --git a/docs/Ptsv2paymentsidcapturesMerchantInformationMerchantDescriptor.md b/docs/Ptsv2paymentsidcapturesMerchantInformationMerchantDescriptor.md deleted file mode 100644 index eebbd5f73..000000000 --- a/docs/Ptsv2paymentsidcapturesMerchantInformationMerchantDescriptor.md +++ /dev/null @@ -1,17 +0,0 @@ - -# Ptsv2paymentsidcapturesMerchantInformationMerchantDescriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) For Payouts: * Paymentech (22) | [optional] -**alternateName** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**contact** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * FDCCompass (13) * Paymentech (13) | [optional] -**address1** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**locality** | **String** | Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**postalCode** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**administrativeArea** | **String** | Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] - - - diff --git a/docs/Ptsv2paymentsidcapturesOrderInformationShipTo.md b/docs/Ptsv2paymentsidcapturesOrderInformationShipTo.md index 0cbcac68c..fcae1edc6 100644 --- a/docs/Ptsv2paymentsidcapturesOrderInformationShipTo.md +++ b/docs/Ptsv2paymentsidcapturesOrderInformationShipTo.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **administrativeArea** | **String** | State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] -**country** | **String** | Country of the shipping address. Use the two character ISO Standard Country Codes. | [optional] +**country** | **String** | Country of the shipping address. Use the two-character ISO Standard Country Codes. | [optional] **postalCode** | **String** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 **American Express Direct**\\ Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. | [optional] diff --git a/docs/Ptsv2paymentsidcapturesPaymentInformationCustomer.md b/docs/Ptsv2paymentsidcapturesPaymentInformationCustomer.md deleted file mode 100644 index 8744a494e..000000000 --- a/docs/Ptsv2paymentsidcapturesPaymentInformationCustomer.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Ptsv2paymentsidcapturesPaymentInformationCustomer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customerId** | **String** | Unique identifier for the customer's card and billing information. When you use Payment Tokenization or Recurring Billing and you include this value in your request, many of the fields that are normally required for an authorization or credit become optional. **NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer’s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself. See \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225. | [optional] - - - diff --git a/docs/Ptsv2paymentsidrefundsOrderInformationLineItems.md b/docs/Ptsv2paymentsidrefundsOrderInformationLineItems.md index d1f93d574..6f3798ac5 100644 --- a/docs/Ptsv2paymentsidrefundsOrderInformationLineItems.md +++ b/docs/Ptsv2paymentsidrefundsOrderInformationLineItems.md @@ -4,13 +4,13 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**productCode** | **String** | Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. | [optional] -**productName** | **String** | For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false` respectively), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. | [optional] -**productSku** | **String** | Identification code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. | [optional] -**quantity** | [**BigDecimal**](BigDecimal.md) | For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. | [optional] +**productCode** | **String** | Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. | [optional] +**productName** | **String** | For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. | [optional] +**productSku** | **String** | Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. | [optional] +**quantity** | [**BigDecimal**](BigDecimal.md) | Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased. | [optional] **unitPrice** | **String** | Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in: - Table 12, \"Authorization Information for Specific Processors,\" on page 36 - Table 16, \"Capture Information for Specific Processors,\" on page 51 - Table 20, \"Credit Information for Specific Processors,\" on page 65 **DCC for First Data**\\ This value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36. **Zero Amount Authorizations**\\ If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220. | [optional] **unitOfMeasure** | **String** | Unit of measure, or unit of measure code, for the item. | [optional] -**totalAmount** | **String** | Total amount for the item. Normally calculated as the unit price x quantity. | [optional] +**totalAmount** | **String** | Total amount for the item. Normally calculated as the unit price x quantity. When orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD= 123 | [optional] **taxAmount** | **String** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. If you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API. This field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API. | [optional] **taxRate** | **String** | Tax rate applied to the item. See \"Numbered Elements,\" page 14. Visa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). Mastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). | [optional] **taxAppliedAfterDiscount** | **String** | Flag to indicate how you handle discount at the line item level. - 0: no line level discount provided - 1: tax was calculated on the post-discount line item total - 2: tax was calculated on the pre-discount line item total `Note` Visa will inset 0 (zero) if an invalid value is included in this field. This field relates to the value in the _lineItems[].discountAmount_ field. | [optional] diff --git a/docs/Ptsv2paymentsidrefundsPaymentInformationCard.md b/docs/Ptsv2paymentsidrefundsPaymentInformationCard.md index 1b1dd7e63..60f0b097a 100644 --- a/docs/Ptsv2paymentsidrefundsPaymentInformationCard.md +++ b/docs/Ptsv2paymentsidrefundsPaymentInformationCard.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**number** | **String** | Customer’s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field for the encoded account number. For processor-specific information, see the customer_cc_number field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationMonth** | **String** | Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationYear** | **String** | Four-digit year in which the credit card expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover | [optional] +**number** | **String** | The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expirationMonth** | **String** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expirationYear** | **String** | Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) | [optional] **accountEncoderId** | **String** | Identifier for the issuing bank that provided the customer’s encoded account number. Contact your processor for the bank’s ID. | [optional] **issueNumber** | **String** | Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions. | [optional] **startMonth** | **String** | Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional] diff --git a/docs/Ptsv2paymentsidreversalsClientReferenceInformation.md b/docs/Ptsv2paymentsidreversalsClientReferenceInformation.md index 10cad6f96..18e29fc77 100644 --- a/docs/Ptsv2paymentsidreversalsClientReferenceInformation.md +++ b/docs/Ptsv2paymentsidreversalsClientReferenceInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API. **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] +**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] **comments** | **String** | Comments | [optional] **partner** | [**Ptsv2paymentsidreversalsClientReferenceInformationPartner**](Ptsv2paymentsidreversalsClientReferenceInformationPartner.md) | | [optional] diff --git a/docs/Ptsv2paymentsidreversalsOrderInformationLineItems.md b/docs/Ptsv2paymentsidreversalsOrderInformationLineItems.md index 587dced6e..f7890d63d 100644 --- a/docs/Ptsv2paymentsidreversalsOrderInformationLineItems.md +++ b/docs/Ptsv2paymentsidreversalsOrderInformationLineItems.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**quantity** | [**BigDecimal**](BigDecimal.md) | For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. | [optional] +**quantity** | [**BigDecimal**](BigDecimal.md) | Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased. | [optional] **unitPrice** | **String** | Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in: - Table 12, \"Authorization Information for Specific Processors,\" on page 36 - Table 16, \"Capture Information for Specific Processors,\" on page 51 - Table 20, \"Credit Information for Specific Processors,\" on page 65 **DCC for First Data**\\ This value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36. **Zero Amount Authorizations**\\ If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220. | [optional] diff --git a/docs/Ptsv2payoutsClientReferenceInformation.md b/docs/Ptsv2payoutsClientReferenceInformation.md index b1a0b515d..caf1fd372 100644 --- a/docs/Ptsv2payoutsClientReferenceInformation.md +++ b/docs/Ptsv2payoutsClientReferenceInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. | [optional] +**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] diff --git a/docs/Ptsv2payoutsMerchantInformation.md b/docs/Ptsv2payoutsMerchantInformation.md index 184acc0ef..a49069547 100644 --- a/docs/Ptsv2payoutsMerchantInformation.md +++ b/docs/Ptsv2payoutsMerchantInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**categoryCode** | **Integer** | Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**categoryCode** | **Integer** | Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) See \"Aggregator Support,\" page 100. **CyberSource through VisaNet**\\ The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code | [optional] **submitLocalDateTime** | **String** | Time that the transaction was submitted in local time. The time is in hhmmss format. | [optional] **vatRegistrationNumber** | **String** | Your government-assigned tax identification number. For CtV processors, the maximum length is 20. For other processor-specific information, see the merchant_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] **merchantDescriptor** | [**Ptsv2payoutsMerchantInformationMerchantDescriptor**](Ptsv2payoutsMerchantInformationMerchantDescriptor.md) | | [optional] diff --git a/docs/Ptsv2payoutsOrderInformationAmountDetails.md b/docs/Ptsv2payoutsOrderInformationAmountDetails.md index 43a00a5af..5b9ba39bd 100644 --- a/docs/Ptsv2payoutsOrderInformationAmountDetails.md +++ b/docs/Ptsv2payoutsOrderInformationAmountDetails.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:  Table 15, \"Authorization Information for Specific Processors,\" on page 43  Table 19, \"Capture Information for Specific Processors,\" on page 58  Table 23, \"Credit Information for Specific Processors,\" on page 75 If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247. **DCC with a Third-Party Provider**\\ Set this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. | [optional] **surcharge** | [**Ptsv2payoutsOrderInformationAmountDetailsSurcharge**](Ptsv2payoutsOrderInformationAmountDetailsSurcharge.md) | | [optional] diff --git a/docs/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.md b/docs/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.md index e936354af..106e36a9f 100644 --- a/docs/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.md +++ b/docs/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**amount** | **String** | The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. - Applicable only for CTV for Payouts. - CTV (<= 08) For processor-specific information, see the surcharge_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**amount** | **String** | The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. If the amount is positive, then it is a debit for the customer.\\ If the amount is negative, then it is a credit for the customer. **NOTE**: This field is supported only for CyberSource through VisaNet (CtV) for Payouts. For CtV, the maximum string length is 8. For processor-specific information, see the surcharge_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] diff --git a/docs/Ptsv2payoutsOrderInformationBillTo.md b/docs/Ptsv2payoutsOrderInformationBillTo.md index ed7382f6f..74686d223 100644 --- a/docs/Ptsv2payoutsOrderInformationBillTo.md +++ b/docs/Ptsv2payoutsOrderInformationBillTo.md @@ -4,15 +4,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**firstName** | **String** | Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**lastName** | **String** | Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**address1** | **String** | First line of the billing street address as it appears on the credit card issuer’s records. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**address2** | **String** | Additional address information. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**locality** | **String** | City of the billing address. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**administrativeArea** | **String** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**phoneNumber** | **String** | Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**firstName** | **String** | Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**lastName** | **String** | Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**address1** | **String** | First line of the billing street address as it appears on the credit card issuer’s records. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**address2** | **String** | Additional address information. For Payouts: This field may be sent only for FDC Compass. **Atos** This field must not contain colons (:). **Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions** This value is used for AVS. **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**country** | **String** | Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**locality** | **String** | City of the billing address. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**administrativeArea** | **String** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For Payouts: This field may be sent only for FDC Compass. **American Express Direct** Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**phoneNumber** | **String** | Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. | [optional] **phoneType** | [**PhoneTypeEnum**](#PhoneTypeEnum) | Customer's phone number type. For Payouts: This field may be sent only for FDC Compass. Possible Values - * day * home * night * work | [optional] diff --git a/docs/Ptsv2payoutsPaymentInformation.md b/docs/Ptsv2payoutsPaymentInformation.md index 745d819f8..4075b5dd3 100644 --- a/docs/Ptsv2payoutsPaymentInformation.md +++ b/docs/Ptsv2payoutsPaymentInformation.md @@ -5,6 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **card** | [**Ptsv2payoutsPaymentInformationCard**](Ptsv2payoutsPaymentInformationCard.md) | | [optional] +**customer** | [**Ptsv2paymentsPaymentInformationCustomer**](Ptsv2paymentsPaymentInformationCustomer.md) | | [optional] diff --git a/docs/Ptsv2payoutsPaymentInformationCard.md b/docs/Ptsv2payoutsPaymentInformationCard.md index 5086346dd..8e7889b4e 100644 --- a/docs/Ptsv2payoutsPaymentInformationCard.md +++ b/docs/Ptsv2payoutsPaymentInformationCard.md @@ -4,11 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover | [optional] -**number** | **String** | Customer’s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field for the encoded account number. For processor-specific information, see the customer_cc_number field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationMonth** | **String** | Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationYear** | **String** | Four-digit year in which the credit card expires. `Format: YYYY`. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**sourceAccountType** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases. - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for CTV. **Note** Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - CHECKING: Checking account - CREDIT: Credit card account - SAVING: Saving account - LINE_OF_CREDIT: Line of credit - PREPAID: Prepaid card account - UNIVERSAL: Universal account | [optional] +**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) | [optional] +**number** | **String** | The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expirationMonth** | **String** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expirationYear** | **String** | Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**sourceAccountType** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for Visa Platform Connect (VPC). **Note**\\ Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - **CHECKING**: Checking account - **CREDIT**: Credit card account - **SAVING**: Saving account - **LINE_OF_CREDIT**: Line of credit or credit portion of combo card - **PREPAID**: Prepaid card account or prepaid portion of combo card - **UNIVERSAL**: Universal account | [optional] diff --git a/docs/Ptsv2payoutsProcessingInformation.md b/docs/Ptsv2payoutsProcessingInformation.md index 949c04174..a9dba413d 100644 --- a/docs/Ptsv2payoutsProcessingInformation.md +++ b/docs/Ptsv2payoutsProcessingInformation.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **businessApplicationId** | **String** | Payouts transaction type. Applicable Processors: FDC Compass, Paymentech, CtV Possible values: **Credit Card Bill Payment** - **CP**: credit card bill payment **Funds Disbursement** - **FD**: funds disbursement - **GD**: government disbursement - **MD**: merchant disbursement **Money Transfer** - **AA**: account to account. Sender and receiver are same person. - **PP**: person to person. Sender and receiver are different. **Prepaid Load** - **TU**: top up | [optional] **networkRoutingOrder** | **String** | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer’s preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer’s routing priorities. See https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code , under section 'Network ID and Sharing Group Code' on the left panel for available values | [optional] -**commerceIndicator** | **String** | Type of transaction. Possible value for Fast Payments transactions: - internet | [optional] +**commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value listed here. Possible value for Fast Payments transactions: - internet **Ingenico ePayments**\\ Ingenico ePayments was previously called _Global Collect_. **Payer Authentication Transactions**\\ For the possible values and requirements, see \"Payer Authentication,\" page 180. **Other Types of Transactions**\\ See Appendix G, \"Commerce Indicators,\" on page 353. | [optional] **reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] **payoutsOptions** | [**Ptsv2payoutsProcessingInformationPayoutsOptions**](Ptsv2payoutsProcessingInformationPayoutsOptions.md) | | [optional] diff --git a/docs/PurchaseAndRefundDetailsApi.md b/docs/PurchaseAndRefundDetailsApi.md index 9853d6de4..3b3b04daf 100644 --- a/docs/PurchaseAndRefundDetailsApi.md +++ b/docs/PurchaseAndRefundDetailsApi.md @@ -23,8 +23,8 @@ Download the Purchase and Refund Details report. This report report includes all PurchaseAndRefundDetailsApi apiInstance = new PurchaseAndRefundDetailsApi(); -DateTime startTime = new DateTime(); // DateTime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX -DateTime endTime = new DateTime(); // DateTime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX +DateTime startTime = new DateTime(); // DateTime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) +DateTime endTime = new DateTime(); // DateTime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) String organizationId = "organizationId_example"; // String | Valid Cybersource Organization Id String paymentSubtype = "ALL"; // String | Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit String viewBy = "requestDate"; // String | View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date @@ -44,8 +44,8 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **startTime** | **DateTime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX | - **endTime** | **DateTime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX | + **startTime** | **DateTime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | + **endTime** | **DateTime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | **organizationId** | **String**| Valid Cybersource Organization Id | [optional] **paymentSubtype** | **String**| Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit | [optional] [default to ALL] [enum: ALL, VI, MC, AX, DI, DP] **viewBy** | **String**| View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date | [optional] [default to requestDate] [enum: requestDate, submissionDate] diff --git a/docs/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md b/docs/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md index 87615b008..b66aa6ef3 100644 --- a/docs/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md +++ b/docs/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.md @@ -15,7 +15,7 @@ Name | Type | Description | Notes **startDay** | **Integer** | Start Day | [optional] **reportFields** | **List<String>** | List of all fields String values | [optional] **reportFilters** | [**Map<String, List<String>>**](List.md) | List of filters to apply | [optional] -**reportPreferences** | [**ReportingV3ReportsIdGet200ResponseReportPreferences**](ReportingV3ReportsIdGet200ResponseReportPreferences.md) | | [optional] +**reportPreferences** | [**Reportingv3reportsReportPreferences**](Reportingv3reportsReportPreferences.md) | | [optional] **groupId** | **String** | Id for the selected group. | [optional] @@ -34,6 +34,7 @@ Name | Value DAILY | "DAILY" WEEKLY | "WEEKLY" MONTHLY | "MONTHLY" +ADHOC | "ADHOC" diff --git a/docs/ReportingV3ReportsIdGet200Response.md b/docs/ReportingV3ReportsIdGet200Response.md index bccf84dff..df932afe9 100644 --- a/docs/ReportingV3ReportsIdGet200Response.md +++ b/docs/ReportingV3ReportsIdGet200Response.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **reportEndTime** | [**DateTime**](DateTime.md) | Report End Time Value | [optional] **timezone** | **String** | Time Zone Value | [optional] **reportFilters** | [**Map<String, List<String>>**](List.md) | List of filters to apply | [optional] -**reportPreferences** | [**ReportingV3ReportsIdGet200ResponseReportPreferences**](ReportingV3ReportsIdGet200ResponseReportPreferences.md) | | [optional] +**reportPreferences** | [**Reportingv3reportsReportPreferences**](Reportingv3reportsReportPreferences.md) | | [optional] **groupId** | **String** | Id for selected group. | [optional] diff --git a/docs/ReportingV3ReportsIdGet200ResponseReportPreferences.md b/docs/ReportingV3ReportsIdGet200ResponseReportPreferences.md deleted file mode 100644 index cc94de6c9..000000000 --- a/docs/ReportingV3ReportsIdGet200ResponseReportPreferences.md +++ /dev/null @@ -1,19 +0,0 @@ - -# ReportingV3ReportsIdGet200ResponseReportPreferences - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**signedAmounts** | **Boolean** | Indicator to determine whether negative sign infron of amount for all refunded transaction | [optional] -**fieldNameConvention** | [**FieldNameConventionEnum**](#FieldNameConventionEnum) | Specify the field naming convention to be followed in reports (applicable to only csv report formats | [optional] - - - -## Enum: FieldNameConventionEnum -Name | Value ----- | ----- -SOAPI | "SOAPI" -SCMP | "SCMP" - - - diff --git a/docs/Reportingv3ReportDownloadsGet400Response.md b/docs/Reportingv3ReportDownloadsGet400Response.md index fa8753f6d..6f4a62b4d 100644 --- a/docs/Reportingv3ReportDownloadsGet400Response.md +++ b/docs/Reportingv3ReportDownloadsGet400Response.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC | +**submitTimeUtc** | [**DateTime**](DateTime.md) | Time of request in UTC. | **reason** | **String** | Documented reason code | **message** | **String** | Short descriptive message to the user. | **details** | [**List<Reportingv3ReportDownloadsGet400ResponseDetails>**](Reportingv3ReportDownloadsGet400ResponseDetails.md) | Error field list | diff --git a/docs/ReportsApi.md b/docs/ReportsApi.md index 59c363295..b6c39b928 100644 --- a/docs/ReportsApi.md +++ b/docs/ReportsApi.md @@ -118,8 +118,8 @@ Retrieve a list of the available reports to which you are subscribed. This will ReportsApi apiInstance = new ReportsApi(); -DateTime startTime = new DateTime(); // DateTime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX -DateTime endTime = new DateTime(); // DateTime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX +DateTime startTime = new DateTime(); // DateTime | Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) +DateTime endTime = new DateTime(); // DateTime | Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) String timeQueryType = "timeQueryType_example"; // String | Specify time you would like to search String organizationId = "organizationId_example"; // String | Valid Cybersource Organization Id String reportMimeType = "reportMimeType_example"; // String | Valid Report Format @@ -140,8 +140,8 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **startTime** | **DateTime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX | - **endTime** | **DateTime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX | + **startTime** | **DateTime**| Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | + **endTime** | **DateTime**| Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) | **timeQueryType** | **String**| Specify time you would like to search | [enum: reportTimeFrame, executedTime] **organizationId** | **String**| Valid Cybersource Organization Id | [optional] **reportMimeType** | **String**| Valid Report Format | [optional] [enum: application/xml, text/csv] diff --git a/docs/RequestBody1.md b/docs/RequestBody1.md index 69089e0fe..e14106117 100644 --- a/docs/RequestBody1.md +++ b/docs/RequestBody1.md @@ -14,7 +14,7 @@ Name | Type | Description | Notes **startTime** | **String** | The hour at which the report generation should start. It should be in hhmm format. | **startDay** | **Integer** | This is the start day if the frequency is WEEKLY or MONTHLY. The value varies from 1-7 for WEEKLY and 1-31 for MONTHLY. For WEEKLY 1 means Sunday and 7 means Saturday. By default the value is 1. | [optional] **reportFilters** | [**Map<String, List<String>>**](List.md) | List of filters to apply | [optional] -**reportPreferences** | [**ReportingV3ReportsIdGet200ResponseReportPreferences**](ReportingV3ReportsIdGet200ResponseReportPreferences.md) | | [optional] +**reportPreferences** | [**Reportingv3reportsReportPreferences**](Reportingv3reportsReportPreferences.md) | | [optional] **groupName** | **String** | Valid GroupName | [optional] @@ -33,6 +33,7 @@ Name | Value DAILY | "DAILY" WEEKLY | "WEEKLY" MONTHLY | "MONTHLY" +ADHOC | "ADHOC" diff --git a/docs/ResponseStatus.md b/docs/ResponseStatus.md deleted file mode 100644 index 72dc29645..000000000 --- a/docs/ResponseStatus.md +++ /dev/null @@ -1,14 +0,0 @@ - -# ResponseStatus - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | [**BigDecimal**](BigDecimal.md) | HTTP Status code. | [optional] -**reason** | **String** | Error Reason Code. | [optional] -**message** | **String** | Error Message. | [optional] -**correlationId** | **String** | API correlation ID. | [optional] -**details** | [**List<InlineResponseDefaultResponseStatusDetails>**](InlineResponseDefaultResponseStatusDetails.md) | | [optional] - - - diff --git a/docs/ResponseStatusDetails.md b/docs/ResponseStatusDetails.md deleted file mode 100644 index 967af627a..000000000 --- a/docs/ResponseStatusDetails.md +++ /dev/null @@ -1,11 +0,0 @@ - -# ResponseStatusDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**location** | **String** | Field name referred to for validation issues. | [optional] -**message** | **String** | Description or code of any error response. | [optional] - - - diff --git a/docs/ReversalApi.md b/docs/ReversalApi.md index be62aa6aa..89ac276df 100644 --- a/docs/ReversalApi.md +++ b/docs/ReversalApi.md @@ -5,6 +5,7 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**authReversal**](ReversalApi.md#authReversal) | **POST** /pts/v2/payments/{id}/reversals | Process an Authorization Reversal +[**mitReversal**](ReversalApi.md#mitReversal) | **POST** /pts/v2/reversals/ | Merchant Initiated Reversal @@ -54,3 +55,48 @@ No authorization required - **Content-Type**: application/json;charset=utf-8 - **Accept**: application/json;charset=utf-8 + +# **mitReversal** +> PtsV2PaymentsReversalsPost201Response mitReversal(mitReversalRequest) + +Merchant Initiated Reversal + +This is to reverse a previous payment that merchant does not receive a reply. + +### Example +```java +// Import classes: +//import Invokers.ApiException; +//import Api.ReversalApi; + + +ReversalApi apiInstance = new ReversalApi(); +MitReversalRequest mitReversalRequest = new MitReversalRequest(); // MitReversalRequest | +try { + PtsV2PaymentsReversalsPost201Response result = apiInstance.mitReversal(mitReversalRequest); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling ReversalApi#mitReversal"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mitReversalRequest** | [**MitReversalRequest**](MitReversalRequest.md)| | + +### Return type + +[**PtsV2PaymentsReversalsPost201Response**](PtsV2PaymentsReversalsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json;charset=utf-8 + diff --git a/docs/RiskV1DecisionsPost201Response.md b/docs/RiskV1DecisionsPost201Response.md new file mode 100644 index 000000000..f8d03e0e3 --- /dev/null +++ b/docs/RiskV1DecisionsPost201Response.md @@ -0,0 +1,16 @@ + +# RiskV1DecisionsPost201Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**PtsV2PaymentsPost201ResponseLinks**](PtsV2PaymentsPost201ResponseLinks.md) | | [optional] +**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] +**submitTimeLocal** | **String** | Time that the transaction was submitted in local time. | [optional] +**status** | **String** | The status of the submitted transaction. Possible values: - `ACCEPTED` - `REJECTED` - `PENDING_REVIEW` | [optional] +**riskInformation** | [**RiskV1DecisionsPost201ResponseRiskInformation**](RiskV1DecisionsPost201ResponseRiskInformation.md) | | [optional] +**errorInformation** | [**PtsV2PaymentsPost201ResponseErrorInformation**](PtsV2PaymentsPost201ResponseErrorInformation.md) | | [optional] + + + diff --git a/docs/RiskV1DecisionsPost201ResponseRiskInformation.md b/docs/RiskV1DecisionsPost201ResponseRiskInformation.md new file mode 100644 index 000000000..286fffbf5 --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseRiskInformation.md @@ -0,0 +1,19 @@ + +# RiskV1DecisionsPost201ResponseRiskInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**profile** | [**RiskV1DecisionsPost201ResponseRiskInformationProfile**](RiskV1DecisionsPost201ResponseRiskInformationProfile.md) | | [optional] +**rules** | [**List<RiskV1DecisionsPost201ResponseRiskInformationRules>**](RiskV1DecisionsPost201ResponseRiskInformationRules.md) | | [optional] +**infoCodes** | [**RiskV1DecisionsPost201ResponseRiskInformationInfoCodes**](RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.md) | | [optional] +**velocity** | [**RiskV1DecisionsPost201ResponseRiskInformationVelocity**](RiskV1DecisionsPost201ResponseRiskInformationVelocity.md) | | [optional] +**casePriority** | **Integer** | You receive this field only if you subscribe to the Enhanced Case Management service. For all possible values, Please refer to Simple Order API Developer Guide on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/) - Look for 'Reply Fields': \"decisionReply_casePriority\". | [optional] +**localTime** | **String** | The customer's local time (hh:mm:ss), which is calculated from the transaction request time and the customer's billing address. | [optional] +**paymentInformation** | [**RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation**](RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation.md) | | [optional] +**score** | [**RiskV1DecisionsPost201ResponseRiskInformationScore**](RiskV1DecisionsPost201ResponseRiskInformationScore.md) | | [optional] +**ipAddress** | [**RiskV1DecisionsPost201ResponseRiskInformationIpAddress**](RiskV1DecisionsPost201ResponseRiskInformationIpAddress.md) | | [optional] +**providers** | [**RiskV1DecisionsPost201ResponseRiskInformationProviders**](RiskV1DecisionsPost201ResponseRiskInformationProviders.md) | | [optional] + + + diff --git a/docs/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.md b/docs/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.md new file mode 100644 index 000000000..5bef92677 --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.md @@ -0,0 +1,17 @@ + +# RiskV1DecisionsPost201ResponseRiskInformationInfoCodes + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**velocity** | **List<String>** | List of information codes triggered by the order. These information codes were generated when you created the order and product velocity rules and are returned so that you can associate them with the rules. | [optional] +**address** | **List<String>** | Indicates a mismatch between the customer’s billing and shipping addresses. | [optional] +**customerList** | **List<String>** | Indicates that customer information is associated with transactions that are either on the negative or the positive list. | [optional] +**identityChange** | **List<String>** | Indicates excessive identity changes. The threshold is variable depending on the identity elements being compared. This field can contain one or more information codes, separated by carets (^). | [optional] +**internet** | **List<String>** | Indicates a problem with the customer’s email address, IP address, or billing address. | [optional] +**phone** | **List<String>** | Indicates a problem with the customer’s phone number. | [optional] +**suspicious** | **List<String>** | Indicates that the customer provided potentially suspicious information. | [optional] +**globalVelocity** | **List<String>** | Indicates that the customer has a high purchase frequency. | [optional] + + + diff --git a/docs/RiskV1DecisionsPost201ResponseRiskInformationIpAddress.md b/docs/RiskV1DecisionsPost201ResponseRiskInformationIpAddress.md new file mode 100644 index 000000000..d73de0495 --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseRiskInformationIpAddress.md @@ -0,0 +1,14 @@ + +# RiskV1DecisionsPost201ResponseRiskInformationIpAddress + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**anonymizerStatus** | **String** | Indicates whether the transaction IP address is associated with a known anonymous proxy. For all possible values, Please refer to Simple Order API Developer Guide on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/)- Look for 'Reply Fields': \"afsReply_ipAnonymizerStatus\". | [optional] +**city** | **String** | Name of the city decoded from the IP address used directly or indirectly by the customer to send the order. | [optional] +**country** | **String** | Name of the country decoded from the IP address used directly or indirectly by the customer to send the order. | [optional] +**state** | **String** | Name of the state decoded from the IP address used directly or indirectly by the customer to send the order. | [optional] +**routingMethod** | **String** | Routing method decoded from the IP address used directly or indirectly by the customer to send the order. For all possible values, Please refer to Simple Order API Developer Guide on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/)- Look for 'Reply Fields': \"afsService_ipRoutingMethod \". | [optional] + + + diff --git a/docs/RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation.md b/docs/RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation.md new file mode 100644 index 000000000..7c8885822 --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation.md @@ -0,0 +1,14 @@ + +# RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**binCountry** | **String** | Country (two-digit country code) associated with the BIN of the customer’s card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the Business Center. | [optional] +**accountType** | **String** | Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. | [optional] +**issuer** | **String** | Name of the bank or entity that issued the card account. | [optional] +**scheme** | **String** | Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron *Note:* Additional values may be present. | [optional] +**bin** | **String** | Credit card BIN (the first six digits of the credit card).Derived either from the `bin` request field or from the first six characters of the `number` field. | [optional] + + + diff --git a/docs/RiskV1DecisionsPost201ResponseRiskInformationProfile.md b/docs/RiskV1DecisionsPost201ResponseRiskInformationProfile.md new file mode 100644 index 000000000..ee908e2df --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseRiskInformationProfile.md @@ -0,0 +1,12 @@ + +# RiskV1DecisionsPost201ResponseRiskInformationProfile + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Name of the active profile chosen by the profile selector. If no profile selector exists, the default active profile is chosen. | [optional] +**desinationQueue** | **String** | Name of the queue where orders that are not automatically accepted are sent. | [optional] +**selectorRule** | **String** | Name of the profile selector rule that chooses the profile to use for the transaction. If no profile selector exists, the value is Default Active Profile. | [optional] + + + diff --git a/docs/RiskV1DecisionsPost201ResponseRiskInformationProviders.md b/docs/RiskV1DecisionsPost201ResponseRiskInformationProviders.md new file mode 100644 index 000000000..2ca9d8914 --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseRiskInformationProviders.md @@ -0,0 +1,10 @@ + +# RiskV1DecisionsPost201ResponseRiskInformationProviders + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**providerName** | [**List<RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName>**](RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.md) | | [optional] + + + diff --git a/docs/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.md b/docs/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.md new file mode 100644 index 000000000..22b50a76a --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.md @@ -0,0 +1,11 @@ + +# RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fieldName** | **List<String>** | | [optional] +**fieldValue** | **List<String>** | | [optional] + + + diff --git a/docs/RiskV1DecisionsPost201ResponseRiskInformationRules.md b/docs/RiskV1DecisionsPost201ResponseRiskInformationRules.md new file mode 100644 index 000000000..6ec1496da --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseRiskInformationRules.md @@ -0,0 +1,11 @@ + +# RiskV1DecisionsPost201ResponseRiskInformationRules + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Description of the rule as it appears in the Profile Editor. | [optional] +**decision** | **String** | Summarizes the result for the rule according to the setting that you chose in the Profile Editor. This field can contain one of the following values: - `IGNORE` - `REVIEW` - `REJECT` - `ACCEPT` | [optional] + + + diff --git a/docs/RiskV1DecisionsPost201ResponseRiskInformationScore.md b/docs/RiskV1DecisionsPost201ResponseRiskInformationScore.md new file mode 100644 index 000000000..667c2ff71 --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseRiskInformationScore.md @@ -0,0 +1,12 @@ + +# RiskV1DecisionsPost201ResponseRiskInformationScore + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**factorCodes** | **List<String>** | | [optional] +**modelUsed** | **String** | Name of the score model used for the transaction. If you did not include a custom model in your request, this field contains the name of CyberSource’s default model. | [optional] +**result** | **String** | Total score calculated for this order. The value cannot be negative. | [optional] + + + diff --git a/docs/RiskV1DecisionsPost201ResponseRiskInformationVelocity.md b/docs/RiskV1DecisionsPost201ResponseRiskInformationVelocity.md new file mode 100644 index 000000000..b0b7c0b0d --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseRiskInformationVelocity.md @@ -0,0 +1,11 @@ + +# RiskV1DecisionsPost201ResponseRiskInformationVelocity + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**morphing** | [**List<RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing>**](RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.md) | | [optional] +**address** | **List<String>** | | [optional] + + + diff --git a/docs/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.md b/docs/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.md new file mode 100644 index 000000000..9e61943e8 --- /dev/null +++ b/docs/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.md @@ -0,0 +1,12 @@ + +# RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**count** | **Integer** | Morphing count. Note The count is not returned for the initial transaction. | [optional] +**fieldName** | **String** | Field name of the morphing element. specified by the setting that you chose in the Velocity Editor. For all possible values, Please refer to Simple Order API Developer Guide on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/) - Look for 'Reply Fields': \"decisionReply_morphingElement_#_fieldName\". | [optional] +**informationCode** | **String** | Identifier that CYBS assigned to the velocity rule specified by the number. | [optional] + + + diff --git a/docs/RiskV1DecisionsPost400Response.md b/docs/RiskV1DecisionsPost400Response.md new file mode 100644 index 000000000..77b9d7f2c --- /dev/null +++ b/docs/RiskV1DecisionsPost400Response.md @@ -0,0 +1,21 @@ + +# RiskV1DecisionsPost400Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] +**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] +**reason** | **String** | The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_MERCHANT_CONFIGURATION - PROCESSOR_UNAVAILABLE | [optional] +**message** | **String** | The detail message related to the status and reason listed above. | [optional] +**details** | [**List<PtsV2PaymentsPost201ResponseErrorInformationDetails>**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) | | [optional] + + + +## Enum: StatusEnum +Name | Value +---- | ----- +REQUEST | "INVALID_REQUEST" + + + diff --git a/docs/Riskv1decisionsBuyerInformation.md b/docs/Riskv1decisionsBuyerInformation.md new file mode 100644 index 000000000..2d39edfaf --- /dev/null +++ b/docs/Riskv1decisionsBuyerInformation.md @@ -0,0 +1,12 @@ + +# Riskv1decisionsBuyerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hashedPassword** | **String** | The description for this field is not available. | [optional] +**dateOfBirth** | **String** | Recipient’s date of birth. **Format**: `YYYYMMDD`. This field is a pass-through, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see \"Recipients,\" page 224. | [optional] +**personalIdentification** | [**List<Ptsv2paymentsBuyerInformationPersonalIdentification>**](Ptsv2paymentsBuyerInformationPersonalIdentification.md) | | [optional] + + + diff --git a/docs/Riskv1decisionsCardVerification.md b/docs/Riskv1decisionsCardVerification.md new file mode 100644 index 000000000..35223aa69 --- /dev/null +++ b/docs/Riskv1decisionsCardVerification.md @@ -0,0 +1,10 @@ + +# Riskv1decisionsCardVerification + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**resultCode** | **String** | Result of card verification. Returned by the authorization service in the `processorInformation.cardVerification.resultCode` reply field. If ics_auth and ics_score are requested at the same time, the value is automatically passed from ics_auth to ics_score. For more information on using this field, see \"\"Sending the Results of Address and Card Verification Tests,\"\" page 16. The field contains one of the following values: - `I`: Card verification number failed processor's data validation check. - `M`: Card verification number matched. - `N`: Card verification number not matched. - `P`: Card verification number not processed. - `S`: Card verification number is on the card but was not included in the request. - `U`: Card verification is not supported by the issuing bank. - `X`: Card verification is not supported by the payment card company. - Space Character: Deprecated. Ignore this value. - `1`: CyberSource does not support card verification for this processor or card type. - `2`: Processor returned value unrecognized for card verification response. - `3`: Processor did not return card verification result code. | [optional] + + + diff --git a/docs/Riskv1decisionsClientReferenceInformation.md b/docs/Riskv1decisionsClientReferenceInformation.md new file mode 100644 index 000000000..55863adb2 --- /dev/null +++ b/docs/Riskv1decisionsClientReferenceInformation.md @@ -0,0 +1,11 @@ + +# Riskv1decisionsClientReferenceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] +**comments** | **String** | Brief description of the order or any comment you wish to add to the order. | [optional] + + + diff --git a/docs/Riskv1decisionsDeviceInformation.md b/docs/Riskv1decisionsDeviceInformation.md new file mode 100644 index 000000000..49b77a074 --- /dev/null +++ b/docs/Riskv1decisionsDeviceInformation.md @@ -0,0 +1,15 @@ + +# Riskv1decisionsDeviceInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cookiesAccepted** | **String** | Boolean that indicates whether the customer’s browser accepts cookies. This field can contain one of the following values: - `yes`: The customer’s browser accepts cookies. - `no`: The customer’s browser does not accept cookies. | [optional] +**ipAddress** | **String** | Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information. | [optional] +**hostName** | **String** | Host name reported by the customer’s browser to your Web server identified via the HTTP header. | [optional] +**fingerprintSessionId** | **String** | Contains the session ID that you send to Decision Manager to obtain the device fingerprint information. The string can contain uppercase and lowercase letters, digits, hyphen (-), and underscore (_). However, do not use the same uppercase and lowercase letters to indicate different session IDs. The session ID must be unique for each merchant ID. You can use any string that you are already generating, such as an order number or web session ID.The session ID must be unique for each page load, regardless of an individual’s web session ID. If the same user navigates to a profiled page and is assigned a web session, navigates away from the profiled page, then navigates back to the profiled page, the generated session ID should be different and unique. An example of an ideal session ID would be a web session ID plus the timestamp. This measure ensures that a unique ID is generated every time the page is loaded, even if it is the same user reloading the page. | [optional] +**httpBrowserEmail** | **String** | Email address set in the customer’s browser, which may differ from customer email. | [optional] +**userAgent** | **String** | Customer’s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies the Netscape browser. | [optional] + + + diff --git a/docs/Riskv1decisionsMerchantDefinedInformation.md b/docs/Riskv1decisionsMerchantDefinedInformation.md new file mode 100644 index 000000000..503d8ef49 --- /dev/null +++ b/docs/Riskv1decisionsMerchantDefinedInformation.md @@ -0,0 +1,11 @@ + +# Riskv1decisionsMerchantDefinedInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **String** | Fields that you can use to store information. The value appears in the Case Management Details window in the Business Center. The first four fields are the same fields that are used by the Secure Data services. See request code examples. Warning Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. | [optional] +**value** | **String** | String value for the key | [optional] + + + diff --git a/docs/Riskv1decisionsOrderInformation.md b/docs/Riskv1decisionsOrderInformation.md new file mode 100644 index 000000000..7c4732468 --- /dev/null +++ b/docs/Riskv1decisionsOrderInformation.md @@ -0,0 +1,15 @@ + +# Riskv1decisionsOrderInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**amountDetails** | [**Riskv1decisionsOrderInformationAmountDetails**](Riskv1decisionsOrderInformationAmountDetails.md) | | [optional] +**shippingDetails** | [**Riskv1decisionsOrderInformationShippingDetails**](Riskv1decisionsOrderInformationShippingDetails.md) | | [optional] +**shipTo** | [**Riskv1decisionsOrderInformationShipTo**](Riskv1decisionsOrderInformationShipTo.md) | | [optional] +**returnsAccepted** | **String** | Boolean that indicates whether returns are accepted for this order. This field can contain one of the following values: - `yes`: Returns are accepted for this order. - `no`: Returns are not accepted for this order. | [optional] +**lineItems** | [**List<Riskv1decisionsOrderInformationLineItems>**](Riskv1decisionsOrderInformationLineItems.md) | This array contains detailed information about individual products in the order. | [optional] +**billTo** | [**Riskv1decisionsOrderInformationBillTo**](Riskv1decisionsOrderInformationBillTo.md) | | [optional] + + + diff --git a/docs/Riskv1decisionsOrderInformationAmountDetails.md b/docs/Riskv1decisionsOrderInformationAmountDetails.md new file mode 100644 index 000000000..72c642de3 --- /dev/null +++ b/docs/Riskv1decisionsOrderInformationAmountDetails.md @@ -0,0 +1,11 @@ + +# Riskv1decisionsOrderInformationAmountDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. | +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:  Table 15, \"Authorization Information for Specific Processors,\" on page 43  Table 19, \"Capture Information for Specific Processors,\" on page 58  Table 23, \"Credit Information for Specific Processors,\" on page 75 If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247. **DCC with a Third-Party Provider**\\ Set this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used. | [optional] + + + diff --git a/docs/Riskv1decisionsOrderInformationBillTo.md b/docs/Riskv1decisionsOrderInformationBillTo.md new file mode 100644 index 000000000..85b96fb14 --- /dev/null +++ b/docs/Riskv1decisionsOrderInformationBillTo.md @@ -0,0 +1,19 @@ + +# Riskv1decisionsOrderInformationBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **String** | First line of the billing street address as it appears on the credit card issuer’s records. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**address2** | **String** | Additional address information. For Payouts: This field may be sent only for FDC Compass. **Atos** This field must not contain colons (:). **Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions** This value is used for AVS. **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**administrativeArea** | **String** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**country** | **String** | Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**locality** | **String** | City of the billing address. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**firstName** | **String** | Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**lastName** | **String** | Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**phoneNumber** | **String** | Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. | [optional] +**email** | **String** | Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For Payouts: This field may be sent only for FDC Compass. **American Express Direct** Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] + + + diff --git a/docs/Riskv1decisionsOrderInformationLineItems.md b/docs/Riskv1decisionsOrderInformationLineItems.md new file mode 100644 index 000000000..be840a315 --- /dev/null +++ b/docs/Riskv1decisionsOrderInformationLineItems.md @@ -0,0 +1,18 @@ + +# Riskv1decisionsOrderInformationLineItems + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**unitPrice** | **String** | Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in: - Table 12, \"Authorization Information for Specific Processors,\" on page 36 - Table 16, \"Capture Information for Specific Processors,\" on page 51 - Table 20, \"Credit Information for Specific Processors,\" on page 65 **DCC for First Data**\\ This value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36. **Zero Amount Authorizations**\\ If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220. | [optional] +**quantity** | [**BigDecimal**](BigDecimal.md) | Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased. | [optional] +**productSKU** | **String** | Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. | [optional] +**productRisk** | **String** | Indicates the level of risk for the product. This field can contain one of the following values: - `low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks. | [optional] +**productName** | **String** | For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. | [optional] +**productCode** | **String** | Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. | [optional] +**gift** | **String** | Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - `yes`: Orders are assigned only slight additional risk if billing and shipping addresses are different. - `no` (default): Orders are assigned higher additional risk if billing and shipping addresses are different. - `off`: Differences between billing and shipping addresses do not affect the score. | [optional] +**distributorProductSku** | **String** | Product’s identifier code. This field is inserted into the outgoing message without being parsed or formatted. This field is included as Distributor product SKU (Offer) in the list of API fields with which you can create custom rules. | [optional] +**passenger** | [**Riskv1decisionsOrderInformationPassenger**](Riskv1decisionsOrderInformationPassenger.md) | | [optional] + + + diff --git a/docs/Riskv1decisionsOrderInformationPassenger.md b/docs/Riskv1decisionsOrderInformationPassenger.md new file mode 100644 index 000000000..d7e0f1b74 --- /dev/null +++ b/docs/Riskv1decisionsOrderInformationPassenger.md @@ -0,0 +1,16 @@ + +# Riskv1decisionsOrderInformationPassenger + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **String** | Passenger classification associated with the price of the ticket. You can use one of the following values: - `ADT`: Adult - `CNN`: Child - `INF`: Infant - `YTH`: Youth - `STU`: Student - `SCR`: Senior Citizen - `MIL`: Military | [optional] +**status** | **String** | Your company's passenger classification, such as with a frequent flyer program. In this case, you might use values such as `standard`, `gold`, or `platinum`. | [optional] +**phone** | **String** | Passenger's phone number. If the order is from outside the U.S., CyberSource recommends that you include the country code. | [optional] +**firstName** | **String** | Passenger's first name. | [optional] +**lastName** | **String** | Passenger's last name. | [optional] +**id** | **String** | ID of the passenger to whom the ticket was issued. For example, you can use this field for the frequent flyer number. | [optional] +**email** | **String** | Passenger's email address, including the full domain name, such as jdoe@example.com. | [optional] + + + diff --git a/docs/InlineResponse2002OrderInformationShipTo.md b/docs/Riskv1decisionsOrderInformationShipTo.md similarity index 68% rename from docs/InlineResponse2002OrderInformationShipTo.md rename to docs/Riskv1decisionsOrderInformationShipTo.md index e58ea9efb..5d1398a60 100644 --- a/docs/InlineResponse2002OrderInformationShipTo.md +++ b/docs/Riskv1decisionsOrderInformationShipTo.md @@ -1,21 +1,18 @@ -# InlineResponse2002OrderInformationShipTo +# Riskv1decisionsOrderInformationShipTo ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**firstName** | **String** | First name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 | [optional] -**lastName** | **String** | Last name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 | [optional] -**company** | **String** | TBD | [optional] **address1** | **String** | First line of the shipping address. | [optional] **address2** | **String** | Second line of the shipping address. | [optional] -**locality** | **String** | City of the shipping address. | [optional] **administrativeArea** | **String** | State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] -**postalCode** | **String** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 | [optional] -**county** | **String** | TBD | [optional] -**country** | **String** | Country of the shipping address. Use the two character ISO Standard Country Codes. | [optional] -**email** | **String** | TBD | [optional] -**phoneNumber** | **String** | Phone number for the shipping address. | [optional] +**country** | **String** | Country of the shipping address. Use the two-character ISO Standard Country Codes. | [optional] +**locality** | **String** | City of the shipping address. | [optional] +**firstName** | **String** | First name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 | [optional] +**lastName** | **String** | Last name of the recipient. **Processor-specific maximum length** - Litle: 25 - All other processors: 60 | [optional] +**phoneNumber** | **String** | Phone number associated with the shipping address. | [optional] +**postalCode** | **String** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 **American Express Direct**\\ Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. | [optional] diff --git a/docs/Riskv1decisionsOrderInformationShippingDetails.md b/docs/Riskv1decisionsOrderInformationShippingDetails.md new file mode 100644 index 000000000..84445ef8e --- /dev/null +++ b/docs/Riskv1decisionsOrderInformationShippingDetails.md @@ -0,0 +1,11 @@ + +# Riskv1decisionsOrderInformationShippingDetails + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**giftWrap** | **String** | Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - `yes`: The customer requested gift wrapping. - `no`: The customer did not request gift wrapping. | [optional] +**shippingMethod** | **String** | Shipping method for the product. Possible values: - `lowcost`: Lowest-cost service - `sameday`: Courier or same-day service - `oneday`: Next-day or overnight service - `twoday`: Two-day service - `threeday`: Three-day service - `pickup`: Store pick-up - `other`: Other shipping method - `none`: No shipping method because product is a service or subscription | [optional] + + + diff --git a/docs/Riskv1decisionsPaymentInformation.md b/docs/Riskv1decisionsPaymentInformation.md new file mode 100644 index 000000000..37e8e10ff --- /dev/null +++ b/docs/Riskv1decisionsPaymentInformation.md @@ -0,0 +1,11 @@ + +# Riskv1decisionsPaymentInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**card** | [**Riskv1decisionsPaymentInformationCard**](Riskv1decisionsPaymentInformationCard.md) | | [optional] +**tokenizedCard** | [**Riskv1decisionsPaymentInformationTokenizedCard**](Riskv1decisionsPaymentInformationTokenizedCard.md) | | [optional] + + + diff --git a/docs/Riskv1decisionsPaymentInformationCard.md b/docs/Riskv1decisionsPaymentInformationCard.md new file mode 100644 index 000000000..ff2ebee07 --- /dev/null +++ b/docs/Riskv1decisionsPaymentInformationCard.md @@ -0,0 +1,14 @@ + +# Riskv1decisionsPaymentInformationCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number** | **String** | The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) | [optional] +**bin** | **String** | description: The BIN is the first six digits of the card's Primary Account Number (PAN). | [optional] +**expirationMonth** | **String** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expirationYear** | **String** | Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] + + + diff --git a/docs/Riskv1decisionsPaymentInformationTokenizedCard.md b/docs/Riskv1decisionsPaymentInformationTokenizedCard.md new file mode 100644 index 000000000..5e05f487d --- /dev/null +++ b/docs/Riskv1decisionsPaymentInformationTokenizedCard.md @@ -0,0 +1,13 @@ + +# Riskv1decisionsPaymentInformationTokenizedCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) | [optional] +**number** | **String** | Customer’s payment network token value. | [optional] +**expirationMonth** | **String** | Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expirationYear** | **String** | Four-digit year in which the payment network token expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] + + + diff --git a/docs/Riskv1decisionsProcessorInformation.md b/docs/Riskv1decisionsProcessorInformation.md new file mode 100644 index 000000000..780ece2f3 --- /dev/null +++ b/docs/Riskv1decisionsProcessorInformation.md @@ -0,0 +1,10 @@ + +# Riskv1decisionsProcessorInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**avs** | [**Riskv1decisionsProcessorInformationAvs**](Riskv1decisionsProcessorInformationAvs.md) | | [optional] + + + diff --git a/docs/Riskv1decisionsProcessorInformationAvs.md b/docs/Riskv1decisionsProcessorInformationAvs.md new file mode 100644 index 000000000..b08e813d1 --- /dev/null +++ b/docs/Riskv1decisionsProcessorInformationAvs.md @@ -0,0 +1,10 @@ + +# Riskv1decisionsProcessorInformationAvs + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**code** | **String** | Value returned for address verification from the Payments Authorization response. | [optional] + + + diff --git a/docs/Riskv1decisionsRiskInformation.md b/docs/Riskv1decisionsRiskInformation.md new file mode 100644 index 000000000..acd8029be --- /dev/null +++ b/docs/Riskv1decisionsRiskInformation.md @@ -0,0 +1,10 @@ + +# Riskv1decisionsRiskInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**profile** | [**Riskv1decisionsRiskInformationProfile**](Riskv1decisionsRiskInformationProfile.md) | | [optional] + + + diff --git a/docs/Riskv1decisionsRiskInformationProfile.md b/docs/Riskv1decisionsRiskInformationProfile.md new file mode 100644 index 000000000..6b6306f70 --- /dev/null +++ b/docs/Riskv1decisionsRiskInformationProfile.md @@ -0,0 +1,10 @@ + +# Riskv1decisionsRiskInformationProfile + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Name of the active profile chosen by the profile selector. If no profile selector exists, the default active profile is chosen. | [optional] + + + diff --git a/docs/Riskv1decisionsTravelInformation.md b/docs/Riskv1decisionsTravelInformation.md new file mode 100644 index 000000000..cc04a2085 --- /dev/null +++ b/docs/Riskv1decisionsTravelInformation.md @@ -0,0 +1,13 @@ + +# Riskv1decisionsTravelInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**completeRoute** | **String** | Concatenation of individual travel legs in the format ORIG1-DEST1[:ORIG2-DEST2...:ORIGn-DESTn], for example, SFO-JFK:JFK-LHR:LHR-CDG. For airport codes, see the IATA Airline and Airport Code Search. Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the value of _complete_route takes precedence over that of the _leg# fields. | [optional] +**departureTime** | **String** | Departure date and time of the first leg of the trip. Use one of the following formats: - yyyy-MM-dd HH:mm z - yyyy-MM-dd hh:mm a z - yyyy-MM-dd hh:mma z HH = hour in 24-hour format hh = hour in 12-hour format a = am or pm (case insensitive) z = time zone of the departing flight, for example: If the airline is based in city A, but the flight departs from city B, z is the time zone of city B at the time of departure. Important For travel information, use GMT instead of UTC, or use the local time zone. Examples 2011-03-20 11:30 PM PDT 2011-03-20 11:30pm GMT 2011-03-20 11:30pm GMT-05:00 Eastern Standard Time: GMT-05:00 or EST Note When specifying an offset from GMT, the format must be exactly as specified in the example. Insert no spaces between the time zone and the offset. | [optional] +**journeyType** | **String** | Type of travel, for example one way or round trip. | [optional] +**legs** | [**List<Riskv1decisionsTravelInformationLegs>**](Riskv1decisionsTravelInformationLegs.md) | | [optional] + + + diff --git a/docs/Riskv1decisionsTravelInformationLegs.md b/docs/Riskv1decisionsTravelInformationLegs.md new file mode 100644 index 000000000..842860513 --- /dev/null +++ b/docs/Riskv1decisionsTravelInformationLegs.md @@ -0,0 +1,11 @@ + +# Riskv1decisionsTravelInformationLegs + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**origination** | **String** | Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a positive integer from 0 to N. For example: decision_manager_travel_leg0_orig=SFO decision_manager_travel_leg1_orig=SFO Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the complete route takes precedence over the individual legs. | [optional] +**destination** | **String** | Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a positive integer from 0 to N. For example: decision_manager_travel_leg0_dest=SFO decision_manager_travel_leg1_dest=SFO Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the complete route takes precedence over the individual legs. | [optional] + + + diff --git a/docs/SearchTransactionsApi.md b/docs/SearchTransactionsApi.md index 4ac791c26..c420049bc 100644 --- a/docs/SearchTransactionsApi.md +++ b/docs/SearchTransactionsApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**createSearch**](SearchTransactionsApi.md#createSearch) | **POST** /tss/v2/searches | Create a search request -[**getSearch**](SearchTransactionsApi.md#getSearch) | **GET** /tss/v2/searches/{id} | Get Search results +[**getSearch**](SearchTransactionsApi.md#getSearch) | **GET** /tss/v2/searches/{searchId} | Get Search results @@ -24,7 +24,7 @@ Create a search request. SearchTransactionsApi apiInstance = new SearchTransactionsApi(); -TssV2TransactionsPostResponse createSearchRequest = new TssV2TransactionsPostResponse(); // TssV2TransactionsPostResponse | +CreateSearchRequest createSearchRequest = new CreateSearchRequest(); // CreateSearchRequest | try { TssV2TransactionsPost201Response result = apiInstance.createSearch(createSearchRequest); System.out.println(result); @@ -38,7 +38,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **createSearchRequest** | [**TssV2TransactionsPostResponse**](TssV2TransactionsPostResponse.md)| | + **createSearchRequest** | [**CreateSearchRequest**](CreateSearchRequest.md)| | ### Return type @@ -55,11 +55,11 @@ No authorization required # **getSearch** -> TssV2TransactionsPost201Response getSearch(id) +> TssV2TransactionsPost201Response getSearch(searchId) Get Search results -Include the Search ID in the GET request to retrieve the search results. +Include the Search ID in the GET request to retrieve the search results. ### Example ```java @@ -69,9 +69,9 @@ Include the Search ID in the GET request to retrieve the search results. SearchTransactionsApi apiInstance = new SearchTransactionsApi(); -String id = "id_example"; // String | Search ID. +String searchId = "searchId_example"; // String | Search ID. try { - TssV2TransactionsPost201Response result = apiInstance.getSearch(id); + TssV2TransactionsPost201Response result = apiInstance.getSearch(searchId); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling SearchTransactionsApi#getSearch"); @@ -83,7 +83,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **id** | **String**| Search ID. | + **searchId** | **String**| Search ID. | ### Return type diff --git a/docs/SecureFileShareApi.md b/docs/SecureFileShareApi.md index f71bfcd33..ae987eb01 100644 --- a/docs/SecureFileShareApi.md +++ b/docs/SecureFileShareApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**getFile**](SecureFileShareApi.md#getFile) | **GET** /sfs/v1/files/{fileId} | Download a file with file identifier -[**getFileDetails**](SecureFileShareApi.md#getFileDetails) | **GET** /sfs/v1/file-details | Get list of files +[**getFileDetail**](SecureFileShareApi.md#getFileDetail) | **GET** /sfs/v1/file-details | Get list of files @@ -54,9 +54,9 @@ No authorization required - **Content-Type**: application/json;charset=utf-8 - **Accept**: application/xml, text/csv, application/pdf - -# **getFileDetails** -> V1FileDetailsGet200Response getFileDetails(startDate, endDate, organizationId) + +# **getFileDetail** +> V1FileDetailsGet200Response getFileDetail(startDate, endDate, organizationId) Get list of files @@ -74,10 +74,10 @@ LocalDate startDate = new LocalDate(); // LocalDate | Valid start date in **ISO LocalDate endDate = new LocalDate(); // LocalDate | Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd String organizationId = "organizationId_example"; // String | Valid Cybersource Organization Id try { - V1FileDetailsGet200Response result = apiInstance.getFileDetails(startDate, endDate, organizationId); + V1FileDetailsGet200Response result = apiInstance.getFileDetail(startDate, endDate, organizationId); System.out.println(result); } catch (ApiException e) { - System.err.println("Exception when calling SecureFileShareApi#getFileDetails"); + System.err.println("Exception when calling SecureFileShareApi#getFileDetail"); e.printStackTrace(); } ``` diff --git a/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded.md new file mode 100644 index 000000000..758d65544 --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded.md @@ -0,0 +1,10 @@ + +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**paymentInstruments** | [**List<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments>**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.md) | Array of Payment Instruments returned for the supplied Instrument Identifier. | [optional] + + + diff --git a/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.md new file mode 100644 index 000000000..3df181b5f --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.md @@ -0,0 +1,20 @@ + +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**TypeEnum**](#TypeEnum) | Checking account type. Possible values: * C: checking * S: savings (USD only) * X: corporate checking (USD only) * G: general ledger | [optional] + + + +## Enum: TypeEnum +Name | Value +---- | ----- +CHECKING | "checking" +SAVINGS | "savings" +CORPORATE_CHECKING | "corporate checking" +GENERAL_LEDGER | "general ledger" + + + diff --git a/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.md new file mode 100644 index 000000000..4640de5be --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.md @@ -0,0 +1,20 @@ + +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**firstName** | **String** | Customer’s first name. For a credit card transaction, this name must match the name on the card. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**lastName** | **String** | Customer’s last name. For a credit card transaction, this name must match the name on the card. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**company** | **String** | Name of the customer’s company. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**address1** | **String** | First line of the billing street address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**address2** | **String** | Additional address information. | [optional] +**locality** | **String** | City of the billing address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**administrativeArea** | **String** | State or province of the billing address. For an address in the U.S. or Canada, use the State, Province, and Territory Codes for the United States and Canada. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example A1B 2C3 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**country** | **String** | Country of the billing address. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**email** | **String** | Customer’s email address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**phoneNumber** | **String** | Customer phone number. When you create a customer profile, the requirements depend on the payment method: * Credit cards — optional. * Electronic checks — contact your payment processor representative to find out if this field is required or optional. * PINless debits — optional. | [optional] + + + diff --git a/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.md new file mode 100644 index 000000000..409f8a596 --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.md @@ -0,0 +1,13 @@ + +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**companyTaxID** | **String** | Tax identifier for the customer’s company. **Important**: Contact your TeleCheck representative to find out whether this field is required or optional. | [optional] +**currency** | **String** | Currency used by the customer. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha. | [optional] +**dateOBirth** | **String** | Date of birth of the customer. Format: `YYYY-MM-DD` or `YYYYMMDD` | [optional] +**personalIdentification** | [**List<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification>**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.md) | | [optional] + + + diff --git a/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy.md new file mode 100644 index 000000000..1e43beaf5 --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy.md @@ -0,0 +1,10 @@ + +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**administrativeArea** | **String** | State or province in which the customer’s driver’s license was issued. Use the State, Province, and Territory Codes for the United States and Canada. **Important**: Contact your TeleCheck representative to learn whether this field is required or optional. | [optional] + + + diff --git a/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.md new file mode 100644 index 000000000..81446ab86 --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.md @@ -0,0 +1,19 @@ + +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Customer's identification number. **Important**: Contact your TeleCheck representative to learn whether this field is required or optional. | [optional] +**type** | [**TypeEnum**](#TypeEnum) | Type of personal identification. **Important**: Contact your TeleCheck representative to learn whether this field is required or optional. | [optional] +**issuedBy** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy.md) | | [optional] + + + +## Enum: TypeEnum +Name | Value +---- | ----- +LICENSE | "driver license" + + + diff --git a/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.md new file mode 100644 index 000000000..0f67e21bc --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.md @@ -0,0 +1,79 @@ + +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**expirationMonth** | **String** | Two-digit month in which the credit card expires. Format: `MM` Possible values: `01` through `12` This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. For more information about relaxed requirements, see the TMS REST API Developer Guide. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting. | [optional] +**expirationYear** | **String** | Four-digit year in which the credit card expires. Format: `YYYY`. Possible values: `1900` through `2099`. **FDC Nashville Global and FDMS South** You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See Relaxed Requirements for Address Data and Expiration Date page. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.' | [optional] +**type** | [**TypeEnum**](#TypeEnum) | Type of credit card. Possible values: * Visa (001) * Mastercard (002) - Eurocard—European regional brand of Mastercard * American Express (003) * Discover (004) * Diners Club (005) * Carte Blanche (006) * JCB (007) * Optima (008) * Twinpay Credit (011) * Twinpay Debit (012) * Walmart (013) * EnRoute (014) * Lowes consumer (015) * Home Depot consumer (016) * MBNA (017) * Dicks Sportswear (018) * Casual Corner (019) * Sears (020) * JAL (021) * Disney (023) * Maestro (024) - UK Domestic * Sams Club consumer (025) * Sams Club business (026) * Nicos (027) * Bill me later (028) * Bebe (029) * Restoration Hardware (030) * Delta (031) — use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types. * Solo (032) * Visa Electron (033) * Dankort (034) * Laser (035) * Carte Bleue (036) — formerly Cartes Bancaires * Cartes Bancaires (036) * Carta Si (037) * pinless debit (038) * encoded account (039) * UATP (040) * Household (041) * Maestro (042) - International * GE Money UK (043) * Korean cards (044) * Style (045) * JCrew (046) * PayEase China processing eWallet (047) * PayEase China processing bank transfer (048) * Meijer Private Label (049) * Hipercard (050) — supported only by the Comercio Latino processor. * Aura (051) — supported only by the Comercio Latino processor. * Redecard (052) * ORICO (053) * Elo (054) — supported only by the Comercio Latino processor. * Capital One Private Label (055) * Synchrony Private Label (056) * Costco Private Label (057) * mada (060) * China Union Pay (062) * Falabella private label (063) | +**issueNumber** | **String** | Number of times a Maestro (UK Domestic) card has been issued to the account holder. | [optional] +**startMonth** | **String** | Month of the start of the Maestro (UK Domestic) card validity period. Format: `MM`. Possible values: `01` through `12`. | [optional] +**startYear** | **String** | Year of the start of the Maestro (UK Domestic) card validity period. Format: `YYYY`. Possible values: `1900` through `2099`. | [optional] +**useAs** | **String** | Card Use As Field. Supported value of `pinless debit` only. Only for use with Pinless Debit tokens. | [optional] + + + +## Enum: TypeEnum +Name | Value +---- | ----- +VISA | "visa" +MASTERCARD | "mastercard" +AMERICAN_EXPRESS | "american express" +DISCOVER | "discover" +DINERS_CLUB | "diners club" +CARTE_BLANCHE | "carte blanche" +JCB | "jcb" +OPTIMA | "optima" +TWINPAY_CREDIT | "twinpay credit" +TWINPAY_DEBIT | "twinpay debit" +WALMART | "walmart" +ENROUTE | "enroute" +LOWES_CONSUMER | "lowes consumer" +HOME_DEPOT_CONSUMER | "home depot consumer" +MBNA | "mbna" +DICKS_SPORTSWEAR | "dicks sportswear" +CASUAL_CORNER | "casual corner" +SEARS | "sears" +JAL | "jal" +DISNEY | "disney" +MAESTRO_UK_DOMESTIC | "maestro uk domestic" +SAMS_CLUB_CONSUMER | "sams club consumer" +SAMS_CLUB_BUSINESS | "sams club business" +NICOS | "nicos" +BILL_ME_LATER | "bill me later" +BEBE | "bebe" +RESTORATION_HARDWARE | "restoration hardware" +DELTA_ONLINE | "delta online" +SOLO | "solo" +VISA_ELECTRON | "visa electron" +DANKORT | "dankort" +LASER | "laser" +CARTE_BLEUE | "carte bleue" +CARTA_SI | "carta si" +PINLESS_DEBIT | "pinless debit" +ENCODED_ACCOUNT | "encoded account" +UATP | "uatp" +HOUSEHOLD | "household" +MAESTRO_INTERNATIONAL | "maestro international" +GE_MONEY_UK | "ge money uk" +KOREAN_CARDS | "korean cards" +STYLE | "style" +JCREW | "jcrew" +PAYEASE_CHINA_PROCESSING_EWALLET | "payease china processing ewallet" +PAYEASE_CHINA_PROCESSING_BANK_TRANSFER | "payease china processing bank transfer" +MEIJER_PRIVATE_LABEL | "meijer private label" +HIPERCARD | "hipercard" +AURA | "aura" +REDECARD | "redecard" +ORICO | "orico" +ELO | "elo" +CAPITAL_ONE_PRIVATE_LABEL | "capital one private label" +SYNCHRONY_PRIVATE_LABEL | "synchrony private label" +CHINA_UNION_PAY | "china union pay" +COSTCO_PRIVATE_LABEL | "costco private label" +MADA | "mada" +FALABELLA_PRIVATE_LABEL | "falabella private label" + + + diff --git a/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.md new file mode 100644 index 000000000..717b11502 --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.md @@ -0,0 +1,32 @@ + +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**TmsV1InstrumentIdentifiersPost200ResponseLinks**](TmsV1InstrumentIdentifiersPost200ResponseLinks.md) | | [optional] +**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. | [optional] +**state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] +**id** | **String** | The ID of the existing instrument identifier to be linked to the newly created payment instrument. | [optional] +**card** | [**TmsV1InstrumentIdentifiersPost200ResponseCard**](TmsV1InstrumentIdentifiersPost200ResponseCard.md) | | [optional] +**bankAccount** | [**TmsV1InstrumentIdentifiersPost200ResponseBankAccount**](TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md) | | [optional] +**processingInformation** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md) | | [optional] +**metadata** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional] + + + +## Enum: ObjectEnum +Name | Value +---- | ----- +INSTRUMENTIDENTIFIER | "instrumentIdentifier" + + + +## Enum: StateEnum +Name | Value +---- | ----- +ACTIVE | "ACTIVE" +CLOSED | "CLOSED" + + + diff --git a/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.md new file mode 100644 index 000000000..13d5d7155 --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.md @@ -0,0 +1,10 @@ + +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchantDescriptor** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor.md) | | [optional] + + + diff --git a/docs/PaymentinstrumentsMerchantInformationMerchantDescriptor.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor.md similarity index 73% rename from docs/PaymentinstrumentsMerchantInformationMerchantDescriptor.md rename to docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor.md index d89f3f6fa..0d558d7c6 100644 --- a/docs/PaymentinstrumentsMerchantInformationMerchantDescriptor.md +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor.md @@ -1,5 +1,5 @@ -# PaymentinstrumentsMerchantInformationMerchantDescriptor +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor ## Properties Name | Type | Description | Notes diff --git a/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.md new file mode 100644 index 000000000..e1f320182 --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.md @@ -0,0 +1,36 @@ + +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**TmsV1InstrumentIdentifiersPost200ResponseLinks**](TmsV1InstrumentIdentifiersPost200ResponseLinks.md) | | [optional] +**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional] +**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. | [optional] +**state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] +**bankAccount** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.md) | | [optional] +**card** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.md) | | [optional] +**buyerInformation** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.md) | | [optional] +**billTo** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.md) | | [optional] +**processingInformation** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.md) | | [optional] +**merchantInformation** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.md) | | [optional] +**metaData** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional] +**instrumentIdentifier** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.md) | | [optional] + + + +## Enum: ObjectEnum +Name | Value +---- | ----- +PAYMENTINSTRUMENT | "paymentInstrument" + + + +## Enum: StateEnum +Name | Value +---- | ----- +ACTIVE | "ACTIVE" +CLOSED | "CLOSED" + + + diff --git a/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.md new file mode 100644 index 000000000..ba360fc12 --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.md @@ -0,0 +1,11 @@ + +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**billPaymentProgramEnabled** | **Boolean** | Indicates that the payments for this customer profile are for the Bill Payment program. Possible values: * false: Not a Visa Bill Payment. * true: Visa Bill Payment. | [optional] +**bankTransferOptions** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions.md) | | [optional] + + + diff --git a/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions.md new file mode 100644 index 000000000..f84440ef1 --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions.md @@ -0,0 +1,20 @@ + +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**seCCode** | [**SeCCodeEnum**](#SeCCodeEnum) | **Important** This field is required if your processor is TeleCheck. Code that specifies the authorization method for the transaction. Possible values: - **CCD**: corporate cash disbursement. Charge or credit against a business checking account. You can use one-time or recurring CCD transactions to transfer funds to or from a corporate entity. A standing authorization is required for recurring transactions. - **PPD**: prearranged payment and deposit entry. Charge or credit against a personal checking or savings account. You can originate a PPD entry only when the payment and deposit terms between you and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions. - **TEL**: telephone-initiated entry. One-time charge against a personal checking or savings account. You can originate a TEL entry only when there is a business relationship between you and the customer or when the customer initiates a telephone call to you. For a TEL entry, you must obtain a payment authorization from the customer over the telephone. There is no recurring billing option for TEL. - **WEB**: internet-initiated entry—charge against a personal checking or savings account. You can originate a one-time or recurring WEB entry when the customer initiates the transaction over the Internet. For a WEB entry, you must obtain payment authorization from the customer over the Internet. | [optional] + + + +## Enum: SeCCodeEnum +Name | Value +---- | ----- +CCD | "CCD" +PPD | "PPD" +TEL | "TEL" +WEB | "WEB" + + + diff --git a/docs/InstrumentidentifiersBankAccount.md b/docs/TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md similarity index 59% rename from docs/InstrumentidentifiersBankAccount.md rename to docs/TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md index ac814de00..c95a6de92 100644 --- a/docs/InstrumentidentifiersBankAccount.md +++ b/docs/TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md @@ -1,10 +1,10 @@ -# InstrumentidentifiersBankAccount +# TmsV1InstrumentIdentifiersPost200ResponseBankAccount ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**number** | **String** | Bank account number. | [optional] +**number** | **String** | Checking account number. | [optional] **routingNumber** | **String** | Routing number. | [optional] diff --git a/docs/TmsV1InstrumentIdentifiersPost200ResponseCard.md b/docs/TmsV1InstrumentIdentifiersPost200ResponseCard.md new file mode 100644 index 000000000..b95ccc391 --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPost200ResponseCard.md @@ -0,0 +1,10 @@ + +# TmsV1InstrumentIdentifiersPost200ResponseCard + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**number** | **String** | Customer’s credit card number. | [optional] + + + diff --git a/docs/TmsV1InstrumentIdentifiersPost200ResponseLinks.md b/docs/TmsV1InstrumentIdentifiersPost200ResponseLinks.md new file mode 100644 index 000000000..aedcad8b3 --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPost200ResponseLinks.md @@ -0,0 +1,12 @@ + +# TmsV1InstrumentIdentifiersPost200ResponseLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**self** | [**TmsV1InstrumentIdentifiersPost200ResponseLinksSelf**](TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.md) | | [optional] +**ancestor** | [**TmsV1InstrumentIdentifiersPost200ResponseLinksSelf**](TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.md) | | [optional] +**successor** | [**TmsV1InstrumentIdentifiersPost200ResponseLinksSelf**](TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.md) | | [optional] + + + diff --git a/docs/Tmsv1instrumentidentifiersLinksSelf.md b/docs/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.md similarity index 74% rename from docs/Tmsv1instrumentidentifiersLinksSelf.md rename to docs/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.md index 11486d5f9..f28855538 100644 --- a/docs/Tmsv1instrumentidentifiersLinksSelf.md +++ b/docs/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.md @@ -1,5 +1,5 @@ -# Tmsv1instrumentidentifiersLinksSelf +# TmsV1InstrumentIdentifiersPost200ResponseLinksSelf ## Properties Name | Type | Description | Notes diff --git a/docs/InstrumentidentifiersMetadata.md b/docs/TmsV1InstrumentIdentifiersPost200ResponseMetadata.md similarity index 77% rename from docs/InstrumentidentifiersMetadata.md rename to docs/TmsV1InstrumentIdentifiersPost200ResponseMetadata.md index bbd87b7ab..c9f9d1a59 100644 --- a/docs/InstrumentidentifiersMetadata.md +++ b/docs/TmsV1InstrumentIdentifiersPost200ResponseMetadata.md @@ -1,5 +1,5 @@ -# InstrumentidentifiersMetadata +# TmsV1InstrumentIdentifiersPost200ResponseMetadata ## Properties Name | Type | Description | Notes diff --git a/docs/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md b/docs/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md new file mode 100644 index 000000000..8763c574d --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md @@ -0,0 +1,10 @@ + +# TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**authorizationOptions** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions.md) | | [optional] + + + diff --git a/docs/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions.md b/docs/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions.md new file mode 100644 index 000000000..5d2337b8b --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions.md @@ -0,0 +1,10 @@ + +# TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**initiator** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.md) | | [optional] + + + diff --git a/docs/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.md b/docs/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.md new file mode 100644 index 000000000..b0361888c --- /dev/null +++ b/docs/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.md @@ -0,0 +1,10 @@ + +# TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**merchantInitiatedTransaction** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md) | | [optional] + + + diff --git a/docs/InstrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md b/docs/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md similarity index 63% rename from docs/InstrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md rename to docs/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md index d59326be0..32d8290ad 100644 --- a/docs/InstrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md +++ b/docs/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md @@ -1,5 +1,5 @@ -# InstrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction +# TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction ## Properties Name | Type | Description | Notes diff --git a/docs/TmsV1InstrumentidentifiersDelete409Response.md b/docs/TmsV1InstrumentidentifiersDelete409Response.md index 1e1a127f1..0d6619112 100644 --- a/docs/TmsV1InstrumentidentifiersDelete409Response.md +++ b/docs/TmsV1InstrumentidentifiersDelete409Response.md @@ -1,10 +1,10 @@ -# TmsV1InstrumentidentifiersDelete409Response +# TmsV1InstrumentIdentifiersDelete409Response ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**TmsV1InstrumentidentifiersDelete409ResponseLinks**](TmsV1InstrumentidentifiersDelete409ResponseLinks.md) | | [optional] +**links** | [**TmsV1InstrumentIdentifiersDelete409ResponseLinks**](TmsV1InstrumentIdentifiersDelete409ResponseLinks.md) | | [optional] diff --git a/docs/TmsV1InstrumentidentifiersDelete409ResponseLinks.md b/docs/TmsV1InstrumentidentifiersDelete409ResponseLinks.md index a2b0ef974..291741205 100644 --- a/docs/TmsV1InstrumentidentifiersDelete409ResponseLinks.md +++ b/docs/TmsV1InstrumentidentifiersDelete409ResponseLinks.md @@ -1,10 +1,10 @@ -# TmsV1InstrumentidentifiersDelete409ResponseLinks +# TmsV1InstrumentIdentifiersDelete409ResponseLinks ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**paymentInstruments** | [**TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments**](TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments.md) | | [optional] +**paymentInstruments** | [**TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments**](TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments.md) | | [optional] diff --git a/docs/TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments.md b/docs/TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments.md index ba4acac9e..a65de9b56 100644 --- a/docs/TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments.md +++ b/docs/TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments.md @@ -1,5 +1,5 @@ -# TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments +# TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments ## Properties Name | Type | Description | Notes diff --git a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.md b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.md index 604e7c2e0..1133ff359 100644 --- a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.md +++ b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.md @@ -1,16 +1,16 @@ -# TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks**](TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks.md) | | [optional] +**links** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.md) | | [optional] **object** | [**ObjectEnum**](#ObjectEnum) | Shows the response is a collection of objects. | [optional] **offset** | **String** | The offset parameter supplied in the request. | [optional] **limit** | **String** | The limit parameter supplied in the request. | [optional] **count** | **String** | The number of Payment Instruments returned in the array. | [optional] **total** | **String** | The total number of Payment Instruments associated with the Instrument Identifier in the zero-based dataset. | [optional] -**embedded** | **Object** | Array of Payment Instruments returned for the supplied Instrument Identifier. | [optional] +**embedded** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded.md) | | [optional] diff --git a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks.md b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks.md index 923f080e2..d61e5e60d 100644 --- a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks.md +++ b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks.md @@ -1,14 +1,14 @@ -# TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**self** | [**TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf**](TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf.md) | | [optional] -**first** | [**TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst**](TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst.md) | | [optional] -**prev** | [**TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev**](TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev.md) | | [optional] -**next** | [**TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext**](TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext.md) | | [optional] -**last** | [**TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast**](TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast.md) | | [optional] +**self** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf.md) | | [optional] +**first** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst.md) | | [optional] +**prev** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev.md) | | [optional] +**next** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext.md) | | [optional] +**last** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast.md) | | [optional] diff --git a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst.md b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst.md index 9f8591dfa..0f7016066 100644 --- a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst.md +++ b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst.md @@ -1,5 +1,5 @@ -# TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst ## Properties Name | Type | Description | Notes diff --git a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast.md b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast.md index dc01b493a..68e4a8add 100644 --- a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast.md +++ b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast.md @@ -1,5 +1,5 @@ -# TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast ## Properties Name | Type | Description | Notes diff --git a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext.md b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext.md index 5d40644b5..a7f0c0ada 100644 --- a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext.md +++ b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext.md @@ -1,5 +1,5 @@ -# TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext ## Properties Name | Type | Description | Notes diff --git a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev.md b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev.md index 6df9cc0b0..18b6c83c0 100644 --- a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev.md +++ b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev.md @@ -1,5 +1,5 @@ -# TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev ## Properties Name | Type | Description | Notes diff --git a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf.md b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf.md index 178662d21..5b9202bab 100644 --- a/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf.md +++ b/docs/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf.md @@ -1,5 +1,5 @@ -# TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf +# TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf ## Properties Name | Type | Description | Notes diff --git a/docs/TmsV1InstrumentidentifiersPost200Response.md b/docs/TmsV1InstrumentidentifiersPost200Response.md index ebcc8d52f..b161d78a2 100644 --- a/docs/TmsV1InstrumentidentifiersPost200Response.md +++ b/docs/TmsV1InstrumentidentifiersPost200Response.md @@ -1,17 +1,17 @@ -# TmsV1InstrumentidentifiersPost200Response +# TmsV1InstrumentIdentifiersPost200Response ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**Tmsv1instrumentidentifiersLinks**](Tmsv1instrumentidentifiersLinks.md) | | [optional] +**links** | [**TmsV1InstrumentIdentifiersPost200ResponseLinks**](TmsV1InstrumentIdentifiersPost200ResponseLinks.md) | | [optional] **id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional] -**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. | [optional] +**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. | [optional] **state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] -**card** | [**Tmsv1instrumentidentifiersCard**](Tmsv1instrumentidentifiersCard.md) | | [optional] -**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional] -**processingInformation** | [**Tmsv1instrumentidentifiersProcessingInformation**](Tmsv1instrumentidentifiersProcessingInformation.md) | | [optional] -**metadata** | [**Tmsv1instrumentidentifiersMetadata**](Tmsv1instrumentidentifiersMetadata.md) | | [optional] +**card** | [**TmsV1InstrumentIdentifiersPost200ResponseCard**](TmsV1InstrumentIdentifiersPost200ResponseCard.md) | | [optional] +**bankAccount** | [**TmsV1InstrumentIdentifiersPost200ResponseBankAccount**](TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md) | | [optional] +**processingInformation** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md) | | [optional] +**metadata** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional] diff --git a/docs/TmsV1PaymentinstrumentsGet200Response.md b/docs/TmsV1PaymentinstrumentsGet200Response.md deleted file mode 100644 index 579fdd879..000000000 --- a/docs/TmsV1PaymentinstrumentsGet200Response.md +++ /dev/null @@ -1,36 +0,0 @@ - -# TmsV1PaymentinstrumentsGet200Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**Tmsv1instrumentidentifiersLinks**](Tmsv1instrumentidentifiersLinks.md) | | [optional] -**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional] -**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. | [optional] -**state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] -**bankAccount** | [**Tmsv1paymentinstrumentsBankAccount**](Tmsv1paymentinstrumentsBankAccount.md) | | [optional] -**card** | [**Tmsv1paymentinstrumentsCard**](Tmsv1paymentinstrumentsCard.md) | | [optional] -**buyerInformation** | [**Tmsv1paymentinstrumentsBuyerInformation**](Tmsv1paymentinstrumentsBuyerInformation.md) | | [optional] -**billTo** | [**Tmsv1paymentinstrumentsBillTo**](Tmsv1paymentinstrumentsBillTo.md) | | [optional] -**processingInformation** | [**Tmsv1paymentinstrumentsProcessingInformation**](Tmsv1paymentinstrumentsProcessingInformation.md) | | [optional] -**merchantInformation** | [**Tmsv1paymentinstrumentsMerchantInformation**](Tmsv1paymentinstrumentsMerchantInformation.md) | | [optional] -**metaData** | [**Tmsv1instrumentidentifiersMetadata**](Tmsv1instrumentidentifiersMetadata.md) | | [optional] -**instrumentIdentifier** | [**Tmsv1paymentinstrumentsInstrumentIdentifier**](Tmsv1paymentinstrumentsInstrumentIdentifier.md) | | [optional] - - - -## Enum: ObjectEnum -Name | Value ----- | ----- -PAYMENTINSTRUMENT | "paymentInstrument" - - - -## Enum: StateEnum -Name | Value ----- | ----- -ACTIVE | "ACTIVE" -CLOSED | "CLOSED" - - - diff --git a/docs/TmsV1PaymentinstrumentsPost201Response.md b/docs/TmsV1PaymentinstrumentsPost201Response.md deleted file mode 100644 index d0a2571ff..000000000 --- a/docs/TmsV1PaymentinstrumentsPost201Response.md +++ /dev/null @@ -1,36 +0,0 @@ - -# TmsV1PaymentinstrumentsPost201Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**Tmsv1instrumentidentifiersLinks**](Tmsv1instrumentidentifiersLinks.md) | | [optional] -**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional] -**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. | [optional] -**state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] -**bankAccount** | [**Tmsv1paymentinstrumentsBankAccount**](Tmsv1paymentinstrumentsBankAccount.md) | | [optional] -**card** | [**TmsV1PaymentinstrumentsPost201ResponseCard**](TmsV1PaymentinstrumentsPost201ResponseCard.md) | | [optional] -**buyerInformation** | [**Tmsv1paymentinstrumentsBuyerInformation**](Tmsv1paymentinstrumentsBuyerInformation.md) | | [optional] -**billTo** | [**Tmsv1paymentinstrumentsBillTo**](Tmsv1paymentinstrumentsBillTo.md) | | [optional] -**processingInformation** | [**Tmsv1paymentinstrumentsProcessingInformation**](Tmsv1paymentinstrumentsProcessingInformation.md) | | [optional] -**merchantInformation** | [**Tmsv1paymentinstrumentsMerchantInformation**](Tmsv1paymentinstrumentsMerchantInformation.md) | | [optional] -**metaData** | [**Tmsv1instrumentidentifiersMetadata**](Tmsv1instrumentidentifiersMetadata.md) | | [optional] -**instrumentIdentifier** | [**Tmsv1paymentinstrumentsInstrumentIdentifier**](Tmsv1paymentinstrumentsInstrumentIdentifier.md) | | [optional] - - - -## Enum: ObjectEnum -Name | Value ----- | ----- -PAYMENTINSTRUMENT | "paymentInstrument" - - - -## Enum: StateEnum -Name | Value ----- | ----- -ACTIVE | "ACTIVE" -CLOSED | "CLOSED" - - - diff --git a/docs/TmsV1PaymentinstrumentsPost201ResponseCard.md b/docs/TmsV1PaymentinstrumentsPost201ResponseCard.md deleted file mode 100644 index 4970e7713..000000000 --- a/docs/TmsV1PaymentinstrumentsPost201ResponseCard.md +++ /dev/null @@ -1,76 +0,0 @@ - -# TmsV1PaymentinstrumentsPost201ResponseCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**expirationMonth** | **String** | Credit card expiration month. | [optional] -**expirationYear** | **String** | Credit card expiration year. | [optional] -**type** | [**TypeEnum**](#TypeEnum) | Credit card brand. | [optional] -**issueNumber** | **String** | Credit card issue number. | [optional] -**startMonth** | **String** | Credit card start month. | [optional] -**startYear** | **String** | Credit card start year. | [optional] -**useAs** | **String** | Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens. | [optional] - - - -## Enum: TypeEnum -Name | Value ----- | ----- -VISA | "visa" -MASTERCARD | "mastercard" -AMERICAN_EXPRESS | "american express" -DISCOVER | "discover" -DINERS_CLUB | "diners club" -CARTE_BLANCHE | "carte blanche" -JCB | "jcb" -OPTIMA | "optima" -TWINPAY_CREDIT | "twinpay credit" -TWINPAY_DEBIT | "twinpay debit" -WALMART | "walmart" -ENROUTE | "enroute" -LOWES_CONSUMER | "lowes consumer" -HOME_DEPOT_CONSUMER | "home depot consumer" -MBNA | "mbna" -DICKS_SPORTSWEAR | "dicks sportswear" -CASUAL_CORNER | "casual corner" -SEARS | "sears" -JAL | "jal" -DISNEY | "disney" -MAESTRO_UK_DOMESTIC | "maestro uk domestic" -SAMS_CLUB_CONSUMER | "sams club consumer" -SAMS_CLUB_BUSINESS | "sams club business" -NICOS | "nicos" -BILL_ME_LATER | "bill me later" -BEBE | "bebe" -RESTORATION_HARDWARE | "restoration hardware" -DELTA_ONLINE | "delta online" -SOLO | "solo" -VISA_ELECTRON | "visa electron" -DANKORT | "dankort" -LASER | "laser" -CARTE_BLEUE | "carte bleue" -CARTA_SI | "carta si" -PINLESS_DEBIT | "pinless debit" -ENCODED_ACCOUNT | "encoded account" -UATP | "uatp" -HOUSEHOLD | "household" -MAESTRO_INTERNATIONAL | "maestro international" -GE_MONEY_UK | "ge money uk" -KOREAN_CARDS | "korean cards" -STYLE | "style" -JCREW | "jcrew" -PAYEASE_CHINA_PROCESSING_EWALLET | "payease china processing ewallet" -PAYEASE_CHINA_PROCESSING_BANK_TRANSFER | "payease china processing bank transfer" -MEIJER_PRIVATE_LABEL | "meijer private label" -HIPERCARD | "hipercard" -AURA | "aura" -REDECARD | "redecard" -ORICO | "orico" -ELO | "elo" -CAPITAL_ONE_PRIVATE_LABEL | "capital one private label" -SYNCHRONY_PRIVATE_LABEL | "synchrony private label" -CHINA_UNION_PAY | "china union pay" - - - diff --git a/docs/Tmsv1instrumentidentifiersBankAccount.md b/docs/Tmsv1instrumentidentifiersBankAccount.md deleted file mode 100644 index 15f405ada..000000000 --- a/docs/Tmsv1instrumentidentifiersBankAccount.md +++ /dev/null @@ -1,11 +0,0 @@ - -# Tmsv1instrumentidentifiersBankAccount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**number** | **String** | Bank account number. | [optional] -**routingNumber** | **String** | Routing number. | [optional] - - - diff --git a/docs/Tmsv1instrumentidentifiersBillTo.md b/docs/Tmsv1instrumentidentifiersBillTo.md new file mode 100644 index 000000000..82cff8458 --- /dev/null +++ b/docs/Tmsv1instrumentidentifiersBillTo.md @@ -0,0 +1,15 @@ + +# Tmsv1instrumentidentifiersBillTo + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**address1** | **String** | First address line registered with card. | [optional] +**address2** | **String** | Second address line registered with card. | [optional] +**locality** | **String** | Locality registered with card. | [optional] +**administrativeArea** | **String** | Administrative area registered with card. | [optional] +**postalCode** | **String** | Postal code registered with card. | [optional] +**country** | **String** | Country registered with card. | [optional] + + + diff --git a/docs/Tmsv1instrumentidentifiersCard.md b/docs/Tmsv1instrumentidentifiersCard.md index b726b3f8c..2cd2370ab 100644 --- a/docs/Tmsv1instrumentidentifiersCard.md +++ b/docs/Tmsv1instrumentidentifiersCard.md @@ -5,6 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **number** | **String** | Credit card number (PAN). | [optional] +**expirationMonth** | **String** | Card expiration month. Format: `MM`. Possible values: `01` through `12`. | [optional] +**expirationYear** | **String** | Card expiration year. Format: `YYYY`. Possible values: `1900` through `2099`. | [optional] +**securityCode** | **String** | Card security code. | [optional] diff --git a/docs/Tmsv1instrumentidentifiersLinks.md b/docs/Tmsv1instrumentidentifiersLinks.md deleted file mode 100644 index 23659d395..000000000 --- a/docs/Tmsv1instrumentidentifiersLinks.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Tmsv1instrumentidentifiersLinks - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**self** | [**Tmsv1instrumentidentifiersLinksSelf**](Tmsv1instrumentidentifiersLinksSelf.md) | | [optional] -**ancestor** | [**Tmsv1instrumentidentifiersLinksSelf**](Tmsv1instrumentidentifiersLinksSelf.md) | | [optional] -**successor** | [**Tmsv1instrumentidentifiersLinksSelf**](Tmsv1instrumentidentifiersLinksSelf.md) | | [optional] - - - diff --git a/docs/Tmsv1instrumentidentifiersMetadata.md b/docs/Tmsv1instrumentidentifiersMetadata.md deleted file mode 100644 index 27c5ccb0f..000000000 --- a/docs/Tmsv1instrumentidentifiersMetadata.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Tmsv1instrumentidentifiersMetadata - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**creator** | **String** | The creator of the token. | [optional] - - - diff --git a/docs/Tmsv1instrumentidentifiersProcessingInformation.md b/docs/Tmsv1instrumentidentifiersProcessingInformation.md deleted file mode 100644 index 10cb97dba..000000000 --- a/docs/Tmsv1instrumentidentifiersProcessingInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Tmsv1instrumentidentifiersProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**authorizationOptions** | [**Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions**](Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions.md) | | [optional] - - - diff --git a/docs/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions.md b/docs/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions.md deleted file mode 100644 index 2a9a93601..000000000 --- a/docs/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**initiator** | [**Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator**](Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator.md) | | [optional] - - - diff --git a/docs/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator.md b/docs/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator.md deleted file mode 100644 index 808b3c879..000000000 --- a/docs/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchantInitiatedTransaction** | [**Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction**](Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md) | | [optional] - - - diff --git a/docs/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md b/docs/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md deleted file mode 100644 index 18511a83d..000000000 --- a/docs/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**previousTransactionId** | **String** | Previous Consumer Initiated Transaction Id. | [optional] - - - diff --git a/docs/Tmsv1paymentinstrumentsBankAccount.md b/docs/Tmsv1paymentinstrumentsBankAccount.md deleted file mode 100644 index b59a091ab..000000000 --- a/docs/Tmsv1paymentinstrumentsBankAccount.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Tmsv1paymentinstrumentsBankAccount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **String** | Type of Bank Account. | [optional] - - - diff --git a/docs/Tmsv1paymentinstrumentsBillTo.md b/docs/Tmsv1paymentinstrumentsBillTo.md deleted file mode 100644 index 7c0144d8f..000000000 --- a/docs/Tmsv1paymentinstrumentsBillTo.md +++ /dev/null @@ -1,20 +0,0 @@ - -# Tmsv1paymentinstrumentsBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**firstName** | **String** | Bill to First Name. | [optional] -**lastName** | **String** | Bill to Last Name. | [optional] -**company** | **String** | Bill to Company. | [optional] -**address1** | **String** | Bill to Address Line 1. | [optional] -**address2** | **String** | Bill to Address Line 2. | [optional] -**locality** | **String** | Bill to City. | [optional] -**administrativeArea** | **String** | Bill to State. | [optional] -**postalCode** | **String** | Bill to Postal Code. | [optional] -**country** | **String** | Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2 | [optional] -**email** | **String** | Valid Bill to Email. | [optional] -**phoneNumber** | **String** | Bill to Phone Number. | [optional] - - - diff --git a/docs/Tmsv1paymentinstrumentsBuyerInformation.md b/docs/Tmsv1paymentinstrumentsBuyerInformation.md deleted file mode 100644 index f0331bbeb..000000000 --- a/docs/Tmsv1paymentinstrumentsBuyerInformation.md +++ /dev/null @@ -1,13 +0,0 @@ - -# Tmsv1paymentinstrumentsBuyerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**companyTaxID** | **String** | Company Tax ID. | [optional] -**currency** | **String** | Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha | [optional] -**dateOBirth** | **String** | Date of birth YYYY-MM-DD. | [optional] -**personalIdentification** | [**List<Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification>**](Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification.md) | | [optional] - - - diff --git a/docs/Tmsv1paymentinstrumentsBuyerInformationIssuedBy.md b/docs/Tmsv1paymentinstrumentsBuyerInformationIssuedBy.md deleted file mode 100644 index 2ab984e3e..000000000 --- a/docs/Tmsv1paymentinstrumentsBuyerInformationIssuedBy.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Tmsv1paymentinstrumentsBuyerInformationIssuedBy - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**administrativeArea** | **String** | State or province where the identification was issued. | [optional] - - - diff --git a/docs/Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification.md b/docs/Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification.md deleted file mode 100644 index 8c40f2f16..000000000 --- a/docs/Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification.md +++ /dev/null @@ -1,12 +0,0 @@ - -# Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | Identification Number. | [optional] -**type** | **String** | Type of personal identification. | [optional] -**issuedBy** | [**Tmsv1paymentinstrumentsBuyerInformationIssuedBy**](Tmsv1paymentinstrumentsBuyerInformationIssuedBy.md) | | [optional] - - - diff --git a/docs/Tmsv1paymentinstrumentsCard.md b/docs/Tmsv1paymentinstrumentsCard.md deleted file mode 100644 index d0a054469..000000000 --- a/docs/Tmsv1paymentinstrumentsCard.md +++ /dev/null @@ -1,76 +0,0 @@ - -# Tmsv1paymentinstrumentsCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**expirationMonth** | **String** | Credit card expiration month. | [optional] -**expirationYear** | **String** | Credit card expiration year. | [optional] -**type** | [**TypeEnum**](#TypeEnum) | Credit card brand. | [optional] -**issueNumber** | **String** | Credit card issue number. | [optional] -**startMonth** | **String** | Credit card start month. | [optional] -**startYear** | **String** | Credit card start year. | [optional] -**useAs** | **String** | Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens. | [optional] - - - -## Enum: TypeEnum -Name | Value ----- | ----- -VISA | "visa" -MASTERCARD | "mastercard" -AMERICAN_EXPRESS | "american express" -DISCOVER | "discover" -DINERS_CLUB | "diners club" -CARTE_BLANCHE | "carte blanche" -JCB | "jcb" -OPTIMA | "optima" -TWINPAY_CREDIT | "twinpay credit" -TWINPAY_DEBIT | "twinpay debit" -WALMART | "walmart" -ENROUTE | "enroute" -LOWES_CONSUMER | "lowes consumer" -HOME_DEPOT_CONSUMER | "home depot consumer" -MBNA | "mbna" -DICKS_SPORTSWEAR | "dicks sportswear" -CASUAL_CORNER | "casual corner" -SEARS | "sears" -JAL | "jal" -DISNEY | "disney" -MAESTRO_UK_DOMESTIC | "maestro uk domestic" -SAMS_CLUB_CONSUMER | "sams club consumer" -SAMS_CLUB_BUSINESS | "sams club business" -NICOS | "nicos" -BILL_ME_LATER | "bill me later" -BEBE | "bebe" -RESTORATION_HARDWARE | "restoration hardware" -DELTA_ONLINE | "delta online" -SOLO | "solo" -VISA_ELECTRON | "visa electron" -DANKORT | "dankort" -LASER | "laser" -CARTE_BLEUE | "carte bleue" -CARTA_SI | "carta si" -PINLESS_DEBIT | "pinless debit" -ENCODED_ACCOUNT | "encoded account" -UATP | "uatp" -HOUSEHOLD | "household" -MAESTRO_INTERNATIONAL | "maestro international" -GE_MONEY_UK | "ge money uk" -KOREAN_CARDS | "korean cards" -STYLE | "style" -JCREW | "jcrew" -PAYEASE_CHINA_PROCESSING_EWALLET | "payease china processing ewallet" -PAYEASE_CHINA_PROCESSING_BANK_TRANSFER | "payease china processing bank transfer" -MEIJER_PRIVATE_LABEL | "meijer private label" -HIPERCARD | "hipercard" -AURA | "aura" -REDECARD | "redecard" -ORICO | "orico" -ELO | "elo" -CAPITAL_ONE_PRIVATE_LABEL | "capital one private label" -SYNCHRONY_PRIVATE_LABEL | "synchrony private label" -CHINA_UNION_PAY | "china union pay" - - - diff --git a/docs/Tmsv1paymentinstrumentsInstrumentIdentifier.md b/docs/Tmsv1paymentinstrumentsInstrumentIdentifier.md deleted file mode 100644 index eda301690..000000000 --- a/docs/Tmsv1paymentinstrumentsInstrumentIdentifier.md +++ /dev/null @@ -1,32 +0,0 @@ - -# Tmsv1paymentinstrumentsInstrumentIdentifier - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**Tmsv1instrumentidentifiersLinks**](Tmsv1instrumentidentifiersLinks.md) | | [optional] -**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. | [optional] -**state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] -**id** | **String** | The id of the existing instrument identifier to be linked to the newly created payment instrument. | [optional] -**card** | [**Tmsv1instrumentidentifiersCard**](Tmsv1instrumentidentifiersCard.md) | | [optional] -**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional] -**processingInformation** | [**Tmsv1instrumentidentifiersProcessingInformation**](Tmsv1instrumentidentifiersProcessingInformation.md) | | [optional] -**metadata** | [**Tmsv1instrumentidentifiersMetadata**](Tmsv1instrumentidentifiersMetadata.md) | | [optional] - - - -## Enum: ObjectEnum -Name | Value ----- | ----- -INSTRUMENTIDENTIFIER | "instrumentIdentifier" - - - -## Enum: StateEnum -Name | Value ----- | ----- -ACTIVE | "ACTIVE" -CLOSED | "CLOSED" - - - diff --git a/docs/Tmsv1paymentinstrumentsMerchantInformation.md b/docs/Tmsv1paymentinstrumentsMerchantInformation.md deleted file mode 100644 index ce83d7b89..000000000 --- a/docs/Tmsv1paymentinstrumentsMerchantInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Tmsv1paymentinstrumentsMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchantDescriptor** | [**Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor**](Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor.md) | | [optional] - - - diff --git a/docs/Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor.md b/docs/Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor.md deleted file mode 100644 index c0b4d02a2..000000000 --- a/docs/Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**alternateName** | **String** | Alternate information for your business. This API field overrides the company entry description value in your CyberSource account. | [optional] - - - diff --git a/docs/Tmsv1paymentinstrumentsProcessingInformation.md b/docs/Tmsv1paymentinstrumentsProcessingInformation.md deleted file mode 100644 index 0962f238c..000000000 --- a/docs/Tmsv1paymentinstrumentsProcessingInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# Tmsv1paymentinstrumentsProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**billPaymentProgramEnabled** | **Boolean** | Bill Payment Program Enabled. | [optional] -**bankTransferOptions** | [**Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions**](Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions.md) | | [optional] - - - diff --git a/docs/Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions.md b/docs/Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions.md deleted file mode 100644 index 96b122265..000000000 --- a/docs/Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions.md +++ /dev/null @@ -1,10 +0,0 @@ - -# Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**seCCode** | **String** | Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB). | [optional] - - - diff --git a/docs/TokenizationApi.md b/docs/TokenizationApi.md index c11c0f4bf..fd421b7bb 100644 --- a/docs/TokenizationApi.md +++ b/docs/TokenizationApi.md @@ -1,15 +1,15 @@ # TokenizationApi -All URIs are relative to *https://api.cybersource.com* +All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**tokenize**](TokenizationApi.md#tokenize) | **POST** /payments/flex/v1/tokens/ | Tokenize card +[**tokenize**](TokenizationApi.md#tokenize) | **POST** /flex/v1/tokens | Tokenize card # **tokenize** -> InlineResponse2001 tokenize(tokenizeRequest) +> FlexV1TokensPost200Response tokenize(tokenizeRequest) Tokenize card @@ -25,7 +25,7 @@ Returns a token representing the supplied card details. The token replaces card TokenizationApi apiInstance = new TokenizationApi(); TokenizeRequest tokenizeRequest = new TokenizeRequest(); // TokenizeRequest | try { - InlineResponse2001 result = apiInstance.tokenize(tokenizeRequest); + FlexV1TokensPost200Response result = apiInstance.tokenize(tokenizeRequest); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling TokenizationApi#tokenize"); @@ -37,11 +37,11 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **tokenizeRequest** | [**TokenizeRequest**](TokenizeRequest.md)| | [optional] + **tokenizeRequest** | [**TokenizeRequest**](TokenizeRequest.md)| | ### Return type -[**InlineResponse2001**](InlineResponse2001.md) +[**FlexV1TokensPost200Response**](FlexV1TokensPost200Response.md) ### Authorization @@ -49,6 +49,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined + - **Content-Type**: application/json;charset=utf-8 - **Accept**: application/json diff --git a/docs/TokenizeParameters.md b/docs/TokenizeParameters.md deleted file mode 100644 index c7f8cb18a..000000000 --- a/docs/TokenizeParameters.md +++ /dev/null @@ -1,11 +0,0 @@ - -# TokenizeParameters - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keyId** | **String** | Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key. | [optional] -**cardInfo** | [**Flexv1tokensCardInfo**](Flexv1tokensCardInfo.md) | | [optional] - - - diff --git a/docs/TokenizeRequest.md b/docs/TokenizeRequest.md index e047ad0a0..614f292fb 100644 --- a/docs/TokenizeRequest.md +++ b/docs/TokenizeRequest.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**keyId** | **String** | Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key. | [optional] +**keyId** | **String** | Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key. | **cardInfo** | [**Flexv1tokensCardInfo**](Flexv1tokensCardInfo.md) | | [optional] diff --git a/docs/TokenizeResult.md b/docs/TokenizeResult.md deleted file mode 100644 index b8f45c904..000000000 --- a/docs/TokenizeResult.md +++ /dev/null @@ -1,17 +0,0 @@ - -# TokenizeResult - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**keyId** | **String** | The Key ID. | [optional] -**token** | **String** | The generated token. The token replaces card data and is used as the Subscription ID in the CyberSource Simple Order API or SCMP API. | [optional] -**maskedPan** | **String** | The masked card number displaying the first 6 digits and the last 4 digits. | [optional] -**cardType** | **String** | The card type. | [optional] -**timestamp** | **Long** | The UTC date and time in milliseconds at which the signature was generated. | [optional] -**signedFields** | **String** | Indicates which fields from the response make up the data that is used when verifying the response signature. See the [sample code] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/java/com/cybersource/flex/application/CheckoutController.java) on how to verify the signature. | [optional] -**signature** | **String** | Flex-generated digital signature. To ensure the values have not been tampered with while passing through the client, verify this server-side using the public key generated from the /keys resource. | [optional] -**discoverableServices** | **Map<String, Object>** | | [optional] - - - diff --git a/docs/TransactionBatchesApi.md b/docs/TransactionBatchesApi.md index 4188d5491..73df20e6b 100644 --- a/docs/TransactionBatchesApi.md +++ b/docs/TransactionBatchesApi.md @@ -4,10 +4,59 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**getTransactionBatchDetails**](TransactionBatchesApi.md#getTransactionBatchDetails) | **GET** /pts/v1/transaction-batch-details | Filters batch response. [**getTransactionBatchId**](TransactionBatchesApi.md#getTransactionBatchId) | **GET** /pts/v1/transaction-batches/{id} | Get individual batch file [**getTransactionBatches**](TransactionBatchesApi.md#getTransactionBatches) | **GET** /pts/v1/transaction-batches | Get a list of batch files + +# **getTransactionBatchDetails** +> getTransactionBatchDetails(transactionBatchId, uploadDate, status) + +Filters batch response. + +Filters batch response. + +### Example +```java +// Import classes: +//import Invokers.ApiException; +//import Api.TransactionBatchesApi; + + +TransactionBatchesApi apiInstance = new TransactionBatchesApi(); +String transactionBatchId = "transactionBatchId_example"; // String | Transaction Batch Id, this is unique. +LocalDate uploadDate = new LocalDate(); // LocalDate | Date in which the original batch file was uploaded. Date must be in ISO-8601 format. +String status = "status_example"; // String | Allows you to filter by rejected response. +try { + apiInstance.getTransactionBatchDetails(transactionBatchId, uploadDate, status); +} catch (ApiException e) { + System.err.println("Exception when calling TransactionBatchesApi#getTransactionBatchDetails"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **transactionBatchId** | **String**| Transaction Batch Id, this is unique. | + **uploadDate** | **LocalDate**| Date in which the original batch file was uploaded. Date must be in ISO-8601 format. | [optional] + **status** | **String**| Allows you to filter by rejected response. | [optional] [enum: Rejected] + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: text/vnd.cybersource.map-csv + # **getTransactionBatchId** > PtsV1TransactionBatchesIdGet200Response getTransactionBatchId(id) diff --git a/docs/TssV2TransactionsGet200Response.md b/docs/TssV2TransactionsGet200Response.md index 64399bde2..c80de0c59 100644 --- a/docs/TssV2TransactionsGet200Response.md +++ b/docs/TssV2TransactionsGet200Response.md @@ -4,12 +4,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] +**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] **rootId** | **String** | Payment Request Id | [optional] **reconciliationId** | **String** | The reconciliation id for the submitted transaction. This value is not returned for all processors. | [optional] **merchantId** | **String** | The description for this field is not available. | [optional] **status** | **String** | The status of the submitted transaction. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**submitTimeUTC** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **applicationInformation** | [**TssV2TransactionsGet200ResponseApplicationInformation**](TssV2TransactionsGet200ResponseApplicationInformation.md) | | [optional] **buyerInformation** | [**TssV2TransactionsGet200ResponseBuyerInformation**](TssV2TransactionsGet200ResponseBuyerInformation.md) | | [optional] **clientReferenceInformation** | [**TssV2TransactionsGet200ResponseClientReferenceInformation**](TssV2TransactionsGet200ResponseClientReferenceInformation.md) | | [optional] @@ -18,7 +18,7 @@ Name | Type | Description | Notes **errorInformation** | [**TssV2TransactionsGet200ResponseErrorInformation**](TssV2TransactionsGet200ResponseErrorInformation.md) | | [optional] **installmentInformation** | [**TssV2TransactionsGet200ResponseInstallmentInformation**](TssV2TransactionsGet200ResponseInstallmentInformation.md) | | [optional] **fraudMarkingInformation** | [**TssV2TransactionsGet200ResponseFraudMarkingInformation**](TssV2TransactionsGet200ResponseFraudMarkingInformation.md) | | [optional] -**merchantDefinedInformation** | [**List<TssV2TransactionsGet200ResponseMerchantDefinedInformation>**](TssV2TransactionsGet200ResponseMerchantDefinedInformation.md) | The description for this field is not available. | [optional] +**merchantDefinedInformation** | [**List<Ptsv2paymentsMerchantDefinedInformation>**](Ptsv2paymentsMerchantDefinedInformation.md) | The description for this field is not available. | [optional] **merchantInformation** | [**TssV2TransactionsGet200ResponseMerchantInformation**](TssV2TransactionsGet200ResponseMerchantInformation.md) | | [optional] **orderInformation** | [**TssV2TransactionsGet200ResponseOrderInformation**](TssV2TransactionsGet200ResponseOrderInformation.md) | | [optional] **paymentInformation** | [**TssV2TransactionsGet200ResponsePaymentInformation**](TssV2TransactionsGet200ResponsePaymentInformation.md) | | [optional] @@ -27,7 +27,7 @@ Name | Type | Description | Notes **pointOfSaleInformation** | [**TssV2TransactionsGet200ResponsePointOfSaleInformation**](TssV2TransactionsGet200ResponsePointOfSaleInformation.md) | | [optional] **riskInformation** | [**TssV2TransactionsGet200ResponseRiskInformation**](TssV2TransactionsGet200ResponseRiskInformation.md) | | [optional] **senderInformation** | [**TssV2TransactionsGet200ResponseSenderInformation**](TssV2TransactionsGet200ResponseSenderInformation.md) | | [optional] -**links** | [**PtsV2PaymentsReversalsPost201ResponseLinks**](PtsV2PaymentsReversalsPost201ResponseLinks.md) | | [optional] +**links** | [**TssV2TransactionsGet200ResponseLinks**](TssV2TransactionsGet200ResponseLinks.md) | | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseBuyerInformation.md b/docs/TssV2TransactionsGet200ResponseBuyerInformation.md index 15fa82589..a8f47047b 100644 --- a/docs/TssV2TransactionsGet200ResponseBuyerInformation.md +++ b/docs/TssV2TransactionsGet200ResponseBuyerInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **String** | Your identifier for the customer. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. **Comercio Latino**\\ For recurring payments in Mexico, the value is the customer’s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. **Litle**\\ For a follow-on credit with Litle, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] **hashedPassword** | **String** | The description for this field is not available. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseClientReferenceInformation.md b/docs/TssV2TransactionsGet200ResponseClientReferenceInformation.md index 1e6422dcf..b08993674 100644 --- a/docs/TssV2TransactionsGet200ResponseClientReferenceInformation.md +++ b/docs/TssV2TransactionsGet200ResponseClientReferenceInformation.md @@ -4,11 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. | [optional] +**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] **applicationVersion** | **String** | The description for this field is not available. | [optional] **applicationName** | **String** | The application name of client which is used to submit the request. | [optional] **applicationUser** | **String** | The description for this field is not available. | [optional] -**comments** | **String** | The description for this field is not available. | [optional] +**comments** | **String** | Brief description of the order or any comment you wish to add to the order. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md b/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md index 2e127bdc3..8415022d4 100644 --- a/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md +++ b/docs/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**eciRaw** | **String** | Raw electronic commerce indicator (ECI). | [optional] +**eciRaw** | **String** | Raw electronic commerce indicator (ECI). For the description and requirements, see \"Payer Authentication,\" page 180. | [optional] **cavv** | **String** | Cardholder authentication verification value (CAVV). | [optional] -**xid** | **String** | Transaction identifier. | [optional] +**xid** | **String** | Transaction identifier. For the description and requirements, see \"Payer Authentication,\" page 180. | [optional] **transactionId** | **String** | Payer auth Transaction identifier. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseDeviceInformation.md b/docs/TssV2TransactionsGet200ResponseDeviceInformation.md index 05521450a..329dc9953 100644 --- a/docs/TssV2TransactionsGet200ResponseDeviceInformation.md +++ b/docs/TssV2TransactionsGet200ResponseDeviceInformation.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ipAddress** | **String** | IP address of the customer. | [optional] -**hostName** | **String** | DNS resolved hostname from above _ipAddress_. | [optional] -**cookiesAccepted** | **String** | The description for this field is not available. | [optional] +**ipAddress** | **String** | Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information. | [optional] +**hostName** | **String** | Host name reported by the customer’s browser to your Web server identified via the HTTP header. | [optional] +**cookiesAccepted** | **String** | Boolean that indicates whether the customer’s browser accepts cookies. This field can contain one of the following values: - `yes`: The customer’s browser accepts cookies. - `no`: The customer’s browser does not accept cookies. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseErrorInformation.md b/docs/TssV2TransactionsGet200ResponseErrorInformation.md index e5a3b1f81..6d8276f70 100644 --- a/docs/TssV2TransactionsGet200ResponseErrorInformation.md +++ b/docs/TssV2TransactionsGet200ResponseErrorInformation.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **reason** | **String** | The description for this field is not available. | [optional] **message** | **String** | The description for this field is not available. | [optional] -**details** | [**List<PtsV2PayoutsPost201ResponseErrorInformationDetails>**](PtsV2PayoutsPost201ResponseErrorInformationDetails.md) | | [optional] +**details** | [**List<PtsV2PaymentsPost201ResponseErrorInformationDetails>**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) | | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseLinks.md b/docs/TssV2TransactionsGet200ResponseLinks.md new file mode 100644 index 000000000..e82a58f2d --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseLinks.md @@ -0,0 +1,11 @@ + +# TssV2TransactionsGet200ResponseLinks + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**self** | [**PtsV2PaymentsPost201ResponseLinksSelf**](PtsV2PaymentsPost201ResponseLinksSelf.md) | | [optional] +**relatedTransactions** | [**List<PtsV2PaymentsPost201ResponseLinksSelf>**](PtsV2PaymentsPost201ResponseLinksSelf.md) | | [optional] + + + diff --git a/docs/TssV2TransactionsGet200ResponseMerchantDefinedInformation.md b/docs/TssV2TransactionsGet200ResponseMerchantDefinedInformation.md deleted file mode 100644 index ae02ce104..000000000 --- a/docs/TssV2TransactionsGet200ResponseMerchantDefinedInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# TssV2TransactionsGet200ResponseMerchantDefinedInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**key** | **String** | The description for this field is not available. | [optional] -**value** | **String** | The description for this field is not available. | [optional] - - - diff --git a/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md b/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md index 760b6a44a..bba387781 100644 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md @@ -4,10 +4,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] +**totalAmount** | **String** | Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:  Table 15, \"Authorization Information for Specific Processors,\" on page 43  Table 19, \"Capture Information for Specific Processors,\" on page 58  Table 23, \"Credit Information for Specific Processors,\" on page 75 If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247. **DCC with a Third-Party Provider**\\ Set this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used. | [optional] +**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. | [optional] **taxAmount** | **String** | Total tax amount for all the items in the order. For processor-specific information, see the total_tax_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] **authorizedAmount** | **String** | Amount that was authorized. | [optional] +**settlementAmount** | **String** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder’s account. | [optional] +**settlementCurrency** | **String** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md b/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md index 27b6f95ff..9383ac601 100644 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md @@ -4,20 +4,20 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**firstName** | **String** | Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**lastName** | **String** | Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**firstName** | **String** | Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**lastName** | **String** | Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] **middelName** | **String** | Customer’s middle name. | [optional] **nameSuffix** | **String** | Customer’s name suffix. | [optional] -**address1** | **String** | First line of the billing street address as it appears on the credit card issuer’s records. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**address2** | **String** | Additional address information. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**locality** | **String** | City of the billing address. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**administrativeArea** | **String** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**company** | **String** | Name of the customer’s company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**email** | **String** | Customer's email address, including the full domain name. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**address1** | **String** | First line of the billing street address as it appears on the credit card issuer’s records. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**address2** | **String** | Additional address information. For Payouts: This field may be sent only for FDC Compass. **Atos** This field must not contain colons (:). **Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions** This value is used for AVS. **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**locality** | **String** | City of the billing address. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**administrativeArea** | **String** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For Payouts: This field may be sent only for FDC Compass. **American Express Direct** Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**company** | [**Ptsv2paymentsOrderInformationBillToCompany**](Ptsv2paymentsOrderInformationBillToCompany.md) | | [optional] +**email** | **String** | Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**country** | **String** | Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] **title** | **String** | Title. | [optional] -**phoneNumber** | **String** | Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**phoneNumber** | **String** | Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md b/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md index 7682989f6..81e4a1073 100644 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md @@ -5,15 +5,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **firstName** | **String** | First name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 | [optional] -**lastName** | **String** | Last name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 | [optional] +**lastName** | **String** | Last name of the recipient. **Processor-specific maximum length** - Litle: 25 - All other processors: 60 | [optional] **address1** | **String** | First line of the shipping address. | [optional] **address2** | **String** | Second line of the shipping address. | [optional] **locality** | **String** | City of the shipping address. | [optional] -**administrativeArea** | **String** | State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] -**postalCode** | **String** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 | [optional] +**administrativeArea** | **String** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**postalCode** | **String** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 **American Express Direct**\\ Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. | [optional] **company** | **String** | Name of the customer’s company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | Country of the shipping address. Use the two character ISO Standard Country Codes. | [optional] -**phoneNumber** | **String** | Phone number for the shipping address. | [optional] +**country** | **String** | Country of the shipping address. Use the two-character ISO Standard Country Codes. | [optional] +**phoneNumber** | **String** | Phone number associated with the shipping address. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md b/docs/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md index 9f89defcb..5777e98ea 100644 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**giftWrap** | **Boolean** | The description for this field is not available. | [optional] -**shippingMethod** | **String** | Shipping method for the product. Possible values: - lowcost: Lowest-cost service - sameday: Courier or same-day service - oneday: Next-day or overnight service - twoday: Two-day service - threeday: Three-day service - pickup: Store pick-up - other: Other shipping method - none: No shipping method because product is a service or subscription | [optional] +**giftWrap** | **String** | Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - `yes`: The customer requested gift wrapping. - `no`: The customer did not request gift wrapping. | [optional] +**shippingMethod** | **String** | Shipping method for the product. Possible values: - `lowcost`: Lowest-cost service - `sameday`: Courier or same-day service - `oneday`: Next-day or overnight service - `twoday`: Two-day service - `threeday`: Three-day service - `pickup`: Store pick-up - `other`: Other shipping method - `none`: No shipping method because product is a service or subscription | [optional] diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformation.md b/docs/TssV2TransactionsGet200ResponsePaymentInformation.md index bbe2d3cdf..b73a6bc6f 100644 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformation.md +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformation.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **paymentType** | [**TssV2TransactionsGet200ResponsePaymentInformationPaymentType**](TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md) | | [optional] -**customer** | [**TssV2TransactionsGet200ResponsePaymentInformationCustomer**](TssV2TransactionsGet200ResponsePaymentInformationCustomer.md) | | [optional] +**customer** | [**Ptsv2paymentsPaymentInformationCustomer**](Ptsv2paymentsPaymentInformationCustomer.md) | | [optional] **card** | [**TssV2TransactionsGet200ResponsePaymentInformationCard**](TssV2TransactionsGet200ResponsePaymentInformationCard.md) | | [optional] **invoice** | [**TssV2TransactionsGet200ResponsePaymentInformationInvoice**](TssV2TransactionsGet200ResponsePaymentInformationInvoice.md) | | [optional] **bank** | [**TssV2TransactionsGet200ResponsePaymentInformationBank**](TssV2TransactionsGet200ResponsePaymentInformationBank.md) | | [optional] diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md index 6d64cd73f..7a878316e 100644 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.md @@ -6,11 +6,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **suffix** | **String** | The description for this field is not available. | [optional] **prefix** | **String** | The description for this field is not available. | [optional] -**checkNumber** | **String** | The description for this field is not available. | [optional] -**type** | **String** | The description for this field is not available. | [optional] +**checkNumber** | **String** | Check number. Chase Paymentech Solutions - Optional. CyberSource ACH Service - Not used. RBS WorldPay Atlanta - Optional on debits. Required on credits. TeleCheck - Strongly recommended on debit requests. Optional on credits. | [optional] +**type** | **String** | Account type. Possible values: - **C**: Checking. - **G**: General ledger. This value is supported only on Wells Fargo ACH. - **S**: Savings (U.S. dollars only). - **X**: Corporate checking (U.S. dollars only). | [optional] **name** | **String** | The description for this field is not available. | [optional] **checkDigit** | **String** | The description for this field is not available. | [optional] -**encoderId** | **String** | The description for this field is not available. | [optional] +**encoderId** | **String** | Identifier for the bank that provided the customer’s encoded account number. To obtain the bank identifier, contact your processor. See \"Encoded Account Numbers,\" page 39. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md index cd4ce989c..41d30d706 100644 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md @@ -6,12 +6,12 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **suffix** | **String** | Last four digits of the cardholder’s account number. This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder. | [optional] **prefix** | **String** | The description for this field is not available. | [optional] -**expirationMonth** | **String** | Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationYear** | **String** | Four-digit year in which the credit card expires. `Format: YYYY`. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**startMonth** | **String** | Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. The start date is not required for Maestro (UK Domestic) transactions. | [optional] -**startYear** | **String** | Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. The start date is not required for Maestro (UK Domestic) transactions. | [optional] -**issueNumber** | **String** | Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. The issue number is not required for Maestro (UK Domestic) transactions. | [optional] -**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover | [optional] +**expirationMonth** | **String** | Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**expirationYear** | **String** | Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**startMonth** | **String** | Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional] +**startYear** | **String** | Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. **Note** The start date is not required for Maestro (UK Domestic) transactions. | [optional] +**issueNumber** | **String** | Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions. | [optional] +**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) | [optional] **accountEncoderId** | **String** | Identifier for the issuing bank that provided the customer’s encoded account number. Contact your processor for the bank’s ID. | [optional] **useAs** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. **Cielo** and **Comercio Latino** Possible values: - CREDIT: Credit card - DEBIT: Debit card This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md deleted file mode 100644 index 2cc0aeb72..000000000 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationCustomer.md +++ /dev/null @@ -1,10 +0,0 @@ - -# TssV2TransactionsGet200ResponsePaymentInformationCustomer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customerId** | **String** | Unique identifier for the customer's card and billing information. | [optional] - - - diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md index 9c90cc0e7..368c085ca 100644 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.md @@ -4,10 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | The description for this field is not available. | [optional] -**type** | **String** | The description for this field is not available. | [optional] -**subType** | **String** | The description for this field is not available. | [optional] -**method** | **String** | The description for this field is not available. | [optional] +**name** | **String** | The name of a payment method. This is required for non-credit card payment. Examples: `SEARS`, `JCREW`, `PAYPAL`, `IDEAL`, `EPS` ...etc. Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. | [optional] +**type** | **String** | The type of payment method. This is required for non-credit card payment. Possible values: - BANK_TRANSFER - CARD (Default) - EWALLET - DIGITAL - DIRECT_DEBIT - INVOICE - PUSH_PAYMENT - CARRIER_BILLING - CASH - CHECK - CRYPTOGRAPHIC Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. | [optional] +**method** | **String** | This is an optional field. Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. | [optional] **fundingSource** | **String** | The description for this field is not available. | [optional] **fundingSourceAffiliation** | **String** | The description for this field is not available. | [optional] **credential** | **String** | The description for this field is not available. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseProcessingInformation.md b/docs/TssV2TransactionsGet200ResponseProcessingInformation.md index 18aea4d40..eb2183576 100644 --- a/docs/TssV2TransactionsGet200ResponseProcessingInformation.md +++ b/docs/TssV2TransactionsGet200ResponseProcessingInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**paymentSolution** | **String** | Type of digital payment solution that is being used for the transaction. Possible Values: - **visacheckout**: Visa Checkout. - **001**: Apple Pay. - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct. - **006**: Android Pay. - **008**: Samsung Pay. | [optional] +**paymentSolution** | **String** | Type of digital payment solution for the transaction. Possible Values: - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API. - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153. | [optional] **commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. When you omit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file for you instead of the default value listed here. | [optional] **businessApplicationId** | **String** | The description for this field is not available. | [optional] **authorizationOptions** | [**TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions**](TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md) | | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md index fba357ce2..ed4d9ffcd 100644 --- a/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md +++ b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**authType** | **String** | Authorization type. Possible values: - **AUTOCAPTURE**: automatic capture. - **STANDARDCAPTURE**: standard capture. - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. For processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**authType** | **String** | Authorization type. Possible values: - **AUTOCAPTURE**: automatic capture. - **STANDARDCAPTURE**: standard capture. - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. **Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing**\\ Set this field to _AUTOCAPTURE_ and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to STANDARDCAPTURE and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see \"Automatic Captures,\" page 33. **Forced Capture**\\ Set this field to _VERBAL_ and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. For more information, see \"Forced Captures,\" page 123. **Verbal Authorization**\\ Set this field to _VERBAL_ and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations,\" page 84. For processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseProcessorInformation.md b/docs/TssV2TransactionsGet200ResponseProcessorInformation.md index 4550863a8..39272c36c 100644 --- a/docs/TssV2TransactionsGet200ResponseProcessorInformation.md +++ b/docs/TssV2TransactionsGet200ResponseProcessorInformation.md @@ -5,16 +5,18 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **processor** | [**TssV2TransactionsGet200ResponseProcessorInformationProcessor**](TssV2TransactionsGet200ResponseProcessorInformationProcessor.md) | | [optional] -**transactionId** | **String** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. | [optional] +**transactionId** | **String** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. | [optional] **networkTransactionId** | **String** | The description for this field is not available. | [optional] **responseId** | **String** | The description for this field is not available. | [optional] **providerTransactionId** | **String** | The description for this field is not available. | [optional] **approvalCode** | **String** | Authorization code. Returned only when the processor returns this value. | [optional] **responseCode** | **String** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. Important Do not use this field to evaluate the result of the authorization. | [optional] **avs** | [**PtsV2PaymentsPost201ResponseProcessorInformationAvs**](PtsV2PaymentsPost201ResponseProcessorInformationAvs.md) | | [optional] -**cardVerification** | [**TssV2TransactionsGet200ResponseProcessorInformationCardVerification**](TssV2TransactionsGet200ResponseProcessorInformationCardVerification.md) | | [optional] -**achVerification** | [**TssV2TransactionsGet200ResponseProcessorInformationAchVerification**](TssV2TransactionsGet200ResponseProcessorInformationAchVerification.md) | | [optional] +**cardVerification** | [**Riskv1decisionsCardVerification**](Riskv1decisionsCardVerification.md) | | [optional] +**achVerification** | [**PtsV2PaymentsPost201ResponseProcessorInformationAchVerification**](PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md) | | [optional] **electronicVerificationResults** | [**TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults**](TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md) | | [optional] +**systemTraceAuditNumber** | **String** | This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. **American Express Direct** System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. **CyberSource through VisaNet** System trace number that must be printed on the customer’s receipt. | [optional] +**responseCodeSource** | **String** | Used by Visa only and contains the response source/reason code that identifies the source of the response decision. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseProcessorInformationAchVerification.md b/docs/TssV2TransactionsGet200ResponseProcessorInformationAchVerification.md deleted file mode 100644 index 74c9ef22c..000000000 --- a/docs/TssV2TransactionsGet200ResponseProcessorInformationAchVerification.md +++ /dev/null @@ -1,11 +0,0 @@ - -# TssV2TransactionsGet200ResponseProcessorInformationAchVerification - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**resultCode** | **String** | The description for this field is not available.. | [optional] -**resultCodeRaw** | **String** | The description for this field is not available. | [optional] - - - diff --git a/docs/TssV2TransactionsGet200ResponseProcessorInformationAvs.md b/docs/TssV2TransactionsGet200ResponseProcessorInformationAvs.md deleted file mode 100644 index b986eaff1..000000000 --- a/docs/TssV2TransactionsGet200ResponseProcessorInformationAvs.md +++ /dev/null @@ -1,11 +0,0 @@ - -# TssV2TransactionsGet200ResponseProcessorInformationAvs - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **String** | AVS result code. | [optional] -**codeRaw** | **String** | AVS result code sent directly from the processor. Returned only when the processor returns this value. Important Do not use this field to evaluate the result of AVS. Use for debugging purposes only. | [optional] - - - diff --git a/docs/TssV2TransactionsGet200ResponseProcessorInformationCardVerification.md b/docs/TssV2TransactionsGet200ResponseProcessorInformationCardVerification.md deleted file mode 100644 index 975b4f104..000000000 --- a/docs/TssV2TransactionsGet200ResponseProcessorInformationCardVerification.md +++ /dev/null @@ -1,10 +0,0 @@ - -# TssV2TransactionsGet200ResponseProcessorInformationCardVerification - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**resultCode** | **String** | CVN result code. | [optional] - - - diff --git a/docs/TssV2TransactionsGet200ResponseRiskInformation.md b/docs/TssV2TransactionsGet200ResponseRiskInformation.md index 6f547205e..93a6e5cfb 100644 --- a/docs/TssV2TransactionsGet200ResponseRiskInformation.md +++ b/docs/TssV2TransactionsGet200ResponseRiskInformation.md @@ -5,11 +5,11 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **profile** | [**TssV2TransactionsGet200ResponseRiskInformationProfile**](TssV2TransactionsGet200ResponseRiskInformationProfile.md) | | [optional] -**rules** | [**List<TssV2TransactionsGet200ResponseRiskInformationProfile>**](TssV2TransactionsGet200ResponseRiskInformationProfile.md) | | [optional] +**rules** | [**List<TssV2TransactionsGet200ResponseRiskInformationRules>**](TssV2TransactionsGet200ResponseRiskInformationRules.md) | | [optional] **passiveProfile** | [**TssV2TransactionsGet200ResponseRiskInformationProfile**](TssV2TransactionsGet200ResponseRiskInformationProfile.md) | | [optional] -**passiveRules** | [**List<TssV2TransactionsGet200ResponseRiskInformationProfile>**](TssV2TransactionsGet200ResponseRiskInformationProfile.md) | | [optional] +**passiveRules** | [**List<TssV2TransactionsGet200ResponseRiskInformationRules>**](TssV2TransactionsGet200ResponseRiskInformationRules.md) | | [optional] **score** | [**TssV2TransactionsGet200ResponseRiskInformationScore**](TssV2TransactionsGet200ResponseRiskInformationScore.md) | | [optional] -**localTime** | **String** | Time that the transaction was submitted in local time.. | [optional] +**localTime** | **String** | Time that the transaction was submitted in local time. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseRiskInformationRules.md b/docs/TssV2TransactionsGet200ResponseRiskInformationRules.md new file mode 100644 index 000000000..2fa667abc --- /dev/null +++ b/docs/TssV2TransactionsGet200ResponseRiskInformationRules.md @@ -0,0 +1,11 @@ + +# TssV2TransactionsGet200ResponseRiskInformationRules + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | Description of the rule as it appears in the Profile Editor. | [optional] +**decision** | **String** | Summarizes the result for the rule according to the setting that you chose in the Profile Editor. This field can contain one of the following values: - `IGNORE` - `REVIEW` - `REJECT` - `ACCEPT` | [optional] + + + diff --git a/docs/TssV2TransactionsPost201Response.md b/docs/TssV2TransactionsPost201Response.md index 7e2057f84..0b5d99958 100644 --- a/docs/TssV2TransactionsPost201Response.md +++ b/docs/TssV2TransactionsPost201Response.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] +**searchId** | **String** | An unique identification number assigned by CyberSource to identify each Search request. | [optional] **save** | **Boolean** | save or not save. | [optional] **name** | **String** | The description for this field is not available. | [optional] **timezone** | **String** | Time Zone. | [optional] @@ -14,7 +14,7 @@ Name | Type | Description | Notes **sort** | **String** | A comma separated list of the following form - fieldName1 asc or desc, fieldName2 asc or desc, etc. | [optional] **count** | **Integer** | Results for this page, this could be below the limit. | [optional] **totalCount** | **Integer** | total number of results. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **embedded** | [**TssV2TransactionsPost201ResponseEmbedded**](TssV2TransactionsPost201ResponseEmbedded.md) | | [optional] **links** | [**PtsV2PaymentsReversalsPost201ResponseLinks**](PtsV2PaymentsReversalsPost201ResponseLinks.md) | | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md index 0b42f2411..3c47c9b21 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**merchantCustomerId** | **String** | Your identifier for the customer. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**merchantCustomerId** | **String** | Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. **Comercio Latino**\\ For recurring payments in Mexico, the value is the customer’s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. **Litle**\\ For a follow-on credit with Litle, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md index c5f776f88..8b803b620 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. | [optional] +**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. | [optional] **applicationName** | **String** | The application name of client which is used to submit the request. | [optional] **applicationUser** | **String** | The description for this field is not available. | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md index 58c183ed6..252eb66a5 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**xid** | **String** | Transaction identifier. | [optional] +**xid** | **String** | Transaction identifier. For the description and requirements, see \"Payer Authentication,\" page 180. | [optional] **transactionId** | **String** | Payer auth Transaction identifier. | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.md index dd85e3ffa..4dbc81f82 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**ipAddress** | **String** | IP address of the customer. | [optional] +**ipAddress** | **String** | Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information. | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md index 2e85fe6ce..5472f162a 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**resellerId** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] +**resellerId** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md index 33437b1d9..7df598b53 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **billTo** | [**TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo**](TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md) | | [optional] **shipTo** | [**TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo**](TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md) | | [optional] -**amountDetails** | [**TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails**](TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails.md) | | [optional] +**amountDetails** | [**Ptsv2paymentsidreversalsReversalInformationAmountDetails**](Ptsv2paymentsidreversalsReversalInformationAmountDetails.md) | | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails.md b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails.md deleted file mode 100644 index c9e83a355..000000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails.md +++ /dev/null @@ -1,11 +0,0 @@ - -# TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] - - - diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md index 631b4d526..d30ec86e3 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md @@ -4,11 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**firstName** | **String** | Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**lastName** | **String** | Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**email** | **String** | Customer's email address, including the full domain name. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**phoneNumber** | **String** | Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**firstName** | **String** | Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**lastName** | **String** | Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**email** | **String** | Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**country** | **String** | Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**phoneNumber** | **String** | Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md index a25b51f6d..9e12b0e38 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.md @@ -5,10 +5,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **firstName** | **String** | First name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 | [optional] -**lastName** | **String** | Last name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 | [optional] +**lastName** | **String** | Last name of the recipient. **Processor-specific maximum length** - Litle: 25 - All other processors: 60 | [optional] **address1** | **String** | First line of the shipping address. | [optional] -**country** | **String** | Country of the shipping address. Use the two character ISO Standard Country Codes. | [optional] -**phoneNumber** | **String** | Phone number for the shipping address. | [optional] +**country** | **String** | Country of the shipping address. Use the two-character ISO Standard Country Codes. | [optional] +**phoneNumber** | **String** | Phone number associated with the shipping address. | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md index 9b088a081..73789647a 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**paymentMethod** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod.md) | | [optional] -**customer** | [**TssV2TransactionsGet200ResponsePaymentInformationCustomer**](TssV2TransactionsGet200ResponsePaymentInformationCustomer.md) | | [optional] +**paymentType** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md) | | [optional] +**customer** | [**Ptsv2paymentsPaymentInformationCustomer**](Ptsv2paymentsPaymentInformationCustomer.md) | | [optional] **card** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md) | | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md index a1a6d411d..6725cf149 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **suffix** | **String** | Last four digits of the cardholder’s account number. This field is returned only for tokenized transactions. You can use this value on the receipt that you give to the cardholder. | [optional] **prefix** | **String** | The description for this field is not available. | [optional] -**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover | [optional] +**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod.md deleted file mode 100644 index cca09bb38..000000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod.md +++ /dev/null @@ -1,10 +0,0 @@ - -# TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **String** | The description for this field is not available. | [optional] - - - diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md new file mode 100644 index 000000000..9a7958a55 --- /dev/null +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.md @@ -0,0 +1,11 @@ + +# TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **String** | The type of payment method. This is required for non-credit card payment. Possible values: - BANK_TRANSFER - CARD (Default) - EWALLET - DIGITAL - DIRECT_DEBIT - INVOICE - PUSH_PAYMENT - CARRIER_BILLING - CASH - CHECK - CRYPTOGRAPHIC Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. | [optional] +**method** | **String** | This is an optional field. Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. | [optional] + + + diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md index 3e3dbbb42..813339ad8 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md @@ -5,9 +5,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **terminalId** | **String** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. For Payouts: This field is applicable for CtV. | [optional] -**terminalSerialNumber** | **String** | The description for this field is not available. | [optional] +**terminalSerialNumber** | **String** | Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX. | [optional] **deviceId** | **String** | The description for this field is not available. | [optional] -**partner** | [**TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner**](TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md) | | [optional] +**partner** | [**Ptsv2paymentsClientReferenceInformationPartner**](Ptsv2paymentsClientReferenceInformationPartner.md) | | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md deleted file mode 100644 index 7727e747b..000000000 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.md +++ /dev/null @@ -1,10 +0,0 @@ - -# TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**originalTransactionId** | **String** | Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. | [optional] - - - diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md index cc9038878..2baa748cb 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**paymentSolution** | **String** | Type of digital payment solution that is being used for the transaction. Possible Values: - **visacheckout**: Visa Checkout. - **001**: Apple Pay. - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct. - **006**: Android Pay. - **008**: Samsung Pay. | [optional] +**paymentSolution** | **String** | Type of digital payment solution for the transaction. Possible Values: - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API. - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153. | [optional] **businessApplicationId** | **String** | The description for this field is not available. | [optional] diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md b/docs/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md index df9735638..108a77aff 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] +**id** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] **merchantId** | **String** | The description for this field is not available. | [optional] **applicationInformation** | [**TssV2TransactionsGet200ResponseApplicationInformation**](TssV2TransactionsGet200ResponseApplicationInformation.md) | | [optional] **buyerInformation** | [**TssV2TransactionsPost201ResponseEmbeddedBuyerInformation**](TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md) | | [optional] @@ -13,7 +13,7 @@ Name | Type | Description | Notes **consumerAuthenticationInformation** | [**TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation**](TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md) | | [optional] **deviceInformation** | [**TssV2TransactionsPost201ResponseEmbeddedDeviceInformation**](TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.md) | | [optional] **fraudMarkingInformation** | [**TssV2TransactionsGet200ResponseFraudMarkingInformation**](TssV2TransactionsGet200ResponseFraudMarkingInformation.md) | | [optional] -**merchantDefinedInformation** | [**List<TssV2TransactionsGet200ResponseMerchantDefinedInformation>**](TssV2TransactionsGet200ResponseMerchantDefinedInformation.md) | The description for this field is not available. | [optional] +**merchantDefinedInformation** | [**List<Ptsv2paymentsMerchantDefinedInformation>**](Ptsv2paymentsMerchantDefinedInformation.md) | The description for this field is not available. | [optional] **merchantInformation** | [**TssV2TransactionsPost201ResponseEmbeddedMerchantInformation**](TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md) | | [optional] **orderInformation** | [**TssV2TransactionsPost201ResponseEmbeddedOrderInformation**](TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md) | | [optional] **paymentInformation** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformation**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.md) | | [optional] diff --git a/docs/TssV2TransactionsPost400Response.md b/docs/TssV2TransactionsPost400Response.md index 8fcc86c12..131a73c6a 100644 --- a/docs/TssV2TransactionsPost400Response.md +++ b/docs/TssV2TransactionsPost400Response.md @@ -4,10 +4,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] +**submitTimeUtc** | **String** | Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. | [optional] +**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. Possible values: - INVALID_REQUEST | [optional] **message** | **String** | The detail message related to the status and reason listed above. | [optional] -**details** | [**List<PtsV2PayoutsPost201ResponseErrorInformationDetails>**](PtsV2PayoutsPost201ResponseErrorInformationDetails.md) | | [optional] +**details** | [**List<PtsV2PaymentsPost201ResponseErrorInformationDetails>**](PtsV2PaymentsPost201ResponseErrorInformationDetails.md) | | [optional] diff --git a/docs/UmsV1UsersGet400Response.md b/docs/UmsV1UsersGet400Response.md deleted file mode 100644 index f0da066a3..000000000 --- a/docs/UmsV1UsersGet400Response.md +++ /dev/null @@ -1,34 +0,0 @@ - -# UmsV1UsersGet400Response - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**submitTimeUtc** | **String** | Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. | [optional] -**status** | [**StatusEnum**](#StatusEnum) | The status of the submitted transaction. | [optional] -**reason** | [**ReasonEnum**](#ReasonEnum) | The reason of the status. | [optional] -**message** | **String** | The detail message related to the status and reason listed above. | [optional] -**details** | [**List<PtsV2PayoutsPost201ResponseErrorInformationDetails>**](PtsV2PayoutsPost201ResponseErrorInformationDetails.md) | | [optional] - - - -## Enum: StatusEnum -Name | Value ----- | ----- -REQUEST | "INVALID_REQUEST" - - - -## Enum: ReasonEnum -Name | Value ----- | ----- -MISSING_FIELD | "MISSING_FIELD" -INVALID_DATA | "INVALID_DATA" -DUPLICATE_REQUEST | "DUPLICATE_REQUEST" -INVALID_CARD | "INVALID_CARD" -INVALID_MERCHANT_CONFIGURATION | "INVALID_MERCHANT_CONFIGURATION" -CAPTURE_ALREADY_VOIDED | "CAPTURE_ALREADY_VOIDED" -ACCOUNT_NOT_ALLOWED_CREDIT | "ACCOUNT_NOT_ALLOWED_CREDIT" - - - diff --git a/docs/UpdateInstrumentIdentifierRequest.md b/docs/UpdateInstrumentIdentifierRequest.md new file mode 100644 index 000000000..cad834367 --- /dev/null +++ b/docs/UpdateInstrumentIdentifierRequest.md @@ -0,0 +1,10 @@ + +# UpdateInstrumentIdentifierRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**processingInformation** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md) | | [optional] + + + diff --git a/docs/UpdatePaymentInstrumentRequest.md b/docs/UpdatePaymentInstrumentRequest.md new file mode 100644 index 000000000..ace1d14e2 --- /dev/null +++ b/docs/UpdatePaymentInstrumentRequest.md @@ -0,0 +1,36 @@ + +# UpdatePaymentInstrumentRequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**links** | [**TmsV1InstrumentIdentifiersPost200ResponseLinks**](TmsV1InstrumentIdentifiersPost200ResponseLinks.md) | | [optional] +**id** | **String** | Unique identification number assigned by CyberSource to the submitted request. | [optional] +**object** | [**ObjectEnum**](#ObjectEnum) | Describes type of token. | [optional] +**state** | [**StateEnum**](#StateEnum) | Current state of the token. | [optional] +**bankAccount** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.md) | | [optional] +**card** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.md) | | [optional] +**buyerInformation** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.md) | | [optional] +**billTo** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.md) | | [optional] +**processingInformation** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.md) | | [optional] +**merchantInformation** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.md) | | [optional] +**metaData** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional] +**instrumentIdentifier** | [**TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier**](TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.md) | | [optional] + + + +## Enum: ObjectEnum +Name | Value +---- | ----- +PAYMENTINSTRUMENT | "paymentInstrument" + + + +## Enum: StateEnum +Name | Value +---- | ----- +ACTIVE | "ACTIVE" +CLOSED | "CLOSED" + + + diff --git a/docs/V2creditsPointOfSaleInformation.md b/docs/V2creditsPointOfSaleInformation.md deleted file mode 100644 index ec67f29b1..000000000 --- a/docs/V2creditsPointOfSaleInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# V2creditsPointOfSaleInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**emv** | [**V2creditsPointOfSaleInformationEmv**](V2creditsPointOfSaleInformationEmv.md) | | [optional] - - - diff --git a/docs/V2creditsPointOfSaleInformationEmv.md b/docs/V2creditsPointOfSaleInformationEmv.md deleted file mode 100644 index ab33dcd9c..000000000 --- a/docs/V2creditsPointOfSaleInformationEmv.md +++ /dev/null @@ -1,12 +0,0 @@ - -# V2creditsPointOfSaleInformationEmv - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tags** | **String** | EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. `Important` The following tags contain sensitive information and **must not** be included in this field: - **56**: Track 1 equivalent data - **57**: Track 2 equivalent data - **5A**: Application PAN - **5F20**: Cardholder name - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six) - **99**: Transaction PIN - **9F0B**: Cardholder name (extended) - **9F1F**: Track 1 discretionary data - **9F20**: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. `Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - **95**: Terminal verification results - **9F10**: Issuer application data - **9F26**: Application cryptogram | [optional] -**fallback** | **Boolean** | Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal: 1. Swipe the card or key the credit card information into the POS terminal. 2. Use the pos_entry_mode field to indicate whether the information was swiped or keyed. This field is supported only on **Chase Paymentech Solutions** and **GPN**. | [optional] -**fallbackCondition** | [**BigDecimal**](BigDecimal.md) | Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for one of these reasons: - Technical failure: the EMV terminal or EMV card cannot read and process chip data. - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card. EMV terminals are coded to determine whether the terminal and EMV card have any applications in common. EMV terminals provide this information to you. Possible values: - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal either used information from a successful chip read or it was not a chip transaction. - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful. This field is supported only on **GPN**. | [optional] - - - diff --git a/docs/V2creditsProcessingInformation.md b/docs/V2creditsProcessingInformation.md deleted file mode 100644 index 42c5bca07..000000000 --- a/docs/V2creditsProcessingInformation.md +++ /dev/null @@ -1,18 +0,0 @@ - -# V2creditsProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. When you omit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file for you instead of the default value listed here. | [optional] -**processorId** | **String** | Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**. | [optional] -**paymentSolution** | **String** | Type of digital payment solution that is being used for the transaction. Possible Values: - **visacheckout**: Visa Checkout. - **001**: Apple Pay. - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct. - **006**: Android Pay. - **008**: Samsung Pay. | [optional] -**reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **String** | Value that links the current payment request to the original request. Set this value to the ID that was returned in the reply message from the original payment request. This value is used for: - Partial authorizations. - Split shipments. | [optional] -**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Litle**. | [optional] -**visaCheckoutId** | **String** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] -**purchaseLevel** | **String** | Set this field to 3 to indicate that the request includes Level III data. | [optional] -**recurringOptions** | [**V2paymentsidrefundsProcessingInformationRecurringOptions**](V2paymentsidrefundsProcessingInformationRecurringOptions.md) | | [optional] - - - diff --git a/docs/V2paymentsAggregatorInformation.md b/docs/V2paymentsAggregatorInformation.md deleted file mode 100644 index 35f57be38..000000000 --- a/docs/V2paymentsAggregatorInformation.md +++ /dev/null @@ -1,12 +0,0 @@ - -# V2paymentsAggregatorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. For processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**name** | **String** | Your payment aggregator business name. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**subMerchant** | [**V2paymentsAggregatorInformationSubMerchant**](V2paymentsAggregatorInformationSubMerchant.md) | | [optional] - - - diff --git a/docs/V2paymentsAggregatorInformationSubMerchant.md b/docs/V2paymentsAggregatorInformationSubMerchant.md deleted file mode 100644 index 000c83551..000000000 --- a/docs/V2paymentsAggregatorInformationSubMerchant.md +++ /dev/null @@ -1,19 +0,0 @@ - -# V2paymentsAggregatorInformationSubMerchant - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cardAcceptorId** | **String** | Unique identifier assigned by the payment card company to the sub-merchant. | [optional] -**name** | **String** | Sub-merchant’s business name. | [optional] -**address1** | **String** | First line of the sub-merchant’s street address. | [optional] -**locality** | **String** | Sub-merchant’s city. | [optional] -**administrativeArea** | **String** | Sub-merchant’s state or province. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] -**region** | **String** | Sub-merchant’s region. Example `NE` indicates that the sub-merchant is in the northeast region. | [optional] -**postalCode** | **String** | Partial postal code for the sub-merchant’s address. | [optional] -**country** | **String** | Sub-merchant’s country. Use the two-character ISO Standard Country Codes. | [optional] -**email** | **String** | Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - CyberSource through VisaNet: 40 - FDC Compass: 40 - FDC Nashville Global: 19 | [optional] -**phoneNumber** | **String** | Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - CyberSource through VisaNet: 20 - FDC Compass: 13 - FDC Nashville Global: 10 | [optional] - - - diff --git a/docs/V2paymentsBuyerInformation.md b/docs/V2paymentsBuyerInformation.md deleted file mode 100644 index 38f8b1286..000000000 --- a/docs/V2paymentsBuyerInformation.md +++ /dev/null @@ -1,14 +0,0 @@ - -# V2paymentsBuyerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchantCustomerId** | **String** | Your identifier for the customer. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**dateOfBirth** | **String** | Recipient’s date of birth. **Format**: `YYYYMMDD`. This field is a pass-through, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] -**vatRegistrationNumber** | **String** | Customer’s government-assigned tax identification number. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**personalIdentification** | [**List<V2paymentsBuyerInformationPersonalIdentification>**](V2paymentsBuyerInformationPersonalIdentification.md) | | [optional] -**hashedPassword** | **String** | TODO | [optional] - - - diff --git a/docs/V2paymentsBuyerInformationPersonalIdentification.md b/docs/V2paymentsBuyerInformationPersonalIdentification.md deleted file mode 100644 index edf7cabeb..000000000 --- a/docs/V2paymentsBuyerInformationPersonalIdentification.md +++ /dev/null @@ -1,20 +0,0 @@ - -# V2paymentsBuyerInformationPersonalIdentification - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**TypeEnum**](#TypeEnum) | | [optional] -**id** | **String** | Personal Identifier for the customer based on various type. This field is supported only on the processors listed in this description. For processor-specific information, see the personal_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**issuedBy** | **String** | TBD | [optional] - - - -## Enum: TypeEnum -Name | Value ----- | ----- -SSN | "ssn" -DRIVERLICENSE | "driverlicense" - - - diff --git a/docs/V2paymentsClientReferenceInformation.md b/docs/V2paymentsClientReferenceInformation.md deleted file mode 100644 index 72051fde5..000000000 --- a/docs/V2paymentsClientReferenceInformation.md +++ /dev/null @@ -1,12 +0,0 @@ - -# V2paymentsClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. | [optional] -**transactionId** | **String** | Identifier that you assign to the transaction. See \"Merchant-Initiated Reversals and Voids,\" page 176 | [optional] -**comments** | **String** | Comments | [optional] - - - diff --git a/docs/V2paymentsConsumerAuthenticationInformation.md b/docs/V2paymentsConsumerAuthenticationInformation.md deleted file mode 100644 index c419701f8..000000000 --- a/docs/V2paymentsConsumerAuthenticationInformation.md +++ /dev/null @@ -1,17 +0,0 @@ - -# V2paymentsConsumerAuthenticationInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**cavv** | **String** | Cardholder authentication verification value (CAVV). | [optional] -**cavvAlgorithm** | **String** | Algorithm used to generate the CAVV for Verified by Visa or the UCAF authentication data for Mastercard SecureCode. | [optional] -**eciRaw** | **String** | Raw electronic commerce indicator (ECI). | [optional] -**paresStatus** | **String** | Payer authentication response status. | [optional] -**veresEnrolled** | **String** | Verification response enrollment status. | [optional] -**xid** | **String** | Transaction identifier. | [optional] -**ucafAuthenticationData** | **String** | Universal cardholder authentication field (UCAF) data. | [optional] -**ucafCollectionIndicator** | **String** | Universal cardholder authentication field (UCAF) collection indicator. | [optional] - - - diff --git a/docs/V2paymentsDeviceInformation.md b/docs/V2paymentsDeviceInformation.md deleted file mode 100644 index 8715e20b7..000000000 --- a/docs/V2paymentsDeviceInformation.md +++ /dev/null @@ -1,12 +0,0 @@ - -# V2paymentsDeviceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**hostName** | **String** | DNS resolved hostname from above _ipAddress_. | [optional] -**ipAddress** | **String** | IP address of the customer. | [optional] -**userAgent** | **String** | Customer’s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies the Netscape browser. | [optional] - - - diff --git a/docs/V2paymentsMerchantDefinedInformation.md b/docs/V2paymentsMerchantDefinedInformation.md deleted file mode 100644 index 51cf6418b..000000000 --- a/docs/V2paymentsMerchantDefinedInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2paymentsMerchantDefinedInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**key** | **String** | TBD | [optional] -**value** | **String** | TBD | [optional] - - - diff --git a/docs/V2paymentsMerchantInformation.md b/docs/V2paymentsMerchantInformation.md deleted file mode 100644 index 0e68add68..000000000 --- a/docs/V2paymentsMerchantInformation.md +++ /dev/null @@ -1,15 +0,0 @@ - -# V2paymentsMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchantDescriptor** | [**V2paymentsMerchantInformationMerchantDescriptor**](V2paymentsMerchantInformationMerchantDescriptor.md) | | [optional] -**salesOrganizationId** | **String** | Company ID assigned to an independent sales organization. Get this value from Mastercard. For processor-specific information, see the sales_organization_ID field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**categoryCode** | **Integer** | Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**vatRegistrationNumber** | **String** | Your government-assigned tax identification number. For CtV processors, the maximum length is 20. For other processor-specific information, see the merchant_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**cardAcceptorReferenceNumber** | **String** | Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the card_acceptor_ref_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**transactionLocalDateTime** | **String** | Local date and time at your physical location. Include both the date and time in this field or leave it blank. This field is supported only for **CyberSource through VisaNet**. For processor-specific information, see the transaction_local_date_time field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) `Format: YYYYMMDDhhmmss`, where: - YYYY = year - MM = month - DD = day - hh = hour - mm = minutes - ss = seconds | [optional] - - - diff --git a/docs/V2paymentsMerchantInformationMerchantDescriptor.md b/docs/V2paymentsMerchantInformationMerchantDescriptor.md deleted file mode 100644 index 7c8679bf6..000000000 --- a/docs/V2paymentsMerchantInformationMerchantDescriptor.md +++ /dev/null @@ -1,17 +0,0 @@ - -# V2paymentsMerchantInformationMerchantDescriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) For Payouts: * Paymentech (22) | [optional] -**alternateName** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**contact** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * FDCCompass (13) * Paymentech (13) | [optional] -**address1** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**locality** | **String** | Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**postalCode** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**administrativeArea** | **String** | Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] - - - diff --git a/docs/V2paymentsOrderInformation.md b/docs/V2paymentsOrderInformation.md deleted file mode 100644 index a72a5f80d..000000000 --- a/docs/V2paymentsOrderInformation.md +++ /dev/null @@ -1,15 +0,0 @@ - -# V2paymentsOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amountDetails** | [**V2paymentsOrderInformationAmountDetails**](V2paymentsOrderInformationAmountDetails.md) | | [optional] -**billTo** | [**V2paymentsOrderInformationBillTo**](V2paymentsOrderInformationBillTo.md) | | [optional] -**shipTo** | [**V2paymentsOrderInformationShipTo**](V2paymentsOrderInformationShipTo.md) | | [optional] -**lineItems** | [**List<V2paymentsOrderInformationLineItems>**](V2paymentsOrderInformationLineItems.md) | | [optional] -**invoiceDetails** | [**V2paymentsOrderInformationInvoiceDetails**](V2paymentsOrderInformationInvoiceDetails.md) | | [optional] -**shippingDetails** | [**V2paymentsOrderInformationShippingDetails**](V2paymentsOrderInformationShippingDetails.md) | | [optional] - - - diff --git a/docs/V2paymentsOrderInformationAmountDetails.md b/docs/V2paymentsOrderInformationAmountDetails.md deleted file mode 100644 index a3c293800..000000000 --- a/docs/V2paymentsOrderInformationAmountDetails.md +++ /dev/null @@ -1,28 +0,0 @@ - -# V2paymentsOrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] -**discountAmount** | **String** | Total discount amount applied to the order. For processor-specific information, see the order_discount_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**dutyAmount** | **String** | Total charges for any import or export duties included in the order. For processor-specific information, see the duty_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxAmount** | **String** | Total tax amount for all the items in the order. For processor-specific information, see the total_tax_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**nationalTaxIncluded** | **String** | Flag that indicates whether a national tax is included in the order total. Possible values: - **0**: national tax not included - **1**: national tax included For processor-specific information, see the national_tax_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxAppliedAfterDiscount** | **String** | Flag that indicates how the merchant manages discounts. Possible values: - **0**: no invoice level discount included - **1**: tax calculated on the postdiscount invoice total - **2**: tax calculated on the prediscount invoice total For processor-specific information, see the order_discount_management_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxAppliedLevel** | **String** | Flag that indicates how you calculate tax. Possible values: - **0**: net prices with tax calculated at line item level - **1**: net prices with tax calculated at invoice level - **2**: gross prices with tax provided at line item level - **3**: gross prices with tax provided at invoice level - **4**: no tax applies on the invoice for the transaction For processor-specific information, see the tax_management_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxTypeCode** | **String** | For tax amounts that can be categorized as one tax type. This field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field. Possible values: - **056**: sales tax (U.S only) - **TX~**: all taxes (Canada only) Note ~ = space. For processor-specific information, see the total_tax_type_code field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**freightAmount** | **String** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**foreignAmount** | **String** | Converted amount returned by the DCC service. For processor-specific information, see the foreign_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**foreignCurrency** | **String** | Billing currency returned by the DCC service. For processor-specific information, see the foreign_currency field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**exchangeRate** | **String** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For processor-specific information, see the exchange_rate field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**exchangeRateTimeStamp** | **String** | Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. For processor-specific information, see the exchange_rate_timestamp field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**surcharge** | [**V2paymentsOrderInformationAmountDetailsSurcharge**](V2paymentsOrderInformationAmountDetailsSurcharge.md) | | [optional] -**settlementAmount** | **String** | This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder’s account. | [optional] -**settlementCurrency** | **String** | This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. | [optional] -**amexAdditionalAmounts** | [**List<V2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts>**](V2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md) | | [optional] -**taxDetails** | [**List<V2paymentsOrderInformationAmountDetailsTaxDetails>**](V2paymentsOrderInformationAmountDetailsTaxDetails.md) | | [optional] - - - diff --git a/docs/V2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md b/docs/V2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md deleted file mode 100644 index 6cabcc11c..000000000 --- a/docs/V2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **String** | Additional amount type. This field is supported only for **American Express Direct**. For processor-specific information, see the additional_amount_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**amount** | **String** | Additional amount. This field is supported only for **American Express Direct**. For processor-specific information, see the additional_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] - - - diff --git a/docs/V2paymentsOrderInformationAmountDetailsSurcharge.md b/docs/V2paymentsOrderInformationAmountDetailsSurcharge.md deleted file mode 100644 index 70ddb0d7e..000000000 --- a/docs/V2paymentsOrderInformationAmountDetailsSurcharge.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2paymentsOrderInformationAmountDetailsSurcharge - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amount** | **String** | The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. - Applicable only for CTV for Payouts. - CTV (<= 08) For processor-specific information, see the surcharge_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**description** | **String** | TBD | [optional] - - - diff --git a/docs/V2paymentsOrderInformationAmountDetailsTaxDetails.md b/docs/V2paymentsOrderInformationAmountDetailsTaxDetails.md deleted file mode 100644 index 75056e4b1..000000000 --- a/docs/V2paymentsOrderInformationAmountDetailsTaxDetails.md +++ /dev/null @@ -1,25 +0,0 @@ - -# V2paymentsOrderInformationAmountDetailsTaxDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**TypeEnum**](#TypeEnum) | This is used to determine what type of tax related data should be inclued under _taxDetails_ object. | [optional] -**amount** | **String** | Please see below table for related decription based on above _type_ field. | type | amount description | |-----------|--------------------| | alternate | Total amount of alternate tax for the order. | | local | Sales tax for the order. | | national | National tax for the order. | | vat | Total amount of VAT or other tax included in the order. | | [optional] -**rate** | **String** | Rate of VAT or other tax for the order. Example 0.040 (=4%) Valid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated) | [optional] -**code** | **String** | Type of tax being applied to the item. Possible values: Below values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle** - 0000: unknown tax type - 0001: federal/national sales tax - 0002: state sales tax - 0003: city sales tax - 0004: local sales tax - 0005: municipal sales tax - 0006: other tax - 0010: value-added tax - 0011: goods and services tax - 0012: provincial sales tax - 0013: harmonized sales tax - 0014: Quebec sales tax (QST) - 0020: room tax - 0021: occupancy tax - 0022: energy tax - Blank: Tax not supported on line item. | [optional] -**taxId** | **String** | Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value, including zero. You may send this field without sending alternate tax amount. | [optional] -**applied** | **Boolean** | The tax is applied. Valid value is `true` or `false`. | [optional] - - - -## Enum: TypeEnum -Name | Value ----- | ----- -ALTERNATE | "alternate" -LOCAL | "local" -NATIONAL | "national" -VAT | "vat" - - - diff --git a/docs/V2paymentsOrderInformationBillTo.md b/docs/V2paymentsOrderInformationBillTo.md deleted file mode 100644 index 322d18a19..000000000 --- a/docs/V2paymentsOrderInformationBillTo.md +++ /dev/null @@ -1,36 +0,0 @@ - -# V2paymentsOrderInformationBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**firstName** | **String** | Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**lastName** | **String** | Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**middleName** | **String** | Customer’s middle name. | [optional] -**nameSuffix** | **String** | Customer’s name suffix. | [optional] -**title** | **String** | Title. | [optional] -**company** | **String** | Name of the customer’s company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**address1** | **String** | First line of the billing street address as it appears on the credit card issuer’s records. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**address2** | **String** | Additional address information. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**locality** | **String** | City of the billing address. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**administrativeArea** | **String** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**district** | **String** | Customer’s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This field is available only on **Cielo**. | [optional] -**buildingNumber** | **String** | Building number in the street address. This field is supported only for: - Cielo transactions. - Redecard customer validation with CyberSource Latin American Processing. | [optional] -**email** | **String** | Customer's email address, including the full domain name. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**phoneNumber** | **String** | Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**phoneType** | [**PhoneTypeEnum**](#PhoneTypeEnum) | Customer's phone number type. For Payouts: This field may be sent only for FDC Compass. Possible Values - * day * home * night * work | [optional] - - - -## Enum: PhoneTypeEnum -Name | Value ----- | ----- -DAY | "day" -HOME | "home" -NIGHT | "night" -WORK | "work" - - - diff --git a/docs/V2paymentsOrderInformationInvoiceDetails.md b/docs/V2paymentsOrderInformationInvoiceDetails.md deleted file mode 100644 index 3bfd18db5..000000000 --- a/docs/V2paymentsOrderInformationInvoiceDetails.md +++ /dev/null @@ -1,17 +0,0 @@ - -# V2paymentsOrderInformationInvoiceDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**purchaseOrderNumber** | **String** | Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. For processor-specific information, see the user_po field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**purchaseOrderDate** | **String** | Date the order was processed. `Format: YYYY-MM-DD`. For processor-specific information, see the purchaser_order_date field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**purchaseContactName** | **String** | The name of the individual or the company contacted for company authorized purchases. For processor-specific information, see the authorized_contact_name field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxable** | **Boolean** | Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0. If you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include _invoiceDetails.taxable_ in the data it sends to the processor. For processor-specific information, see the tax_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**vatInvoiceReferenceNumber** | **String** | VAT invoice number associated with the transaction. For processor-specific information, see the vat_invoice_ref_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**commodityCode** | **String** | International description code of the overall order’s goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. For processor-specific information, see the summary_commodity_code field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**merchandiseCode** | [**BigDecimal**](BigDecimal.md) | Identifier for the merchandise. Possible value: - 1000: Gift card This field is supported only for **American Express Direct**. | [optional] -**transactionAdviceAddendum** | [**List<V2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum>**](V2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.md) | | [optional] - - - diff --git a/docs/V2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.md b/docs/V2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.md deleted file mode 100644 index 42be65f4e..000000000 --- a/docs/V2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.md +++ /dev/null @@ -1,10 +0,0 @@ - -# V2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**data** | **String** | Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information about a transaction on the customer’s American Express card statement. When you send TAA fields, start with amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be ignored. To use these fields, contact CyberSource Customer Support to have your account enabled for this feature. | [optional] - - - diff --git a/docs/V2paymentsOrderInformationLineItems.md b/docs/V2paymentsOrderInformationLineItems.md deleted file mode 100644 index 292078822..000000000 --- a/docs/V2paymentsOrderInformationLineItems.md +++ /dev/null @@ -1,30 +0,0 @@ - -# V2paymentsOrderInformationLineItems - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**productCode** | **String** | Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. | [optional] -**productName** | **String** | For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the values related to shipping and handling. | [optional] -**productSku** | **String** | Identification code for the product. For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the values related to shipping and/or handling. | [optional] -**quantity** | [**BigDecimal**](BigDecimal.md) | For a payment or capture, this field is required when _productCode_ is not **default** or one of the values related to shipping and handling. | [optional] -**unitPrice** | **String** | Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**unitOfMeasure** | **String** | Unit of measure, or unit of measure code, for the item. | [optional] -**totalAmount** | **String** | Total amount for the item. Normally calculated as the unit price x quantity. | [optional] -**taxAmount** | **String** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. This field is frequently used for Level II and Level III transactions. | [optional] -**taxRate** | **String** | Tax rate applied to the item. See \"Numbered Elements,\" page 14. Visa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). Mastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). | [optional] -**taxAppliedAfterDiscount** | **String** | Flag to indicate how you handle discount at the line item level. - 0: no line level discount provided - 1: tax was calculated on the post-discount line item total - 2: tax was calculated on the pre-discount line item total `Note` Visa will inset 0 (zero) if an invalid value is included in this field. This field relates to the value in the _lineItems[].discountAmount_ field. | [optional] -**taxStatusIndicator** | **String** | Flag to indicate whether tax is exempted or not included. - 0: tax not included - 1: tax included - 2: transaction is not subject to tax | [optional] -**taxTypeCode** | **String** | Type of tax being applied to the item. Possible values: Below values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle** - 0000: unknown tax type - 0001: federal/national sales tax - 0002: state sales tax - 0003: city sales tax - 0004: local sales tax - 0005: municipal sales tax - 0006: other tax - 0010: value-added tax - 0011: goods and services tax - 0012: provincial sales tax - 0013: harmonized sales tax - 0014: Quebec sales tax (QST) - 0020: room tax - 0021: occupancy tax - 0022: energy tax - Blank: Tax not supported on line item. | [optional] -**amountIncludesTax** | **Boolean** | Flag that indicates whether the tax amount is included in the Line Item Total. | [optional] -**typeOfSupply** | **String** | Flag to indicate whether the purchase is categorized as goods or services. Possible values: - 00: goods - 01: services | [optional] -**commodityCode** | **String** | Commodity code or International description code used to classify the item. Contact your acquirer for a list of codes. | [optional] -**discountAmount** | **String** | Discount applied to the item. | [optional] -**discountApplied** | **Boolean** | Flag that indicates whether the amount is discounted. If you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets this field to **true**. | [optional] -**discountRate** | **String** | Rate the item is discounted. Maximum of 2 decimal places. Example 5.25 (=5.25%) | [optional] -**invoiceNumber** | **String** | Field to support an invoice number for a transaction. You must specify the number of line items that will include an invoice number. By default, the first line item will include an invoice number field. The invoice number field can be included for up to 10 line items. | [optional] -**taxDetails** | [**List<V2paymentsOrderInformationAmountDetailsTaxDetails>**](V2paymentsOrderInformationAmountDetailsTaxDetails.md) | | [optional] -**fulfillmentType** | **String** | TODO | [optional] - - - diff --git a/docs/V2paymentsOrderInformationShipTo.md b/docs/V2paymentsOrderInformationShipTo.md deleted file mode 100644 index ea211c506..000000000 --- a/docs/V2paymentsOrderInformationShipTo.md +++ /dev/null @@ -1,21 +0,0 @@ - -# V2paymentsOrderInformationShipTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**firstName** | **String** | First name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 | [optional] -**lastName** | **String** | Last name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 | [optional] -**address1** | **String** | First line of the shipping address. | [optional] -**address2** | **String** | Second line of the shipping address. | [optional] -**locality** | **String** | City of the shipping address. | [optional] -**administrativeArea** | **String** | State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] -**postalCode** | **String** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 | [optional] -**country** | **String** | Country of the shipping address. Use the two character ISO Standard Country Codes. | [optional] -**district** | **String** | Neighborhood, community, or region within a city or municipality. | [optional] -**buildingNumber** | **String** | Building number in the street address. For example, the building number is 187 in the following address: Rua da Quitanda 187 | [optional] -**phoneNumber** | **String** | Phone number for the shipping address. | [optional] -**company** | **String** | Name of the customer’s company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] - - - diff --git a/docs/V2paymentsOrderInformationShippingDetails.md b/docs/V2paymentsOrderInformationShippingDetails.md deleted file mode 100644 index faa560a25..000000000 --- a/docs/V2paymentsOrderInformationShippingDetails.md +++ /dev/null @@ -1,12 +0,0 @@ - -# V2paymentsOrderInformationShippingDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**giftWrap** | **Boolean** | TBD | [optional] -**shippingMethod** | **String** | Shipping method for the product. Possible values: - lowcost: Lowest-cost service - sameday: Courier or same-day service - oneday: Next-day or overnight service - twoday: Two-day service - threeday: Three-day service - pickup: Store pick-up - other: Other shipping method - none: No shipping method because product is a service or subscription | [optional] -**shipFromPostalCode** | **String** | Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is the postal code associated with your CyberSource account. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: `[5 digits][dash][4 digits]` Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: `[alpha][numeric][alpha][space] [numeric][alpha][numeric]` Example A1B 2C3 This field is frequently used for Level II and Level III transactions. | [optional] - - - diff --git a/docs/V2paymentsPaymentInformation.md b/docs/V2paymentsPaymentInformation.md deleted file mode 100644 index 01311bff8..000000000 --- a/docs/V2paymentsPaymentInformation.md +++ /dev/null @@ -1,13 +0,0 @@ - -# V2paymentsPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**V2paymentsPaymentInformationCard**](V2paymentsPaymentInformationCard.md) | | [optional] -**tokenizedCard** | [**V2paymentsPaymentInformationTokenizedCard**](V2paymentsPaymentInformationTokenizedCard.md) | | [optional] -**fluidData** | [**V2paymentsPaymentInformationFluidData**](V2paymentsPaymentInformationFluidData.md) | | [optional] -**customer** | [**V2paymentsPaymentInformationCustomer**](V2paymentsPaymentInformationCustomer.md) | | [optional] - - - diff --git a/docs/V2paymentsPaymentInformationCard.md b/docs/V2paymentsPaymentInformationCard.md deleted file mode 100644 index c9ddda159..000000000 --- a/docs/V2paymentsPaymentInformationCard.md +++ /dev/null @@ -1,21 +0,0 @@ - -# V2paymentsPaymentInformationCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**number** | **String** | Customer’s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field for the encoded account number. For processor-specific information, see the customer_cc_number field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationMonth** | **String** | Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationYear** | **String** | Four-digit year in which the credit card expires. `Format: YYYY`. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover | [optional] -**useAs** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. **Cielo** and **Comercio Latino** Possible values: - CREDIT: Credit card - DEBIT: Debit card This field is required for: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. | [optional] -**sourceAccountType** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases. - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for CTV. **Note** Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - CHECKING: Checking account - CREDIT: Credit card account - SAVING: Saving account - LINE_OF_CREDIT: Line of credit - PREPAID: Prepaid card account - UNIVERSAL: Universal account | [optional] -**securityCode** | **String** | Card Verification Number. | [optional] -**securityCodeIndicator** | **String** | Flag that indicates whether a CVN code was sent. Possible values: - 0 (default): CVN service not requested. CyberSource uses this default value when you do not include _securityCode_ in the request. - 1 (default): CVN service requested and supported. CyberSource uses this default value when you include _securityCode_ in the request. - 2: CVN on credit card is illegible. - 9: CVN was not imprinted on credit card. | [optional] -**accountEncoderId** | **String** | Identifier for the issuing bank that provided the customer’s encoded account number. Contact your processor for the bank’s ID. | [optional] -**issueNumber** | **String** | Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. The issue number is not required for Maestro (UK Domestic) transactions. | [optional] -**startMonth** | **String** | Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. The start date is not required for Maestro (UK Domestic) transactions. | [optional] -**startYear** | **String** | Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. The start date is not required for Maestro (UK Domestic) transactions. | [optional] - - - diff --git a/docs/V2paymentsPaymentInformationCustomer.md b/docs/V2paymentsPaymentInformationCustomer.md deleted file mode 100644 index 879338366..000000000 --- a/docs/V2paymentsPaymentInformationCustomer.md +++ /dev/null @@ -1,10 +0,0 @@ - -# V2paymentsPaymentInformationCustomer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customerId** | **String** | Unique identifier for the customer's card and billing information. | [optional] - - - diff --git a/docs/V2paymentsPaymentInformationFluidData.md b/docs/V2paymentsPaymentInformationFluidData.md deleted file mode 100644 index 5c325b1d6..000000000 --- a/docs/V2paymentsPaymentInformationFluidData.md +++ /dev/null @@ -1,13 +0,0 @@ - -# V2paymentsPaymentInformationFluidData - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**key** | **String** | TBD | [optional] -**descriptor** | **String** | Format of the encrypted payment data. | [optional] -**value** | **String** | The encrypted payment data value. If using Apple Pay or Samsung Pay, the values are: - Apple Pay: RklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U - Samsung Pay: RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ= | [optional] -**encoding** | **String** | Encoding method used to encrypt the payment data. Possible value: Base64 | [optional] - - - diff --git a/docs/V2paymentsPaymentInformationTokenizedCard.md b/docs/V2paymentsPaymentInformationTokenizedCard.md deleted file mode 100644 index 3dc8015f4..000000000 --- a/docs/V2paymentsPaymentInformationTokenizedCard.md +++ /dev/null @@ -1,19 +0,0 @@ - -# V2paymentsPaymentInformationTokenizedCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**number** | **String** | Customer’s payment network token value. | [optional] -**expirationMonth** | **String** | Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12. | [optional] -**expirationYear** | **String** | Four-digit year in which the payment network token expires. `Format: YYYY`. | [optional] -**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover | [optional] -**cryptogram** | **String** | This field is used internally. | [optional] -**requestorId** | **String** | Value that identifies your business and indicates that the cardholder’s account number is tokenized. This value is assigned by the token service provider and is unique within the token service provider’s database. `Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. | [optional] -**transactionType** | **String** | Type of transaction that provided the token data. This value does not specify the token service provider; it specifies the entity that provided you with information about the token. Set the value for this field to 1. An application on the customer’s mobile device provided the token data. | [optional] -**assuranceLevel** | **String** | Confidence level of the tokenization. This value is assigned by the token service provider. `Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**. | [optional] -**storageMethod** | **String** | Type of technology used in the device to store token data. Possible values: - 001: Secure Element (SE) Smart card or memory with restricted access and encryption to prevent data tampering. For storing payment credentials, a SE is tested against a set of requirements defined by the payment networks. `Note` This field is supported only for **FDC Compass**. - 002: Host Card Emulation (HCE) Emulation of a smart card by using software to create a virtual and exact representation of the card. Sensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database must meet very stringent security requirements that exceed PCI DSS. `Note` This field is supported only for **FDC Compass**. | [optional] -**securityCode** | **String** | CVN. | [optional] - - - diff --git a/docs/V2paymentsPointOfSaleInformation.md b/docs/V2paymentsPointOfSaleInformation.md deleted file mode 100644 index f786f6212..000000000 --- a/docs/V2paymentsPointOfSaleInformation.md +++ /dev/null @@ -1,21 +0,0 @@ - -# V2paymentsPointOfSaleInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**terminalId** | **String** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. For Payouts: This field is applicable for CtV. | [optional] -**terminalSerialNumber** | **String** | TBD | [optional] -**laneNumber** | **String** | Identifier for an alternate terminal at your retail location. You define the value for this field. This field is supported only for MasterCard transactions on FDC Nashville Global. Use the _terminalID_ field to identify the main terminal at your retail location. If your retail location has multiple terminals, use this _alternateTerminalID_ field to identify the terminal used for the transaction. This field is a pass-through, which means that CyberSource does not check the value or modify the value in any way before sending it to the processor. | [optional] -**cardPresent** | **Boolean** | Indicates whether the card is present at the time of the transaction. Possible values: - **true**: Card is present. - **false**: Card is not present. | [optional] -**catLevel** | **Integer** | Type of cardholder-activated terminal. Possible values: - 1: Automated dispensing machine - 2: Self-service terminal - 3: Limited amount terminal - 4: In-flight commerce (IFC) terminal - 5: Radio frequency device - 6: Mobile acceptance terminal - 7: Electronic cash register - 8: E-commerce device at your location - 9: Terminal or cash register that uses a dialup connection to connect to the transaction processing network * Applicable only for CTV for Payouts. | [optional] -**entryMode** | **String** | Method of entering credit card information into the POS terminal. Possible values: - contact: Read from direct contact with chip card. - contactless: Read from a contactless interface using chip data. - keyed: Manually keyed into POS terminal. - msd: Read from a contactless interface using magnetic stripe data (MSD). - swiped: Read from credit card magnetic stripe. The contact, contactless, and msd values are supported only for EMV transactions. * Applicable only for CTV for Payouts. | [optional] -**terminalCapability** | **Integer** | POS terminal’s capability. Possible values: - 1: Terminal has a magnetic stripe reader only. - 2: Terminal has a magnetic stripe reader and manual entry capability. - 3: Terminal has manual entry capability only. - 4: Terminal can read chip cards. - 5: Terminal can read contactless chip cards. The values of 4 and 5 are supported only for EMV transactions. * Applicable only for CTV for Payouts. | [optional] -**pinEntryCapability** | **Integer** | A one-digit code that identifies the capability of terminal to capture PINs. This code does not necessarily mean that a PIN was entered or is included in this message. For Payouts: This field is applicable for CtV. | [optional] -**operatingEnvironment** | **String** | Operating environment. Possible values: - 0: No terminal used or unknown environment. - 1: On merchant premises, attended. - 2: On merchant premises, unattended, or cardholder terminal. Examples: oil, kiosks, self-checkout, home computer, mobile telephone, personal digital assistant (PDA). Cardholder terminal is supported only for MasterCard transactions on **CyberSource through VisaNet**. - 3: Off merchant premises, attended. Examples: portable POS devices at trade shows, at service calls, or in taxis. - 4: Off merchant premises, unattended, or cardholder terminal. Examples: vending machines, home computer, mobile telephone, PDA. Cardholder terminal is supported only for MasterCard transactions on **CyberSource through VisaNet**. - 5: On premises of cardholder, unattended. - 9: Unknown delivery mode. - S: Electronic delivery of product. Examples: music, software, or eTickets that are downloaded over the internet. - T: Physical delivery of product. Examples: music or software that is delivered by mail or by a courier. This field is supported only for **American Express Direct** and **CyberSource through VisaNet**. **CyberSource through VisaNet** For MasterCard transactions, the only valid values are 2 and 4. | [optional] -**emv** | [**V2paymentsPointOfSaleInformationEmv**](V2paymentsPointOfSaleInformationEmv.md) | | [optional] -**amexCapnData** | **String** | Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. | [optional] -**trackData** | **String** | Card’s track 1 and 2 data. For all processors except FDMS Nashville, this value consists of one of the following: - Track 1 data - Track 2 data - Data for both tracks 1 and 2 For FDMS Nashville, this value consists of one of the following: - Track 1 data - Data for both tracks 1 and 2 Example: %B4111111111111111^SMITH/JOHN ^1612101976110000868000000?;4111111111111111=16121019761186800000? | [optional] - - - diff --git a/docs/V2paymentsPointOfSaleInformationEmv.md b/docs/V2paymentsPointOfSaleInformationEmv.md deleted file mode 100644 index 3512b7350..000000000 --- a/docs/V2paymentsPointOfSaleInformationEmv.md +++ /dev/null @@ -1,14 +0,0 @@ - -# V2paymentsPointOfSaleInformationEmv - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tags** | **String** | EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. `Important` The following tags contain sensitive information and **must not** be included in this field: - **56**: Track 1 equivalent data - **57**: Track 2 equivalent data - **5A**: Application PAN - **5F20**: Cardholder name - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six) - **99**: Transaction PIN - **9F0B**: Cardholder name (extended) - **9F1F**: Track 1 discretionary data - **9F20**: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. `Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - **95**: Terminal verification results - **9F10**: Issuer application data - **9F26**: Application cryptogram | [optional] -**cardholderVerificationMethod** | [**BigDecimal**](BigDecimal.md) | Method that was used to verify the cardholder's identity. Possible values: - **0**: No verification - **1**: Signature This field is supported only on **American Express Direct**. | [optional] -**cardSequenceNumber** | **String** | Number assigned to a specific card when two or more cards are associated with the same primary account number. This value enables issuers to distinguish among multiple cards that are linked to the same account. This value can also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip reader. When the chip reader does not provide this value, do not include this field in your request. | [optional] -**fallback** | **Boolean** | Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal: 1. Swipe the card or key the credit card information into the POS terminal. 2. Use the pos_entry_mode field to indicate whether the information was swiped or keyed. This field is supported only on **Chase Paymentech Solutions** and **GPN**. | [optional] -**fallbackCondition** | [**BigDecimal**](BigDecimal.md) | Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for one of these reasons: - Technical failure: the EMV terminal or EMV card cannot read and process chip data. - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card. EMV terminals are coded to determine whether the terminal and EMV card have any applications in common. EMV terminals provide this information to you. Possible values: - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal either used information from a successful chip read or it was not a chip transaction. - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful. This field is supported only on **GPN**. | [optional] - - - diff --git a/docs/V2paymentsProcessingInformation.md b/docs/V2paymentsProcessingInformation.md deleted file mode 100644 index 976cb7ed5..000000000 --- a/docs/V2paymentsProcessingInformation.md +++ /dev/null @@ -1,23 +0,0 @@ - -# V2paymentsProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**capture** | **Boolean** | Flag that specifies whether to also include capture service in the submitted request or not. | [optional] -**processorId** | **String** | Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**. | [optional] -**businessApplicationId** | **String** | TBD | [optional] -**commerceIndicator** | **String** | Type of transaction. Some payment card companies use this information when determining discount rates. When you omit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file for you instead of the default value listed here. | [optional] -**paymentSolution** | **String** | Type of digital payment solution that is being used for the transaction. Possible Values: - **visacheckout**: Visa Checkout. - **001**: Apple Pay. - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct. - **006**: Android Pay. - **008**: Samsung Pay. | [optional] -**reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **String** | Value that links the current payment request to the original request. Set this value to the ID that was returned in the reply message from the original payment request. This value is used for: - Partial authorizations. - Split shipments. | [optional] -**purchaseLevel** | **String** | Set this field to 3 to indicate that the request includes Level III data. | [optional] -**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Litle**. | [optional] -**visaCheckoutId** | **String** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] -**issuer** | [**V2paymentsProcessingInformationIssuer**](V2paymentsProcessingInformationIssuer.md) | | [optional] -**authorizationOptions** | [**V2paymentsProcessingInformationAuthorizationOptions**](V2paymentsProcessingInformationAuthorizationOptions.md) | | [optional] -**captureOptions** | [**V2paymentsProcessingInformationCaptureOptions**](V2paymentsProcessingInformationCaptureOptions.md) | | [optional] -**recurringOptions** | [**V2paymentsProcessingInformationRecurringOptions**](V2paymentsProcessingInformationRecurringOptions.md) | | [optional] - - - diff --git a/docs/V2paymentsProcessingInformationAuthorizationOptions.md b/docs/V2paymentsProcessingInformationAuthorizationOptions.md deleted file mode 100644 index f30fe683d..000000000 --- a/docs/V2paymentsProcessingInformationAuthorizationOptions.md +++ /dev/null @@ -1,31 +0,0 @@ - -# V2paymentsProcessingInformationAuthorizationOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**authType** | **String** | Authorization type. Possible values: - **AUTOCAPTURE**: automatic capture. - **STANDARDCAPTURE**: standard capture. - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. For processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**verbalAuthCode** | **String** | Authorization code. **Forced Capture** Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. **Verbal Authorization** Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the auth_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**verbalAuthTransactionId** | **String** | Transaction ID (TID). | [optional] -**authIndicator** | **String** | Flag that specifies the purpose of the authorization. Possible values: - **0**: Preauthorization - **1**: Final authorization For processor-specific information, see the auth_indicator field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**partialAuthIndicator** | **Boolean** | Flag that indicates whether the transaction is enabled for partial authorization or not. When your request includes this field, this value overrides the information in your CyberSource account. For processor-specific information, see the auth_partial_auth_indicator field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**balanceInquiry** | **Boolean** | Flag that indicates whether to return balance information. | [optional] -**ignoreAvsResult** | **Boolean** | Flag that indicates whether to allow the capture service to run even when the payment receives an AVS decline. | [optional] -**declineAvsFlags** | [**List<DeclineAvsFlagsEnum>**](#List<DeclineAvsFlagsEnum>) | An array of AVS flags that cause the reply flag to be returned. `Important` To receive declines for the AVS code N, include the value N in the array. | [optional] -**ignoreCvResult** | **Boolean** | Flag that indicates whether to allow the capture service to run even when the payment receives a CVN decline. | [optional] -**initiator** | [**V2paymentsProcessingInformationAuthorizationOptionsInitiator**](V2paymentsProcessingInformationAuthorizationOptionsInitiator.md) | | [optional] - - - -## Enum: List<DeclineAvsFlagsEnum> -Name | Value ----- | ----- -D | "D" -A | "A" -V | "V" -S | "S" -N | "N" -O | "O" - - - diff --git a/docs/V2paymentsProcessingInformationAuthorizationOptionsInitiator.md b/docs/V2paymentsProcessingInformationAuthorizationOptionsInitiator.md deleted file mode 100644 index 44efd56ed..000000000 --- a/docs/V2paymentsProcessingInformationAuthorizationOptionsInitiator.md +++ /dev/null @@ -1,21 +0,0 @@ - -# V2paymentsProcessingInformationAuthorizationOptionsInitiator - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**TypeEnum**](#TypeEnum) | This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction. | [optional] -**credentialStoredOnFile** | **Boolean** | Flag that indicates whether merchant is intend to use this transaction to store payment credential for follow-up merchant-initiated transactions or not. | [optional] -**storedCredentialUsed** | **Boolean** | Flag that indicates whether merchant is intend to use this transaction to store payment credential for follow-up merchant-initiated transactions or not. | [optional] -**merchantInitiatedTransaction** | [**V2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction**](V2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md) | | [optional] - - - -## Enum: TypeEnum -Name | Value ----- | ----- -CUSTOMER | "customer" -MERCHANT | "merchant" - - - diff --git a/docs/V2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md b/docs/V2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md deleted file mode 100644 index b05fa97a0..000000000 --- a/docs/V2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**reason** | **String** | Reason for the merchant-initiated transaction. Possible values: - **1**: Resubmission - **2**: Delayed charge - **3**: Reauthorization for split shipment - **4**: No show - **5**: Account top up This field is not required for installment payments or recurring payments or when _reAuth.first_ is true. It is required for all other merchant-initiated transactions. This field is supported only for Visa transactions on CyberSource through VisaNet. | [optional] -**previousTransactionId** | **String** | Transaction identifier that was returned in the payment response field _processorInformation.transactionID_ in the reply message for either the original merchant initiated payment in the series or the previous merchant-initiated payment in the series. <p/> If the current payment request includes a token instead of an account number, the following time limits apply for the value of this field: For a **resubmission**, the transaction ID must be less than 14 days old. For a **delayed charge** or **reauthorization**, the transaction ID must be less than 30 days old. The value for this field does not correspond to any data in the TC 33 capture file. This field is supported only for Visa transactions on CyberSource through VisaNet. | [optional] - - - diff --git a/docs/V2paymentsProcessingInformationCaptureOptions.md b/docs/V2paymentsProcessingInformationCaptureOptions.md deleted file mode 100644 index 7324427f0..000000000 --- a/docs/V2paymentsProcessingInformationCaptureOptions.md +++ /dev/null @@ -1,12 +0,0 @@ - -# V2paymentsProcessingInformationCaptureOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**captureSequenceNumber** | [**BigDecimal**](BigDecimal.md) | Capture number when requesting multiple partial captures for one payment. Used along with _totalCaptureCount_ to track which capture is being processed. For example, the second of five captures would be passed to CyberSource as: - _captureSequenceNumber_ = 2, and - _totalCaptureCount_ = 5 | [optional] -**totalCaptureCount** | [**BigDecimal**](BigDecimal.md) | Total number of captures when requesting multiple partial captures for one payment. Used along with _captureSequenceNumber_ which capture is being processed. For example, the second of five captures would be passed to CyberSource as: - _captureSequenceNumber_ = 2, and - _totalCaptureCount_ = 5 | [optional] -**dateToCapture** | **String** | Date on which you want the capture to occur. This field is supported only for **CyberSource through VisaNet**. `Format: MMDD` | [optional] - - - diff --git a/docs/V2paymentsProcessingInformationIssuer.md b/docs/V2paymentsProcessingInformationIssuer.md deleted file mode 100644 index 0fbded4e4..000000000 --- a/docs/V2paymentsProcessingInformationIssuer.md +++ /dev/null @@ -1,10 +0,0 @@ - -# V2paymentsProcessingInformationIssuer - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**discretionaryData** | **String** | Data defined by the issuer. The value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value. This field is supported only for Visa transactions on **CyberSource through VisaNet**. | [optional] - - - diff --git a/docs/V2paymentsProcessingInformationRecurringOptions.md b/docs/V2paymentsProcessingInformationRecurringOptions.md deleted file mode 100644 index 835b68323..000000000 --- a/docs/V2paymentsProcessingInformationRecurringOptions.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2paymentsProcessingInformationRecurringOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**loanPayment** | **Boolean** | Flag that indicates whether this is a payment towards an existing contractual loan. | [optional] -**firstRecurringPayment** | **Boolean** | Flag that indicates whether this transaction is the first in a series of recurring payments. This field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**. | [optional] - - - diff --git a/docs/V2paymentsRecipientInformation.md b/docs/V2paymentsRecipientInformation.md deleted file mode 100644 index 5e7593c06..000000000 --- a/docs/V2paymentsRecipientInformation.md +++ /dev/null @@ -1,12 +0,0 @@ - -# V2paymentsRecipientInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**accountId** | **String** | Identifier for the recipient’s account. Use the first six digits and last four digits of the recipient’s account number. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] -**lastName** | **String** | Recipient’s last name. This field is a passthrough, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] -**postalCode** | **String** | Partial postal code for the recipient’s address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: **NN5**. This field is a pass-through, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional] - - - diff --git a/docs/V2paymentsidcapturesAggregatorInformation.md b/docs/V2paymentsidcapturesAggregatorInformation.md deleted file mode 100644 index fc74e3361..000000000 --- a/docs/V2paymentsidcapturesAggregatorInformation.md +++ /dev/null @@ -1,12 +0,0 @@ - -# V2paymentsidcapturesAggregatorInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. For processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**name** | **String** | Your payment aggregator business name. For processor-specific information, see the aggregator_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**subMerchant** | [**V2paymentsidcapturesAggregatorInformationSubMerchant**](V2paymentsidcapturesAggregatorInformationSubMerchant.md) | | [optional] - - - diff --git a/docs/V2paymentsidcapturesAggregatorInformationSubMerchant.md b/docs/V2paymentsidcapturesAggregatorInformationSubMerchant.md deleted file mode 100644 index bf6b58bd5..000000000 --- a/docs/V2paymentsidcapturesAggregatorInformationSubMerchant.md +++ /dev/null @@ -1,17 +0,0 @@ - -# V2paymentsidcapturesAggregatorInformationSubMerchant - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | Sub-merchant’s business name. | [optional] -**address1** | **String** | First line of the sub-merchant’s street address. | [optional] -**locality** | **String** | Sub-merchant’s city. | [optional] -**administrativeArea** | **String** | Sub-merchant’s state or province. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] -**postalCode** | **String** | Partial postal code for the sub-merchant’s address. | [optional] -**country** | **String** | Sub-merchant’s country. Use the two-character ISO Standard Country Codes. | [optional] -**email** | **String** | Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - CyberSource through VisaNet: 40 - FDC Compass: 40 - FDC Nashville Global: 19 | [optional] -**phoneNumber** | **String** | Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - CyberSource through VisaNet: 20 - FDC Compass: 13 - FDC Nashville Global: 10 | [optional] - - - diff --git a/docs/V2paymentsidcapturesBuyerInformation.md b/docs/V2paymentsidcapturesBuyerInformation.md deleted file mode 100644 index 48b2335fa..000000000 --- a/docs/V2paymentsidcapturesBuyerInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2paymentsidcapturesBuyerInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchantCustomerId** | **String** | Your identifier for the customer. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**vatRegistrationNumber** | **String** | Customer’s government-assigned tax identification number. For processor-specific information, see the purchaser_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] - - - diff --git a/docs/V2paymentsidcapturesMerchantInformation.md b/docs/V2paymentsidcapturesMerchantInformation.md deleted file mode 100644 index f72202cc2..000000000 --- a/docs/V2paymentsidcapturesMerchantInformation.md +++ /dev/null @@ -1,13 +0,0 @@ - -# V2paymentsidcapturesMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchantDescriptor** | [**V2paymentsMerchantInformationMerchantDescriptor**](V2paymentsMerchantInformationMerchantDescriptor.md) | | [optional] -**cardAcceptorReferenceNumber** | **String** | Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the card_acceptor_ref_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**categoryCode** | **Integer** | Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**vatRegistrationNumber** | **String** | Your government-assigned tax identification number. For CtV processors, the maximum length is 20. For other processor-specific information, see the merchant_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] - - - diff --git a/docs/V2paymentsidcapturesOrderInformation.md b/docs/V2paymentsidcapturesOrderInformation.md deleted file mode 100644 index c2a359c1e..000000000 --- a/docs/V2paymentsidcapturesOrderInformation.md +++ /dev/null @@ -1,15 +0,0 @@ - -# V2paymentsidcapturesOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amountDetails** | [**V2paymentsidcapturesOrderInformationAmountDetails**](V2paymentsidcapturesOrderInformationAmountDetails.md) | | [optional] -**billTo** | [**V2paymentsidcapturesOrderInformationBillTo**](V2paymentsidcapturesOrderInformationBillTo.md) | | [optional] -**shipTo** | [**V2paymentsidcapturesOrderInformationShipTo**](V2paymentsidcapturesOrderInformationShipTo.md) | | [optional] -**lineItems** | [**List<V2paymentsOrderInformationLineItems>**](V2paymentsOrderInformationLineItems.md) | | [optional] -**invoiceDetails** | [**V2paymentsidcapturesOrderInformationInvoiceDetails**](V2paymentsidcapturesOrderInformationInvoiceDetails.md) | | [optional] -**shippingDetails** | [**V2paymentsidcapturesOrderInformationShippingDetails**](V2paymentsidcapturesOrderInformationShippingDetails.md) | | [optional] - - - diff --git a/docs/V2paymentsidcapturesOrderInformationAmountDetails.md b/docs/V2paymentsidcapturesOrderInformationAmountDetails.md deleted file mode 100644 index efc839589..000000000 --- a/docs/V2paymentsidcapturesOrderInformationAmountDetails.md +++ /dev/null @@ -1,25 +0,0 @@ - -# V2paymentsidcapturesOrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] -**discountAmount** | **String** | Total discount amount applied to the order. For processor-specific information, see the order_discount_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**dutyAmount** | **String** | Total charges for any import or export duties included in the order. For processor-specific information, see the duty_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxAmount** | **String** | Total tax amount for all the items in the order. For processor-specific information, see the total_tax_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**nationalTaxIncluded** | **String** | Flag that indicates whether a national tax is included in the order total. Possible values: - **0**: national tax not included - **1**: national tax included For processor-specific information, see the national_tax_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxAppliedAfterDiscount** | **String** | Flag that indicates how the merchant manages discounts. Possible values: - **0**: no invoice level discount included - **1**: tax calculated on the postdiscount invoice total - **2**: tax calculated on the prediscount invoice total For processor-specific information, see the order_discount_management_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxAppliedLevel** | **String** | Flag that indicates how you calculate tax. Possible values: - **0**: net prices with tax calculated at line item level - **1**: net prices with tax calculated at invoice level - **2**: gross prices with tax provided at line item level - **3**: gross prices with tax provided at invoice level - **4**: no tax applies on the invoice for the transaction For processor-specific information, see the tax_management_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxTypeCode** | **String** | For tax amounts that can be categorized as one tax type. This field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field. Possible values: - **056**: sales tax (U.S only) - **TX~**: all taxes (Canada only) Note ~ = space. For processor-specific information, see the total_tax_type_code field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**freightAmount** | **String** | Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field. For processor-specific information, see the freight_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**foreignAmount** | **String** | Converted amount returned by the DCC service. For processor-specific information, see the foreign_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**foreignCurrency** | **String** | Billing currency returned by the DCC service. For processor-specific information, see the foreign_currency field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**exchangeRate** | **String** | Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places. For processor-specific information, see the exchange_rate field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**exchangeRateTimeStamp** | **String** | Time stamp for the exchange rate. This value is returned by the DCC service. Format: `YYYYMMDD~HH:MM` where ~ denotes a space. For processor-specific information, see the exchange_rate_timestamp field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**amexAdditionalAmounts** | [**List<V2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts>**](V2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.md) | | [optional] -**taxDetails** | [**List<V2paymentsOrderInformationAmountDetailsTaxDetails>**](V2paymentsOrderInformationAmountDetailsTaxDetails.md) | | [optional] - - - diff --git a/docs/V2paymentsidcapturesOrderInformationBillTo.md b/docs/V2paymentsidcapturesOrderInformationBillTo.md deleted file mode 100644 index a2b0dc255..000000000 --- a/docs/V2paymentsidcapturesOrderInformationBillTo.md +++ /dev/null @@ -1,20 +0,0 @@ - -# V2paymentsidcapturesOrderInformationBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**firstName** | **String** | Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**lastName** | **String** | Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**company** | **String** | Name of the customer’s company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**address1** | **String** | First line of the billing street address as it appears on the credit card issuer’s records. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**address2** | **String** | Additional address information. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**locality** | **String** | City of the billing address. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**administrativeArea** | **String** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**email** | **String** | Customer's email address, including the full domain name. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**phoneNumber** | **String** | Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] - - - diff --git a/docs/V2paymentsidcapturesOrderInformationInvoiceDetails.md b/docs/V2paymentsidcapturesOrderInformationInvoiceDetails.md deleted file mode 100644 index ae91d48b9..000000000 --- a/docs/V2paymentsidcapturesOrderInformationInvoiceDetails.md +++ /dev/null @@ -1,16 +0,0 @@ - -# V2paymentsidcapturesOrderInformationInvoiceDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**purchaseOrderNumber** | **String** | Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource recommends that you do not populate the field with all zeros or nines. For processor-specific information, see the user_po field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**purchaseOrderDate** | **String** | Date the order was processed. `Format: YYYY-MM-DD`. For processor-specific information, see the purchaser_order_date field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**purchaseContactName** | **String** | The name of the individual or the company contacted for company authorized purchases. For processor-specific information, see the authorized_contact_name field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**taxable** | **Boolean** | Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0. If you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include _invoiceDetails.taxable_ in the data it sends to the processor. For processor-specific information, see the tax_indicator field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**vatInvoiceReferenceNumber** | **String** | VAT invoice number associated with the transaction. For processor-specific information, see the vat_invoice_ref_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**commodityCode** | **String** | International description code of the overall order’s goods or services or the Categorizes purchases for VAT reporting. Contact your acquirer for a list of codes. For processor-specific information, see the summary_commodity_code field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**transactionAdviceAddendum** | [**List<V2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum>**](V2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.md) | | [optional] - - - diff --git a/docs/V2paymentsidcapturesOrderInformationShipTo.md b/docs/V2paymentsidcapturesOrderInformationShipTo.md deleted file mode 100644 index c845c9042..000000000 --- a/docs/V2paymentsidcapturesOrderInformationShipTo.md +++ /dev/null @@ -1,12 +0,0 @@ - -# V2paymentsidcapturesOrderInformationShipTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**administrativeArea** | **String** | State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] -**country** | **String** | Country of the shipping address. Use the two character ISO Standard Country Codes. | [optional] -**postalCode** | **String** | Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 | [optional] - - - diff --git a/docs/V2paymentsidcapturesOrderInformationShippingDetails.md b/docs/V2paymentsidcapturesOrderInformationShippingDetails.md deleted file mode 100644 index da614136f..000000000 --- a/docs/V2paymentsidcapturesOrderInformationShippingDetails.md +++ /dev/null @@ -1,10 +0,0 @@ - -# V2paymentsidcapturesOrderInformationShippingDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**shipFromPostalCode** | **String** | Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is the postal code associated with your CyberSource account. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: `[5 digits][dash][4 digits]` Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: `[alpha][numeric][alpha][space] [numeric][alpha][numeric]` Example A1B 2C3 This field is frequently used for Level II and Level III transactions. | [optional] - - - diff --git a/docs/V2paymentsidcapturesPaymentInformation.md b/docs/V2paymentsidcapturesPaymentInformation.md deleted file mode 100644 index 60f3db479..000000000 --- a/docs/V2paymentsidcapturesPaymentInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# V2paymentsidcapturesPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**customer** | [**V2paymentsPaymentInformationCustomer**](V2paymentsPaymentInformationCustomer.md) | | [optional] - - - diff --git a/docs/V2paymentsidcapturesPointOfSaleInformation.md b/docs/V2paymentsidcapturesPointOfSaleInformation.md deleted file mode 100644 index 9ed1d07b2..000000000 --- a/docs/V2paymentsidcapturesPointOfSaleInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2paymentsidcapturesPointOfSaleInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**emv** | [**V2paymentsidcapturesPointOfSaleInformationEmv**](V2paymentsidcapturesPointOfSaleInformationEmv.md) | | [optional] -**amexCapnData** | **String** | Point-of-sale details for the transaction. This value is returned only for **American Express Direct**. CyberSource generates this value, which consists of a series of codes that identify terminal capability, security data, and specific conditions present at the time the transaction occurred. To comply with the CAPN requirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on credits. When you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from the authorization service to the subsequent services for you. However, when you perform authorizations through CyberSource and perform subsequent services through other financial institutions, you must ensure that your requests for captures and credits include this value. | [optional] - - - diff --git a/docs/V2paymentsidcapturesPointOfSaleInformationEmv.md b/docs/V2paymentsidcapturesPointOfSaleInformationEmv.md deleted file mode 100644 index 7fcdf5d96..000000000 --- a/docs/V2paymentsidcapturesPointOfSaleInformationEmv.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2paymentsidcapturesPointOfSaleInformationEmv - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tags** | **String** | EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags. `Important` The following tags contain sensitive information and **must not** be included in this field: - **56**: Track 1 equivalent data - **57**: Track 2 equivalent data - **5A**: Application PAN - **5F20**: Cardholder name - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six) - **99**: Transaction PIN - **9F0B**: Cardholder name (extended) - **9F1F**: Track 1 discretionary data - **9F20**: Track 2 discretionary data For captures, this field is required for contact EMV transactions. Otherwise, it is optional. For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional. `Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional. - **95**: Terminal verification results - **9F10**: Issuer application data - **9F26**: Application cryptogram | [optional] -**fallback** | **Boolean** | Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal: 1. Swipe the card or key the credit card information into the POS terminal. 2. Use the pos_entry_mode field to indicate whether the information was swiped or keyed. This field is supported only on **Chase Paymentech Solutions** and **GPN**. | [optional] - - - diff --git a/docs/V2paymentsidcapturesProcessingInformation.md b/docs/V2paymentsidcapturesProcessingInformation.md deleted file mode 100644 index 051f001a3..000000000 --- a/docs/V2paymentsidcapturesProcessingInformation.md +++ /dev/null @@ -1,18 +0,0 @@ - -# V2paymentsidcapturesProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**paymentSolution** | **String** | Type of digital payment solution that is being used for the transaction. Possible Values: - **visacheckout**: Visa Checkout. - **001**: Apple Pay. - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct. - **006**: Android Pay. - **008**: Samsung Pay. | [optional] -**reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **String** | Value that links the current payment request to the original request. Set this value to the ID that was returned in the reply message from the original payment request. This value is used for: - Partial authorizations. - Split shipments. | [optional] -**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Litle**. | [optional] -**visaCheckoutId** | **String** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] -**purchaseLevel** | **String** | Set this field to 3 to indicate that the request includes Level III data. | [optional] -**issuer** | [**V2paymentsProcessingInformationIssuer**](V2paymentsProcessingInformationIssuer.md) | | [optional] -**authorizationOptions** | [**V2paymentsidcapturesProcessingInformationAuthorizationOptions**](V2paymentsidcapturesProcessingInformationAuthorizationOptions.md) | | [optional] -**captureOptions** | [**V2paymentsidcapturesProcessingInformationCaptureOptions**](V2paymentsidcapturesProcessingInformationCaptureOptions.md) | | [optional] - - - diff --git a/docs/V2paymentsidcapturesProcessingInformationAuthorizationOptions.md b/docs/V2paymentsidcapturesProcessingInformationAuthorizationOptions.md deleted file mode 100644 index bf80b668f..000000000 --- a/docs/V2paymentsidcapturesProcessingInformationAuthorizationOptions.md +++ /dev/null @@ -1,12 +0,0 @@ - -# V2paymentsidcapturesProcessingInformationAuthorizationOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**authType** | **String** | Authorization type. Possible values: - **AUTOCAPTURE**: automatic capture. - **STANDARDCAPTURE**: standard capture. - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. For processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**verbalAuthCode** | **String** | Authorization code. **Forced Capture** Use this field to send the authorization code you received from a payment that you authorized outside the CyberSource system. **Verbal Authorization** Use this field in CAPTURE API to send the verbally received authorization code. For processor-specific information, see the auth_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**verbalAuthTransactionId** | **String** | Transaction ID (TID). | [optional] - - - diff --git a/docs/V2paymentsidcapturesProcessingInformationCaptureOptions.md b/docs/V2paymentsidcapturesProcessingInformationCaptureOptions.md deleted file mode 100644 index 8c8f64eb2..000000000 --- a/docs/V2paymentsidcapturesProcessingInformationCaptureOptions.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2paymentsidcapturesProcessingInformationCaptureOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**captureSequenceNumber** | [**BigDecimal**](BigDecimal.md) | Capture number when requesting multiple partial captures for one payment. Used along with _totalCaptureCount_ to track which capture is being processed. For example, the second of five captures would be passed to CyberSource as: - _captureSequenceNumber_ = 2, and - _totalCaptureCount_ = 5 | [optional] -**totalCaptureCount** | [**BigDecimal**](BigDecimal.md) | Total number of captures when requesting multiple partial captures for one payment. Used along with _captureSequenceNumber_ which capture is being processed. For example, the second of five captures would be passed to CyberSource as: - _captureSequenceNumber_ = 2, and - _totalCaptureCount_ = 5 | [optional] - - - diff --git a/docs/V2paymentsidrefundsMerchantInformation.md b/docs/V2paymentsidrefundsMerchantInformation.md deleted file mode 100644 index 279104744..000000000 --- a/docs/V2paymentsidrefundsMerchantInformation.md +++ /dev/null @@ -1,13 +0,0 @@ - -# V2paymentsidrefundsMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**merchantDescriptor** | [**V2paymentsMerchantInformationMerchantDescriptor**](V2paymentsMerchantInformationMerchantDescriptor.md) | | [optional] -**categoryCode** | **Integer** | Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**vatRegistrationNumber** | **String** | Your government-assigned tax identification number. For CtV processors, the maximum length is 20. For other processor-specific information, see the merchant_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**cardAcceptorReferenceNumber** | **String** | Reference number that facilitates card acceptor/corporation communication and record keeping. For processor-specific information, see the card_acceptor_ref_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] - - - diff --git a/docs/V2paymentsidrefundsOrderInformation.md b/docs/V2paymentsidrefundsOrderInformation.md deleted file mode 100644 index df31f9b2a..000000000 --- a/docs/V2paymentsidrefundsOrderInformation.md +++ /dev/null @@ -1,15 +0,0 @@ - -# V2paymentsidrefundsOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amountDetails** | [**V2paymentsidcapturesOrderInformationAmountDetails**](V2paymentsidcapturesOrderInformationAmountDetails.md) | | [optional] -**billTo** | [**V2paymentsidcapturesOrderInformationBillTo**](V2paymentsidcapturesOrderInformationBillTo.md) | | [optional] -**shipTo** | [**V2paymentsidcapturesOrderInformationShipTo**](V2paymentsidcapturesOrderInformationShipTo.md) | | [optional] -**lineItems** | [**List<V2paymentsidrefundsOrderInformationLineItems>**](V2paymentsidrefundsOrderInformationLineItems.md) | | [optional] -**invoiceDetails** | [**V2paymentsidcapturesOrderInformationInvoiceDetails**](V2paymentsidcapturesOrderInformationInvoiceDetails.md) | | [optional] -**shippingDetails** | [**V2paymentsidcapturesOrderInformationShippingDetails**](V2paymentsidcapturesOrderInformationShippingDetails.md) | | [optional] - - - diff --git a/docs/V2paymentsidrefundsOrderInformationLineItems.md b/docs/V2paymentsidrefundsOrderInformationLineItems.md deleted file mode 100644 index b4f98febe..000000000 --- a/docs/V2paymentsidrefundsOrderInformationLineItems.md +++ /dev/null @@ -1,29 +0,0 @@ - -# V2paymentsidrefundsOrderInformationLineItems - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**productCode** | **String** | Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. | [optional] -**productName** | **String** | For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the values related to shipping and handling. | [optional] -**productSku** | **String** | Identification code for the product. For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the values related to shipping and/or handling. | [optional] -**quantity** | [**BigDecimal**](BigDecimal.md) | For a payment or capture, this field is required when _productCode_ is not **default** or one of the values related to shipping and handling. | [optional] -**unitPrice** | **String** | Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**unitOfMeasure** | **String** | Unit of measure, or unit of measure code, for the item. | [optional] -**totalAmount** | **String** | Total amount for the item. Normally calculated as the unit price x quantity. | [optional] -**taxAmount** | **String** | Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must be in the same currency. The tax amount field is additive. The following example uses a two-exponent currency such as USD: 1. You include each line item in your request. ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80 ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included. This field is frequently used for Level II and Level III transactions. | [optional] -**taxRate** | **String** | Tax rate applied to the item. See \"Numbered Elements,\" page 14. Visa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional decimal places will be truncated). Mastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%). | [optional] -**taxAppliedAfterDiscount** | **String** | Flag to indicate how you handle discount at the line item level. - 0: no line level discount provided - 1: tax was calculated on the post-discount line item total - 2: tax was calculated on the pre-discount line item total `Note` Visa will inset 0 (zero) if an invalid value is included in this field. This field relates to the value in the _lineItems[].discountAmount_ field. | [optional] -**taxStatusIndicator** | **String** | Flag to indicate whether tax is exempted or not included. - 0: tax not included - 1: tax included - 2: transaction is not subject to tax | [optional] -**taxTypeCode** | **String** | Type of tax being applied to the item. Possible values: Below values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle** - 0000: unknown tax type - 0001: federal/national sales tax - 0002: state sales tax - 0003: city sales tax - 0004: local sales tax - 0005: municipal sales tax - 0006: other tax - 0010: value-added tax - 0011: goods and services tax - 0012: provincial sales tax - 0013: harmonized sales tax - 0014: Quebec sales tax (QST) - 0020: room tax - 0021: occupancy tax - 0022: energy tax - Blank: Tax not supported on line item. | [optional] -**amountIncludesTax** | **Boolean** | Flag that indicates whether the tax amount is included in the Line Item Total. | [optional] -**typeOfSupply** | **String** | Flag to indicate whether the purchase is categorized as goods or services. Possible values: - 00: goods - 01: services | [optional] -**commodityCode** | **String** | Commodity code or International description code used to classify the item. Contact your acquirer for a list of codes. | [optional] -**discountAmount** | **String** | Discount applied to the item. | [optional] -**discountApplied** | **Boolean** | Flag that indicates whether the amount is discounted. If you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets this field to **true**. | [optional] -**discountRate** | **String** | Rate the item is discounted. Maximum of 2 decimal places. Example 5.25 (=5.25%) | [optional] -**invoiceNumber** | **String** | Field to support an invoice number for a transaction. You must specify the number of line items that will include an invoice number. By default, the first line item will include an invoice number field. The invoice number field can be included for up to 10 line items. | [optional] -**taxDetails** | [**List<V2paymentsOrderInformationAmountDetailsTaxDetails>**](V2paymentsOrderInformationAmountDetailsTaxDetails.md) | | [optional] - - - diff --git a/docs/V2paymentsidrefundsPaymentInformation.md b/docs/V2paymentsidrefundsPaymentInformation.md deleted file mode 100644 index 77b391bfd..000000000 --- a/docs/V2paymentsidrefundsPaymentInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# V2paymentsidrefundsPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**V2paymentsidrefundsPaymentInformationCard**](V2paymentsidrefundsPaymentInformationCard.md) | | [optional] - - - diff --git a/docs/V2paymentsidrefundsPaymentInformationCard.md b/docs/V2paymentsidrefundsPaymentInformationCard.md deleted file mode 100644 index 38d5a1c3d..000000000 --- a/docs/V2paymentsidrefundsPaymentInformationCard.md +++ /dev/null @@ -1,17 +0,0 @@ - -# V2paymentsidrefundsPaymentInformationCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**number** | **String** | Customer’s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field for the encoded account number. For processor-specific information, see the customer_cc_number field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationMonth** | **String** | Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationYear** | **String** | Four-digit year in which the credit card expires. `Format: YYYY`. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**type** | **String** | Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover | [optional] -**accountEncoderId** | **String** | Identifier for the issuing bank that provided the customer’s encoded account number. Contact your processor for the bank’s ID. | [optional] -**issueNumber** | **String** | Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. The issue number is not required for Maestro (UK Domestic) transactions. | [optional] -**startMonth** | **String** | Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. The start date is not required for Maestro (UK Domestic) transactions. | [optional] -**startYear** | **String** | Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. The start date is not required for Maestro (UK Domestic) transactions. | [optional] - - - diff --git a/docs/V2paymentsidrefundsPointOfSaleInformation.md b/docs/V2paymentsidrefundsPointOfSaleInformation.md deleted file mode 100644 index c0f84e0a8..000000000 --- a/docs/V2paymentsidrefundsPointOfSaleInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# V2paymentsidrefundsPointOfSaleInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**emv** | [**V2paymentsidcapturesPointOfSaleInformationEmv**](V2paymentsidcapturesPointOfSaleInformationEmv.md) | | [optional] - - - diff --git a/docs/V2paymentsidrefundsProcessingInformation.md b/docs/V2paymentsidrefundsProcessingInformation.md deleted file mode 100644 index 4cfd250cb..000000000 --- a/docs/V2paymentsidrefundsProcessingInformation.md +++ /dev/null @@ -1,16 +0,0 @@ - -# V2paymentsidrefundsProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**paymentSolution** | **String** | Type of digital payment solution that is being used for the transaction. Possible Values: - **visacheckout**: Visa Checkout. - **001**: Apple Pay. - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct. - **006**: Android Pay. - **008**: Samsung Pay. | [optional] -**reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **String** | Value that links the current payment request to the original request. Set this value to the ID that was returned in the reply message from the original payment request. This value is used for: - Partial authorizations. - Split shipments. | [optional] -**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Litle**. | [optional] -**visaCheckoutId** | **String** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] -**purchaseLevel** | **String** | Set this field to 3 to indicate that the request includes Level III data. | [optional] -**recurringOptions** | [**V2paymentsidrefundsProcessingInformationRecurringOptions**](V2paymentsidrefundsProcessingInformationRecurringOptions.md) | | [optional] - - - diff --git a/docs/V2paymentsidrefundsProcessingInformationRecurringOptions.md b/docs/V2paymentsidrefundsProcessingInformationRecurringOptions.md deleted file mode 100644 index 86e23850c..000000000 --- a/docs/V2paymentsidrefundsProcessingInformationRecurringOptions.md +++ /dev/null @@ -1,10 +0,0 @@ - -# V2paymentsidrefundsProcessingInformationRecurringOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**loanPayment** | **Boolean** | Flag that indicates whether this is a payment towards an existing contractual loan. | [optional] - - - diff --git a/docs/V2paymentsidreversalsClientReferenceInformation.md b/docs/V2paymentsidreversalsClientReferenceInformation.md deleted file mode 100644 index 9fccc704e..000000000 --- a/docs/V2paymentsidreversalsClientReferenceInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2paymentsidreversalsClientReferenceInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**code** | **String** | Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. | [optional] -**comments** | **String** | Comments | [optional] - - - diff --git a/docs/V2paymentsidreversalsOrderInformation.md b/docs/V2paymentsidreversalsOrderInformation.md deleted file mode 100644 index 47b7b9b07..000000000 --- a/docs/V2paymentsidreversalsOrderInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# V2paymentsidreversalsOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**lineItems** | [**List<V2paymentsidreversalsOrderInformationLineItems>**](V2paymentsidreversalsOrderInformationLineItems.md) | | [optional] - - - diff --git a/docs/V2paymentsidreversalsOrderInformationLineItems.md b/docs/V2paymentsidreversalsOrderInformationLineItems.md deleted file mode 100644 index 836dd3ba4..000000000 --- a/docs/V2paymentsidreversalsOrderInformationLineItems.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2paymentsidreversalsOrderInformationLineItems - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**quantity** | [**BigDecimal**](BigDecimal.md) | For a payment or capture, this field is required when _productCode_ is not **default** or one of the values related to shipping and handling. | [optional] -**unitPrice** | **String** | Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] - - - diff --git a/docs/V2paymentsidreversalsPointOfSaleInformation.md b/docs/V2paymentsidreversalsPointOfSaleInformation.md deleted file mode 100644 index d0d8d2eaa..000000000 --- a/docs/V2paymentsidreversalsPointOfSaleInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# V2paymentsidreversalsPointOfSaleInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**emv** | [**InlineResponse201PointOfSaleInformationEmv**](InlineResponse201PointOfSaleInformationEmv.md) | | [optional] - - - diff --git a/docs/V2paymentsidreversalsProcessingInformation.md b/docs/V2paymentsidreversalsProcessingInformation.md deleted file mode 100644 index 9f227f95a..000000000 --- a/docs/V2paymentsidreversalsProcessingInformation.md +++ /dev/null @@ -1,15 +0,0 @@ - -# V2paymentsidreversalsProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**paymentSolution** | **String** | Type of digital payment solution that is being used for the transaction. Possible Values: - **visacheckout**: Visa Checkout. - **001**: Apple Pay. - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct. - **006**: Android Pay. - **008**: Samsung Pay. | [optional] -**reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**linkId** | **String** | Value that links the current payment request to the original request. Set this value to the ID that was returned in the reply message from the original payment request. This value is used for: - Partial authorizations. - Split shipments. | [optional] -**reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Litle**. | [optional] -**visaCheckoutId** | **String** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional] -**issuer** | [**V2paymentsProcessingInformationIssuer**](V2paymentsProcessingInformationIssuer.md) | | [optional] - - - diff --git a/docs/V2paymentsidreversalsReversalInformation.md b/docs/V2paymentsidreversalsReversalInformation.md deleted file mode 100644 index 6c8e507e2..000000000 --- a/docs/V2paymentsidreversalsReversalInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2paymentsidreversalsReversalInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amountDetails** | [**V2paymentsidreversalsReversalInformationAmountDetails**](V2paymentsidreversalsReversalInformationAmountDetails.md) | | [optional] -**reason** | **String** | Reason for the authorization reversal. Possible value: - 34: Suspected fraud CyberSource ignores this field for processors that do not support this value. | [optional] - - - diff --git a/docs/V2paymentsidreversalsReversalInformationAmountDetails.md b/docs/V2paymentsidreversalsReversalInformationAmountDetails.md deleted file mode 100644 index d966911dc..000000000 --- a/docs/V2paymentsidreversalsReversalInformationAmountDetails.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2paymentsidreversalsReversalInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] - - - diff --git a/docs/V2payoutsMerchantInformation.md b/docs/V2payoutsMerchantInformation.md deleted file mode 100644 index 40cb1c34b..000000000 --- a/docs/V2payoutsMerchantInformation.md +++ /dev/null @@ -1,13 +0,0 @@ - -# V2payoutsMerchantInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**categoryCode** | **Integer** | Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**submitLocalDateTime** | **String** | Time that the transaction was submitted in local time. The time is in hhmmss format. | [optional] -**vatRegistrationNumber** | **String** | Your government-assigned tax identification number. For CtV processors, the maximum length is 20. For other processor-specific information, see the merchant_vat_registration_number field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) | [optional] -**merchantDescriptor** | [**V2payoutsMerchantInformationMerchantDescriptor**](V2payoutsMerchantInformationMerchantDescriptor.md) | | [optional] - - - diff --git a/docs/V2payoutsMerchantInformationMerchantDescriptor.md b/docs/V2payoutsMerchantInformationMerchantDescriptor.md deleted file mode 100644 index e65ff4e1a..000000000 --- a/docs/V2payoutsMerchantInformationMerchantDescriptor.md +++ /dev/null @@ -1,15 +0,0 @@ - -# V2payoutsMerchantInformationMerchantDescriptor - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) For Payouts: * Paymentech (22) | [optional] -**locality** | **String** | Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**administrativeArea** | **String** | Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**postalCode** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**contact** | **String** | For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * FDCCompass (13) * Paymentech (13) | [optional] - - - diff --git a/docs/V2payoutsOrderInformation.md b/docs/V2payoutsOrderInformation.md deleted file mode 100644 index 9b914fa5f..000000000 --- a/docs/V2payoutsOrderInformation.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2payoutsOrderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**amountDetails** | [**V2payoutsOrderInformationAmountDetails**](V2payoutsOrderInformationAmountDetails.md) | | [optional] -**billTo** | [**V2payoutsOrderInformationBillTo**](V2payoutsOrderInformationBillTo.md) | | [optional] - - - diff --git a/docs/V2payoutsOrderInformationAmountDetails.md b/docs/V2payoutsOrderInformationAmountDetails.md deleted file mode 100644 index d13aebad7..000000000 --- a/docs/V2payoutsOrderInformationAmountDetails.md +++ /dev/null @@ -1,12 +0,0 @@ - -# V2payoutsOrderInformationAmountDetails - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**totalAmount** | **String** | Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**currency** | **String** | Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. | [optional] -**surchargeAmount** | **String** | The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. * Applicable only for CTV for Payouts. * CTV (<= 08) For processor-specific information, see the surcharge_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] - - - diff --git a/docs/V2payoutsOrderInformationBillTo.md b/docs/V2payoutsOrderInformationBillTo.md deleted file mode 100644 index df22464f0..000000000 --- a/docs/V2payoutsOrderInformationBillTo.md +++ /dev/null @@ -1,29 +0,0 @@ - -# V2payoutsOrderInformationBillTo - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**firstName** | **String** | Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**lastName** | **String** | Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**address1** | **String** | First line of the billing street address as it appears on the credit card issuer’s records. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**address2** | **String** | Additional address information. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**locality** | **String** | City of the billing address. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**administrativeArea** | **String** | State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**postalCode** | **String** | Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**phoneNumber** | **String** | Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**phoneType** | [**PhoneTypeEnum**](#PhoneTypeEnum) | Customer's phone number type. For Payouts: This field may be sent only for FDC Compass. Possible Values - * day * home * night * work | [optional] - - - -## Enum: PhoneTypeEnum -Name | Value ----- | ----- -DAY | "day" -HOME | "home" -NIGHT | "night" -WORK | "work" - - - diff --git a/docs/V2payoutsPaymentInformation.md b/docs/V2payoutsPaymentInformation.md deleted file mode 100644 index 1972868ad..000000000 --- a/docs/V2payoutsPaymentInformation.md +++ /dev/null @@ -1,10 +0,0 @@ - -# V2payoutsPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**card** | [**V2payoutsPaymentInformationCard**](V2payoutsPaymentInformationCard.md) | | [optional] - - - diff --git a/docs/V2payoutsPaymentInformationCard.md b/docs/V2payoutsPaymentInformationCard.md deleted file mode 100644 index 0a7c98597..000000000 --- a/docs/V2payoutsPaymentInformationCard.md +++ /dev/null @@ -1,14 +0,0 @@ - -# V2payoutsPaymentInformationCard - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | **String** | Type of card to authorize. * 001 Visa * 002 Mastercard * 003 Amex * 004 Discover | [optional] -**number** | **String** | Customer’s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field for the encoded account number. For processor-specific information, see the customer_cc_number field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationMonth** | **String** | Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**expirationYear** | **String** | Four-digit year in which the credit card expires. `Format: YYYY`. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**sourceAccountType** | **String** | Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases. * Debit transactions on Cielo and Comercio Latino. * Transactions with Brazilian-issued cards on CyberSource through VisaNet. * Applicable only for CTV. Note Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. * CH: Checking account * CR: Credit card account * SA: Savings account * UA: Universal Account For combo card transactions with Mastercard in Brazil on CyberSource through VisaNet, the **cardUsage** field is also supported. | [optional] - - - diff --git a/docs/V2payoutsProcessingInformation.md b/docs/V2payoutsProcessingInformation.md deleted file mode 100644 index f5be9ee77..000000000 --- a/docs/V2payoutsProcessingInformation.md +++ /dev/null @@ -1,14 +0,0 @@ - -# V2payoutsProcessingInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**businessApplicationId** | **String** | Payouts transaction type. Applicable Processors: FDC Compass, Paymentech, CtV Possible values: **Credit Card Bill Payment** - **CP**: credit card bill payment **Funds Disbursement** - **FD**: funds disbursement - **GD**: government disbursement - **MD**: merchant disbursement **Money Transfer** - **AA**: account to account. Sender and receiver are same person. - **PP**: person to person. Sender and receiver are different. **Prepaid Load** - **TU**: top up | [optional] -**networkRoutingOrder** | **String** | This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only. The networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order. Note: Supported only in US for domestic transactions involving Push Payments Gateway Service. VisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order. If an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer’s preference. If an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer’s routing priorities. See https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code , under section 'Network ID and Sharing Group Code' on the left panel for available values | [optional] -**commerceIndicator** | **String** | Type of transaction. Possible value for Fast Payments transactions: - internet | [optional] -**reconciliationId** | **String** | Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). | [optional] -**payoutsOptions** | [**V2payoutsProcessingInformationPayoutsOptions**](V2payoutsProcessingInformationPayoutsOptions.md) | | [optional] - - - diff --git a/docs/V2payoutsProcessingInformationPayoutsOptions.md b/docs/V2payoutsProcessingInformationPayoutsOptions.md deleted file mode 100644 index d5aea35ac..000000000 --- a/docs/V2payoutsProcessingInformationPayoutsOptions.md +++ /dev/null @@ -1,13 +0,0 @@ - -# V2payoutsProcessingInformationPayoutsOptions - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**acquirerMerchantId** | **String** | This field identifies the card acceptor for defining the point of service terminal in both local and interchange environments. An acquirer-assigned code identifying the card acceptor for the transaction. Depending on the acquirer and merchant billing and reporting requirements, the code can represent a merchant, a specific merchant location, or a specific merchant location terminal. Acquiring Institution Identification Code uniquely identifies the merchant. The value from the original is required in any subsequent messages, including reversals, chargebacks, and representments. * Applicable only for CTV for Payouts. | [optional] -**acquirerBin** | **String** | This code identifies the financial institution acting as the acquirer of this customer transaction. The acquirer is the member or system user that signed the merchant or ADM or dispensed cash. This number is usually Visa-assigned. * Applicable only for CTV for Payouts. | [optional] -**retrievalReferenceNumber** | **String** | This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set. * Applicable only for CTV for Payouts. | [optional] -**accountFundingReferenceId** | **String** | Visa-generated transaction identifier (TID) that is unique for each original authorization and financial request. * Applicable only for CTV for Payouts. | [optional] - - - diff --git a/docs/V2payoutsRecipientInformation.md b/docs/V2payoutsRecipientInformation.md deleted file mode 100644 index ceea91c49..000000000 --- a/docs/V2payoutsRecipientInformation.md +++ /dev/null @@ -1,19 +0,0 @@ - -# V2payoutsRecipientInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**firstName** | **String** | First name of recipient. characters. * CTV (14) * Paymentech (30) | [optional] -**middleInitial** | **String** | Middle Initial of recipient. Required only for FDCCompass. | [optional] -**lastName** | **String** | Last name of recipient. characters. * CTV (14) * Paymentech (30) | [optional] -**address1** | **String** | Recipient address information. Required only for FDCCompass. | [optional] -**locality** | **String** | Recipient city. Required only for FDCCompass. | [optional] -**administrativeArea** | **String** | Recipient State. Required only for FDCCompass. | [optional] -**country** | **String** | Recipient country code. Required only for FDCCompass. | [optional] -**postalCode** | **String** | Recipient postal code. Required only for FDCCompass. | [optional] -**phoneNumber** | **String** | Recipient phone number. Required only for FDCCompass. | [optional] -**dateOfBirth** | **String** | Recipient date of birth in YYYYMMDD format. Required only for FDCCompass. | [optional] - - - diff --git a/docs/V2payoutsSenderInformation.md b/docs/V2payoutsSenderInformation.md deleted file mode 100644 index 895cd6be2..000000000 --- a/docs/V2payoutsSenderInformation.md +++ /dev/null @@ -1,23 +0,0 @@ - -# V2payoutsSenderInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**referenceNumber** | **String** | Reference number generated by you that uniquely identifies the sender. | [optional] -**account** | [**V2payoutsSenderInformationAccount**](V2payoutsSenderInformationAccount.md) | | [optional] -**firstName** | **String** | First name of sender (Optional). * CTV (14) * Paymentech (30) | [optional] -**middleInitial** | **String** | Recipient middle initial (Optional). | [optional] -**lastName** | **String** | Recipient last name (Optional). * CTV (14) * Paymentech (30) | [optional] -**name** | **String** | Name of sender. **Funds Disbursement** This value is the name of the originator sending the funds disbursement. * CTV, Paymentech (30) | [optional] -**address1** | **String** | Street address of sender. **Funds Disbursement** This value is the address of the originator sending the funds disbursement. | [optional] -**locality** | **String** | City of sender. **Funds Disbursement** This value is the city of the originator sending the funds disbursement. | [optional] -**administrativeArea** | **String** | Sender’s state. Use the State, Province, and Territory Codes for the United States and Canada. | [optional] -**countryCode** | **String** | Country of sender. Use the ISO Standard Country Codes. * CTV (3) | [optional] -**postalCode** | **String** | Sender’s postal code. Required only for FDCCompass. | [optional] -**phoneNumber** | **String** | Sender’s phone number. Required only for FDCCompass. | [optional] -**dateOfBirth** | **String** | Sender’s date of birth in YYYYMMDD format. Required only for FDCCompass. | [optional] -**vatRegistrationNumber** | **String** | Customer's government-assigned tax identification number. | [optional] - - - diff --git a/docs/V2payoutsSenderInformationAccount.md b/docs/V2payoutsSenderInformationAccount.md deleted file mode 100644 index f74b5c13e..000000000 --- a/docs/V2payoutsSenderInformationAccount.md +++ /dev/null @@ -1,11 +0,0 @@ - -# V2payoutsSenderInformationAccount - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**fundsSource** | **String** | Source of funds. Possible values: Paymentech, CTV, FDC Compass: - 01: Credit card - 02: Debit card - 03: Prepaid card Paymentech, CTV - - 04: Cash - 05: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings accounts, and proprietary debit or ATM cards. - 06: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines of credit. FDCCompass - - 04: Deposit Account **Funds Disbursement** This value is most likely 05 to identify that the originator used a deposit account to fund the disbursement. **Credit Card Bill Payment** This value must be 02, 03, 04, or 05. | [optional] -**number** | **String** | The account number of the entity funding the transaction. It is the sender’s account number. It can be a debit/credit card account number or bank account number. **Funds disbursements** This field is optional. **All other transactions** This field is required when the sender funds the transaction with a financial instrument, for example debit card. Length: * FDCCompass (<= 19) * Paymentech (<= 16) | [optional] - - - diff --git a/docs/VoidApi.md b/docs/VoidApi.md index 1ad90331d..377774278 100644 --- a/docs/VoidApi.md +++ b/docs/VoidApi.md @@ -4,12 +4,58 @@ All URIs are relative to *https://apitest.cybersource.com* Method | HTTP request | Description ------------- | ------------- | ------------- +[**mitVoid**](VoidApi.md#mitVoid) | **POST** /pts/v2/voids/ | Merchant Initiated Void [**voidCapture**](VoidApi.md#voidCapture) | **POST** /pts/v2/captures/{id}/voids | Void a Capture [**voidCredit**](VoidApi.md#voidCredit) | **POST** /pts/v2/credits/{id}/voids | Void a Credit [**voidPayment**](VoidApi.md#voidPayment) | **POST** /pts/v2/payments/{id}/voids | Void a Payment [**voidRefund**](VoidApi.md#voidRefund) | **POST** /pts/v2/refunds/{id}/voids | Void a Refund + +# **mitVoid** +> PtsV2PaymentsVoidsPost201Response mitVoid(mitVoidRequest) + +Merchant Initiated Void + +This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply. + +### Example +```java +// Import classes: +//import Invokers.ApiException; +//import Api.VoidApi; + + +VoidApi apiInstance = new VoidApi(); +MitVoidRequest mitVoidRequest = new MitVoidRequest(); // MitVoidRequest | +try { + PtsV2PaymentsVoidsPost201Response result = apiInstance.mitVoid(mitVoidRequest); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling VoidApi#mitVoid"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **mitVoidRequest** | [**MitVoidRequest**](MitVoidRequest.md)| | + +### Return type + +[**PtsV2PaymentsVoidsPost201Response**](PtsV2PaymentsVoidsPost201Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/json;charset=utf-8 + # **voidCapture** > PtsV2PaymentsVoidsPost201Response voidCapture(voidCaptureRequest, id) diff --git a/generator/cybersource-rest-spec.json b/generator/cybersource-rest-spec.json index b697af01b..481d1dda9 100644 --- a/generator/cybersource-rest-spec.json +++ b/generator/cybersource-rest-spec.json @@ -1,26512 +1,30669 @@ { - "swagger": "2.0", - "info": { - "description": "Simple PAN tokenization service", - "version": "0.0.1", - "title": "CyberSource Flex API" - }, - "host": "apitest.cybersource.com", - "schemes": [ - "https" - ], - "basePath": "/", - "consumes": [ - "application/json;charset=utf-8" - ], - "produces": [ - "application/json;charset=utf-8" - ], - "tags": [{ - "name": "Flex API" - } - ], - "paths": { - "/flex/v1/keys/": { - "x-name": "Generate Key", - "x-description": "Generate a one-time use public key and key ID to encrypt the card number in the follow-on Tokenize Card request. The key used to encrypt the card number on the cardholder\u2019s device or browser is valid for 15 minutes and must be used to verify the signature in the response message. CyberSource recommends creating a new key for each order. Generating a key is an authenticated request initiated from your servers, prior to requesting to tokenize the card data from your customer\u2019s device or browser.", - "post": { - "tags": [ - "KeyGeneration" - ], - "summary": "Generate Key", - "description": "Generate a one-time use public key and key ID to encrypt the card number in the follow-on Tokenize Card request. The key used to encrypt the card number on the cardholder\u2019s device or browser is valid for 15 minutes and must be used to verify the signature in the response message. CyberSource recommends creating a new key for each order. Generating a key is an authenticated request initiated from your servers, prior to requesting to tokenize the card data from your customer\u2019s device or browser.", - "operationId": "generatePublicKey", - "produces": [ - "application/json" - ], - "parameters": [{ - "in": "body", - "name": "generatePublicKeyRequest", - "schema": { - "required": [ - "encryptionType" - ], + "swagger": "2.0", + "info": { + "description": "All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html", + "version": "0.0.1", + "title": "CyberSource Merged Spec" + }, + "host": "apitest.cybersource.com", + "schemes": [ + "https" + ], + "basePath": "/", + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "tags": [], + "x-devcenter-metaData": { + "categoryTagArray": [] + }, + "paths": { + "/flex/v1/keys": { + "x-name": "Generate Key", + "x-description": "Generate a one-time use public key and key ID to encrypt the card number in the follow-on Tokenize Card request. The key used to encrypt the card number on the cardholder\u2019s device or browser is valid for 15 minutes and must be used to verify the signature in the response message. CyberSource recommends creating a new key for each order. Generating a key is an authenticated request initiated from your servers, prior to requesting to tokenize the card data from your customer\u2019s device or browser.", + "post": { + "tags": [ + "Key Generation" + ], + "summary": "Generate Key", + "description": "Generate a one-time use public key and key ID to encrypt the card number in the follow-on Tokenize Card request. The key used to encrypt the card number on the cardholder\u2019s device or browser is valid for 15 minutes and must be used to verify the signature in the response message. CyberSource recommends creating a new key for each order. Generating a key is an authenticated request initiated from your servers, prior to requesting to tokenize the card data from your customer\u2019s device or browser.", + "operationId": "generatePublicKey", + "x-devcenter-metaData": { + "categoryTag": "Flex" + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "generatePublicKeyRequest", + "required": true, + "schema": { + "type": "object", + "required": [ + "encryptionType" + ], + "properties": { + "encryptionType": { + "type": "string", + "description": "How the card number should be encrypted in the subsequent Tokenize Card request. Possible values are RsaOaep256 or None (if using this value the card number must be in plain text when included in the Tokenize Card request). The Tokenize Card request uses a secure connection (TLS 1.2+) regardless of what encryption type is specified." + } + } + } + } + ], + "x-example": { + "example0": { + "summary": "Generate Key", + "value": { + "encryptionType": "RsaOaep256" + } + } + }, + "responses": { + "200": { + "description": "Retrieved key.", + "schema": { + "title": "flexV1KeysPost200Response", + "properties": { + "keyId": { + "type": "string", + "description": "Unique identifier for the generated token. Used in the subsequent Tokenize Card request from your customer\u2019s device or browser." + }, + "der": { + "type": "object", + "description": "The public key in DER format. Used to validate the response from the Tokenize Card request. Additionally this format is useful for client side encryption in Android and iOS implementations.", + "properties": { + "format": { + "type": "string", + "description": "Specifies the format of the public key; currently X.509." + }, + "algorithm": { + "type": "string", + "description": "Algorithm used to encrypt the public key." + }, + "publicKey": { + "type": "string", + "description": "Base64 encoded public key value." + } + } + }, + "jwk": { + "type": "object", + "description": "The public key in JSON Web Key (JWK) format. This format is useful for client side encryption in JavaScript based implementations.", + "properties": { + "kty": { + "type": "string", + "description": "Algorithm used to encrypt the public key." + }, + "use": { + "type": "string", + "description": "Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc." + }, + "kid": { + "type": "string", + "description": "The key ID in JWK format." + }, + "n": { + "type": "string", + "description": "JWK RSA Modulus" + }, + "e": { + "type": "string", + "description": "JWK RSA Exponent" + } + } + } + } + } + }, + "default": { + "description": "Error retrieving key.", + "schema": { + "type": "object", + "properties": { + "responseStatus": { + "properties": { + "status": { + "type": "number", + "description": "HTTP Status code." + }, + "reason": { + "type": "string", + "description": "Error Reason Code." + }, + "message": { + "type": "string", + "description": "Error Message." + }, + "correlationId": { + "type": "string", + "description": "API correlation ID." + }, + "details": { + "type": "array", + "items": { + "properties": { + "location": { + "type": "string", + "description": "Field name referred to for validation issues." + }, + "message": { + "type": "string", + "description": "Description or code of any error response." + } + } + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "next": { + "type": "array", + "items": { + "properties": { + "href": { + "type": "string", + "description": "URI of the linked resource." + }, + "title": { + "type": "string", + "description": "Label of the linked resource." + }, + "method": { + "type": "string", + "description": "HTTP method of the linked resource." + } + } + } + }, + "documentation": { + "type": "array", + "items": { + "properties": { + "href": { + "type": "string", + "description": "URI of the linked resource." + }, + "title": { + "type": "string", + "description": "Label of the linked resource." + }, + "method": { + "type": "string", + "description": "HTTP method of the linked resource." + } + } + } + }, + "self": { + "properties": { + "href": { + "type": "string", + "description": "URI of the linked resource." + }, + "title": { + "type": "string", + "description": "Label of the linked resource." + }, + "method": { + "type": "string", + "description": "HTTP method of the linked resource." + } + } + } + } + } + } + } + } + }, + "x-samplePayload": { + "encryptionType": "RsaOaep256" + }, + "x-sampleResponse": { + "keyId": "05BgbFie7vX5vzSMKOoqEAAdfpdR4kas", + "der": { + "format": "X.509", + "algorithm": "RSA", + "publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAgC1G6rVue4w/jjJrKPZusGN9G+Y7mWuLJ0O2/GHd94LvR51+ok7ahuQUVMZLdigixnspaGo/WVLvTTZ5J28Cc1uSx0o/BsxpNaAQD8/aBZL3nnAiBLACxI1JHAVo7SXbJQmz+mqVFYTppg9QmpB2ATTmXjUOQy+Fqkw3EByfCANHhHSNs4+HASovsfcRMUmmvDfTd5qBb23KzDJeDVqTYWa3XjUorlZOCJuLyPgeDEK8oOC9C4W9dn32z8FJ4E6Dz28M/2O3g8FLQD2F+NezkQJsl8MEYo4rl1nr7/oIkMsYLCCoG8jwmryErb7km9JWWgqZ80trkjijFqDAbHfUEwIDAQAB" + }, + "jwk": { + "kty": "RSA", + "use": "enc", + "kid": "05BgbFie7vX5vzSMKOoqEAAdfpdR4kas", + "n": "fC1G6rVue4w_jjJrKPZusGN9G-Y7mWuLJ0O2_GHd94LvR51-ok7ahuQUVMZLdigixnspaGo_WVLvTTZ5J28Cc1uSx0o_BsxpNaAQD8_aBZL3nnAiBLACxI1JHAVo7SXAJQmz-mqVFYTppg9QmpB2ATTmXjUOQy-Fqkw3EByfCANHhHSNs4-HASovsfcRMUmmvDfTd5qBb23KzDJeDVqTYWa3XjUorlZOCJuLyPgeDEK8oOC9C4W9dn32z8FJ4E6Dz28M_2O3g8FLQD2F-NezkQJsl8MEYo4rl1nr7_oIkMsYLCCoG8jwmryErb7km9JWWgqZ80trkjijFqDAbHfUEw", + "e": "AQAB" + } + } + } + }, + "/flex/v1/tokens": { + "x-name": "Tokenize Card", + "x-description": "Returns a token representing the supplied card details. The token replaces card data and can be used as the Subscription ID in the CyberSource Simple Order API or SCMP API. This is an unauthenticated call that you should initiate from your customer\u2019s device or browser.", + "post": { + "tags": [ + "tokenization" + ], + "summary": "Tokenize card", + "description": "Returns a token representing the supplied card details. The token replaces card data and can be used as the Subscription ID in the CyberSource Simple Order API or SCMP API. This is an unauthenticated call that you should initiate from your customer\u2019s device or browser.", + "operationId": "tokenize", + "x-devcenter-metaData": { + "categoryTag": "Flex", + "isClientSideApi": true, + "noAuth": true + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "tokenizeRequest", + "required": true, + "schema": { + "type": "object", + "required": [ + "keyId" + ], + "properties": { + "keyId": { + "type": "string", + "description": "Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key." + }, + "cardInfo": { + "type": "object", + "required": [ + "cardNumber", + "cardType" + ], + "properties": { + "cardNumber": { + "type": "string", + "description": "Encrypted or plain text card number. If the encryption type of \u201cNone\u201d was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders\u2019 device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request." + }, + "cardExpirationMonth": { + "type": "string", + "description": "Two digit expiration month" + }, + "cardExpirationYear": { + "type": "string", + "description": "Four digit expiration year" + }, + "cardType": { + "type": "string", + "description": "Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types." + } + } + } + } + } + } + ], + "x-example": { + "example0": { + "summary": "Flex Tokenize Card", + "value": { + "keyId": "08z9hCmn4pRpdNhPJBEYR3Mc2DGLWq5j", + "cardInfo": { + "cardNumber": "4111111111111111", + "cardExpirationMonth": "12", + "cardExpirationYear": "2031", + "cardType": "001" + } + } + } + }, + "responses": { + "200": { + "description": "Created payment token.", + "schema": { + "title": "flexV1TokensPost200Response", + "properties": { + "keyId": { + "type": "string", + "description": "The Key ID." + }, + "token": { + "type": "string", + "description": "The generated token. The token replaces card data and is used as the Subscription ID in the CyberSource Simple Order API or SCMP API." + }, + "maskedPan": { + "type": "string", + "description": "The masked card number displaying the first 6 digits and the last 4 digits." + }, + "cardType": { + "type": "string", + "description": "The card type." + }, + "timestamp": { + "type": "integer", + "format": "int64", + "description": "The UTC date and time in milliseconds at which the signature was generated." + }, + "signedFields": { + "type": "string", + "description": "Indicates which fields from the response make up the data that is used when verifying the response signature. See the [sample code] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/java/com/cybersource/flex/application/CheckoutController.java) on how to verify the signature." + }, + "signature": { + "type": "string", + "description": "Flex-generated digital signature. To ensure the values have not been tampered with while passing through the client, verify this server-side using the public key generated from the /keys resource." + }, + "discoverableServices": { + "type": "object", + "additionalProperties": { + "type": "object" + } + } + } + } + }, + "default": { + "description": "Error creating token.", + "schema": { + "type": "object", + "properties": { + "responseStatus": { + "properties": { + "status": { + "type": "number", + "description": "HTTP Status code." + }, + "reason": { + "type": "string", + "description": "Error Reason Code." + }, + "message": { + "type": "string", + "description": "Error Message." + }, + "correlationId": { + "type": "string", + "description": "API correlation ID." + }, + "details": { + "type": "array", + "items": { + "properties": { + "location": { + "type": "string", + "description": "Field name referred to for validation issues." + }, + "message": { + "type": "string", + "description": "Description or code of any error response." + } + } + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "next": { + "type": "array", + "items": { + "properties": { + "href": { + "type": "string", + "description": "URI of the linked resource." + }, + "title": { + "type": "string", + "description": "Label of the linked resource." + }, + "method": { + "type": "string", + "description": "HTTP method of the linked resource." + } + } + } + }, + "documentation": { + "type": "array", + "items": { + "properties": { + "href": { + "type": "string", + "description": "URI of the linked resource." + }, + "title": { + "type": "string", + "description": "Label of the linked resource." + }, + "method": { + "type": "string", + "description": "HTTP method of the linked resource." + } + } + } + }, + "self": { + "properties": { + "href": { + "type": "string", + "description": "URI of the linked resource." + }, + "title": { + "type": "string", + "description": "Label of the linked resource." + }, + "method": { + "type": "string", + "description": "HTTP method of the linked resource." + } + } + } + } + } + } + } + } + }, + "x-samplePayload": { + "keyId": "05BgbFie7vX5vzSMKOoqEAAdfpdR4kas", + "cardDetails": { + "cardNumber": "ejbhIpMEgYnIODcB4//rrVxMHrqHcnLD6pDRF36jlEk72bETAfiOoxmpI9pGiidqMmkgAnvJfVgR3CLAV5EdG4Mu5IWK26QRnVtwvsVEUtpah7IylbxV9MLvXh2FjIJskKCWNLidb1G4PN5963hnV3IoZd2pF99JwV9lPhOHT5ymlNeg7sTzQQDN1I0/yJApds+t79hl9QVp4PusUDfSsPQTtR2frzlH4V3W+XjHDhmy5oNhiUaVxv27cyG1SWeCKkVC9tc8zLy4pvlgoplrLV8JRaS9hfWalJjv2xtk3DXmNT2urtFv2evcI3LM/S29KlJjPXZcBp0IYyB/taunCA==", + "cardType": "001" + } + }, + "x-sampleResponse": { + "keyId": "05BgbFie7vX5vzSMKOoqEAAdfpdR4kas", + "token": "0100153497304242", + "maskedPan": "424242XXXXXX4242", + "cardType": "001", + "timestamp": 1472733222651, + "signedFields": "token,cardType,maskedPan,timestamp", + "signature": "TcM7METFOIidwbxWG2Xhawx/5gZ7hZB0Lyrhg3NRJ+Pma+Nq7BugvsqLCE2R24+h13xnM6vpJXR2cqfQPkxhb6joJT8jcciEf+lj6h/KjvXuR4pJ4fMll4WS1Z4+574ps0ysV/5zs7kT2IAZj7i+szlYwFJxGhOGC0218x1N0NxELTDyU/HI6n+Aa+mYBqkMXth42t+GNQ7goVXkJWRgQSjp2v0WTh2d2plDnxEWPURZXz7GLdQXRIYUWWx/L5JSf88F1zgjYDpBitNSYBMMILKfDd3KEg+6nIruCln5kDMbTRD8LwPpGYC9tyM9+UM8MBINPHhaqdFp2wHF7dccKA==", + "discoverableServices": {} + } + } + }, + "/pts/v2/payments/": { + "post": { + "summary": "Process a Payment", + "description": "Authorize the payment for the transaction.\n", + "tags": [ + "payments" + ], + "operationId": "createPayment", + "x-devcenter-metaData": { + "categoryTag": "Payments" + }, + "parameters": [ + { + "name": "createPaymentRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "transactionId": { + "type": "string", + "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nSee page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "originalTransactionId": { + "type": "string", + "maxLength": 32, + "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "capture": { + "type": "boolean", + "description": "Flag that specifies whether to also include capture service in the submitted request or not.\n\nPossible values:\n- **true**\n- **false** (default).\n", + "enum": [ + true, + false + ], + "default": false + }, + "processorId": { + "type": "string", + "maxLength": 3, + "description": "Value that identifies the processor/acquirer to use for the transaction. This value is supported only for\n**CyberSource through VisaNet**.\n\nContact CyberSource Customer Support to get the value for this field.\n" + }, + "businessApplicationId": { + "type": "string", + "description": "The description for this field is not available." + }, + "commerceIndicator": { + "type": "string", + "maxLength": 20, + "description": "Type of transaction. Some payment card companies use this information when determining discount rates. When you\nomit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file\nfor you instead of the default value listed here.\n" + }, + "paymentSolution": { + "type": "string", + "maxLength": 12, + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" + }, + "linkId": { + "type": "string", + "maxLength": 26, + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n" + }, + "purchaseLevel": { + "type": "string", + "maxLength": 1, + "description": "Set this field to 3 to indicate that the request includes Level III data." + }, + "reportGroup": { + "type": "string", + "maxLength": 25, + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n" + }, + "visaCheckoutId": { + "type": "string", + "maxLength": 48, + "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n" + }, + "authorizationOptions": { + "type": "object", + "properties": { + "authType": { + "type": "string", + "maxLength": 15, + "description": "Authorization type.\n\nPossible values:\n\n - **AUTOCAPTURE**: automatic capture.\n - **STANDARDCAPTURE**: standard capture.\n - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n**Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing**\\\nSet this field to _AUTOCAPTURE_ and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to STANDARDCAPTURE and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see \"Automatic Captures,\" page 33.\n\n**Forced Capture**\\\nSet this field to _VERBAL_ and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. For more information, see \"Forced Captures,\" page 123.\n\n**Verbal Authorization**\\\nSet this field to _VERBAL_ and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations,\" page 84.\n\nFor processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "verbalAuthCode": { + "type": "string", + "maxLength": 7, + "description": "Authorization code.\n\n**Forced Capture**\\\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n**Verbal Authorization**\\\nUse this field in CAPTURE API to send the verbally received authorization code.\n\nFor processor-specific information, see the _auth_code_ field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "verbalAuthTransactionId": { + "type": "string", + "maxLength": 15, + "description": "Transaction ID (TID)." + }, + "authIndicator": { + "type": "string", + "maxLength": 1, + "description": "Flag that specifies the purpose of the authorization.\n\nPossible values:\n - **0**: Preauthorization\n - **1**: Final authorization\n\nTo set the default for this field, contact CyberSource Customer Support.\nSee \"Final Authorization Indicator,\" page 119.\n\nBarclays and Elavon\nThe default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support.\n\nCyberSource through VisaNet\nWhen the value for this field is 0, it corresponds to the following data in the TC 33 capture file5:\n - Record: CP01 TCR0\n - Position: 164\n - Field: Additional Authorization Indicators\nWhen the value for this field is 1, it does not correspond to any data in the TC 33 capture file.\n\nFor processor-specific information, see the auth_indicator field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "partialAuthIndicator": { + "type": "boolean", + "description": "Flag that indicates whether the transaction is enabled for partial authorization or not. When your request\nincludes this field, this value overrides the information in your CyberSource account. For processor-specific\ninformation, see the _auth_partial_auth_indicator_ field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\\\nTo set the default for this field, contact CyberSource Customer Support.\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR0\n- Position: 164\n- Field: Additional Authorization Indicators\n\nPossible values:\n- **true** Enable the transaction for partial authorization.\n- **false** Do not enable the transaction for partial authorization.\n", + "enum": [ + true, + false + ] + }, + "balanceInquiry": { + "type": "boolean", + "description": "Flag that indicates whether to return balance information.\n\nPossible values:\n- **true**\n- **false**\n", + "enum": [ + true, + false + ] + }, + "ignoreAvsResult": { + "type": "boolean", + "description": "Flag that indicates whether to allow the capture service to run, even when the payment\nreceives an AVS decline.\n\nPossible values:\n- **true** Ignore the results of AVS checking and run the capture service.\n- **false** (default): If the authorization receives an AVS decline, do not run the capture service.\n", + "enum": [ + true, + false + ], + "default": false + }, + "declineAvsFlags": { + "type": "array", + "description": "An array of AVS flags that cause the reply flag to be returned.\n\n`Important` To receive declines for the AVS code N, include the value N in the array.\n\nPossible values:\n- D\n- A\n- V\n- S\n- N\n- O\n", + "items": { + "type": "string", + "enum": [ + "D", + "A", + "V", + "S", + "N", + "O" + ] + } + }, + "ignoreCvResult": { + "type": "boolean", + "description": "Flag that indicates whether to allow the capture service to run even when\nthe payment receives a CVN decline.\n\nPossible values:\n- **true** Ignore the results of CVN checking and run the capture service.\n- **false** (default) If the authorization receives a CVN decline, do not run the capture service.\n", + "enum": [ + true, + false + ], + "default": false + }, + "initiator": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction.\n\nValid values:\n- **customer**\n- **merchant**\n", + "enum": [ + "customer", + "merchant" + ] + }, + "credentialStoredOnFile": { + "type": "boolean", + "description": "Flag that indicates whether merchant intends to use this transaction to store payment credentials for follow-up\nmerchant-initiated transactions.\n\nValid values:\n- `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n- `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n\nSee \"Merchant-Initiated Transactions,\" page 177.\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\nThis field is supported only for Visa transactions on CyberSource through VisaNet.\n", + "enum": [ + true, + false + ] + }, + "storedCredentialUsed": { + "type": "boolean", + "description": "Flag that indicates whether merchant is intend to use this transaction to store payment credential for follow-up\nmerchant-initiated transactions or not.\n\nPossible values:\n- **true**\n- **false**\n", + "enum": [ + true, + false + ] + }, + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "maxLength": 1, + "description": "Reason for the merchant-initiated transaction or incremental authorization. Possible values:\n- `1`: Resubmission\n- `2`: Delayed charge\n- `3`: Reauthorization for split shipment\n- `4`: No show\n- `5`: Account top up\nThis field is required only for the five kinds of transactions in the preceding list.\nThis field is supported only for merchant-initiated transactions and incremental authorizations.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR0\n- Position: 160-163\n- Field: Message Reason Code\n\n**All Processors**\\\nSee \"Merchant-Initiated Transactions,\" page 196. For CyberSource through VisaNet, see also \"Incremental Authorizations,\" page 40.\n" + }, + "previousTransactionId": { + "type": "string", + "maxLength": 15, + "description": "Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_\nin the reply message for either the original merchant-initiated payment in the series or the previous\nmerchant-initiated payment in the series.\n\nIf the current payment request includes a token instead of an account number, the following time limits apply for the value of this field:\n- For a **resubmission**, the transaction ID must be less than 14 days old.\n- For a **delayed charge** or **reauthorization**, the transaction ID must be less than 30 days old.\n\n**NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported\nonly for Visa transactions on CyberSource through VisaNet.\n" + } + } + } + } + }, + "billPayment": { + "type": "boolean", + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan. See \"Visa Bill Payments,\" page 220, and \"Visa Debt Repayments,\" page 221, for lists of processors that support these features.\n\nPossible values:\n- true: Bill payment or loan payment.\n- false (default): Not a bill payment or loan payment.\n" + }, + "billPaymentType": { + "type": "string", + "description": "Reason for the payment.\n\nPossible values:\n- 001: Utility payment\n- 002: Government services\n- 003: Mobile phone top-up\n- 004: Coupon payment\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR0\n- Position: 48-50\n- Field: Bill Payment Transaction Type Identifier\n\nThis field is supported only for bill payments in Brazil with Mastercard on CyberSource through VisaNet.\nSee Mastercard Bill Payments.\n\nNote For information about bill payments with Visa, see Visa Bill Payments.\n" + } + } + }, + "captureOptions": { + "type": "object", + "properties": { + "captureSequenceNumber": { + "type": "number", + "minimum": 1, + "maximum": 99, + "description": "Capture number when requesting multiple partial captures for one payment.\nUsed along with _totalCaptureCount_ to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n" + }, + "totalCaptureCount": { + "type": "number", + "minimum": 1, + "maximum": 99, + "description": "Total number of captures when requesting multiple partial captures for one payment.\nUsed along with _captureSequenceNumber_ which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n" + }, + "dateToCapture": { + "type": "string", + "maxLength": 4, + "description": "Date on which you want the capture to occur. This field is supported only for CyberSource through VisaNet.\\\n`Format: MMDD`\n" + } + } + }, + "recurringOptions": { + "type": "object", + "properties": { + "loanPayment": { + "type": "boolean", + "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- **true** Loan payment\n- **false** (default) Not a loan payment\n\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\n", + "enum": [ + true, + false + ], + "default": false + }, + "firstRecurringPayment": { + "type": "boolean", + "description": "Flag that indicates whether this transaction is the first in a series of recurring payments.\n\nThis field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**.\n\nPossible values:\n - **true** Indicates this is the first payment in a series of recurring payments\n - **false** (default) Indicates this is not the first payment in a series of recurring payments.\n\nFor more details, see \"Recurring Payments,\" page 198.\n", + "enum": [ + true, + false + ], + "default": false + } + } + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "declineAvsFlags": { + "type": "string", + "maxLength": 15, + "description": "List of AVS flags that cause the request to be declined for AVS reasons. Use a space to separate the flags in\nthe list. Important Make sure that you include the value N in the list if you want to receive declines for the\nAVS code N.\n" + }, + "secCode": { + "type": "string", + "maxLength": 3, + "description": "Authorization method used for the transaction. See \"SEC Codes,\" page 89.\n\nTeleCheck Accepts only the following values:\n- **PPD**\n- **TEL**\n- **WEB**\n" + }, + "terminalCity": { + "type": "string", + "maxLength": 4, + "description": "City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction\nwill be declined.\n\nYou cannot include any special characters.\n" + }, + "terminalState": { + "type": "string", + "maxLength": 2, + "description": "State in which the terminal is located. If more than two alphanumeric characters are submitted, the transaction\nwill be declined.\n\nYou cannot include any special characters.\n" + }, + "effectiveDate": { + "type": "string", + "maxLength": 8, + "description": "Effective date for the transaction. The effective date must be within 45 days of the current day. If you do not\ninclude this value, CyberSource sets the effective date to the next business day.\n\nFormat: `MMDDYYYY`\n\nSupported only for the CyberSource ACH Service.\n" + }, + "partialPaymentId": { + "type": "string", + "maxLength": 25, + "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order. See \"Multiple\nPartial Credits,\" page 41.\n" + }, + "customerMemo": { + "type": "string", + "maxLength": 80, + "description": "Payment related information.\n\nThis information is included on the customer\u2019s statement.\n" + }, + "paymentCategoryCode": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates whether to process the payment.\n\nUse with deferred payments. See \"Deferred and Partial Payments,\" page 37.\n\nPossible values:\n- **0**: Standard debit with immediate payment (default).\n- **1**: For deferred payments, indicates that this is a deferred payment and that you will send a debit request\nwith `paymentCategoryCode = 2` in the future.\n- **2**: For deferred payments, indicates notification to initiate payment.\n\nChase Paymentech Solutions and TeleCheck Use for deferred and partial payments.\n\nCyberSource ACH Service Not used.\n\nRBS WorldPay Atlanta Not used.\n" + }, + "settlementMethod": { + "type": "string", + "maxLength": 1, + "description": "Method used for settlement.\n\nPossible values:\n- **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- **F**: Facsimile draft (U.S. dollars only)\n- **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nSee \"Settlement Delivery Methods,\" page 44.\n" + }, + "fraudScreeningLevel": { + "type": "string", + "maxLength": 1, + "description": "Level of fraud screening.\n\nPossible values:\n- **1**: Validation \u2014 default if the field has not already been configured for your merchant ID\n- **2**: Verification\n\nFor a description of this feature and a list of supported processors, see \"Verification and Validation,\" page 24.\n" + } + } + } + } + }, + "issuerInformation": { + "type": "object", + "properties": { + "discretionaryData": { + "type": "string", + "maxLength": 255, + "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n" + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 20, + "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\nFor processor-specific information, see the `customer_cc_expmo` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`.\n\nFor processor-specific information, see the `customer_cc_expyr` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "type": { + "type": "string", + "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n" + }, + "useAs": { + "type": "string", + "maxLength": 20, + "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\n**Cielo** and **Comercio Latino**\n\nPossible values:\n\n - CREDIT: Credit card\n - DEBIT: Debit card\n\nThis field is required for:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n" + }, + "sourceAccountType": { + "type": "string", + "maxLength": 20, + "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\nThis field is required in the following cases:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n - Applicable only for Visa Platform Connect (VPC).\n \n**Note**\\\nCombo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank\nidentification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or\ncredit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends\nthat you include this field for combo card transactions.\n\nPossible values include the following.\n\n - **CHECKING**: Checking account\n - **CREDIT**: Credit card account\n - **SAVING**: Saving account\n - **LINE_OF_CREDIT**: Line of credit or credit portion of combo card\n - **PREPAID**: Prepaid card account or prepaid portion of combo card\n - **UNIVERSAL**: Universal account\n" + }, + "securityCode": { + "type": "string", + "maxLength": 4, + "description": "Card Verification Number.\n\n**Ingenico ePayments**\nDo not include this field when _commerceIndicator=recurring_.\n**Note** Ingenico ePayments was previously called Global Collect.\n" + }, + "securityCodeIndicator": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates whether a CVN code was sent. Possible values:\n\n - 0 (default): CVN service not requested. CyberSource uses this default value when you do not include\n _securityCode_ field in the request.\n - 1 (default): CVN service requested and supported. CyberSource uses this default value when you include\n _securityCode_ field in the request.\n - 2: CVN on credit card is illegible.\n - 9: CVN was not imprinted on credit card.\n" + }, + "accountEncoderId": { + "type": "string", + "maxLength": 3, + "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n" + }, + "issueNumber": { + "type": "string", + "maxLength": 5, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" + }, + "startMonth": { + "type": "string", + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "startYear": { + "type": "string", + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "productName": { + "type": "string", + "maxLength": 15, + "description": "Name of the card product.\n\nPossible value:\n- BNDES\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 115-120\n- Field: Brazil Country Data\n" + } + } + }, + "tokenizedCard": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 20, + "description": "Customer\u2019s payment network token value.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the payment network token expires. `Format: YYYY`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "type": { + "type": "string", + "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n" + }, + "cryptogram": { + "type": "string", + "maxLength": 40, + "description": "This field is used internally." + }, + "requestorId": { + "type": "string", + "maxLength": 11, + "description": "Value that identifies your business and indicates that the cardholder\u2019s account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider\u2019s database.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n" + }, + "transactionType": { + "type": "string", + "maxLength": 1, + "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n" + }, + "assuranceLevel": { + "type": "string", + "maxLength": 2, + "description": "Confidence level of the tokenization. This value is assigned by the token service provider.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n" + }, + "storageMethod": { + "type": "string", + "maxLength": 3, + "description": "Type of technology used in the device to store token data. Possible values:\n\n - 001: Secure Element (SE)\n\nSmart card or memory with restricted access and encryption to prevent data tampering. For storing payment\ncredentials, a SE is tested against a set of requirements defined by the payment networks.\n\n`Note` This field is supported only for **FDC Compass**.\n\n- 002: Host Card Emulation (HCE)\n\nEmulation of a smart card by using software to create a virtual and exact representation of the card.\nSensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database\nmust meet very stringent security requirements that exceed PCI DSS.\n\n`Note` This field is supported only for **FDC Compass**.\n" + }, + "securityCode": { + "type": "string", + "maxLength": 4, + "description": "Card Verification Number.\n\n**Ingenico ePayments**\nDo not include this field when _commerceIndicator=recurring_.\n**Note** Ingenico ePayments was previously called Global Collect. CVN.\n" + } + } + }, + "fluidData": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "The name of the merchant-defined data field. The range of this field starts at 1 and terminiates at 100." + }, + "descriptor": { + "type": "string", + "maxLength": 128, + "description": "The specific string for identifying the payment solution that is sending the encrypted payment data to CyberSource.\nValid values:\n- `Apple Pay`\n- `Samsung Pay`\n**NOTE**: For other payment solutions, the value may be specific to the customer's mobile device. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Merchant needs to pass in this value.\n" + }, + "value": { + "type": "string", + "maxLength": 3072, + "description": "Represents the encrypted payment data BLOB. The entry for this field is dependent on the payment solution a merchant uses.\n\nValid values:\n- Apple Pay: `RklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U`\n- Samsung Pay: `RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ=`\n**NOTE**: For other payment solutions, the value of the descriptor may be specific to the customer's mobile device. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Merchant needs to pass in this value.\n" + }, + "encoding": { + "type": "string", + "maxLength": 6, + "description": "Encoding method used to encrypt the payment data.\n\nValid value: Base64\n" + } + } + }, + "customer": { + "type": "object", + "properties": { + "customerId": { + "type": "string", + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" + } + } + }, + "bank": { + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 1, + "description": "Account type.\n\nPossible values:\n - **C**: Checking.\n - **G**: General ledger. This value is supported only on Wells Fargo ACH.\n - **S**: Savings (U.S. dollars only).\n - **X**: Corporate checking (U.S. dollars only).\n" + }, + "number": { + "type": "string", + "maxLength": 17, + "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" + }, + "encoderId": { + "type": "string", + "maxLength": 3, + "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor. See \"Encoded Account Numbers,\" page 39.\n" + }, + "checkNumber": { + "type": "string", + "maxLength": 8, + "description": "Check number.\n\nChase Paymentech Solutions - Optional.\nCyberSource ACH Service - Not used.\nRBS WorldPay Atlanta - Optional on debits. Required on credits.\nTeleCheck - Strongly recommended on debit requests. Optional on credits.\n" + }, + "checkImageReferenceNumber": { + "type": "string", + "maxLength": 32, + "description": "Image reference number associated with the check. You cannot include any special characters.\n" + } + } + }, + "routingNumber": { + "type": "string", + "maxLength": 9, + "description": "Bank routing number.\n\nThis is also called the transit number.\n" + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "maxLength": 19, + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + }, + "discountAmount": { + "type": "string", + "maxLength": 15, + "description": "Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "dutyAmount": { + "type": "string", + "maxLength": 15, + "description": "Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAmount": { + "type": "string", + "maxLength": 12, + "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "nationalTaxIncluded": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAppliedAfterDiscount": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAppliedLevel": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxTypeCode": { + "type": "string", + "maxLength": 3, + "description": "For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "freightAmount": { + "type": "string", + "maxLength": 13, + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "foreignAmount": { + "type": "string", + "maxLength": 15, + "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "foreignCurrency": { + "type": "string", + "maxLength": 5, + "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "exchangeRate": { + "type": "string", + "maxLength": 13, + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "exchangeRateTimeStamp": { + "type": "string", + "maxLength": 14, + "description": "Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "surcharge": { + "type": "object", + "properties": { + "amount": { + "type": "string", + "maxLength": 15, + "description": "The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer.\n\nIf the amount is positive, then it is a debit for the customer.\\\nIf the amount is negative, then it is a credit for the customer.\n\n**NOTE**: This field is supported only for CyberSource through VisaNet (CtV) for Payouts. For CtV, the maximum string length is 8.\n\nFor processor-specific information, see the surcharge_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "description": { + "type": "string", + "description": "Merchant-defined field for describing the surcharge amount." + } + } + }, + "settlementAmount": { + "type": "string", + "maxLength": 12, + "description": "This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder\u2019s account.\n" + }, + "settlementCurrency": { + "type": "string", + "maxLength": 3, + "description": "This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account.\n" + }, + "amexAdditionalAmounts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 3, + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "amount": { + "type": "string", + "maxLength": 12, + "description": "Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + } + }, + "taxDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", + "enum": [ + "alternate", + "local", + "national", + "vat" + ] + }, + "amount": { + "type": "string", + "maxLength": 13, + "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" + }, + "rate": { + "type": "string", + "maxLength": 6, + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" + }, + "code": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" + }, + "applied": { + "type": "boolean", + "description": "The tax is applied. Valid value is `true` or `false`." + }, + "exemptionCode": { + "type": "string", + "maxLength": 1, + "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" + } + } + } + }, + "serviceFeeAmount": { + "type": "string", + "maxLength": 15, + "description": "Service fee. Required for service fee transactions.\n" + }, + "originalAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount in your original local pricing currency.\n\nThis value cannot be negative. You can include a decimal point (.) in this field to denote the currency\nexponent, but you cannot include any other special characters.\n\nIf needed, CyberSource truncates the amount to the correct number of decimal places.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n" + }, + "originalCurrency": { + "type": "string", + "maxLength": 15, + "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n" + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "middleName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s middle name.\n" + }, + "nameSuffix": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s name suffix.\n" + }, + "title": { + "type": "string", + "maxLength": 60, + "description": "Title.\n" + }, + "company": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address1": { + "type": "string", + "maxLength": 40, + "description": "First line in the street address of the company purchasing the product." + }, + "address2": { + "type": "string", + "maxLength": 40, + "description": "Additional address information for the company purchasing the product." + }, + "locality": { + "type": "string", + "maxLength": 30, + "description": "City in the address of the company purchasing the product." + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n" + } + } + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "district": { + "type": "string", + "maxLength": 50, + "description": "Customer\u2019s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n" + }, + "buildingNumber": { + "type": "string", + "maxLength": 256, + "description": "Building number in the street address.\n\nFor example, if the street address is:\nRua da Quitanda 187\nthen the building number is 187.\n\nThis field is supported only for:\n - Cielo transactions.\n - Redecard customer validation with CyberSource Latin American Processing.\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" + }, + "phoneType": { + "type": "string", + "enum": [ + "day", + "home", + "night", + "work" + ], + "description": "Customer's phone number type.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nPossible Values - \n* day\n* home\n* night\n* work\n" + } + } + }, + "shipTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Last name of the recipient.\n\n**Processor-specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the shipping address." + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Second line of the shipping address." + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the shipping address." + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" + }, + "country": { + "type": "string", + "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.", + "maxLength": 2 + }, + "district": { + "type": "string", + "maxLength": 50, + "description": "Neighborhood, community, or region within a city or municipality." + }, + "buildingNumber": { + "type": "string", + "maxLength": 15, + "description": "Building number in the street address. For example, the building number is 187 in the following address:\n\nRua da Quitanda 187\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Phone number associated with the shipping address." + }, + "company": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + }, + "lineItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "productCode": { + "type": "string", + "maxLength": 255, + "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n" + }, + "productName": { + "type": "string", + "maxLength": 255, + "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`),\nthis field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of\nthe other values that are related to shipping and/or handling.\n" + }, + "productSku": { + "type": "string", + "maxLength": 255, + "description": "Stock Keeping Unit (SKU) code for the product.\n\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n" + }, + "quantity": { + "type": "number", + "minimum": 1, + "maximum": 9999999999, + "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n", + "default": 1 + }, + "unitPrice": { + "type": "string", + "maxLength": 15, + "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" + }, + "unitOfMeasure": { + "type": "string", + "maxLength": 12, + "description": "Unit of measure, or unit of measure code, for the item.\n" + }, + "totalAmount": { + "type": "string", + "maxLength": 13, + "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units. Example: 123.45 USD= 123\n" + }, + "taxAmount": { + "type": "string", + "maxLength": 15, + "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nIf you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API.\n\nThis field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API.\n" + }, + "taxRate": { + "type": "string", + "maxLength": 7, + "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + }, + "taxAppliedAfterDiscount": { + "type": "string", + "maxLength": 1, + "description": "Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n" + }, + "taxStatusIndicator": { + "type": "string", + "maxLength": 1, + "description": "Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n" + }, + "taxTypeCode": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "amountIncludesTax": { + "type": "boolean", + "description": "Flag that indicates whether the tax amount is included in the Line Item Total.\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "typeOfSupply": { + "type": "string", + "maxLength": 2, + "description": "Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n" + }, + "commodityCode": { + "type": "string", + "maxLength": 15, + "description": "Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n" + }, + "discountAmount": { + "type": "string", + "maxLength": 13, + "description": "Discount applied to the item." + }, + "discountApplied": { + "type": "boolean", + "description": "Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "discountRate": { + "type": "string", + "maxLength": 6, + "description": "Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n" + }, + "invoiceNumber": { + "type": "string", + "maxLength": 23, + "description": "Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n" + }, + "taxDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", + "enum": [ + "alternate", + "local", + "national", + "vat" + ] + }, + "amount": { + "type": "string", + "maxLength": 13, + "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" + }, + "rate": { + "type": "string", + "maxLength": 6, + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" + }, + "code": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" + }, + "applied": { + "type": "boolean", + "description": "The tax is applied. Valid value is `true` or `false`." + }, + "exemptionCode": { + "type": "string", + "maxLength": 1, + "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" + } + } + } + }, + "fulfillmentType": { + "type": "string", + "description": "The description for this field is not available." + }, + "weight": { + "type": "string", + "maxLength": 9, + "description": "Weight of the item. See Numbered Elements." + }, + "weightIdentifier": { + "type": "string", + "maxLength": 1, + "description": "Type of weight. See Numbered Elements.\n\nPossible values:\n- B: Billed weight\n- N: Actual net weight\n" + }, + "weightUnit": { + "type": "string", + "maxLength": 2, + "description": "Code that specifies the unit of measurement for the weight amount. For example, OZ specifies ounce and LB\nspecifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC).\n\nSee Numbered Elements.\n" + }, + "referenceDataCode": { + "type": "string", + "maxLength": 2, + "description": "Code that identifies the value of the corresponding item_#_referenceData_#_number field. See Numbered Elements.\n\nPossible values:\n- AN: Client-defined asset code\n- MG: Manufacturer's part number\n- PO: Purchase order number\n- SK: Supplier stock keeping unit number\n- UP: Universal product code\n- VC: Supplier catalog number\n- VP: Vendor part number\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" + }, + "referenceDataNumber": { + "type": "string", + "maxLength": 30, + "description": "Reference number.\n\nThe meaning of this value is identified by the value of the corresponding `referenceDataCode` field.\nSee Numbered Elements.\n\nThe maximum length for this field depends on the value of the corresponding `referenceDataCode` field:\n- When the code is `PO`, the maximum length for the reference number is 22.\n- When the code is `VC`, the maximum length for the reference number is 20.\n- For all other codes, the maximum length for the reference number is 30.\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" + } + } + } + }, + "invoiceDetails": { + "type": "object", + "properties": { + "invoiceNumber": { + "type": "string", + "description": "Invoice Number." + }, + "barcodeNumber": { + "type": "string", + "description": "Barcode Number." + }, + "expirationDate": { + "type": "string", + "description": "Expiration Date." + }, + "purchaseOrderNumber": { + "type": "string", + "maxLength": 25, + "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "purchaseOrderDate": { + "type": "string", + "maxLength": 10, + "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "purchaseContactName": { + "type": "string", + "maxLength": 36, + "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxable": { + "type": "boolean", + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "vatInvoiceReferenceNumber": { + "type": "string", + "maxLength": 15, + "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "commodityCode": { + "type": "string", + "maxLength": 4, + "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "merchandiseCode": { + "type": "number", + "description": "Identifier for the merchandise. Possible value:\n\n - 1000: Gift card\n\nThis field is supported only for **American Express Direct**.\n" + }, + "transactionAdviceAddendum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "string", + "maxLength": 40, + "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n" + } + } + } + }, + "referenceDataCode": { + "type": "string", + "maxLength": 3, + "description": "Code that identifies the value of the reference_data_number field. For the possible values, see Reference Data\nCodes.\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" + }, + "referenceDataNumber": { + "type": "string", + "maxLength": 30, + "description": "Reference number. The meaning of this value is identified by the value of the referenceDataCode field.\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" + } + } + }, + "shippingDetails": { + "type": "object", + "description": "Contains shipping information not related to address.", + "properties": { + "giftWrap": { + "type": "string", + "maxLength": 3, + "description": "Boolean that indicates whether the customer requested gift wrapping for this\npurchase. This field can contain one of the following\nvalues:\n\n- `yes`: The customer requested gift wrapping.\n- `no`: The customer did not request gift wrapping.\n" + }, + "shippingMethod": { + "type": "string", + "maxLength": 10, + "description": "Shipping method for the product. Possible values:\n\n - `lowcost`: Lowest-cost service\n - `sameday`: Courier or same-day service\n - `oneday`: Next-day or overnight service\n - `twoday`: Two-day service\n - `threeday`: Three-day service\n - `pickup`: Store pick-up\n - `other`: Other shipping method\n - `none`: No shipping method because product is a service or subscription\n" + }, + "shipFromPostalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n" + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "merchantCustomerId": { + "type": "string", + "maxLength": 100, + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "dateOfBirth": { + "type": "string", + "maxLength": 8, + "description": "Recipient\u2019s date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a pass-through, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n" + }, + "vatRegistrationNumber": { + "type": "string", + "maxLength": 20, + "description": "Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "companyTaxId": { + "type": "string", + "maxLength": 9, + "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n\n** TeleCheck **\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n** All Other Processors **\nNot used\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n\nThis field is supported only on the following processors.\n\n**ComercioLatino**\\\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n**CyberSource Latin American Processing**\\\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n", + "enum": [ + "NATIONAL", + "CPF", + "CPNJ", + "CURP", + "SSN", + "DRIVER_LICENSE" + ] + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "The value of the identification type. This field is supported only on the following processors.\n\n**ComercioLatino**\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n**CyberSource Latin American Processing**\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the personal_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf type = PASSPORT, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + }, + "issuedBy": { + "type": "string", + "description": "If type = DRIVER_LICENSE, this is the State or province where the customer\u2019s driver\u2019s license was issued.\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n\n** TeleCheck **\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n** All Other Processors **\nNot used.\n\nIf type = PASSPORT, this is the Issuing country for the cardholder\u2019s passport.\nRecommended for Discover ProtectBuy.\n" + } + } + } + }, + "hashedPassword": { + "type": "string", + "maxLength": 100, + "description": "The description for this field is not available.\n" + } + } + }, + "recipientInformation": { + "type": "object", + "properties": { + "accountId": { + "type": "string", + "maxLength": 10, + "description": "Identifier for the recipient\u2019s account. Use the first six digits and last four digits of the recipient\u2019s account\nnumber. This field is a pass-through, which means that CyberSource does not verify the value or modify it in\nany way before sending it to the processor. If the field is not required for the transaction, CyberSource does\nnot forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n" + }, + "lastName": { + "type": "string", + "maxLength": 6, + "description": "Recipient\u2019s last name. This field is a passthrough, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor. If the field is not required for the transaction,\nCyberSource does not forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 6, + "description": "Partial postal code for the recipient\u2019s address. For example, if the postal code is **NN5 7SG**, the value for\nthis field should be the first part of the postal code: **NN5**. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n" + } + } + }, + "deviceInformation": { + "type": "object", + "properties": { + "hostName": { + "type": "string", + "maxLength": 60, + "description": "Host name reported by the customer\u2019s browser to your Web server identified via the HTTP header." + }, + "ipAddress": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n" + }, + "userAgent": { + "type": "string", + "maxLength": 40, + "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n" + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" + }, + "alternateName": { + "type": "string", + "maxLength": 13, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "contact": { + "type": "string", + "maxLength": 14, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "locality": { + "type": "string", + "maxLength": 13, + "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 14, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + }, + "salesOrganizationId": { + "type": "string", + "maxLength": 11, + "description": "Company ID assigned to an independent sales organization. Get this value from Mastercard.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 106-116\n- Field: Mastercard Independent Sales Organization ID\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\nFor processor-specific information, see the sales_organization_ID field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "categoryCode": { + "type": "integer", + "maximum": 9999, + "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + }, + "categoryCodeDomestic": { + "type": "integer", + "maximum": 9999, + "description": "Merchant category code for domestic transactions. The value for this field is a four-digit number that the payment\ncard industry uses to classify merchants into market segments. A payment card company assigned one or more of these\nvalues to your business when you started accepting the payment card company\u2019s cards. Including this field in a request\nfor a domestic transaction might reduce interchange fees.\n\nWhen you include this field in a request:\n- Do not include the merchantCategoryCode field.\n- The value for this field overrides the value in your CyberSource account.\n\nThis field is supported only for:\n- Domestic transactions with Mastercard in Spain. Domestic means that you and the cardholder are in the same country.\n- Merchants enrolled in the OmniPay Direct interchange program.\n- First Data Merchant Solutions (Europe) on OmniPay Direct.\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" + }, + "vatRegistrationNumber": { + "type": "string", + "maxLength": 21, + "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "cardAcceptorReferenceNumber": { + "type": "string", + "maxLength": 25, + "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "transactionLocalDateTime": { + "type": "string", + "maxLength": 14, + "description": "Local date and time at your physical location. Include both the date and time in this field or leave it blank.\nThis field is supported only for **CyberSource through VisaNet**.\n\nFor processor-specific information, see the transaction_local_date_time field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n`Format: YYYYMMDDhhmmss`, where:\n\n - YYYY = year\n - MM = month\n - DD = day\n - hh = hour\n - mm = minutes\n - ss = seconds\n\n For processor-specific information, see the _transaction_local_date_time_ field in Credit Card Services Using the SCMP API.\n" + }, + "serviceFeeDescriptor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 22, + "description": "Name of the service provider that is collecting the service fee. The service provider name must consist of\n3, 7, or 12 characters followed by an asterisk (*). This value must also include the words \u201cService Fee.\u201d\n\nWhen you include more than one consecutive space, extra spaces are removed. Use one of the following formats\nfor this value:\n- <3-character name>*Service Fee\n- <7-character name>*Service Fee\n- <12-character name>*Service Fee\n\nWhen payments are made in installments, this value must also include installment information such as\n\u201c1 of 5\u201d or \u201c3 of 7.\u201d For installment payments, use one of the following formats for this value:\n- <3-character name>*Service Fee* of \n- <7-character name>*Service Fee* of \n- <12-character name>*Service Fee* of \n\nwhere is the payment number and is the total number of payments.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource\naccount.\n\nThis value might be displayed on the cardholder\u2019s statement.\n" + }, + "contact": { + "type": "string", + "maxLength": 11, + "description": "Contact information for the service provider that is collecting the service fee. when you include more than one\nconsecutive space, extra spaces are removed.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder\u2019s statement.\n" + }, + "state": { + "type": "string", + "maxLength": 20, + "description": "State or territory in which the service provider is located.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder\u2019s statement.\n" + } + } + } + } + }, + "aggregatorInformation": { + "type": "object", + "properties": { + "aggregatorId": { + "type": "string", + "maxLength": 20, + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "name": { + "type": "string", + "maxLength": 37, + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "subMerchant": { + "type": "object", + "properties": { + "cardAcceptorId": { + "type": "string", + "maxLength": 15, + "description": "Unique identifier assigned by the payment card company to the sub-merchant." + }, + "name": { + "type": "string", + "maxLength": 37, + "description": "Sub-merchant\u2019s business name.\n\n**American Express Direct**\\\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\n**FDC Nashville Global**\\\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n" + }, + "address1": { + "type": "string", + "maxLength": 38, + "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "locality": { + "type": "string", + "maxLength": 21, + "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "region": { + "type": "string", + "maxLength": 3, + "description": "Sub-merchant\u2019s region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n\nSee \"Aggregator Support,\" page 110.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 15, + "description": "Partial postal code for the sub-merchant\u2019s address.\n\nSee \"Aggregator Support,\" page 100 for details.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "country": { + "type": "string", + "maxLength": 3, + "description": "Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nSee \"Aggregator Support,\" page 101.\n" + }, + "email": { + "type": "string", + "maxLength": 40, + "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 20, + "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n" + } + } + } + } + }, + "consumerAuthenticationInformation": { + "type": "object", + "properties": { + "cavv": { + "type": "string", + "maxLength": 40, + "description": "Cardholder authentication verification value (CAVV)." + }, + "cavvAlgorithm": { + "type": "string", + "maxLength": 1, + "description": "Algorithm used to generate the CAVV for Verified by Visa or the UCAF authentication data for Mastercard Identity Check.\n" + }, + "eciRaw": { + "type": "string", + "maxLength": 2, + "description": "Raw electronic commerce indicator (ECI). For the description and requirements, see \"Payer Authentication,\" page 180." + }, + "paresStatus": { + "type": "string", + "maxLength": 1, + "description": "Payer authentication response status. For the description and requirements, see \"Payer Authentication,\" page 180.\n" + }, + "veresEnrolled": { + "type": "string", + "maxLength": 1, + "description": "Verification response enrollment status. For the description and requirements, see \"Payer Authentication,\" page 180." + }, + "xid": { + "type": "string", + "maxLength": 40, + "description": "Transaction identifier. For the description and requirements, see \"Payer Authentication,\" page 180." + }, + "ucafAuthenticationData": { + "type": "string", + "maxLength": 32, + "description": "Universal cardholder authentication field (UCAF) data.\n\nFor the description and requirements, see \"Payer Authentication,\" page 180.\n" + }, + "ucafCollectionIndicator": { + "type": "string", + "maxLength": 1, + "description": "Universal cardholder authentication field (UCAF) collection indicator.\n\nFor the description and requirements, see \"Payer Authentication,\" page 180.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR7\n- Position: 5\n- Field: Mastercard Electronic Commerce Indicators\u2014-UCAF Collection Indicator\n" + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "terminalId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the terminal at your retail location. You can define this value yourself, but consult the\nprocessor for requirements.\n\nFor Payouts: This field is applicable for CtV.\n" + }, + "terminalSerialNumber": { + "type": "string", + "maxLength": 32, + "description": "Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that\nis installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "laneNumber": { + "type": "string", + "maxLength": 8, + "description": "Identifier for an alternate terminal at your retail location. You define the value for this field.\n\nThis field is supported only for MasterCard transactions on FDC Nashville Global. Use the _terminalID_ field to\nidentify the main terminal at your retail location. If your retail location has multiple terminals, use this\n_alternateTerminalID_ field to identify the terminal used for the transaction.\n\nThis field is a pass-through, which means that CyberSource does not check the value or modify the value in any\nway before sending it to the processor.\n" + }, + "catLevel": { + "type": "integer", + "minimum": 1, + "maximum": 9, + "description": "Type of cardholder-activated terminal. Possible values:\n\n - 1: Automated dispensing machine\n - 2: Self-service terminal\n - 3: Limited amount terminal\n - 4: In-flight commerce (IFC) terminal\n - 5: Radio frequency device\n - 6: Mobile acceptance terminal\n - 7: Electronic cash register\n - 8: E-commerce device at your location\n - 9: Terminal or cash register that uses a dialup connection to connect to the transaction processing network\n * Applicable only for CTV for Payouts.\n" + }, + "entryMode": { + "type": "string", + "maxLength": 11, + "description": "Method of entering credit card information into the POS terminal. Possible values:\n\n - contact: Read from direct contact with chip card.\n - contactless: Read from a contactless interface using chip data.\n - keyed: Manually keyed into POS terminal.\n - msd: Read from a contactless interface using magnetic stripe data (MSD).\n - swiped: Read from credit card magnetic stripe.\n\nThe contact, contactless, and msd values are supported only for EMV transactions.\n* Applicable only for CTV for Payouts.\n" + }, + "terminalCapability": { + "type": "integer", + "minimum": 1, + "maximum": 5, + "description": "POS terminal\u2019s capability. Possible values:\n\n - 1: Terminal has a magnetic stripe reader only.\n - 2: Terminal has a magnetic stripe reader and manual entry capability.\n - 3: Terminal has manual entry capability only.\n - 4: Terminal can read chip cards.\n - 5: Terminal can read contactless chip cards.\n\nThe values of 4 and 5 are supported only for EMV transactions.\n* Applicable only for CTV for Payouts. \n" + }, + "pinEntryCapability": { + "type": "integer", + "minimum": 1, + "maximum": 1, + "description": "A one-digit code that identifies the capability of terminal to capture PINs. \nThis code does not necessarily mean that a PIN was entered or is included in this message. \nFor Payouts: This field is applicable for CtV.\n" + }, + "operatingEnvironment": { + "type": "string", + "maxLength": 1, + "description": "Operating environment. Possible values:\n\n - 0: No terminal used or unknown environment.\n - 1: On merchant premises, attended.\n - 2: On merchant premises, unattended, or cardholder terminal. Examples: oil, kiosks, self-checkout, home\n computer, mobile telephone, personal digital assistant (PDA). Cardholder terminal is supported only for\n MasterCard transactions on **CyberSource through VisaNet**.\n - 3: Off merchant premises, attended. Examples: portable POS devices at trade shows, at service calls, or in\n taxis.\n - 4: Off merchant premises, unattended, or cardholder terminal. Examples: vending machines, home computer,\n mobile telephone, PDA. Cardholder terminal is supported only for MasterCard transactions on **CyberSource\n through VisaNet**.\n - 5: On premises of cardholder, unattended.\n - 9: Unknown delivery mode.\n - S: Electronic delivery of product. Examples: music, software, or eTickets that are downloaded over the\n internet.\n - T: Physical delivery of product. Examples: music or software that is delivered by mail or by a courier.\n\nThis field is supported only for **American Express Direct** and **CyberSource through VisaNet**.\n\n**CyberSource through VisaNet**\\\nFor MasterCard transactions, the only valid values are 2 and 4.\n" + }, + "emv": { + "type": "object", + "properties": { + "tags": { + "type": "string", + "maxLength": 1998, + "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" + }, + "cardholderVerificationMethodUsed": { + "type": "number", + "description": "Method that was used to verify the cardholder's identity.\n\nPossible values:\n - **0**: No verification\n - **1**: Signature\n\nThis field is supported only on **American Express Direct**.\n" + }, + "cardSequenceNumber": { + "type": "string", + "maxLength": 3, + "description": "Number assigned to a specific card when two or more cards are associated with the same primary account number.\nThis value enables issuers to distinguish among multiple cards that are linked to the same account. This value\ncan also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip\nreader. When the chip reader does not provide this value, do not include this field in your request.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10.\n" + }, + "fallback": { + "type": "boolean", + "maxLength": 5, + "description": "Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.\n\nPossible values:\n - **true**\n - **false** (default)\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n", + "enum": [ + true, + false + ], + "default": false + }, + "fallbackCondition": { + "type": "number", + "description": "Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for\none of these reasons:\n\n - Technical failure: the EMV terminal or EMV card cannot read and process chip data.\n - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card.\n EMV terminals are coded to determine whether the terminal and EMV card have any applications in common.\n EMV terminals provide this information to you.\n\nPossible values:\n\n - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal either used information from a successful chip read or it was not a chip transaction.\n - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.\n\nThis field is supported only on **GPN**.\n\n**NOTE**: Merchants must include this field in a request whenever a transaction must fall back to swiped mode.\n" + } + } + }, + "amexCapnData": { + "type": "string", + "maxLength": 12, + "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n" + }, + "trackData": { + "type": "string", + "description": "Card\u2019s track 1 and 2 data. For all processors except FDMS Nashville, this value consists of\none of the following:\n\n - Track 1 data\n - Track 2 data\n - Data for both tracks 1 and 2\n\nFor FDMS Nashville, this value consists of one of the following:\n - Track 1 data\n - Data for both tracks 1 and 2\n\nExample: %B4111111111111111^SMITH/JOHN ^1612101976110000868000000?;4111111111111111=16121019761186800000?\n" + }, + "storeAndForwardIndicator": { + "type": "string", + "maxLength": 1, + "description": "When connectivity is unavailable, the client software that is installed on the POS terminal can store a\ntransaction in its memory and send it for authorization when connectivity is restored. This value is provided by\nthe client software that is installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nPossible values:\n- Y: Transaction was stored and then forwarded.\n- N (default): Transaction was not stored and then forwarded.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "cardholderVerificationMethod": { + "type": "array", + "items": { + "type": "string", + "description": "Complete list of cardholder verification methods (CVMs) supported by the terminal.\n\nPossible values:\n- PIN\n- Signature\n\n**NOTE**: You can submit one of the values or both in a request.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "example": [ + "PIN", + "Signature" + ] + }, + "terminalInputCapability": { + "type": "array", + "items": { + "description": "Complete list of card input methods supported by the terminal.\n\nPossible values:\n- Keyed: Terminal can accept card data that is entered manually.\n- Swiped: Terminal can accept card data from a magnetic stripe reader.\n- Contact: Terminal can accept card data in EMV contact mode.\n- Contactless: Terminal can accept card data in EMV contactless mode.\n- BarCode: Terminal can read bar codes.\n- QRcode: Terminal can read QR codes.\n- OCR: Terminal can perform optical character recognition (OCT).\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n", + "type": "string" + }, + "example": [ + "Keyed", + "Swiped", + "Contact", + "QRcode" + ] + }, + "terminalCardCaptureCapability": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether the terminal can capture the card.\n\nPossible values:\n- 1: Terminal can capture card.\n- 0: Terminal cannot capture card.\n\nThis field is supported only on American Express Direct.\n" + }, + "terminalOutputCapability": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether the terminal can print or display messages.\n\nPossible values:\n- 1: Neither\n- 2: Print only\n- 3: Display only\n- 4: Print and display\n\nThis field is supported only on American Express Direct.\n" + }, + "terminalPinCapability": { + "type": "integer", + "description": "Maximum PIN length that the terminal can capture.\n\nPossible values:\n- 0: No PIN capture capability\n- 1: PIN capture capability unknown\n- 4: Four characters\n- 5: Five characters\n- 6: Six characters\n- 7: Seven characters\n- 8: Eight characters\n- 9: Nine characters\n- 10: Ten characters\n- 11: Eleven characters\n- 12: Twelve characters\n\nThis field is supported only on American Express Direct and SIX.\n" + }, + "deviceId": { + "type": "string", + "maxLength": 32, + "description": "Value created by the client software that uniquely identifies the POS device. This value is provided by the\nclient software that is installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "pinBlockEncodingFormat": { + "type": "integer", + "maximum": 9, + "description": "Format that is used to encode the PIN block. This value is provided by the client software that is installed on\nthe POS terminal.\n\nPossible values:\n- 0: ISO 9564 format 0\n- 1: ISO 9564 format 1\n- 2: ISO 9564 format 2\n- 3: ISO 9564 format 3\n\nIn the Credit Card Guide for the auth service: This field is supported only on American Express Direct, FDC\nNashville Global, and SIX.\n" + }, + "encryptedPin": { + "type": "string", + "maxLength": 16, + "description": "Encrypted PIN.\n\nThis value is provided by the client software that is installed on the POS terminal.\n\nIn the Credit Card Guide for the auth service: This field is supported only on American Express Direct, FDC\nNashville Global, and SIX.\n" + }, + "encryptedKeySerialNumber": { + "type": "string", + "maxLength": 20, + "description": "This is a combination of the device's unique identifier and a transaction counter that is used in the process of\ndecrypting the encrypted PIN.\n\nFor all terminals that are using derived unique key per transaction (DUKPT) encryption, this is generated as a\nsingle number within the terminal.\n" + }, + "partnerSdkVersion": { + "type": "string", + "maxLength": 32, + "description": "Version of the software installed on the POS terminal. This value is provided by the client software that is\ninstalled on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + } + } + }, + "merchantDefinedInformation": { + "type": "array", + "description": "The description for this field is not available.", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 50, + "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n" + }, + "value": { + "type": "string", + "maxLength": 255, + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + } + } + } + }, + "installmentInformation": { + "type": "object", + "properties": { + "amount": { + "type": "string", + "maxLength": 12, + "description": "Amount for the current installment payment.\n\nThis field is supported only for CyberSource through VisaNet. See \"Installment Payments,\" page 127.\n" + }, + "frequency": { + "type": "string", + "maxLength": 1, + "description": "Installment Frequency of the installment payments.\n\nThis field is supported only for CyberSource through VisaNet. Possible values:\n- B: Biweekly\n- M: Monthly\n- W: Weekly\n\nSee \"Installment Payments,\" page 127.\n" + }, + "planType": { + "type": "string", + "maxLength": 1, + "description": "**American Express Direct, Cielo, and CyberSource Latin American Processing**\\\nFlag that indicates the type of funding for the installment plan associated with the payment.\n\nPossible values:\n- 1: Merchant-funded installment plan\n- 2: Issuer-funded installment plan\nIf you do not include this field in the request, CyberSource uses the value in your CyberSource account.\n\nTo change the value in your CyberSource account, contact CyberSource Customer Service. See \"Installment Payments,\" page 136.\n\n**CyberSource through VisaNet and American Express**\\\nDefined code that indicates the type of installment plan for this transaction.\n\nContact American Express for:\n- Information about the kinds of installment plans that American Express provides\n- Values for this field\n\nSee \"Installment Payments,\" page 125.\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 5-6\n- Field: Plan Type\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\n**CyberSource through VisaNet with Visa or Mastercard**\\\nFlag indicating the type of funding for the installment plan associated with the payment.\nPossible values:\n- 1 or 01: Merchant-funded installment plan\n- 2 or 02: Issuer-funded installment plan\n- 43: Crediario installment plan\u2014only with Visa in Brazil\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 5-6\n- Field: Installment Type\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR5\n- Position: 39-40\n- Field: Installment Plan Type (Issuer or Merchant)\n" + }, + "sequence": { + "type": "integer", + "maximum": 99, + "description": "Installment number when making payments in installments. Used along with _totalCount_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\nSee \"Installment Payments,\" page 125.\n\n**Chase Paymentech Solutions and FDC Compass**\\\nThis field is optional because this value is required in the merchant descriptors. See \"Chase Paymentech\nSolutions Merchant Descriptors,\" page 142, and \"FDC Compass Merchant Descriptors,\" page 153.\n\n**CyberSource through VisaNet**\\\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + }, + "totalAmount": { + "type": "string", + "maxLength": 12, + "description": "Total amount of the loan that is being paid in installments. This field is supported only for CyberSource\nthrough VisaNet. See \"Installment Payments,\" page 127.\n" + }, + "totalCount": { + "type": "integer", + "maximum": 99, + "description": "Total number of installments when making payments in installments. See \"Installment Payments,\" page 127.\n\n**Chase Paymentech Solutions and FDC Compass**\\\nThis field is optional because this value is required in the merchant descriptors. See \"Chase Paymentech\nSolutions Merchant Descriptors,\" page 144, and \"FDC Compass Merchant Descriptors,\" page 155.\n\n**American Express Direct, Cielo, and Comercio Latino**\\\nThis value is the total number of installments you approved.\n\n**CyberSource Latin American Processing in Brazil**\\\nThis value is the total number of installments that you approved. The default is 1.\n\n**All Other Processors**\\\nThis value is used along with _sequence_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\n**CyberSource through VisaNet**\\\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 23-25\n- Field: Number of Installments\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 7-8\n- Field: Number of Installments\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR1\n- Position: 7-8\n- Field: Number of Installments\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR5\n- Position: 20-22\n- Field: Installment Total Count\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + }, + "firstInstallmentDate": { + "type": "string", + "maximum": 6, + "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a\nstring of six zeros (000000) to the processor. See Installment Payments on CyberSource through VisaNet.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" + }, + "invoiceData": { + "type": "string", + "maximum": 20, + "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n" + }, + "paymentType": { + "type": "string", + "maximum": 1, + "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" + }, + "eligibilityInquiry": { + "type": "string", + "maximum": 9, + "description": "Indicates whether the authorization request is a Crediario eligibility inquiry.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nSet the value for this field to `Crediario`.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n" + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "processingInformation": { + "commerceIndicator": "internet" + }, + "aggregatorInformation": { + "subMerchant": { + "cardAcceptorId": "1234567890", + "country": "US", + "phoneNumber": "650-432-0000", + "address1": "900 Metro Center", + "postalCode": "94404-2775", + "locality": "Foster City", + "name": "Visa Inc", + "administrativeArea": "CA", + "region": "PEN", + "email": "test@cybs.com" + }, + "name": "V-Internatio", + "aggregatorId": "123456789" + }, + "orderInformation": { + "billTo": { + "country": "US", + "lastName": "VDP", + "address2": "Address 2", + "address1": "201 S. Division St.", + "postalCode": "48104-2201", + "locality": "Ann Arbor", + "administrativeArea": "MI", + "firstName": "RTS", + "phoneNumber": "999999999", + "district": "MI", + "buildingNumber": "123", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "102.21", + "currency": "USD" + } + }, + "paymentInformation": { + "card": { + "expirationYear": "2031", + "number": "5555555555554444", + "securityCode": "123", + "expirationMonth": "12", + "type": "002" + } + } + } + } + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "title": "ptsV2PaymentsPost201Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + }, + "reversal": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + }, + "capture": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - AUTHORIZED\n - PARTIAL_AUTHORIZED\n - AUTHORIZED_PENDING_REVIEW\n - DECLINED\n - INVALID_REQUEST\n", + "enum": [ + "AUTHORIZED", + "PARTIAL_AUTHORIZED", + "AUTHORIZED_PENDING_REVIEW", + "DECLINED", + "INVALID_REQUEST", + "PENDING" + ] + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" + }, + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - AVS_FAILED\n - CONTACT_PROCESSOR\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - INSUFFICIENT_FUND\n - STOLEN_LOST_CARD\n - ISSUER_UNAVAILABLE\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - EXCEEDS_CREDIT_LIMIT\n - INVALID_CVN\n - DECLINED_CHECK\n - BLACKLISTED_CUSTOMER\n - SUSPENDED_ACCOUNT\n - PAYMENT_REFUSED\n - CV_FAILED\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - INVALID_MERCHANT_CONFIGURATION\n - DECISION_PROFILE_REJECT\n - SCORE_EXCEEDS_THRESHOLD\n", + "enum": [ + "AVS_FAILED", + "CONTACT_PROCESSOR", + "CV_FAILED", + "EXPIRED_CARD", + "PROCESSOR_DECLINED", + "INSUFFICIENT_FUND", + "STOLEN_LOST_CARD", + "ISSUER_UNAVAILABLE", + "UNAUTHORIZED_CARD", + "CVN_NOT_MATCH", + "EXCEEDS_CREDIT_LIMIT", + "INVALID_CVN", + "PAYMENT_REFUSED", + "INVALID_ACCOUNT", + "GENERAL_DECLINE", + "DECISION_PROFILE_REJECT", + "SCORE_EXCEEDS_THRESHOLD" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "submitLocalDateTime": { + "type": "string", + "maxLength": 14, + "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" + }, + "ownerMerchantId": { + "type": "string", + "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "bankTransferOptions": { + "type": "object", + "properties": { + "settlementMethod": { + "type": "string", + "maxLength": 1, + "description": "Method used for settlement.\n\nPossible values:\n- **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- **F**: Facsimile draft (U.S. dollars only)\n- **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nSee \"Settlement Delivery Methods,\" page 44.\n" + }, + "fraudScreeningLevel": { + "type": "string", + "maxLength": 1, + "description": "Level of fraud screening.\n\nPossible values:\n- **1**: Validation \u2014 default if the field has not already been configured for your merchant ID\n- **2**: Verification\n\nFor a description of this feature and a list of supported processors, see \"Verification and Validation,\" page 24.\n" + } + } + } + } + }, + "processorInformation": { + "type": "object", + "properties": { + "authIndicator": { + "type": "string", + "maxLength": 1, + "description": "Flag that specifies the purpose of the authorization.\n\nPossible values:\n - **0**: Preauthorization\n - **1**: Final authorization\n\nFor processor-specific information, see the auth_indicator field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "approvalCode": { + "type": "string", + "description": "Authorization code. Returned only when the processor returns this value.\n" + }, + "transactionId": { + "type": "string", + "maxLength": 50, + "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n" + }, + "networkTransactionId": { + "type": "string", + "description": "The description for this field is not available." + }, + "providerTransactionId": { + "type": "string", + "description": "The description for this field is not available." + }, + "responseCode": { + "type": "string", + "maxLength": 10, + "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n" + }, + "responseCodeSource": { + "type": "string", + "maxLength": 1, + "description": "Used by Visa only and contains the response source/reason code that identifies the source of the response decision.\n" + }, + "responseDetails": { + "type": "string", + "maxLength": 255, + "description": "This field might contain information about a decline. This field is supported only for **CyberSource through\nVisaNet**.\n" + }, + "responseCategoryCode": { + "type": "string", + "maxLength": 32, + "description": "Processor-defined response category code. The associated detail error code is in the auth_auth_response\nfield or the auth_reversal_auth_ response field depending on which service you requested.\n\nThis field is supported only for:\n\n - Japanese issuers\n - Domestic transactions in Japan\n - Comercio Latino\u2014processor transaction ID required for troubleshooting\n\n**Maximum length for processors**:\n\n - Comercio Latino: 32\n - All other processors: 3\n" + }, + "forwardedAcquirerCode": { + "type": "string", + "maxLength": 32, + "description": "Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n" + }, + "avs": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "AVS result code.\n" + }, + "codeRaw": { + "type": "string", + "maxLength": 10, + "description": "AVS result code sent directly from the processor. Returned only when the processor returns this value.\nImportant Do not use this field to evaluate the result of AVS. Use for debugging purposes only.\n" + } + } + }, + "cardVerification": { + "type": "object", + "properties": { + "resultCode": { + "type": "string", + "maxLength": 1, + "description": "Result of card verification. Returned by the authorization service in the `processorInformation.cardVerification.resultCode`\nreply field. If ics_auth and ics_score are requested at the same time, the value is automatically\npassed from ics_auth to ics_score. For more information on using this field, see\n\"\"Sending the Results of Address and Card Verification Tests,\"\" page 16.\nThe field contains one of the following values:\n - `I`: Card verification number failed processor's data\n validation check.\n - `M`: Card verification number matched.\n - `N`: Card verification number not matched.\n - `P`: Card verification number not processed.\n - `S`: Card verification number is on the card but was not included in the request.\n - `U`: Card verification is not supported by the issuing bank.\n - `X`: Card verification is not supported by the payment card company.\n - Space Character: Deprecated. Ignore this value.\n - `1`: CyberSource does not support card verification for this processor or card type.\n - `2`: Processor returned value unrecognized for card verification response.\n - `3`: Processor did not return card verification result code.\n" + }, + "resultCodeRaw": { + "type": "string", + "maxLength": 10, + "description": "CVN result code sent directly from the processor. Returned only when the processor returns this value.\n\n`Important` Do not use this field to evaluate the result of card verification. Use for debugging purposes only.\n" + } + } + }, + "merchantAdvice": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 2, + "description": "Reason the recurring payment transaction was declined. For some processors, this field is used only for\nMastercard. For other processors, this field is used for Visa and Mastercard. And for other processors, this\nfield is not implemented.\n\nPossible values:\n\n - **00**: Response not provided.\n - **01**: New account information is available. Obtain the new information.\n - **02**: Try again later.\n - **03**: Do not try again. Obtain another type of payment from the customer.\n - **04**: Problem with a token or a partial shipment indicator.\n - **21**: Recurring payment cancellation service.\n - **99**: An unknown value was returned from the processor.\n" + }, + "codeRaw": { + "type": "string", + "maxLength": 2, + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\nFor processor-specific information, see the auth_merchant_advice_code_raw field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + }, + "electronicVerificationResults": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 1, + "description": "Mapped Electronic Verification response code for the customer\u2019s name.\n" + }, + "codeRaw": { + "type": "string", + "maxLength": 1, + "description": "Raw Electronic Verification response code from the processor for the customer\u2019s last name" + }, + "email": { + "type": "string", + "maxLength": 1, + "description": "Mapped Electronic Verification response code for the customer\u2019s email address.\n" + }, + "emailRaw": { + "type": "string", + "maxLength": 1, + "description": "Raw Electronic Verification response code from the processor for the customer\u2019s email address." + }, + "phoneNumber": { + "type": "string", + "maxLength": 1, + "description": "Mapped Electronic Verification response code for the customer\u2019s phone number.\n" + }, + "phoneNumberRaw": { + "type": "string", + "maxLength": 1, + "description": "Raw Electronic Verification response code from the processor for the customer\u2019s phone number." + }, + "postalCode": { + "type": "string", + "maxLength": 1, + "description": "Mapped Electronic Verification response code for the customer\u2019s postal code.\n" + }, + "postalCodeRaw": { + "type": "string", + "maxLength": 1, + "description": "Raw Electronic Verification response code from the processor for the customer\u2019s postal code." + }, + "street": { + "type": "string", + "maxLength": 1, + "description": "Mapped Electronic Verification response code for the customer\u2019s street address.\n" + }, + "streetRaw": { + "type": "string", + "maxLength": 1, + "description": "Raw Electronic Verification response code from the processor for the customer\u2019s street address." + }, + "name": { + "type": "string", + "maxLength": 30, + "description": "The description for this field is not available.\n" + }, + "nameRaw": { + "type": "string", + "maxLength": 30, + "description": "The description for this field is not available." + } + } + }, + "achVerification": { + "type": "object", + "properties": { + "resultCode": { + "type": "string", + "maxLength": 2, + "description": "Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible\nvalues, see Appendix H, \"Verification Codes,\" on page 91.\n" + }, + "resultCodeRaw": { + "type": "string", + "maxLength": 10, + "description": "Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the\npossible values, see Appendix H, \"Verification Codes,\" on page 91.\n" + } + } + }, + "customer": { + "type": "object", + "properties": { + "personalIdResult": { + "type": "string", + "maxLength": 1, + "description": "Personal identifier result. This field is supported only for Redecard in Brazil for CyberSource Latin\nAmerican Processing. If you included _buyerInformation.personalIdentification[].ID_ in the request, this\nvalue indicates whether or not _buyerInformation.personalIdentification[].ID_ matched a value in a record\non file. Returned only when the personal ID result is returned by the processor.\n\nPossible values:\n\n - **Y**: Match\n - **N**: No match\n - **K**: Not supported\n - **U**: Unknown\n - **Z**: No response returned\n" + } + } + }, + "consumerAuthenticationResponse": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 3, + "description": "Mapped response code for Verified by Visa and American Express SafeKey:\n" + }, + "codeRaw": { + "type": "string", + "maxLength": 3, + "description": "Raw response code sent directly from the processor for Verified by Visa and American Express SafeKey:\n" + } + } + }, + "systemTraceAuditNumber": { + "type": "string", + "maxLength": 6, + "description": "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\n\n**American Express Direct**\n\nSystem trace audit number (STAN). This value identifies the transaction and is useful when investigating a\nchargeback dispute.\n\n**CyberSource through VisaNet**\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n" + }, + "paymentAccountReferenceNumber": { + "type": "string", + "maxLength": 32, + "description": "Visa-generated reference number that identifies a card-present transaction for which youprovided one of the\nfollowing:\n\n - Visa primary account number (PAN)\n - Visa-generated token for a PAN\n\nThis reference number serves as a link to the cardholder account and to all transactions for that account.\n" + }, + "transactionIntegrityCode": { + "type": "string", + "maxLength": 2, + "description": "Transaction integrity classification provided by Mastercard. This value specifies Mastercard\u2019s evaluation of\nthe transaction\u2019s safety and security. This field is returned only for **CyberSource through VisaNet**.\n\nFor card-present transactions, possible values:\n\n - **A1**: EMV or token in a secure, trusted environment\n - **B1**: EMV or chip equivalent\n - **C1**: Magnetic stripe\n - **E1**: Key entered\n - **U0**: Unclassified\n\nFor card-not-present transactions, possible values:\n\n - **A2**: Digital transactions\n - **B2**: Authenticated checkout\n - **C2**: Transaction validation\n - **D2**: Enhanced data\n - **E2**: Generic messaging\n - **U0**: Unclassified\n\nFor information about these values, contact Mastercard or your acquirer.\n" + }, + "amexVerbalAuthReferenceNumber": { + "type": "string", + "maxLength": 6, + "description": "Referral response number for a verbal authorization with FDMS Nashville when using an American Express card.\nGive this number to American Express when you call them for the verbal authorization.\n" + }, + "salesSlipNumber": { + "type": "number", + "maximum": 99999, + "description": "Transaction identifier that CyberSource generates. You have the option of printing the sales slip number on\nthe receipt.\n\nThis field is supported only for **JCN Gateway**.\n" + }, + "masterCardServiceCode": { + "type": "string", + "maxLength": 2, + "description": "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource.\n\nPossible value:\n - 53: Mastercard card-on-file token service\n" + }, + "masterCardServiceReplyCode": { + "type": "string", + "maxLength": 1, + "description": "Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **C**: Service completed successfully.\n - **F**: One of the following:\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or\n authorization reversal.\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.\n - Token requestor ID is missing or formatted incorrectly.\n - **I**: One of the following:\n - Invalid token requestor ID.\n - Suspended or deactivated token.\n - Invalid token (not in mapping table).\n - **T**: Invalid combination of token requestor ID and token.\n - **U**: Expired token.\n - **W**: Primary account number (PAN) listed in electronic warning bulletin.\n\nNote This field is returned only for **CyberSource through VisaNet**.\n" + }, + "masterCardAuthenticationType": { + "type": "string", + "maxLength": 1, + "description": "Type of authentication for which the transaction qualifies as determined by the Mastercard authentication\nservice, which confirms the identity of the cardholder. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **1**: Transaction qualifies for Mastercard authentication type 1.\n - **2**: Transaction qualifies for Mastercard authentication type 2.\n" + }, + "name": { + "type": "string", + "maxLength": 30, + "description": "Name of the Processor.\n" + }, + "routing": { + "type": "object", + "properties": { + "network": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether the transaction was routed on a credit network, a debit network, or the STAR signature debit\nnetwork.\n\nPossible values:\n- C: Credit network\n- D: Debit network (without signature)\n- S: STAR signature debit network\n\nThis field is supported only on FDC Nashville Global.\n" + }, + "networkName": { + "type": "string", + "maxLength": 10, + "description": "Name of the network on which the transaction was routed.\n\nThis field is supported only on FDC Nashville Global.\n" + }, + "customerSignatureRequired": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether you need to obtain the cardholder's signature.\n\nPossible values:\n- Y: You need to obtain the cardholder's signature.\n- N: You do not need to obtain the cardholder's signature.\n\nThis field is supported only on FDC Nashville Global.\n" + } + } + }, + "merchantNumber": { + "type": "string", + "maxLength": 15, + "description": "Identifier that was assigned to you by your acquirer.\n\nThis value must be printed on the receipt.\n\nThis field is supported only on **American Express Direct**, **FDC Nashville Global**, and **SIX**.\n" + } + } + }, + "issuerInformation": { + "type": "object", + "properties": { + "country": { + "type": "string", + "maxLength": 3, + "description": "Country in which the card was issued. This information enables you to determine whether the card was issued\ndomestically or internationally. Use the two-character ISO Standard Country Codes.\n\nThis field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase\nPaymentech Solutions.\n" + }, + "discretionaryData": { + "type": "string", + "maxLength": 255, + "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n" + }, + "responseCode": { + "type": "string", + "maxLength": 6, + "description": "Additional authorization code that must be printed on the receipt when returned by the processor.\n\nThis value is generated by the processor and is returned only for a successful transaction.\n\nThis field is supported only on FDC Nashville Global and SIX.\n" + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "suffix": { + "type": "string", + "description": "Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n" + } + } + }, + "tokenizedCard": { + "type": "object", + "properties": { + "prefix": { + "type": "string", + "maxLength": 6, + "description": "First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n" + }, + "suffix": { + "type": "string", + "maxLength": 4, + "description": "Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n" + }, + "type": { + "type": "string", + "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n" + }, + "assuranceLevel": { + "type": "string", + "maxLength": 2, + "description": "Confidence level of the tokenization. This value is assigned by the token service provider.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the payment network token expires. `Format: YYYY`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "requestorId": { + "type": "string", + "maxLength": 11, + "description": "Value that identifies your business and indicates that the cardholder\u2019s account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider\u2019s database.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n" + } + } + }, + "accountFeatures": { + "type": "object", + "properties": { + "accountType": { + "type": "string", + "maxLength": 2, + "description": "Type of account. This value is returned only if you requested a balance inquiry. Possible values:\n\n - **00**: Not applicable or not specified\n - **10**: Savings account\n - **20**: Checking account\n - **30**: Credit card account\n - **40**: Universal account\n" + }, + "accountStatus": { + "type": "string", + "maxLength": 1, + "description": "Possible values:\n\n - **N**: Nonregulated\n - **R**: Regulated\n\n`Note` This field is returned only for CyberSource through VisaNet.\n" + }, + "balanceAmount": { + "type": "string", + "maxLength": 12, + "description": "Remaining balance on the account.\n" + }, + "balanceAmountType": { + "type": "string", + "maxLength": 2, + "description": "Type of amount. This value is returned only if you requested a balance inquiry. The issuer determines the value\nthat is returned. Possible values for deposit accounts:\n\n - **01**: Current ledger (posted) balance.\n - **02**: Current available balance, which is typically the ledger balance less outstanding authorizations.\n\nSome depository institutions also include pending deposits and the credit or overdraft line associated with the\naccount. Possible values for credit card accounts:\n\n - **01**: Credit amount remaining for customer (open to buy).\n - **02**: Credit limit.\n" + }, + "currency": { + "type": "string", + "maxLength": 5, + "description": "Currency of the remaining balance on the account. For the possible values, see the ISO Standard Currency Codes.\n" + }, + "balanceSign": { + "type": "string", + "maxLength": 1, + "description": "Sign for the remaining balance on the account. Returned only when the processor returns this value. Possible values:\n\nPossible values:\n - **+**\n - **-**\n", + "enum": [ + "+", + "-" + ] + }, + "affluenceIndicator": { + "type": "string", + "maxLength": 13, + "description": "**Chase Paymentech Solutions**\n\nIndicates whether a customer has high credit limits. This information enables you to market high cost items to\nthese customers and to understand the kinds of cards that high income customers are using.\n\nThis field is supported for Visa, Mastercard, Discover, and Diners Club. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n\n**Litle**\n\nFlag that indicates that a Visa cardholder or Mastercard cardholder is in one of the affluent categories.\nPossible values:\n\n - **AFFLUENT**: High income customer with high spending pattern (>100k USD annual income and >40k USD annual\n card usage).\n - **MASS AFFLUENT**: High income customer (>100k USD annual income).\n\n**Processor specific maximum length**:\n\n - Chase Paymentech Solutions: 1\n - Litle: 13\n" + }, + "category": { + "type": "string", + "maxLength": 7, + "description": "**CyberSource through VisaNet**\n\nVisa product ID.\n\n**GPN**\n\nVisa or Mastercard product ID.\n\n**Litle**\n\nType of card used in the transaction. The only possible value is:\n\n - PREPAID: Prepaid Card\n\n**RBS WorldPay Atlanta**\n\nType of card used in the transaction. Possible values:\n\n - **B**: Business Card\n - **O**: Noncommercial Card\n - **R**: Corporate Card\n - **S**: Purchase Card\n - **Blank**: Purchase card not supported\n\n**Maximum length for processors**:\n\n - CyberSource through VisaNet: 3\n - GPN: 3\n - Litle: 7\n - RBS WorldPay Atlanta: 1\n" + }, + "commercial": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether the card is a commercial card, which enables you to include Level II data in your transaction\nrequests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" + }, + "group": { + "type": "string", + "maxLength": 1, + "description": "Type of commercial card. This field is supported only for CyberSource through VisaNet. Possible values:\n\n - **B**: Business card\n - **R**: Corporate card\n - **S**: Purchasing card\n - **0**: Noncommercial card\n" + }, + "healthCare": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether the card is a healthcare card. This field is supported for Visa and Mastercard on **Chase\nPaymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" + }, + "payroll": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether the card is a payroll card. This field is supported for Visa, Discover, Diners Club, and JCB\non **Chase Paymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" + }, + "level3Eligible": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether the card is eligible for Level III interchange fees, which enables you to include Level III\ndata in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech\nSolutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" + }, + "pinlessDebit": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether the card is a PINless debit card. This field is supported for Visa and Mastercard on **Chase\nPaymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" + }, + "signatureDebit": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether the card is a signature debit card. This information enables you to alter the way an order is\nprocessed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might\nwant to perform reversals promptly for a signature debit card. This field is supported for Visa, Mastercard, and\nMaestro (International) on Chase Paymentech Solutions. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" + }, + "prepaid": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or\nprepaid card is presented for use when establishing a new recurring, installment, or deferred billing\nrelationship.\n\nThis field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions.\nPossible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" + }, + "regulated": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card\nissuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover,\nDiners Club, and JCB on Chase Paymentech Solutions. Possible values:\n\n - **Y**: Yes (assets greater than 10B USD)\n - **N**: No (assets less than 10B USD)\n - **X**: Not applicable / Unknown\n" + } + } + }, + "bank": { + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "correctedAccountNumber": { + "type": "string", + "maxLength": 17, + "description": "Corrected account number from the ACH verification service, which is described in \"ACH Verification,\" page 25.\n" + } + } + }, + "correctedRoutingNumber": { + "type": "string", + "maxLength": 9, + "description": "The description for this field is not available." + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount you requested for the payment or capture.\n\nThis value is returned for partial authorizations.\n" + }, + "authorizedAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount that was authorized.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + }, + "invoiceDetails": { + "type": "object", + "properties": { + "level3TransmissionStatus": { + "type": "boolean", + "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n", + "enum": [ + true, + false + ] + } + } + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "emv": { + "type": "object", + "properties": { + "tags": { + "type": "string", + "maxLength": 1998, + "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" + } + } + }, + "amexCapnData": { + "type": "string", + "maxLength": 12, + "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n" + } + } + }, + "installmentInformation": { + "type": "object", + "properties": { + "additionalCosts": { + "type": "string", + "maximum": 12, + "description": "Additional costs charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 128-139\n- Field: Total Other Costs\n" + }, + "additionalCostsPercentage": { + "type": "string", + "maximum": 4, + "description": "Additional costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 140-143\n- Field: Percent of Total Other Costs\n" + }, + "amountFunded": { + "type": "string", + "maximum": 12, + "description": "Amount funded.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 48-59\n- Field: Total Amount Funded\n" + }, + "amountRequestedPercentage": { + "type": "string", + "maximum": 4, + "description": "Amount requested divided by the amount funded.\n\nFor example:\n- A value of 90.0 specifies 90%.\n- A value of 93.7 specifies 93.7%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 60-63\n- Field: Percent of Amount Requested\n" + }, + "annualFinancingCost": { + "type": "string", + "maximum": 7, + "description": "Annual cost of financing the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 158-164\n- Field: Annual Total Cost of Financing\n" + }, + "annualInterestRate": { + "type": "string", + "maximum": 7, + "description": "Annual interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 151-157\n- Field: Annual Interest Rate\n" + }, + "expenses": { + "type": "string", + "maximum": 12, + "description": "Expenses charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 64-75\n- Field: Total Expenses\n" + }, + "expensesPercentage": { + "type": "string", + "maximum": 4, + "description": "Expenses divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 76-79\n- Field: Percent of Total Expenses\n" + }, + "fees": { + "type": "string", + "maximum": 12, + "description": "Fees charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 80-91\n- Field: Total Fees\n" + }, + "feesPercentage": { + "type": "string", + "maximum": 4, + "description": "Fees divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 92-95\n- Field: Percent of Total Fees\n" + }, + "insurance": { + "type": "string", + "maximum": 12, + "description": "Insurance charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 112-123\n- Field: Total Insurance\n" + }, + "insurancePercentage": { + "type": "string", + "maximum": 4, + "description": "Insurance costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 124-127\n- Field: Percent Of Total Insurance\n" + }, + "monthlyInterestRate": { + "type": "string", + "maximum": 7, + "description": "Monthly interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 144-150\n- Field: Monthly Interest Rate\n" + }, + "taxes": { + "type": "string", + "maximum": 12, + "description": "Taxes collected by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 96-107\n- Field: Total Taxes\n" + }, + "taxesPercentage": { + "type": "string", + "maximum": 4, + "description": "Taxes divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 108-111\n- Field: Percent of Total Taxes\n" + } + } + } + }, + "example": { + "_links": { + "self": { + "href": "/pts/v2/payments/4963015972176007901546", + "method": "GET" + }, + "authReversal": { + "href": "/pts/v2/payments/4963015972176007901546/reversals", + "method": "POST" + }, + "capture": { + "href": "/pts/v2/payments/4963015972176007901546/captures", + "method": "POST" + }, + "refund": { + "href": "/pts/v2/payments/4963015972176007901546/refunds", + "method": "POST" + }, + "void": { + "href": "/pts/v2/payments/4963015972176007901546/voids", + "method": "POST" + } + }, + "id": "4963015972176007901546", + "submitTimeUtc": "2017-06-01T071957Z", + "status": "200", + "reconciliationId": "39570726X3E1LBQR", + "statusInformation": { + "reason": "SUCCESS", + "message": "Successful transaction." + }, + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "orderInformation": { + "amountDetails": { + "authorizedAmount": "102.21", + "currency": "USD" + } + }, + "processorInformation": { + "approvalCode": "888888", + "cardVerification": { + "resultCode": "" + }, + "avs": { + "code": "X", + "codeRaw": "I1" + }, + "responseCode": "100" + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "title": "ptsV2PaymentsPost400Response", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - CARD_TYPE_NOT_ACCEPTED\n - INVALID_MERCHANT_CONFIGURATION\n - PROCESSOR_UNAVAILABLE\n - INVALID_AMOUNT\n - INVALID_CARD_TYPE\n - INVALID_PAYMENT_ID\n - DEBIT_CARD_USEAGE_EXCEEDD_LIMIT\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_CARD", + "CARD_TYPE_NOT_ACCEPTED", + "INVALID_MERCHANT_CONFIGURATION", + "PROCESSOR_UNAVAILABLE", + "INVALID_AMOUNT", + "INVALID_CARD_TYPE", + "DEBIT_CARD_USEAGE_EXCEEDD_LIMIT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "title": "ptsV2PaymentsPost502Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Simple Authorization(Internet)", + "value": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "processingInformation": { + "commerceIndicator": "internet" + }, + "orderInformation": { + "billTo": { + "firstName": "John", + "lastName": "Doe", + "address2": "Address 2", + "address1": "1 Market St", + "postalCode": "94105", + "locality": "san francisco", + "administrativeArea": "CA", + "country": "US", + "phoneNumber": "4158880000", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "102.21", + "currency": "USD" + } + }, + "paymentInformation": { + "card": { + "expirationYear": "2031", + "number": "4111111111111111", + "securityCode": "123", + "expirationMonth": "12" + } + } + } + }, + "example1": { + "summary": "Simple Authorization(Retail)", + "value": { + "clientReferenceInformation": { + "code": "TC50171_8" + }, + "pointOfSaleInformation": { + "terminalId": "001", + "cardPresent": "Y", + "entryMode": "keyed", + "terminalCapability": "2" + }, + "processingInformation": { + "commerceIndicator": "retail" + }, + "orderInformation": { + "billTo": { + "firstName": "John", + "lastName": "Doe", + "address2": "Address 2", + "address1": "1 Market St", + "postalCode": "94105", + "locality": "san francisco", + "administrativeArea": "CA", + "country": "US", + "phoneNumber": "4158880000", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "108.00", + "currency": "USD" + } + }, + "paymentInformation": { + "card": { + "expirationYear": "2031", + "number": "5555555555554444", + "securityCode": "123", + "expirationMonth": "12", + "type": "002" + } + } + } + }, + "example2": { + "summary": "Payment with Payment Instrument Token", + "value": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "processingInformation": { + "commerceIndicator": "internet" + }, + "orderInformation": { + "billTo": { + "firstName": "John", + "lastName": "Doe", + "address1": "1 Market St", + "postalCode": "94105", + "locality": "san francisco", + "administrativeArea": "CA", + "country": "US", + "phoneNumber": "4158880000", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "22", + "currency": "USD" + } + }, + "paymentInformation": { + "customer": { + "customerId": "7500BB199B4270EFE05340588D0AFCAD" + } + } + } + }, + "example3": { + "summary": "Payment Network Tokenization", + "value": { + "clientReferenceInformation": { + "code": "TC_123122" + }, + "processingInformation": { + "commerceIndicator": "internet" + }, + "orderInformation": { + "billTo": { + "firstName": "John", + "lastName": "Doe", + "address1": "1 Market St", + "postalCode": "94105", + "locality": "san francisco", + "administrativeArea": "CA", + "country": "US", + "phoneNumber": "4158880000", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "100", + "currency": "USD" + } + }, + "paymentInformation": { + "tokenizedCard": { + "expirationYear": "2031", + "number": "4111111111111111", + "expirationMonth": "12", + "transactionType": "1" + } + }, + "consumerAuthenticationInformation": { + "cavv": "AAABCSIIAAAAAAACcwgAEMCoNh+=", + "xid": "T1Y0OVcxMVJJdkI0WFlBcXptUzE=" + } + } + }, + "example4": { + "summary": "Digital Payment - GooglePay", + "value": { + "clientReferenceInformation": { + "code": "TC_1231223" + }, + "processingInformation": { + "paymentSolution": "012", + "commerceIndicator": "internet" + }, + "orderInformation": { + "billTo": { + "country": "US", + "firstName": "John", + "lastName": "Deo", + "phoneNumber": "6504327113", + "address1": "901 Metro Center Blvd", + "postalCode": "94404", + "locality": "Foster City", + "administrativeArea": "CA", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "20", + "currency": "USD" + } + }, + "paymentInformation": { + "tokenizedCard": { + "expirationYear": "2020", + "number": "4111111111111111", + "expirationMonth": "12", + "transactionType": "1", + "cryptogram": "EHuWW9PiBkWvqE5juRwDzAUFBAk=" + } + } + } + }, + "example5": { + "summary": "Digital Payments - ApplePay", + "value": { + "clientReferenceInformation": { + "code": "TC_1231223" + }, + "processingInformation": { + "paymentSolution": "001", + "commerceIndicator": "internet" + }, + "orderInformation": { + "billTo": { + "country": "US", + "firstName": "John", + "lastName": "Deo", + "phoneNumber": "6504327113", + "address2": "Desk M3-5573", + "address1": "901 Metro Center Blvd", + "postalCode": "94404", + "locality": "Foster City", + "administrativeArea": "CA", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "10", + "currency": "USD" + } + }, + "paymentInformation": { + "tokenizedCard": { + "expirationYear": "2031", + "number": "4111111111111111", + "expirationMonth": "12", + "transactionType": "1", + "cryptogram": "AceY+igABPs3jdwNaDg3MAACAAA=" + } + } + } + }, + "example6": { + "summary": "CyberSource MPOS - EMV", + "value": { + "clientReferenceInformation": { + "code": "TC50171_16" + }, + "pointOfSaleInformation": { + "cardPresent": "Y", + "catLevel": "1", + "endlessAisleTransactionIndicator": "true", + "entryMode": "contact", + "terminalCapability": "1", + "emv": { + "fallbackCondition": "1", + "fallback": "true" + } + }, + "processingInformation": { + "commerceIndicator": "retail", + "paymentSolution": "011" + }, + "orderInformation": { + "billTo": { + "firstName": "John", + "lastName": "Doe", + "address2": "Address 2", + "address1": "1 Market St", + "postalCode": "94105", + "locality": "san francisco", + "administrativeArea": "CA", + "country": "US", + "phoneNumber": "4158880000", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "15.0", + "currency": "USD" + } + }, + "paymentInformation": { + "fluidData": { + "descriptor": "EMV.PAYMENT.AnywhereCommerce.Walker", + "value": "ewogICJkYXRhIiA6ICJOZmNwRURiK1dLdzBnQkpsaTRcL1hlWm1ITzdUSng0bnRoMnc2Mk9ITVJQK3hCRlFPdFE0WWpRcnY0RmFkOHh6VExqT2VFQm5iNHFzeGZMYTNyNXcxVEdXblFGQnNzMWtPYnA0XC95alNtVE1JSGVjbGc5OFROaEhNb0VRcjJkRkFqYVpBTFAxSlBsdVhKSVwvbTZKSmVwNGh3VHRWZE16Z2laSUhnaWFCYzNXZVd1ZnYzc1l0cGRaZDZYZENEUFdLeXFkYjBJdUtkdkpBPT0iLAogICJzaWduYXR1cmUiIDogIkFxck1pKzc0cm1GeVBKVE9HN3NuN2p5K1YxTlpBZUNJVE56TW01N1B5cmc9IiwKICAic2lnbmF0dXJlQWxnSW5mbyIgOiAiSE1BQ3dpdGhTSEEyNTYiLAogICJoZWFkZXIiIDogewogICAgInRyYW5zYWN0aW9uSWQiIDogIjE1MTU2MjI2NjIuMTcyMjIwIiwKICAgICJwdWJsaWNLZXlIYXNoIiA6ICJcLzdmdldqRVhMazJPRWpcL3Z5bk1jeEZvMmRWSTlpRXVoT2Nab0tHQnpGTmM9IiwKICAgICJhcHBsaWNhdGlvbkRhdGEiIDogIkN5YmVyU291cmNlLlZNcG9zS2l0IiwKICAgICJlcGhlbWVyYWxQdWJsaWNLZXkiIDogIk1Ga3dFd1lIS29aSXpqMENBUVlJS29aSXpqMERBUWNEUWdBRW1JN0tScnRNN2NNelk5Zmw2UWt2NEQzdE9jU0NYR1hoOFwvK2R4K2s5c1Zrbk05UFQrOXRqMzk2YWF6QjRcL0hYaWlLRW9DXC9jUzdoSzF6UFk3MVwvN0pUUT09IgogIH0sCiAgInZlcnNpb24iIDogIjEuMCIKfQ==" + } + } + } + }, + "example7": { + "summary": "Zero Dollar Authorization", + "value": { + "clientReferenceInformation": { + "code": "1234567890" + }, + "processingInformation": { + "commerceIndicator": "internet" + }, + "orderInformation": { + "billTo": { + "firstName": "John", + "lastName": "Doe", + "address1": "1 Market St", + "postalCode": "94105", + "locality": "san francisco", + "administrativeArea": "CA", + "country": "US", + "phoneNumber": "4158880000", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": 0, + "currency": "USD" + } + }, + "paymentInformation": { + "card": { + "expirationYear": "2031", + "number": "5555555555554444", + "securityCode": "123", + "expirationMonth": "12" + } + } + } + }, + "example8": { + "summary": "Level II Data", + "value": { + "clientReferenceInformation": { + "code": "TC50171_12" + }, + "processingInformation": { + "commerceIndicator": "internet" + }, + "orderInformation": { + "billTo": { + "firstName": "John", + "lastName": "Doe", + "address1": "1 Market St", + "postalCode": "94105", + "locality": "san francisco", + "administrativeArea": "CA", + "country": "US", + "phoneNumber": "4158880000", + "email": "test@cybs.com" + }, + "invoiceDetails": { + "purchaseOrderNumber": "LevelII Auth Po" + }, + "amountDetails": { + "totalAmount": "112.00", + "currency": "USD" + } + }, + "paymentInformation": { + "card": { + "expirationYear": "2031", + "number": "4111111111111111", + "securityCode": "123", + "expirationMonth": "12", + "type": "001" + } + } + } + }, + "example9": { + "summary": "Level III Data", + "value": { + "clientReferenceInformation": { + "code": "TC50171_14" + }, + "processingInformation": { + "commerceIndicator": "internet", + "purchaseLevel": "3" + }, + "orderInformation": { + "billTo": { + "firstName": "John", + "lastName": "Doe", + "address1": "1 Market St", + "postalCode": "94105", + "locality": "san francisco", + "administrativeArea": "CA", + "country": "US", + "phoneNumber": "4158880000", + "email": "test@cybs.com" + }, + "invoiceDetails": { + "purchaseOrderNumber": "LevelIII Auth Po" + }, + "lineItems": [ + { + "discountApplied": "false", + "quantity": "10", + "unitPrice": "10.00", + "totalAmount": "100", + "productCode": "default", + "amountIncludesTax": "false" + } + ], + "amountDetails": { + "totalAmount": "100.00", + "currency": "USD" + } + }, + "paymentInformation": { + "card": { + "expirationYear": "2031", + "number": "4111111111111111", + "securityCode": "123", + "expirationMonth": "12", + "type": "001" + } + } + } + }, + "example10": { + "summary": "Partial Authorization", + "value": { + "clientReferenceInformation": { + "code": "1234567890" + }, + "pointOfSaleInformation": { + "cardPresent": "true", + "catLevel": "6", + "emv": { + "fallbackCondition": "1", + "fallback": "false" + }, + "terminalCapability": "4" + }, + "orderInformation": { + "billTo": { + "firstName": "John", + "lastName": "Doe", + "address1": "1 Market St", + "postalCode": "94105", + "locality": "san francisco", + "administrativeArea": "CA", + "country": "US", + "phoneNumber": "4158880000", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "7012.00", + "currency": "USD" + } + }, + "paymentInformation": { + "card": { + "expirationYear": "2031", + "number": "4111111111111111", + "securityCode": "123", + "expirationMonth": "12" + } + } + } + }, + "example11": { + "summary": "Electronic Check Debits", + "value": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "processingInformation": { + "commerceIndicator": "internet" + }, + "orderInformation": { + "billTo": { + "firstName": "John", + "lastName": "Doe", + "address1": "1 Market St", + "postalCode": "94105", + "locality": "san francisco", + "administrativeArea": "CA", + "country": "US", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "100", + "currency": "USD" + } + }, + "paymentInformation": { + "bank": { + "account": { + "number": "4100", + "type": "C" + }, + "routingNumber": "071923284" + } + } + } + }, + "example12": { + "summary": "Service Fees with Credit Card transaction", + "value": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "processingInformation": { + "commerceIndicator": "internet" + }, + "orderInformation": { + "billTo": { + "firstName": "John", + "lastName": "Doe", + "address1": "1 Market St", + "postalCode": "94105", + "locality": "san francisco", + "administrativeArea": "CA", + "country": "US", + "phoneNumber": "4158880000", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "2325.00", + "currency": "USD", + "serviceFeeAmount": "30.0" + } + }, + "paymentInformation": { + "card": { + "expirationYear": "2031", + "number": "4111111111111111", + "securityCode": "123", + "expirationMonth": "12" + } + }, + "merchantInformation": { + "serviceFeeDescriptor": { + "name": "CyberVacations Service Fee", + "contact": "800-999-9999", + "state": "CA" + } + } + } + } + } + } + }, + "/pts/v2/payments/{id}/reversals": { + "post": { + "summary": "Process an Authorization Reversal", + "description": "Include the payment ID in the POST request to reverse the payment amount.", + "tags": [ + "reversal" + ], + "operationId": "authReversal", + "x-devcenter-metaData": { + "categoryTag": "Payments" + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The payment ID returned from a previous payment request.", + "required": true, + "type": "string" + }, + { + "name": "authReversalRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + }, + "reversalInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "maxLength": 19, + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + }, + "reason": { + "type": "string", + "description": "Reason for the authorization reversal. Possible value:\n\n - 34: Suspected fraud\n\nCyberSource ignores this field for processors that do not support this value.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "paymentSolution": { + "type": "string", + "maxLength": 12, + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" + }, + "linkId": { + "type": "string", + "maxLength": 26, + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n" + }, + "reportGroup": { + "type": "string", + "maxLength": 25, + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n" + }, + "visaCheckoutId": { + "type": "string", + "maxLength": 48, + "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n" + }, + "issuer": { + "type": "object", + "properties": { + "discretionaryData": { + "type": "string", + "maxLength": 255, + "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n" + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "serviceFeeAmount": { + "type": "string", + "maxLength": 15, + "description": "Service fee. Required for service fee transactions.\n" + } + } + }, + "lineItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quantity": { + "type": "number", + "minimum": 1, + "maximum": 9999999999, + "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n", + "default": 1 + }, + "unitPrice": { + "type": "string", + "maxLength": 15, + "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" + } + } + } + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "emv": { + "type": "object", + "properties": { + "tags": { + "type": "string", + "maxLength": 1998, + "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" + } + } + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "reversalInformation": { + "reason": "testing", + "amountDetails": { + "totalAmount": "102.21" + } + } + } + } + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "title": "ptsV2PaymentsReversalsPost201Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - REVERSED\n", + "enum": [ + "REVERSED" + ] + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "submitLocalDateTime": { + "type": "string", + "maxLength": 14, + "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" + }, + "ownerMerchantId": { + "type": "string", + "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" + } + } + }, + "reversalAmountDetails": { + "type": "object", + "properties": { + "reversedAmount": { + "type": "string", + "maxLength": 15, + "description": "Total reversed amount." + }, + "originalTransactionAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount of the original transaction." + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + }, + "processorInformation": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "maxLength": 18, + "description": "Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n" + }, + "responseCode": { + "type": "string", + "maxLength": 10, + "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n" + }, + "responseCategoryCode": { + "type": "string", + "maxLength": 32, + "description": "Processor-defined response category code. The associated detail error code is in the auth_auth_response\nfield or the auth_reversal_auth_ response field depending on which service you requested.\n\nThis field is supported only for:\n\n - Japanese issuers\n - Domestic transactions in Japan\n - Comercio Latino\u2014processor transaction ID required for troubleshooting\n\n**Maximum length for processors**:\n\n - Comercio Latino: 32\n - All other processors: 3\n" + }, + "forwardedAcquirerCode": { + "type": "string", + "maxLength": 32, + "description": "Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n" + }, + "masterCardServiceCode": { + "type": "string", + "maxLength": 2, + "description": "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource.\n\nPossible value:\n - 53: Mastercard card-on-file token service\n" + }, + "masterCardServiceReplyCode": { + "type": "string", + "maxLength": 1, + "description": "Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **C**: Service completed successfully.\n - **F**: One of the following:\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or\n authorization reversal.\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.\n - Token requestor ID is missing or formatted incorrectly.\n - **I**: One of the following:\n - Invalid token requestor ID.\n - Suspended or deactivated token.\n - Invalid token (not in mapping table).\n - **T**: Invalid combination of token requestor ID and token.\n - **U**: Expired token.\n - **W**: Primary account number (PAN) listed in electronic warning bulletin.\n\nNote This field is returned only for **CyberSource through VisaNet**.\n" + } + } + }, + "issuerInformation": { + "type": "object", + "properties": { + "responseCode": { + "type": "string", + "maxLength": 6, + "description": "Additional authorization code that must be printed on the receipt when returned by the processor.\n\nThis value is generated by the processor and is returned only for a successful transaction.\n\nThis field is supported only on FDC Nashville Global and SIX.\n" + } + } + }, + "authorizationInformation": { + "type": "object", + "properties": { + "approvalCode": { + "type": "string", + "maxLength": 6, + "description": "The authorization code returned by the processor." + }, + "reasonCode": { + "type": "string", + "maxLength": 50, + "description": "Reply flag for the original transaction." + }, + "reversalSubmitted": { + "type": "string", + "maxLength": 1, + "description": "Flag indicating whether a full authorization reversal was successfully submitted.\n\nPossible values:\n- Y: The authorization reversal was successfully submitted.\n- N: The authorization reversal was not successfully submitted. You must send a credit request for a refund.\n\nThis field is supported only for **FDC Nashville Global**.\n" + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "emv": { + "type": "object", + "properties": { + "tags": { + "type": "string", + "maxLength": 1998, + "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" + } + } + } + } + } + }, + "example": { + "_links": { + "self": { + "href": "/pts/v2/reversals/4963015523026180001545", + "method": "GET" + } + }, + "id": "4963015523026180001545", + "submitTimeUtc": "2017-06-01T071912Z", + "status": "200", + "statusInformation": { + "reason": "SUCCESS", + "message": "Successful transaction." + }, + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "orderInformation": { + "amountDetails": { + "currency": "USD" + } + }, + "processorInformation": { + "responseCode": "100" + }, + "reversalAmountDetails": { + "reversedAmount": "102.21", + "currency": "USD" + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "title": "ptsV2PaymentsReversalsPost400Response", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - PROCESSOR_UNAVAILABLE\n - AUTH_ALREADY_REVERSED\n - TRANSACTION_ALREADY_SETTLED\n - INVALID_AMOUNT\n - MISSING_AUTH\n - TRANSACTION_ALREADY_REVERSED_OR_SETTLED\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_MERCHANT_CONFIGURATION", + "AUTH_ALREADY_REVERSED", + "MISSING_AUTH", + "TRANSACTION_ALREADY_REVERSED_OR_SETTLED" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "title": "ptsV2PaymentsReversalsPost502Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Process an Authorization Reversal", + "value": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "reversalInformation": { + "reason": "testing", + "amountDetails": { + "totalAmount": "102.21" + } + } + } + }, + "example1": { + "summary": "Service Fees Authorization Reversal", + "value": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "reversalInformation": { + "reason": "34", + "amountDetails": { + "totalAmount": "2325.00", + "serviceFeeAmount": "30.0" + } + } + } + } + } + } + }, + "/pts/v2/reversals/": { + "post": { + "summary": "Merchant Initiated Reversal", + "description": "This is to reverse a previous payment that merchant does not receive a reply.", + "tags": [ + "reversal" + ], + "operationId": "mitReversal", + "x-devcenter-metaData": { + "categoryTag": "Payments" + }, + "parameters": [ + { + "name": "mitReversalRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "transactionId": { + "type": "string", + "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nSee page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "originalTransactionId": { + "type": "string", + "maxLength": 32, + "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + }, + "reversalInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "maxLength": 19, + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + }, + "reason": { + "type": "string", + "description": "Reason for the authorization reversal. Possible value:\n\n - 34: Suspected fraud\n\nCyberSource ignores this field for processors that do not support this value.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "paymentSolution": { + "type": "string", + "maxLength": 12, + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" + }, + "linkId": { + "type": "string", + "maxLength": 26, + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n" + }, + "reportGroup": { + "type": "string", + "maxLength": 25, + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n" + }, + "visaCheckoutId": { + "type": "string", + "maxLength": 48, + "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n" + }, + "issuer": { + "type": "object", + "properties": { + "discretionaryData": { + "type": "string", + "maxLength": 255, + "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n" + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "serviceFeeAmount": { + "type": "string", + "maxLength": 15, + "description": "Service fee. Required for service fee transactions.\n" + } + } + }, + "lineItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quantity": { + "type": "number", + "minimum": 1, + "maximum": 9999999999, + "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n", + "default": 1 + }, + "unitPrice": { + "type": "string", + "maxLength": 15, + "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" + } + } + } + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "emv": { + "type": "object", + "properties": { + "tags": { + "type": "string", + "maxLength": 1998, + "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" + } + } + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "TC50171_3", + "transactionId": "496301552302618" + }, + "reversalInformation": { + "reason": "testing", + "amountDetails": { + "totalAmount": "102.21" + } + } + } + } + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - REVERSED\n", + "enum": [ + "REVERSED" + ] + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "submitLocalDateTime": { + "type": "string", + "maxLength": 14, + "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" + }, + "ownerMerchantId": { + "type": "string", + "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" + } + } + }, + "reversalAmountDetails": { + "type": "object", + "properties": { + "reversedAmount": { + "type": "string", + "maxLength": 15, + "description": "Total reversed amount." + }, + "originalTransactionAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount of the original transaction." + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + }, + "processorInformation": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "maxLength": 18, + "description": "Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n" + }, + "responseCode": { + "type": "string", + "maxLength": 10, + "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n" + }, + "responseCategoryCode": { + "type": "string", + "maxLength": 32, + "description": "Processor-defined response category code. The associated detail error code is in the auth_auth_response\nfield or the auth_reversal_auth_ response field depending on which service you requested.\n\nThis field is supported only for:\n\n - Japanese issuers\n - Domestic transactions in Japan\n - Comercio Latino\u2014processor transaction ID required for troubleshooting\n\n**Maximum length for processors**:\n\n - Comercio Latino: 32\n - All other processors: 3\n" + }, + "forwardedAcquirerCode": { + "type": "string", + "maxLength": 32, + "description": "Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n" + }, + "masterCardServiceCode": { + "type": "string", + "maxLength": 2, + "description": "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource.\n\nPossible value:\n - 53: Mastercard card-on-file token service\n" + }, + "masterCardServiceReplyCode": { + "type": "string", + "maxLength": 1, + "description": "Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **C**: Service completed successfully.\n - **F**: One of the following:\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or\n authorization reversal.\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.\n - Token requestor ID is missing or formatted incorrectly.\n - **I**: One of the following:\n - Invalid token requestor ID.\n - Suspended or deactivated token.\n - Invalid token (not in mapping table).\n - **T**: Invalid combination of token requestor ID and token.\n - **U**: Expired token.\n - **W**: Primary account number (PAN) listed in electronic warning bulletin.\n\nNote This field is returned only for **CyberSource through VisaNet**.\n" + } + } + }, + "issuerInformation": { + "type": "object", + "properties": { + "responseCode": { + "type": "string", + "maxLength": 6, + "description": "Additional authorization code that must be printed on the receipt when returned by the processor.\n\nThis value is generated by the processor and is returned only for a successful transaction.\n\nThis field is supported only on FDC Nashville Global and SIX.\n" + } + } + }, + "authorizationInformation": { + "type": "object", + "properties": { + "approvalCode": { + "type": "string", + "maxLength": 6, + "description": "The authorization code returned by the processor." + }, + "reasonCode": { + "type": "string", + "maxLength": 50, + "description": "Reply flag for the original transaction." + }, + "reversalSubmitted": { + "type": "string", + "maxLength": 1, + "description": "Flag indicating whether a full authorization reversal was successfully submitted.\n\nPossible values:\n- Y: The authorization reversal was successfully submitted.\n- N: The authorization reversal was not successfully submitted. You must send a credit request for a refund.\n\nThis field is supported only for **FDC Nashville Global**.\n" + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "emv": { + "type": "object", + "properties": { + "tags": { + "type": "string", + "maxLength": 1998, + "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" + } + } + } + } + } + }, + "example": { + "_links": { + "self": { + "href": "/pts/v2/reversals/4963015523026180001545", + "method": "GET" + } + }, + "id": "4963015523026180001545", + "submitTimeUtc": "2017-06-01T071912Z", + "status": "200", + "statusInformation": { + "reason": "SUCCESS", + "message": "Successful transaction." + }, + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "orderInformation": { + "amountDetails": { + "currency": "USD" + } + }, + "processorInformation": { + "responseCode": "100" + }, + "reversalAmountDetails": { + "reversedAmount": "102.21", + "currency": "USD" + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - PROCESSOR_UNAVAILABLE\n - AUTH_ALREADY_REVERSED\n - TRANSACTION_ALREADY_SETTLED\n - INVALID_AMOUNT\n - MISSING_AUTH\n - TRANSACTION_ALREADY_REVERSED_OR_SETTLED\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_MERCHANT_CONFIGURATION", + "AUTH_ALREADY_REVERSED", + "MISSING_AUTH", + "TRANSACTION_ALREADY_REVERSED_OR_SETTLED" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + } + } + }, + "/pts/v2/payments/{id}/captures": { + "post": { + "summary": "Capture a Payment", + "description": "Include the payment ID in the POST request to capture the payment amount.", + "tags": [ + "capture" + ], + "operationId": "capturePayment", + "x-devcenter-metaData": { + "categoryTag": "Payments" + }, + "parameters": [ + { + "name": "capturePaymentRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "transactionId": { + "type": "string", + "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nSee page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "originalTransactionId": { + "type": "string", + "maxLength": 32, + "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "paymentSolution": { + "type": "string", + "maxLength": 12, + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" + }, + "linkId": { + "type": "string", + "maxLength": 26, + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n" + }, + "reportGroup": { + "type": "string", + "maxLength": 25, + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n" + }, + "visaCheckoutId": { + "type": "string", + "maxLength": 48, + "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n" + }, + "purchaseLevel": { + "type": "string", + "maxLength": 1, + "description": "Set this field to 3 to indicate that the request includes Level III data." + }, + "issuer": { + "type": "object", + "properties": { + "discretionaryData": { + "type": "string", + "maxLength": 255, + "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n" + } + } + }, + "authorizationOptions": { + "type": "object", + "properties": { + "authType": { + "type": "string", + "maxLength": 15, + "description": "Authorization type.\n\nPossible values:\n\n - **AUTOCAPTURE**: automatic capture.\n - **STANDARDCAPTURE**: standard capture.\n - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n**Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing**\\\nSet this field to _AUTOCAPTURE_ and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to STANDARDCAPTURE and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see \"Automatic Captures,\" page 33.\n\n**Forced Capture**\\\nSet this field to _VERBAL_ and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. For more information, see \"Forced Captures,\" page 123.\n\n**Verbal Authorization**\\\nSet this field to _VERBAL_ and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations,\" page 84.\n\nFor processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "verbalAuthCode": { + "type": "string", + "maxLength": 7, + "description": "Authorization code.\n\n**Forced Capture**\\\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n**Verbal Authorization**\\\nUse this field in CAPTURE API to send the verbally received authorization code.\n\nFor processor-specific information, see the _auth_code_ field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "verbalAuthTransactionId": { + "type": "string", + "maxLength": 15, + "description": "Transaction ID (TID)." + } + } + }, + "captureOptions": { + "type": "object", + "properties": { + "captureSequenceNumber": { + "type": "number", + "minimum": 1, + "maximum": 99, + "description": "Capture number when requesting multiple partial captures for one payment.\nUsed along with _totalCaptureCount_ to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n" + }, + "totalCaptureCount": { + "type": "number", + "minimum": 1, + "maximum": 99, + "description": "Total number of captures when requesting multiple partial captures for one payment.\nUsed along with _captureSequenceNumber_ which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n" + } + } + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "customer": { + "type": "object", + "properties": { + "customerId": { + "type": "string", + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "maxLength": 19, + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + }, + "discountAmount": { + "type": "string", + "maxLength": 15, + "description": "Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "dutyAmount": { + "type": "string", + "maxLength": 15, + "description": "Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAmount": { + "type": "string", + "maxLength": 12, + "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "nationalTaxIncluded": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAppliedAfterDiscount": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAppliedLevel": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxTypeCode": { + "type": "string", + "maxLength": 3, + "description": "For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "freightAmount": { + "type": "string", + "maxLength": 13, + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "foreignAmount": { + "type": "string", + "maxLength": 15, + "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "foreignCurrency": { + "type": "string", + "maxLength": 5, + "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "exchangeRate": { + "type": "string", + "maxLength": 13, + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "exchangeRateTimeStamp": { + "type": "string", + "maxLength": 14, + "description": "Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "amexAdditionalAmounts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 3, + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "amount": { + "type": "string", + "maxLength": 12, + "description": "Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + } + }, + "taxDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", + "enum": [ + "alternate", + "local", + "national", + "vat" + ] + }, + "amount": { + "type": "string", + "maxLength": 13, + "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" + }, + "rate": { + "type": "string", + "maxLength": 6, + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" + }, + "code": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" + }, + "applied": { + "type": "boolean", + "description": "The tax is applied. Valid value is `true` or `false`." + }, + "exemptionCode": { + "type": "string", + "maxLength": 1, + "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" + } + } + } + }, + "serviceFeeAmount": { + "type": "string", + "maxLength": 15, + "description": "Service fee. Required for service fee transactions.\n" + }, + "originalCurrency": { + "type": "string", + "maxLength": 15, + "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n" + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "company": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address1": { + "type": "string", + "maxLength": 40, + "description": "First line in the street address of the company purchasing the product." + }, + "address2": { + "type": "string", + "maxLength": 40, + "description": "Additional address information for the company purchasing the product." + }, + "locality": { + "type": "string", + "maxLength": 30, + "description": "City in the address of the company purchasing the product." + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n" + } + } + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" + } + } + }, + "shipTo": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "country": { + "type": "string", + "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.", + "maxLength": 2 + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" + } + } + }, + "lineItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "productCode": { + "type": "string", + "maxLength": 255, + "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n" + }, + "productName": { + "type": "string", + "maxLength": 255, + "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`),\nthis field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of\nthe other values that are related to shipping and/or handling.\n" + }, + "productSku": { + "type": "string", + "maxLength": 255, + "description": "Stock Keeping Unit (SKU) code for the product.\n\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n" + }, + "quantity": { + "type": "number", + "minimum": 1, + "maximum": 9999999999, + "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n", + "default": 1 + }, + "unitPrice": { + "type": "string", + "maxLength": 15, + "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" + }, + "unitOfMeasure": { + "type": "string", + "maxLength": 12, + "description": "Unit of measure, or unit of measure code, for the item.\n" + }, + "totalAmount": { + "type": "string", + "maxLength": 13, + "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units. Example: 123.45 USD= 123\n" + }, + "taxAmount": { + "type": "string", + "maxLength": 15, + "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nIf you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API.\n\nThis field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API.\n" + }, + "taxRate": { + "type": "string", + "maxLength": 7, + "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + }, + "taxAppliedAfterDiscount": { + "type": "string", + "maxLength": 1, + "description": "Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n" + }, + "taxStatusIndicator": { + "type": "string", + "maxLength": 1, + "description": "Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n" + }, + "taxTypeCode": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "amountIncludesTax": { + "type": "boolean", + "description": "Flag that indicates whether the tax amount is included in the Line Item Total.\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "typeOfSupply": { + "type": "string", + "maxLength": 2, + "description": "Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n" + }, + "commodityCode": { + "type": "string", + "maxLength": 15, + "description": "Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n" + }, + "discountAmount": { + "type": "string", + "maxLength": 13, + "description": "Discount applied to the item." + }, + "discountApplied": { + "type": "boolean", + "description": "Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "discountRate": { + "type": "string", + "maxLength": 6, + "description": "Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n" + }, + "invoiceNumber": { + "type": "string", + "maxLength": 23, + "description": "Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n" + }, + "taxDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", + "enum": [ + "alternate", + "local", + "national", + "vat" + ] + }, + "amount": { + "type": "string", + "maxLength": 13, + "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" + }, + "rate": { + "type": "string", + "maxLength": 6, + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" + }, + "code": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" + }, + "applied": { + "type": "boolean", + "description": "The tax is applied. Valid value is `true` or `false`." + }, + "exemptionCode": { + "type": "string", + "maxLength": 1, + "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" + } + } + } + }, + "fulfillmentType": { + "type": "string", + "description": "The description for this field is not available." + }, + "weight": { + "type": "string", + "maxLength": 9, + "description": "Weight of the item. See Numbered Elements." + }, + "weightIdentifier": { + "type": "string", + "maxLength": 1, + "description": "Type of weight. See Numbered Elements.\n\nPossible values:\n- B: Billed weight\n- N: Actual net weight\n" + }, + "weightUnit": { + "type": "string", + "maxLength": 2, + "description": "Code that specifies the unit of measurement for the weight amount. For example, OZ specifies ounce and LB\nspecifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC).\n\nSee Numbered Elements.\n" + }, + "referenceDataCode": { + "type": "string", + "maxLength": 2, + "description": "Code that identifies the value of the corresponding item_#_referenceData_#_number field. See Numbered Elements.\n\nPossible values:\n- AN: Client-defined asset code\n- MG: Manufacturer's part number\n- PO: Purchase order number\n- SK: Supplier stock keeping unit number\n- UP: Universal product code\n- VC: Supplier catalog number\n- VP: Vendor part number\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" + }, + "referenceDataNumber": { + "type": "string", + "maxLength": 30, + "description": "Reference number.\n\nThe meaning of this value is identified by the value of the corresponding `referenceDataCode` field.\nSee Numbered Elements.\n\nThe maximum length for this field depends on the value of the corresponding `referenceDataCode` field:\n- When the code is `PO`, the maximum length for the reference number is 22.\n- When the code is `VC`, the maximum length for the reference number is 20.\n- For all other codes, the maximum length for the reference number is 30.\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" + } + } + } + }, + "invoiceDetails": { + "type": "object", + "properties": { + "purchaseOrderNumber": { + "type": "string", + "maxLength": 25, + "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "purchaseOrderDate": { + "type": "string", + "maxLength": 10, + "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "purchaseContactName": { + "type": "string", + "maxLength": 36, + "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxable": { + "type": "boolean", + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "vatInvoiceReferenceNumber": { + "type": "string", + "maxLength": 15, + "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "commodityCode": { + "type": "string", + "maxLength": 4, + "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "transactionAdviceAddendum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "string", + "maxLength": 40, + "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n" + } + } + } + } + } + }, + "shippingDetails": { + "type": "object", + "properties": { + "shipFromPostalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n" + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "merchantCustomerId": { + "type": "string", + "maxLength": 100, + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "vatRegistrationNumber": { + "type": "string", + "maxLength": 20, + "description": "Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + } + } + }, + "deviceInformation": { + "type": "object", + "properties": { + "hostName": { + "type": "string", + "maxLength": 60, + "description": "Host name reported by the customer\u2019s browser to your Web server identified via the HTTP header." + }, + "ipAddress": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n" + }, + "userAgent": { + "type": "string", + "maxLength": 40, + "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n" + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" + }, + "alternateName": { + "type": "string", + "maxLength": 13, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "contact": { + "type": "string", + "maxLength": 14, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "locality": { + "type": "string", + "maxLength": 13, + "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 14, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + }, + "cardAcceptorReferenceNumber": { + "type": "string", + "maxLength": 25, + "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "categoryCode": { + "type": "integer", + "maximum": 9999, + "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + }, + "vatRegistrationNumber": { + "type": "string", + "maxLength": 21, + "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "serviceFeeDescriptor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 22, + "description": "Name of the service provider that is collecting the service fee. The service provider name must consist of\n3, 7, or 12 characters followed by an asterisk (*). This value must also include the words \u201cService Fee.\u201d\n\nWhen you include more than one consecutive space, extra spaces are removed. Use one of the following formats\nfor this value:\n- <3-character name>*Service Fee\n- <7-character name>*Service Fee\n- <12-character name>*Service Fee\n\nWhen payments are made in installments, this value must also include installment information such as\n\u201c1 of 5\u201d or \u201c3 of 7.\u201d For installment payments, use one of the following formats for this value:\n- <3-character name>*Service Fee* of \n- <7-character name>*Service Fee* of \n- <12-character name>*Service Fee* of \n\nwhere is the payment number and is the total number of payments.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource\naccount.\n\nThis value might be displayed on the cardholder\u2019s statement.\n" + }, + "contact": { + "type": "string", + "maxLength": 11, + "description": "Contact information for the service provider that is collecting the service fee. when you include more than one\nconsecutive space, extra spaces are removed.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder\u2019s statement.\n" + }, + "state": { + "type": "string", + "maxLength": 20, + "description": "State or territory in which the service provider is located.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder\u2019s statement.\n" + } + } + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" + } + } + }, + "aggregatorInformation": { + "type": "object", + "properties": { + "aggregatorId": { + "type": "string", + "maxLength": 20, + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "name": { + "type": "string", + "maxLength": 37, + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "subMerchant": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 37, + "description": "Sub-merchant\u2019s business name.\n\n**American Express Direct**\\\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\n**FDC Nashville Global**\\\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n" + }, + "address1": { + "type": "string", + "maxLength": 38, + "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "locality": { + "type": "string", + "maxLength": 21, + "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 15, + "description": "Partial postal code for the sub-merchant\u2019s address.\n\nSee \"Aggregator Support,\" page 100 for details.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "country": { + "type": "string", + "maxLength": 3, + "description": "Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nSee \"Aggregator Support,\" page 101.\n" + }, + "email": { + "type": "string", + "maxLength": 40, + "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 20, + "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n" + } + } + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "emv": { + "type": "object", + "properties": { + "tags": { + "type": "string", + "maxLength": 1998, + "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" + }, + "fallback": { + "type": "boolean", + "maxLength": 5, + "description": "Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.\n\nPossible values:\n - **true**\n - **false** (default)\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n", + "enum": [ + true, + false + ], + "default": false + } + } + }, + "amexCapnData": { + "type": "string", + "maxLength": 12, + "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n" + } + } + }, + "merchantDefinedInformation": { + "type": "array", + "description": "The description for this field is not available.", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 50, + "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n" + }, + "value": { + "type": "string", + "maxLength": 255, + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + } + } + } + }, + "installmentInformation": { + "type": "object", + "properties": { + "firstInstallmentDate": { + "type": "string", + "maximum": 6, + "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a\nstring of six zeros (000000) to the processor. See Installment Payments on CyberSource through VisaNet.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" + }, + "invoiceData": { + "type": "string", + "maximum": 20, + "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n" + }, + "paymentType": { + "type": "string", + "maximum": 1, + "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" + }, + "additionalCosts": { + "type": "string", + "maximum": 12, + "description": "Additional costs charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 128-139\n- Field: Total Other Costs\n" + }, + "additionalCostsPercentage": { + "type": "string", + "maximum": 4, + "description": "Additional costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 140-143\n- Field: Percent of Total Other Costs\n" + }, + "amountFunded": { + "type": "string", + "maximum": 12, + "description": "Amount funded.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 48-59\n- Field: Total Amount Funded\n" + }, + "amountRequestedPercentage": { + "type": "string", + "maximum": 4, + "description": "Amount requested divided by the amount funded.\n\nFor example:\n- A value of 90.0 specifies 90%.\n- A value of 93.7 specifies 93.7%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 60-63\n- Field: Percent of Amount Requested\n" + }, + "annualFinancingCost": { + "type": "string", + "maximum": 7, + "description": "Annual cost of financing the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 158-164\n- Field: Annual Total Cost of Financing\n" + }, + "annualInterestRate": { + "type": "string", + "maximum": 7, + "description": "Annual interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 151-157\n- Field: Annual Interest Rate\n" + }, + "expenses": { + "type": "string", + "maximum": 12, + "description": "Expenses charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 64-75\n- Field: Total Expenses\n" + }, + "expensesPercentage": { + "type": "string", + "maximum": 4, + "description": "Expenses divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 76-79\n- Field: Percent of Total Expenses\n" + }, + "fees": { + "type": "string", + "maximum": 12, + "description": "Fees charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 80-91\n- Field: Total Fees\n" + }, + "feesPercentage": { + "type": "string", + "maximum": 4, + "description": "Fees divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 92-95\n- Field: Percent of Total Fees\n" + }, + "insurance": { + "type": "string", + "maximum": 12, + "description": "Insurance charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 112-123\n- Field: Total Insurance\n" + }, + "insurancePercentage": { + "type": "string", + "maximum": 4, + "description": "Insurance costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 124-127\n- Field: Percent Of Total Insurance\n" + }, + "monthlyInterestRate": { + "type": "string", + "maximum": 7, + "description": "Monthly interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 144-150\n- Field: Monthly Interest Rate\n" + }, + "taxes": { + "type": "string", + "maximum": 12, + "description": "Taxes collected by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 96-107\n- Field: Total Taxes\n" + }, + "taxesPercentage": { + "type": "string", + "maximum": 4, + "description": "Taxes divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 108-111\n- Field: Percent of Total Taxes\n" + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "orderInformation": { + "amountDetails": { + "totalAmount": "102.21", + "currency": "USD" + } + } + }, + "x-example": { + "example0": { + "summary": "Capture a Payment", + "value": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "orderInformation": { + "amountDetails": { + "totalAmount": "102.21", + "currency": "USD" + } + } + } + }, + "example1": { + "summary": "Capture a Payment - Service Fee", + "value": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "orderInformation": { + "amountDetails": { + "totalAmount": "2325.00", + "currency": "USD", + "serviceFeeAmount": "30.0" + } + }, + "merchantInformation": { + "serviceFeeDescriptor": { + "name": "CyberVacations Service Fee", + "contact": "800-999-9999", + "state": "CA" + } + } + } + } + } + } + }, + { + "name": "id", + "in": "path", + "description": "The payment ID returned from a previous payment request. This ID links the capture to the payment.\n", + "required": true, + "type": "string" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "title": "ptsV2PaymentsCapturesPost201Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + }, + "void": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + }, + "refund": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - PENDING\n", + "enum": [ + "PENDING" + ] + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "submitLocalDateTime": { + "type": "string", + "maxLength": 14, + "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" + }, + "ownerMerchantId": { + "type": "string", + "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" + } + } + }, + "processorInformation": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "maxLength": 18, + "description": "Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n" + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount you requested for the capture.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + }, + "invoiceDetails": { + "type": "object", + "properties": { + "level3TransmissionStatus": { + "type": "boolean", + "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n", + "enum": [ + true, + false + ] + } + } + } + } + } + }, + "example": { + "_links": { + "self": { + "href": "/pts/v2/captures/4963014519526177701545", + "method": "GET" + }, + "refund": { + "href": "/pts/v2/captures/4963014519526177701545/refunds", + "method": "POST" + }, + "void": { + "href": "/pts/v2/captures/4963014519526177701545/voids", + "method": "POST" + } + }, + "id": "4963014519526177701545", + "submitTimeUtc": "2017-06-01T071731Z", + "status": "200", + "reconciliationId": "39570715X3E1LBQA", + "statusInformation": { + "reason": "SUCCESS", + "message": "Successful transaction." + }, + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "orderInformation": { + "amountDetails": { + "totalAmount": "102.21", + "currency": "USD" + } + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "title": "ptsV2PaymentsCapturesPost400Response", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - EXCEEDS_AUTH_AMOUNT\n - AUTH_ALREADY_REVERSED\n - TRANSACTION_ALREADY_SETTLED\n - INVALID_AMOUNT\n - MISSING_AUTH\n - TRANSACTION_ALREADY_REVERSED_OR_SETTLED\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_MERCHANT_CONFIGURATION", + "EXCEEDS_AUTH_AMOUNT", + "AUTH_ALREADY_REVERSED", + "TRANSACTION_ALREADY_SETTLED", + "MISSING_AUTH", + "TRANSACTION_ALREADY_REVERSED_OR_SETTLED" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "title": "ptsV2PaymentsCapturesPost502Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Capture a Payment", + "value": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "orderInformation": { + "amountDetails": { + "totalAmount": "102.21", + "currency": "USD" + } + } + } + }, + "example1": { + "summary": "Capture a Payment - Service Fee", + "value": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "orderInformation": { + "amountDetails": { + "totalAmount": "2325.00", + "currency": "USD", + "serviceFeeAmount": "30.0" + } + }, + "merchantInformation": { + "serviceFeeDescriptor": { + "name": "CyberVacations Service Fee", + "contact": "800-999-9999", + "state": "CA" + } + } + } + } + } + } + }, + "/pts/v2/payments/{id}/refunds": { + "post": { + "summary": "Refund a Payment", + "description": "Include the payment ID in the POST request to refund the payment amount.\n", + "tags": [ + "refund" + ], + "operationId": "refundPayment", + "x-devcenter-metaData": { + "categoryTag": "Payments" + }, + "parameters": [ + { + "name": "refundPaymentRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "transactionId": { + "type": "string", + "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nSee page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "originalTransactionId": { + "type": "string", + "maxLength": 32, + "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "paymentSolution": { + "type": "string", + "maxLength": 12, + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" + }, + "linkId": { + "type": "string", + "maxLength": 26, + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n" + }, + "reportGroup": { + "type": "string", + "maxLength": 25, + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n" + }, + "visaCheckoutId": { + "type": "string", + "maxLength": 48, + "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n" + }, + "purchaseLevel": { + "type": "string", + "maxLength": 1, + "description": "Set this field to 3 to indicate that the request includes Level III data." + }, + "recurringOptions": { + "type": "object", + "properties": { + "loanPayment": { + "type": "boolean", + "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- **true** Loan payment\n- **false** (default) Not a loan payment\n\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\n", + "enum": [ + true, + false + ], + "default": false + } + } + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 20, + "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\nFor processor-specific information, see the `customer_cc_expmo` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`.\n\nFor processor-specific information, see the `customer_cc_expyr` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "type": { + "type": "string", + "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n" + }, + "accountEncoderId": { + "type": "string", + "maxLength": 3, + "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n" + }, + "issueNumber": { + "type": "string", + "maxLength": 5, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" + }, + "startMonth": { + "type": "string", + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "startYear": { + "type": "string", + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + } + } + }, + "bank": { + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 1, + "description": "Account type.\n\nPossible values:\n - **C**: Checking.\n - **G**: General ledger. This value is supported only on Wells Fargo ACH.\n - **S**: Savings (U.S. dollars only).\n - **X**: Corporate checking (U.S. dollars only).\n" + }, + "number": { + "type": "string", + "maxLength": 17, + "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" + }, + "encoderId": { + "type": "string", + "maxLength": 3, + "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor. See \"Encoded Account Numbers,\" page 39.\n" + }, + "checkNumber": { + "type": "string", + "maxLength": 8, + "description": "Check number.\n\nChase Paymentech Solutions - Optional.\nCyberSource ACH Service - Not used.\nRBS WorldPay Atlanta - Optional on debits. Required on credits.\nTeleCheck - Strongly recommended on debit requests. Optional on credits.\n" + }, + "checkImageReferenceNumber": { + "type": "string", + "maxLength": 32, + "description": "Image reference number associated with the check. You cannot include any special characters.\n" + } + } + }, + "routingNumber": { + "type": "string", + "maxLength": 9, + "description": "Bank routing number.\n\nThis is also called the transit number.\n" + } + } + }, + "customer": { + "type": "object", + "properties": { + "customerId": { + "type": "string", + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "maxLength": 19, + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + }, + "discountAmount": { + "type": "string", + "maxLength": 15, + "description": "Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "dutyAmount": { + "type": "string", + "maxLength": 15, + "description": "Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAmount": { + "type": "string", + "maxLength": 12, + "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "nationalTaxIncluded": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAppliedAfterDiscount": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAppliedLevel": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxTypeCode": { + "type": "string", + "maxLength": 3, + "description": "For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "freightAmount": { + "type": "string", + "maxLength": 13, + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "foreignAmount": { + "type": "string", + "maxLength": 15, + "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "foreignCurrency": { + "type": "string", + "maxLength": 5, + "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "exchangeRate": { + "type": "string", + "maxLength": 13, + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "exchangeRateTimeStamp": { + "type": "string", + "maxLength": 14, + "description": "Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "amexAdditionalAmounts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 3, + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "amount": { + "type": "string", + "maxLength": 12, + "description": "Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + } + }, + "taxDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", + "enum": [ + "alternate", + "local", + "national", + "vat" + ] + }, + "amount": { + "type": "string", + "maxLength": 13, + "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" + }, + "rate": { + "type": "string", + "maxLength": 6, + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" + }, + "code": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" + }, + "applied": { + "type": "boolean", + "description": "The tax is applied. Valid value is `true` or `false`." + }, + "exemptionCode": { + "type": "string", + "maxLength": 1, + "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" + } + } + } + }, + "serviceFeeAmount": { + "type": "string", + "maxLength": 15, + "description": "Service fee. Required for service fee transactions.\n" + }, + "originalCurrency": { + "type": "string", + "maxLength": 15, + "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n" + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "company": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address1": { + "type": "string", + "maxLength": 40, + "description": "First line in the street address of the company purchasing the product." + }, + "address2": { + "type": "string", + "maxLength": 40, + "description": "Additional address information for the company purchasing the product." + }, + "locality": { + "type": "string", + "maxLength": 30, + "description": "City in the address of the company purchasing the product." + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n" + } + } + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" + } + } + }, + "shipTo": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "country": { + "type": "string", + "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.", + "maxLength": 2 + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" + } + } + }, + "lineItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "productCode": { + "type": "string", + "maxLength": 255, + "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n" + }, + "productName": { + "type": "string", + "maxLength": 255, + "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`),\nthis field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of\nthe other values that are related to shipping and/or handling.\n" + }, + "productSku": { + "type": "string", + "maxLength": 255, + "description": "Stock Keeping Unit (SKU) code for the product.\n\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n" + }, + "quantity": { + "type": "number", + "minimum": 1, + "maximum": 9999999999, + "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n", + "default": 1 + }, + "unitPrice": { + "type": "string", + "maxLength": 15, + "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" + }, + "unitOfMeasure": { + "type": "string", + "maxLength": 12, + "description": "Unit of measure, or unit of measure code, for the item.\n" + }, + "totalAmount": { + "type": "string", + "maxLength": 13, + "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units. Example: 123.45 USD= 123\n" + }, + "taxAmount": { + "type": "string", + "maxLength": 15, + "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nIf you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API.\n\nThis field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API.\n" + }, + "taxRate": { + "type": "string", + "maxLength": 7, + "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + }, + "taxAppliedAfterDiscount": { + "type": "string", + "maxLength": 1, + "description": "Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n" + }, + "taxStatusIndicator": { + "type": "string", + "maxLength": 1, + "description": "Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n" + }, + "taxTypeCode": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "amountIncludesTax": { + "type": "boolean", + "description": "Flag that indicates whether the tax amount is included in the Line Item Total.\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "typeOfSupply": { + "type": "string", + "maxLength": 2, + "description": "Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n" + }, + "commodityCode": { + "type": "string", + "maxLength": 15, + "description": "Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n" + }, + "discountAmount": { + "type": "string", + "maxLength": 13, + "description": "Discount applied to the item." + }, + "discountApplied": { + "type": "boolean", + "description": "Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "discountRate": { + "type": "string", + "maxLength": 6, + "description": "Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n" + }, + "invoiceNumber": { + "type": "string", + "maxLength": 23, + "description": "Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n" + }, + "taxDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", + "enum": [ + "alternate", + "local", + "national", + "vat" + ] + }, + "amount": { + "type": "string", + "maxLength": 13, + "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" + }, + "rate": { + "type": "string", + "maxLength": 6, + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" + }, + "code": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" + }, + "applied": { + "type": "boolean", + "description": "The tax is applied. Valid value is `true` or `false`." + }, + "exemptionCode": { + "type": "string", + "maxLength": 1, + "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" + } + } + } + } + } + } + }, + "invoiceDetails": { + "type": "object", + "properties": { + "purchaseOrderNumber": { + "type": "string", + "maxLength": 25, + "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "purchaseOrderDate": { + "type": "string", + "maxLength": 10, + "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "purchaseContactName": { + "type": "string", + "maxLength": 36, + "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxable": { + "type": "boolean", + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "vatInvoiceReferenceNumber": { + "type": "string", + "maxLength": 15, + "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "commodityCode": { + "type": "string", + "maxLength": 4, + "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "transactionAdviceAddendum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "string", + "maxLength": 40, + "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n" + } + } + } + } + } + }, + "shippingDetails": { + "type": "object", + "properties": { + "shipFromPostalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n" + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "merchantCustomerId": { + "type": "string", + "maxLength": 100, + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "vatRegistrationNumber": { + "type": "string", + "maxLength": 20, + "description": "Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + } + } + }, + "deviceInformation": { + "type": "object", + "properties": { + "hostName": { + "type": "string", + "maxLength": 60, + "description": "Host name reported by the customer\u2019s browser to your Web server identified via the HTTP header." + }, + "ipAddress": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n" + }, + "userAgent": { + "type": "string", + "maxLength": 40, + "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n" + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" + }, + "alternateName": { + "type": "string", + "maxLength": 13, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "contact": { + "type": "string", + "maxLength": 14, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "locality": { + "type": "string", + "maxLength": 13, + "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 14, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + }, + "categoryCode": { + "type": "integer", + "maximum": 9999, + "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + }, + "vatRegistrationNumber": { + "type": "string", + "maxLength": 21, + "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "cardAcceptorReferenceNumber": { + "type": "string", + "maxLength": 25, + "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" + } + } + }, + "aggregatorInformation": { + "type": "object", + "properties": { + "aggregatorId": { + "type": "string", + "maxLength": 20, + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "name": { + "type": "string", + "maxLength": 37, + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "subMerchant": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 37, + "description": "Sub-merchant\u2019s business name.\n\n**American Express Direct**\\\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\n**FDC Nashville Global**\\\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n" + }, + "address1": { + "type": "string", + "maxLength": 38, + "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "locality": { + "type": "string", + "maxLength": 21, + "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 15, + "description": "Partial postal code for the sub-merchant\u2019s address.\n\nSee \"Aggregator Support,\" page 100 for details.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "country": { + "type": "string", + "maxLength": 3, + "description": "Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nSee \"Aggregator Support,\" page 101.\n" + }, + "email": { + "type": "string", + "maxLength": 40, + "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 20, + "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n" + } + } + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "emv": { + "type": "object", + "properties": { + "tags": { + "type": "string", + "maxLength": 1998, + "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" + }, + "fallback": { + "type": "boolean", + "maxLength": 5, + "description": "Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.\n\nPossible values:\n - **true**\n - **false** (default)\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n", + "enum": [ + true, + false + ], + "default": false + } + } + } + } + }, + "merchantDefinedInformation": { + "type": "array", + "description": "The description for this field is not available.", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 50, + "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n" + }, + "value": { + "type": "string", + "maxLength": 255, + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + } + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "Testing-VDP-Payments-Refund" + }, + "orderInformation": { + "amountDetails": { + "totalAmount": "102.21", + "currency": "USD" + } + } + } + } + }, + { + "name": "id", + "in": "path", + "description": "The payment ID. This ID is returned from a previous payment request.", + "required": true, + "type": "string" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "title": "ptsV2PaymentsRefundPost201Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + }, + "void": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - PENDING\n", + "enum": [ + "PENDING" + ] + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "submitLocalDateTime": { + "type": "string", + "maxLength": 14, + "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" + }, + "ownerMerchantId": { + "type": "string", + "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" + } + } + }, + "refundAmountDetails": { + "type": "object", + "properties": { + "refundAmount": { + "type": "string", + "maxLength": 15, + "description": "Total amount of the refund." + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + }, + "processorInformation": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "maxLength": 18, + "description": "Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n" + }, + "forwardedAcquirerCode": { + "type": "string", + "maxLength": 32, + "description": "Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n" + }, + "merchantNumber": { + "type": "string", + "maxLength": 15, + "description": "Identifier that was assigned to you by your acquirer.\n\nThis value must be printed on the receipt.\n\nThis field is supported only on **American Express Direct**, **FDC Nashville Global**, and **SIX**.\n" + }, + "responseCode": { + "type": "string", + "maxLength": 10, + "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n" + }, + "achVerification": { + "type": "object", + "properties": { + "resultCode": { + "type": "string", + "maxLength": 2, + "description": "Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible\nvalues, see Appendix H, \"Verification Codes,\" on page 91.\n" + }, + "resultCodeRaw": { + "type": "string", + "maxLength": 10, + "description": "Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the\npossible values, see Appendix H, \"Verification Codes,\" on page 91.\n" + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "invoiceDetails": { + "type": "object", + "properties": { + "level3TransmissionStatus": { + "type": "boolean", + "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n", + "enum": [ + true, + false + ] + } + } + } + } + } + }, + "example": { + "_links": { + "self": { + "href": "/pts/v2/refunds/4963014779006178301545", + "method": "GET" + }, + "void": { + "href": "/pts/v2/refunds/4963014779006178301545/voids", + "method": "POST" + } + }, + "id": "4963014779006178301545", + "submitTimeUtc": "2017-06-01T071757Z", + "status": "200", + "reconciliationId": "39571012D3DFEKS0", + "statusInformation": { + "reason": "SUCCESS", + "message": "Successful transaction." + }, + "clientReferenceInformation": { + "code": "Testing-VDP-Payments-Refund" + }, + "orderInformation": { + "amountDetails": { + "currency": "USD" + } + }, + "refundAmountDetails": { + "currency": "USD", + "refundAmount": "102.21" + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "title": "ptsV2PaymentsRefundPost400Response", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - INVALID_MERCHANT_CONFIGURATION\n - INVALID_AMOUNT\n - CAPTURE_ALREADY_VOIDED\n - ACCOUNT_NOT_ALLOWED_CREDIT\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_CARD", + "INVALID_MERCHANT_CONFIGURATION", + "CAPTURE_ALREADY_VOIDED", + "ACCOUNT_NOT_ALLOWED_CREDIT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "title": "ptsV2PaymentsRefundPost502Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Refund a Payment", + "value": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "orderInformation": { + "amountDetails": { + "totalAmount": "10", + "currency": "USD" + } + } + } + } + } + } + }, + "/pts/v2/captures/{id}/refunds": { + "post": { + "summary": "Refund a Capture", + "description": "Include the capture ID in the POST request to refund the captured amount.\n", + "tags": [ + "refund" + ], + "operationId": "refundCapture", + "x-devcenter-metaData": { + "categoryTag": "Payments" + }, + "parameters": [ + { + "name": "refundCaptureRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "transactionId": { + "type": "string", + "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nSee page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "originalTransactionId": { + "type": "string", + "maxLength": 32, + "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "paymentSolution": { + "type": "string", + "maxLength": 12, + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" + }, + "linkId": { + "type": "string", + "maxLength": 26, + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n" + }, + "reportGroup": { + "type": "string", + "maxLength": 25, + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n" + }, + "visaCheckoutId": { + "type": "string", + "maxLength": 48, + "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n" + }, + "purchaseLevel": { + "type": "string", + "maxLength": 1, + "description": "Set this field to 3 to indicate that the request includes Level III data." + }, + "recurringOptions": { + "type": "object", + "properties": { + "loanPayment": { + "type": "boolean", + "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- **true** Loan payment\n- **false** (default) Not a loan payment\n\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\n", + "enum": [ + true, + false + ], + "default": false + } + } + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 20, + "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\nFor processor-specific information, see the `customer_cc_expmo` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`.\n\nFor processor-specific information, see the `customer_cc_expyr` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "type": { + "type": "string", + "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n" + }, + "accountEncoderId": { + "type": "string", + "maxLength": 3, + "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n" + }, + "issueNumber": { + "type": "string", + "maxLength": 5, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" + }, + "startMonth": { + "type": "string", + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "startYear": { + "type": "string", + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + } + } + }, + "bank": { + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 1, + "description": "Account type.\n\nPossible values:\n - **C**: Checking.\n - **G**: General ledger. This value is supported only on Wells Fargo ACH.\n - **S**: Savings (U.S. dollars only).\n - **X**: Corporate checking (U.S. dollars only).\n" + }, + "number": { + "type": "string", + "maxLength": 17, + "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" + }, + "encoderId": { + "type": "string", + "maxLength": 3, + "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor. See \"Encoded Account Numbers,\" page 39.\n" + }, + "checkNumber": { + "type": "string", + "maxLength": 8, + "description": "Check number.\n\nChase Paymentech Solutions - Optional.\nCyberSource ACH Service - Not used.\nRBS WorldPay Atlanta - Optional on debits. Required on credits.\nTeleCheck - Strongly recommended on debit requests. Optional on credits.\n" + }, + "checkImageReferenceNumber": { + "type": "string", + "maxLength": 32, + "description": "Image reference number associated with the check. You cannot include any special characters.\n" + } + } + }, + "routingNumber": { + "type": "string", + "maxLength": 9, + "description": "Bank routing number.\n\nThis is also called the transit number.\n" + } + } + }, + "customer": { + "type": "object", + "properties": { + "customerId": { + "type": "string", + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "maxLength": 19, + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + }, + "discountAmount": { + "type": "string", + "maxLength": 15, + "description": "Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "dutyAmount": { + "type": "string", + "maxLength": 15, + "description": "Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAmount": { + "type": "string", + "maxLength": 12, + "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "nationalTaxIncluded": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAppliedAfterDiscount": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAppliedLevel": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxTypeCode": { + "type": "string", + "maxLength": 3, + "description": "For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "freightAmount": { + "type": "string", + "maxLength": 13, + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "foreignAmount": { + "type": "string", + "maxLength": 15, + "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "foreignCurrency": { + "type": "string", + "maxLength": 5, + "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "exchangeRate": { + "type": "string", + "maxLength": 13, + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "exchangeRateTimeStamp": { + "type": "string", + "maxLength": 14, + "description": "Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "amexAdditionalAmounts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 3, + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "amount": { + "type": "string", + "maxLength": 12, + "description": "Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + } + }, + "taxDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", + "enum": [ + "alternate", + "local", + "national", + "vat" + ] + }, + "amount": { + "type": "string", + "maxLength": 13, + "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" + }, + "rate": { + "type": "string", + "maxLength": 6, + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" + }, + "code": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" + }, + "applied": { + "type": "boolean", + "description": "The tax is applied. Valid value is `true` or `false`." + }, + "exemptionCode": { + "type": "string", + "maxLength": 1, + "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" + } + } + } + }, + "serviceFeeAmount": { + "type": "string", + "maxLength": 15, + "description": "Service fee. Required for service fee transactions.\n" + }, + "originalCurrency": { + "type": "string", + "maxLength": 15, + "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n" + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "company": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address1": { + "type": "string", + "maxLength": 40, + "description": "First line in the street address of the company purchasing the product." + }, + "address2": { + "type": "string", + "maxLength": 40, + "description": "Additional address information for the company purchasing the product." + }, + "locality": { + "type": "string", + "maxLength": 30, + "description": "City in the address of the company purchasing the product." + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n" + } + } + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" + } + } + }, + "shipTo": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "country": { + "type": "string", + "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.", + "maxLength": 2 + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" + } + } + }, + "lineItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "productCode": { + "type": "string", + "maxLength": 255, + "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n" + }, + "productName": { + "type": "string", + "maxLength": 255, + "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`),\nthis field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of\nthe other values that are related to shipping and/or handling.\n" + }, + "productSku": { + "type": "string", + "maxLength": 255, + "description": "Stock Keeping Unit (SKU) code for the product.\n\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n" + }, + "quantity": { + "type": "number", + "minimum": 1, + "maximum": 9999999999, + "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n", + "default": 1 + }, + "unitPrice": { + "type": "string", + "maxLength": 15, + "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" + }, + "unitOfMeasure": { + "type": "string", + "maxLength": 12, + "description": "Unit of measure, or unit of measure code, for the item.\n" + }, + "totalAmount": { + "type": "string", + "maxLength": 13, + "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units. Example: 123.45 USD= 123\n" + }, + "taxAmount": { + "type": "string", + "maxLength": 15, + "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nIf you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API.\n\nThis field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API.\n" + }, + "taxRate": { + "type": "string", + "maxLength": 7, + "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + }, + "taxAppliedAfterDiscount": { + "type": "string", + "maxLength": 1, + "description": "Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n" + }, + "taxStatusIndicator": { + "type": "string", + "maxLength": 1, + "description": "Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n" + }, + "taxTypeCode": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "amountIncludesTax": { + "type": "boolean", + "description": "Flag that indicates whether the tax amount is included in the Line Item Total.\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "typeOfSupply": { + "type": "string", + "maxLength": 2, + "description": "Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n" + }, + "commodityCode": { + "type": "string", + "maxLength": 15, + "description": "Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n" + }, + "discountAmount": { + "type": "string", + "maxLength": 13, + "description": "Discount applied to the item." + }, + "discountApplied": { + "type": "boolean", + "description": "Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "discountRate": { + "type": "string", + "maxLength": 6, + "description": "Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n" + }, + "invoiceNumber": { + "type": "string", + "maxLength": 23, + "description": "Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n" + }, + "taxDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", + "enum": [ + "alternate", + "local", + "national", + "vat" + ] + }, + "amount": { + "type": "string", + "maxLength": 13, + "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" + }, + "rate": { + "type": "string", + "maxLength": 6, + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" + }, + "code": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" + }, + "applied": { + "type": "boolean", + "description": "The tax is applied. Valid value is `true` or `false`." + }, + "exemptionCode": { + "type": "string", + "maxLength": 1, + "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" + } + } + } + } + } + } + }, + "invoiceDetails": { + "type": "object", + "properties": { + "purchaseOrderNumber": { + "type": "string", + "maxLength": 25, + "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "purchaseOrderDate": { + "type": "string", + "maxLength": 10, + "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "purchaseContactName": { + "type": "string", + "maxLength": 36, + "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxable": { + "type": "boolean", + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "vatInvoiceReferenceNumber": { + "type": "string", + "maxLength": 15, + "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "commodityCode": { + "type": "string", + "maxLength": 4, + "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "transactionAdviceAddendum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "string", + "maxLength": 40, + "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n" + } + } + } + } + } + }, + "shippingDetails": { + "type": "object", + "properties": { + "shipFromPostalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n" + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "merchantCustomerId": { + "type": "string", + "maxLength": 100, + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "vatRegistrationNumber": { + "type": "string", + "maxLength": 20, + "description": "Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + } + } + }, + "deviceInformation": { + "type": "object", + "properties": { + "hostName": { + "type": "string", + "maxLength": 60, + "description": "Host name reported by the customer\u2019s browser to your Web server identified via the HTTP header." + }, + "ipAddress": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n" + }, + "userAgent": { + "type": "string", + "maxLength": 40, + "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n" + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" + }, + "alternateName": { + "type": "string", + "maxLength": 13, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "contact": { + "type": "string", + "maxLength": 14, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "locality": { + "type": "string", + "maxLength": 13, + "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 14, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + }, + "categoryCode": { + "type": "integer", + "maximum": 9999, + "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + }, + "vatRegistrationNumber": { + "type": "string", + "maxLength": 21, + "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "cardAcceptorReferenceNumber": { + "type": "string", + "maxLength": 25, + "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" + } + } + }, + "aggregatorInformation": { + "type": "object", + "properties": { + "aggregatorId": { + "type": "string", + "maxLength": 20, + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "name": { + "type": "string", + "maxLength": 37, + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "subMerchant": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 37, + "description": "Sub-merchant\u2019s business name.\n\n**American Express Direct**\\\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\n**FDC Nashville Global**\\\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n" + }, + "address1": { + "type": "string", + "maxLength": 38, + "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "locality": { + "type": "string", + "maxLength": 21, + "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 15, + "description": "Partial postal code for the sub-merchant\u2019s address.\n\nSee \"Aggregator Support,\" page 100 for details.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "country": { + "type": "string", + "maxLength": 3, + "description": "Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nSee \"Aggregator Support,\" page 101.\n" + }, + "email": { + "type": "string", + "maxLength": 40, + "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 20, + "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n" + } + } + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "emv": { + "type": "object", + "properties": { + "tags": { + "type": "string", + "maxLength": 1998, + "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" + }, + "fallback": { + "type": "boolean", + "maxLength": 5, + "description": "Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.\n\nPossible values:\n - **true**\n - **false** (default)\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n", + "enum": [ + true, + false + ], + "default": false + } + } + } + } + }, + "merchantDefinedInformation": { + "type": "array", + "description": "The description for this field is not available.", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 50, + "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n" + }, + "value": { + "type": "string", + "maxLength": 255, + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + } + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "Testing-VDP-Payments-Refund" + }, + "orderInformation": { + "amountDetails": { + "totalAmount": "102.21", + "currency": "USD" + } + } + } + } + }, + { + "name": "id", + "in": "path", + "description": "The capture ID. This ID is returned from a previous capture request.", + "required": true, + "type": "string" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "title": "ptsV2CapturesRefundsPost201Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + }, + "void": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - PENDING\n", + "enum": [ + "PENDING" + ] + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "submitLocalDateTime": { + "type": "string", + "maxLength": 14, + "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" + }, + "ownerMerchantId": { + "type": "string", + "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" + } + } + }, + "refundAmountDetails": { + "type": "object", + "properties": { + "refundAmount": { + "type": "string", + "maxLength": 15, + "description": "Total amount of the refund." + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + }, + "processorInformation": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "maxLength": 18, + "description": "Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n" + }, + "forwardedAcquirerCode": { + "type": "string", + "maxLength": 32, + "description": "Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n" + }, + "merchantNumber": { + "type": "string", + "maxLength": 15, + "description": "Identifier that was assigned to you by your acquirer.\n\nThis value must be printed on the receipt.\n\nThis field is supported only on **American Express Direct**, **FDC Nashville Global**, and **SIX**.\n" + }, + "responseCode": { + "type": "string", + "maxLength": 10, + "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n" + }, + "achVerification": { + "type": "object", + "properties": { + "resultCode": { + "type": "string", + "maxLength": 2, + "description": "Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible\nvalues, see Appendix H, \"Verification Codes,\" on page 91.\n" + }, + "resultCodeRaw": { + "type": "string", + "maxLength": 10, + "description": "Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the\npossible values, see Appendix H, \"Verification Codes,\" on page 91.\n" + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "invoiceDetails": { + "type": "object", + "properties": { + "level3TransmissionStatus": { + "type": "boolean", + "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n", + "enum": [ + true, + false + ] + } + } + } + } + } + }, + "example": { + "_links": { + "self": { + "href": "/pts/v2/refunds/4963014779006178301545", + "method": "GET" + }, + "void": { + "href": "/pts/v2/refunds/4963014779006178301545/voids", + "method": "POST" + } + }, + "id": "4963014779006178301545", + "submitTimeUtc": "2017-06-01T071757Z", + "status": "200", + "reconciliationId": "39571012D3DFEKS0", + "statusInformation": { + "reason": "SUCCESS", + "message": "Successful transaction." + }, + "clientReferenceInformation": { + "code": "Testing-VDP-Payments-Refund" + }, + "orderInformation": { + "amountDetails": { + "currency": "USD" + } + }, + "refundAmountDetails": { + "currency": "USD", + "refundAmount": "102.21" + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "title": "ptsV2CapturesRefundsPost400Response", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - INVALID_MERCHANT_CONFIGURATION\n - INVALID_AMOUNT\n - CAPTURE_ALREADY_VOIDED\n - ACCOUNT_NOT_ALLOWED_CREDIT\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_CARD", + "INVALID_MERCHANT_CONFIGURATION", + "CAPTURE_ALREADY_VOIDED", + "ACCOUNT_NOT_ALLOWED_CREDIT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "title": "ptsV2CapturesRefundsPost502Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Refund a Capture", + "value": { + "clientReferenceInformation": { + "code": "TC50171_3" + }, + "orderInformation": { + "amountDetails": { + "totalAmount": "102.21", + "currency": "USD" + } + } + } + } + } + } + }, + "/pts/v2/credits/": { + "post": { + "summary": "Process a Credit", + "description": "POST to the credit resource to credit funds to a specified credit card.", + "tags": [ + "credit" + ], + "operationId": "createCredit", + "x-devcenter-metaData": { + "categoryTag": "Payments" + }, + "parameters": [ + { + "name": "createCreditRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "transactionId": { + "type": "string", + "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nSee page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "originalTransactionId": { + "type": "string", + "maxLength": 32, + "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "commerceIndicator": { + "type": "string", + "maxLength": 20, + "description": "Type of transaction. Some payment card companies use this information when determining discount rates. When you\nomit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file\nfor you instead of the default value listed here.\n" + }, + "processorId": { + "type": "string", + "maxLength": 3, + "description": "Value that identifies the processor/acquirer to use for the transaction. This value is supported only for\n**CyberSource through VisaNet**.\n\nContact CyberSource Customer Support to get the value for this field.\n" + }, + "paymentSolution": { + "type": "string", + "maxLength": 12, + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" + }, + "linkId": { + "type": "string", + "maxLength": 26, + "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n" + }, + "reportGroup": { + "type": "string", + "maxLength": 25, + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n" + }, + "visaCheckoutId": { + "type": "string", + "maxLength": 48, + "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n" + }, + "purchaseLevel": { + "type": "string", + "maxLength": 1, + "description": "Set this field to 3 to indicate that the request includes Level III data." + }, + "recurringOptions": { + "type": "object", + "properties": { + "loanPayment": { + "type": "boolean", + "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- **true** Loan payment\n- **false** (default) Not a loan payment\n\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\n", + "enum": [ + true, + false + ], + "default": false + } + } + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "customerMemo": { + "type": "string", + "maxLength": 80, + "description": "Payment related information.\n\nThis information is included on the customer\u2019s statement.\n" + }, + "secCode": { + "type": "string", + "maxLength": 3, + "description": "Authorization method used for the transaction. See \"SEC Codes,\" page 89.\n\nTeleCheck Accepts only the following values:\n- **PPD**\n- **TEL**\n- **WEB**\n" + }, + "terminalCity": { + "type": "string", + "maxLength": 4, + "description": "City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction\nwill be declined.\n\nYou cannot include any special characters.\n" + }, + "terminalState": { + "type": "string", + "maxLength": 2, + "description": "State in which the terminal is located. If more than two alphanumeric characters are submitted, the transaction\nwill be declined.\n\nYou cannot include any special characters.\n" + }, + "effectiveDate": { + "type": "string", + "maxLength": 8, + "description": "Effective date for the transaction. The effective date must be within 45 days of the current day. If you do not\ninclude this value, CyberSource sets the effective date to the next business day.\n\nFormat: `MMDDYYYY`\n\nSupported only for the CyberSource ACH Service.\n" + }, + "partialPaymentId": { + "type": "string", + "maxLength": 25, + "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order. See \"Multiple\nPartial Credits,\" page 41.\n" + }, + "settlementMethod": { + "type": "string", + "maxLength": 1, + "description": "Method used for settlement.\n\nPossible values:\n- **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- **F**: Facsimile draft (U.S. dollars only)\n- **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nSee \"Settlement Delivery Methods,\" page 44.\n" + } + } + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "maxLength": 20, + "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\nFor processor-specific information, see the `customer_cc_expmo` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`.\n\nFor processor-specific information, see the `customer_cc_expyr` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "type": { + "type": "string", + "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n" + }, + "accountEncoderId": { + "type": "string", + "maxLength": 3, + "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n" + }, + "issueNumber": { + "type": "string", + "maxLength": 5, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" + }, + "startMonth": { + "type": "string", + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "startYear": { + "type": "string", + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + } + } + }, + "bank": { + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "type": { + "type": "string", + "maxLength": 1, + "description": "Account type.\n\nPossible values:\n - **C**: Checking.\n - **G**: General ledger. This value is supported only on Wells Fargo ACH.\n - **S**: Savings (U.S. dollars only).\n - **X**: Corporate checking (U.S. dollars only).\n" + }, + "number": { + "type": "string", + "maxLength": 17, + "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" + }, + "encoderId": { + "type": "string", + "maxLength": 3, + "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor. See \"Encoded Account Numbers,\" page 39.\n" + }, + "checkNumber": { + "type": "string", + "maxLength": 8, + "description": "Check number.\n\nChase Paymentech Solutions - Optional.\nCyberSource ACH Service - Not used.\nRBS WorldPay Atlanta - Optional on debits. Required on credits.\nTeleCheck - Strongly recommended on debit requests. Optional on credits.\n" + }, + "checkImageReferenceNumber": { + "type": "string", + "maxLength": 32, + "description": "Image reference number associated with the check. You cannot include any special characters.\n" + } + } + }, + "routingNumber": { + "type": "string", + "maxLength": 9, + "description": "Bank routing number.\n\nThis is also called the transit number.\n" + } + } + }, + "customer": { + "type": "object", + "properties": { + "customerId": { + "type": "string", + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "maxLength": 19, + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + }, + "discountAmount": { + "type": "string", + "maxLength": 15, + "description": "Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "dutyAmount": { + "type": "string", + "maxLength": 15, + "description": "Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAmount": { + "type": "string", + "maxLength": 12, + "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "nationalTaxIncluded": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAppliedAfterDiscount": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxAppliedLevel": { + "type": "string", + "maxLength": 1, + "description": "Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxTypeCode": { + "type": "string", + "maxLength": 3, + "description": "For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "freightAmount": { + "type": "string", + "maxLength": 13, + "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "foreignAmount": { + "type": "string", + "maxLength": 15, + "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "foreignCurrency": { + "type": "string", + "maxLength": 5, + "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "exchangeRate": { + "type": "string", + "maxLength": 13, + "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "exchangeRateTimeStamp": { + "type": "string", + "maxLength": 14, + "description": "Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "amexAdditionalAmounts": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 3, + "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "amount": { + "type": "string", + "maxLength": 12, + "description": "Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + } + }, + "taxDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", + "enum": [ + "alternate", + "local", + "national", + "vat" + ] + }, + "amount": { + "type": "string", + "maxLength": 13, + "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" + }, + "rate": { + "type": "string", + "maxLength": 6, + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" + }, + "code": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" + }, + "applied": { + "type": "boolean", + "description": "The tax is applied. Valid value is `true` or `false`." + }, + "exemptionCode": { + "type": "string", + "maxLength": 1, + "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" + } + } + } + }, + "serviceFeeAmount": { + "type": "string", + "maxLength": 15, + "description": "Service fee. Required for service fee transactions.\n" + }, + "originalCurrency": { + "type": "string", + "maxLength": 15, + "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n" + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "company": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address1": { + "type": "string", + "maxLength": 40, + "description": "First line in the street address of the company purchasing the product." + }, + "address2": { + "type": "string", + "maxLength": 40, + "description": "Additional address information for the company purchasing the product." + }, + "locality": { + "type": "string", + "maxLength": 30, + "description": "City in the address of the company purchasing the product." + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n" + } + } + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" + } + } + }, + "shipTo": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "country": { + "type": "string", + "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.", + "maxLength": 2 + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" + } + } + }, + "lineItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "productCode": { + "type": "string", + "maxLength": 255, + "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n" + }, + "productName": { + "type": "string", + "maxLength": 255, + "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`),\nthis field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of\nthe other values that are related to shipping and/or handling.\n" + }, + "productSku": { + "type": "string", + "maxLength": 255, + "description": "Stock Keeping Unit (SKU) code for the product.\n\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n" + }, + "quantity": { + "type": "number", + "minimum": 1, + "maximum": 9999999999, + "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n", + "default": 1 + }, + "unitPrice": { + "type": "string", + "maxLength": 15, + "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" + }, + "unitOfMeasure": { + "type": "string", + "maxLength": 12, + "description": "Unit of measure, or unit of measure code, for the item.\n" + }, + "totalAmount": { + "type": "string", + "maxLength": 13, + "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n\nWhen orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total\nfor prepaid gift cards in major units. Example: 123.45 USD= 123\n" + }, + "taxAmount": { + "type": "string", + "maxLength": 15, + "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nIf you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API.\n\nThis field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API.\n" + }, + "taxRate": { + "type": "string", + "maxLength": 7, + "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" + }, + "taxAppliedAfterDiscount": { + "type": "string", + "maxLength": 1, + "description": "Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n" + }, + "taxStatusIndicator": { + "type": "string", + "maxLength": 1, + "description": "Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n" + }, + "taxTypeCode": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "amountIncludesTax": { + "type": "boolean", + "description": "Flag that indicates whether the tax amount is included in the Line Item Total.\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "typeOfSupply": { + "type": "string", + "maxLength": 2, + "description": "Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n" + }, + "commodityCode": { + "type": "string", + "maxLength": 15, + "description": "Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n" + }, + "discountAmount": { + "type": "string", + "maxLength": 13, + "description": "Discount applied to the item." + }, + "discountApplied": { + "type": "boolean", + "description": "Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "discountRate": { + "type": "string", + "maxLength": 6, + "description": "Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n" + }, + "invoiceNumber": { + "type": "string", + "maxLength": 23, + "description": "Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n" + }, + "taxDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", + "enum": [ + "alternate", + "local", + "national", + "vat" + ] + }, + "amount": { + "type": "string", + "maxLength": 13, + "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" + }, + "rate": { + "type": "string", + "maxLength": 6, + "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" + }, + "code": { + "type": "string", + "maxLength": 4, + "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" + }, + "applied": { + "type": "boolean", + "description": "The tax is applied. Valid value is `true` or `false`." + }, + "exemptionCode": { + "type": "string", + "maxLength": 1, + "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" + } + } + } + } + } + } + }, + "invoiceDetails": { + "type": "object", + "properties": { + "purchaseOrderNumber": { + "type": "string", + "maxLength": 25, + "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "purchaseOrderDate": { + "type": "string", + "maxLength": 10, + "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "purchaseContactName": { + "type": "string", + "maxLength": 36, + "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxable": { + "type": "boolean", + "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n", + "enum": [ + true, + false + ] + }, + "vatInvoiceReferenceNumber": { + "type": "string", + "maxLength": 15, + "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "commodityCode": { + "type": "string", + "maxLength": 4, + "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "transactionAdviceAddendum": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "string", + "maxLength": 40, + "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n" + } + } + } + } + } + }, + "shippingDetails": { + "type": "object", + "properties": { + "shipFromPostalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n" + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "merchantCustomerId": { + "type": "string", + "maxLength": 100, + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "vatRegistrationNumber": { + "type": "string", + "maxLength": 20, + "description": "Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + } + } + }, + "deviceInformation": { + "type": "object", + "properties": { + "hostName": { + "type": "string", + "maxLength": 60, + "description": "Host name reported by the customer\u2019s browser to your Web server identified via the HTTP header." + }, + "ipAddress": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n" + }, + "userAgent": { + "type": "string", + "maxLength": 40, + "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n" + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" + }, + "alternateName": { + "type": "string", + "maxLength": 13, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "contact": { + "type": "string", + "maxLength": 14, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "locality": { + "type": "string", + "maxLength": 13, + "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 14, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + }, + "categoryCode": { + "type": "integer", + "maximum": 9999, + "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + }, + "vatRegistrationNumber": { + "type": "string", + "maxLength": 21, + "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "cardAcceptorReferenceNumber": { + "type": "string", + "maxLength": 25, + "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "taxId": { + "type": "string", + "maxLength": 15, + "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" + } + } + }, + "aggregatorInformation": { + "type": "object", + "properties": { + "aggregatorId": { + "type": "string", + "maxLength": 20, + "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "name": { + "type": "string", + "maxLength": 37, + "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "subMerchant": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 37, + "description": "Sub-merchant\u2019s business name.\n\n**American Express Direct**\\\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\n**FDC Nashville Global**\\\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n" + }, + "address1": { + "type": "string", + "maxLength": 38, + "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "locality": { + "type": "string", + "maxLength": 21, + "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 15, + "description": "Partial postal code for the sub-merchant\u2019s address.\n\nSee \"Aggregator Support,\" page 100 for details.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" + }, + "country": { + "type": "string", + "maxLength": 3, + "description": "Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nSee \"Aggregator Support,\" page 101.\n" + }, + "email": { + "type": "string", + "maxLength": 40, + "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 20, + "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n" + } + } + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "emv": { + "type": "object", + "properties": { + "tags": { + "type": "string", + "maxLength": 1998, + "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" + }, + "fallback": { + "type": "boolean", + "maxLength": 5, + "description": "Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.\n\nPossible values:\n - **true**\n - **false** (default)\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n", + "enum": [ + true, + false + ], + "default": false + }, + "fallbackCondition": { + "type": "number", + "description": "Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for\none of these reasons:\n\n - Technical failure: the EMV terminal or EMV card cannot read and process chip data.\n - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card.\n EMV terminals are coded to determine whether the terminal and EMV card have any applications in common.\n EMV terminals provide this information to you.\n\nPossible values:\n\n - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal either used information from a successful chip read or it was not a chip transaction.\n - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.\n\nThis field is supported only on **GPN**.\n\n**NOTE**: Merchants must include this field in a request whenever a transaction must fall back to swiped mode.\n" + } + } + }, + "partnerSdkVersion": { + "type": "string", + "maxLength": 32, + "description": "Version of the software installed on the POS terminal. This value is provided by the client software that is\ninstalled on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "storeAndForwardIndicator": { + "type": "string", + "maxLength": 1, + "description": "When connectivity is unavailable, the client software that is installed on the POS terminal can store a\ntransaction in its memory and send it for authorization when connectivity is restored. This value is provided by\nthe client software that is installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nPossible values:\n- Y: Transaction was stored and then forwarded.\n- N (default): Transaction was not stored and then forwarded.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "cardholderVerificationMethod": { + "type": "array", + "items": { + "type": "string", + "description": "Complete list of cardholder verification methods (CVMs) supported by the terminal.\n\nPossible values:\n- PIN\n- Signature\n\n**NOTE**: You can submit one of the values or both in a request.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "example": [ + "PIN", + "Signature" + ] + }, + "terminalInputCapability": { + "type": "array", + "items": { + "description": "Complete list of card input methods supported by the terminal.\n\nPossible values:\n- Keyed: Terminal can accept card data that is entered manually.\n- Swiped: Terminal can accept card data from a magnetic stripe reader.\n- Contact: Terminal can accept card data in EMV contact mode.\n- Contactless: Terminal can accept card data in EMV contactless mode.\n- BarCode: Terminal can read bar codes.\n- QRcode: Terminal can read QR codes.\n- OCR: Terminal can perform optical character recognition (OCT).\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n", + "type": "string" + }, + "example": [ + "Keyed", + "Swiped", + "Contact", + "QRcode" + ] + }, + "terminalSerialNumber": { + "type": "string", + "maxLength": 32, + "description": "Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that\nis installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "terminalCardCaptureCapability": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether the terminal can capture the card.\n\nPossible values:\n- 1: Terminal can capture card.\n- 0: Terminal cannot capture card.\n\nThis field is supported only on American Express Direct.\n" + }, + "terminalOutputCapability": { + "type": "string", + "maxLength": 1, + "description": "Indicates whether the terminal can print or display messages.\n\nPossible values:\n- 1: Neither\n- 2: Print only\n- 3: Display only\n- 4: Print and display\n\nThis field is supported only on American Express Direct.\n" + }, + "terminalPinCapability": { + "type": "integer", + "description": "Maximum PIN length that the terminal can capture.\n\nPossible values:\n- 0: No PIN capture capability\n- 1: PIN capture capability unknown\n- 4: Four characters\n- 5: Five characters\n- 6: Six characters\n- 7: Seven characters\n- 8: Eight characters\n- 9: Nine characters\n- 10: Ten characters\n- 11: Eleven characters\n- 12: Twelve characters\n\nThis field is supported only on American Express Direct and SIX.\n" + }, + "deviceId": { + "type": "string", + "maxLength": 32, + "description": "Value created by the client software that uniquely identifies the POS device. This value is provided by the\nclient software that is installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + } + } + }, + "merchantDefinedInformation": { + "type": "array", + "description": "The description for this field is not available.", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 50, + "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n" + }, + "value": { + "type": "string", + "maxLength": 255, + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + } + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "12345678" + }, + "orderInformation": { + "billTo": { + "country": "US", + "firstName": "Test", + "lastName": "test", + "phoneNumber": "9999999999", + "address1": "test", + "postalCode": "48104-2201", + "locality": "Ann Arbor", + "administrativeArea": "MI", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "200", + "currency": "usd" + } + }, + "paymentInformation": { + "card": { + "expirationYear": "2031", + "number": "4111111111111111", + "expirationMonth": "03", + "type": "001" + } + } + } + } + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "title": "ptsV2CreditsPost201Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + }, + "void": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - PENDING\n", + "enum": [ + "PENDING" + ] + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "submitLocalDateTime": { + "type": "string", + "maxLength": 14, + "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" + }, + "ownerMerchantId": { + "type": "string", + "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" + } + } + }, + "creditAmountDetails": { + "type": "object", + "properties": { + "creditAmount": { + "type": "string", + "maxLength": 15, + "description": "Total amount of the credit." + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "bankTransferOptions": { + "type": "object", + "properties": { + "settlementMethod": { + "type": "string", + "maxLength": 1, + "description": "Method used for settlement.\n\nPossible values:\n- **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- **F**: Facsimile draft (U.S. dollars only)\n- **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nSee \"Settlement Delivery Methods,\" page 44.\n" + } + } + } + } + }, + "processorInformation": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "maxLength": 18, + "description": "Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n" + }, + "forwardedAcquirerCode": { + "type": "string", + "maxLength": 32, + "description": "Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n" + }, + "merchantNumber": { + "type": "string", + "maxLength": 15, + "description": "Identifier that was assigned to you by your acquirer.\n\nThis value must be printed on the receipt.\n\nThis field is supported only on **American Express Direct**, **FDC Nashville Global**, and **SIX**.\n" + }, + "responseCode": { + "type": "string", + "maxLength": 10, + "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n" + }, + "achVerification": { + "type": "object", + "properties": { + "resultCode": { + "type": "string", + "maxLength": 2, + "description": "Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible\nvalues, see Appendix H, \"Verification Codes,\" on page 91.\n" + }, + "resultCodeRaw": { + "type": "string", + "maxLength": 10, + "description": "Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the\npossible values, see Appendix H, \"Verification Codes,\" on page 91.\n" + } + } + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "bank": { + "type": "object", + "properties": { + "account": { + "type": "object", + "properties": { + "correctedAccountNumber": { + "type": "string", + "maxLength": 17, + "description": "Corrected account number from the ACH verification service, which is described in \"ACH Verification,\" page 25.\n" + } + } + }, + "correctedRoutingNumber": { + "type": "string", + "maxLength": 9, + "description": "The description for this field is not available." + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "invoiceDetails": { + "type": "object", + "properties": { + "level3TransmissionStatus": { + "type": "boolean", + "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n", + "enum": [ + true, + false + ] + } + } + } + } + } + }, + "example": { + "_links": { + "self": { + "href": "/pts/v2/credits/4963014324246004901546", + "method": "GET" + }, + "void": { + "href": "/pts/v2/credits/4963014324246004901546/voids", + "method": "POST" + } + }, + "id": "4963014324246004901546", + "submitTimeUtc": "2017-06-01T071712Z", + "status": "200", + "reconciliationId": "39570714X3E1LBQ8", + "statusInformation": { + "reason": "SUCCESS", + "message": "Successful transaction." + }, + "clientReferenceInformation": { + "code": "12345678" + }, + "creditAmountDetails": { + "currency": "usd", + "creditAmount": "200.00" + }, + "orderInformation": { + "amountDetails": { + "currency": "usd" + } + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "title": "ptsV2CreditsPost400Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - INVALID_MERCHANT_CONFIGURATION\n - INVALID_AMOUNT\n - CAPTURE_ALREADY_VOIDED\n - ACCOUNT_NOT_ALLOWED_CREDIT\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_CARD", + "INVALID_MERCHANT_CONFIGURATION", + "CAPTURE_ALREADY_VOIDED", + "ACCOUNT_NOT_ALLOWED_CREDIT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "title": "ptsV2CreditsPost502Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Credit", + "value": { + "clientReferenceInformation": { + "code": "12345678" + }, + "orderInformation": { + "billTo": { + "country": "US", + "firstName": "John", + "lastName": "Deo", + "phoneNumber": "9321499232", + "address1": "900 Metro Center Blvd", + "postalCode": "48104-2201", + "locality": "Foster City", + "administrativeArea": "CA", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "200", + "currency": "usd" + } + }, + "paymentInformation": { + "card": { + "expirationYear": "2031", + "number": "4111111111111111", + "expirationMonth": "03", + "type": "001" + } + } + } + }, + "example1": { + "summary": "Electronic Check Stand-Alone Credits", + "value": { + "clientReferenceInformation": { + "code": "TC46125-1" + }, + "processingInformation": { + "commerceIndicator": "internet" + }, + "orderInformation": { + "billTo": { + "firstName": "John", + "lastName": "Doe", + "address1": "1 Market St", + "postalCode": "94105", + "locality": "san francisco", + "administrativeArea": "CA", + "country": "US", + "phoneNumber": "4158880000", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "100", + "currency": "USD" + } + }, + "paymentInformation": { + "bank": { + "account": { + "number": "4100", + "type": "C", + "checkNumber": "123456" + }, + "routingNumber": "071923284" + } + } + } + }, + "example2": { + "summary": "Service Fees Credit", + "value": { + "clientReferenceInformation": { + "code": "12345678" + }, + "orderInformation": { + "billTo": { + "firstName": "John", + "lastName": "Doe", + "address1": "1 Market St", + "postalCode": "94105", + "locality": "san francisco", + "administrativeArea": "CA", + "country": "US", + "phoneNumber": "4158880000", + "email": "test@cybs.com" + }, + "amountDetails": { + "totalAmount": "2325.00", + "currency": "usd", + "serviceFeeAmount": "30.0" + } + }, + "paymentInformation": { + "card": { + "expirationYear": "2031", + "number": "4111111111111111", + "expirationMonth": "03" + } + } + } + } + } + } + }, + "/pts/v2/payments/{id}/voids": { + "post": { + "summary": "Void a Payment", + "description": "Include the payment ID in the POST request to cancel the payment.", + "tags": [ + "void" + ], + "operationId": "voidPayment", + "x-devcenter-metaData": { + "categoryTag": "Payments" + }, + "parameters": [ + { + "name": "voidPaymentRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "test_void" + } + } + } + }, + { + "name": "id", + "in": "path", + "description": "The payment ID returned from a previous payment request.", + "required": true, + "type": "string" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "title": "ptsV2PaymentsVoidsPost201Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - VOIDED\n", + "enum": [ + "VOIDED" + ] + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "submitLocalDateTime": { + "type": "string", + "maxLength": 14, + "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" + }, + "ownerMerchantId": { + "type": "string", + "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" + } + } + }, + "voidAmountDetails": { + "type": "object", + "properties": { + "voidAmount": { + "type": "string", + "description": "Total amount of the void." + }, + "originalTransactionAmount": { + "type": "string", + "description": "Amount of the original transaction." + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + } + }, + "example": { + "_links": { + "self": { + "href": "/pts/v2/voids/4963015122056179201545", + "method": "GET" + } + }, + "id": "4963015122056179201545", + "submitTimeUtc": "2017-06-01T071832Z", + "status": "VOIDED", + "clientReferenceInformation": { + "code": "test_void" + }, + "orderInformation": { + "amountDetails": { + "currency": "USD" + } + }, + "voidAmountDetails": { + "currency": "usd", + "voidAmount": "102.21" + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "title": "ptsV2PaymentsVoidsPost400Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - NOT_VOIDABLE\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_MERCHANT_CONFIGURATION", + "NOT_VOIDABLE" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "title": "ptsV2PaymentsVoidsPost502Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": null, + "summary": "Void a Payment", + "value": { + "clientReferenceInformation": { + "code": "test_void" + } + } + } + } + }, + "/pts/v2/captures/{id}/voids": { + "post": { + "summary": "Void a Capture", + "description": "Include the capture ID in the POST request to cancel the capture.", + "tags": [ + "void" + ], + "operationId": "voidCapture", + "x-devcenter-metaData": { + "categoryTag": "Payments" + }, + "parameters": [ + { + "name": "voidCaptureRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "test_void" + } + } + } + }, + { + "name": "id", + "in": "path", + "description": "The capture ID returned from a previous capture request.", + "required": true, + "type": "string" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "title": "ptsV2CapturesVoidsPost201Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - VOIDED\n", + "enum": [ + "VOIDED" + ] + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "submitLocalDateTime": { + "type": "string", + "maxLength": 14, + "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" + }, + "ownerMerchantId": { + "type": "string", + "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" + } + } + }, + "voidAmountDetails": { + "type": "object", + "properties": { + "voidAmount": { + "type": "string", + "description": "Total amount of the void." + }, + "originalTransactionAmount": { + "type": "string", + "description": "Amount of the original transaction." + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + } + }, + "example": { + "_links": { + "self": { + "href": "/pts/v2/voids/4963015122056179201545", + "method": "GET" + } + }, + "id": "4963015122056179201545", + "submitTimeUtc": "2017-06-01T071832Z", + "status": "VOIDED", + "clientReferenceInformation": { + "code": "test_void" + }, + "orderInformation": { + "amountDetails": { + "currency": "USD" + } + }, + "voidAmountDetails": { + "currency": "usd", + "voidAmount": "102.21" + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "title": "ptsV2CapturesVoidsPost400Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - NOT_VOIDABLE\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_MERCHANT_CONFIGURATION", + "NOT_VOIDABLE" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "title": "ptsV2CapturesVoidsPost502Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": null, + "summary": "Void a Capture", + "value": { + "clientReferenceInformation": { + "code": "test_void" + } + } + } + } + }, + "/pts/v2/refunds/{id}/voids": { + "post": { + "summary": "Void a Refund", + "description": "Include the refund ID in the POST request to cancel the refund.", + "tags": [ + "void" + ], + "operationId": "voidRefund", + "x-devcenter-metaData": { + "categoryTag": "Payments" + }, + "parameters": [ + { + "name": "voidRefundRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "test_void" + } + } + } + }, + { + "name": "id", + "in": "path", + "description": "The refund ID returned from a previous refund request.", + "required": true, + "type": "string" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "title": "ptsV2RefundsVoidsPost201Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - VOIDED\n", + "enum": [ + "VOIDED" + ] + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "submitLocalDateTime": { + "type": "string", + "maxLength": 14, + "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" + }, + "ownerMerchantId": { + "type": "string", + "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" + } + } + }, + "voidAmountDetails": { + "type": "object", + "properties": { + "voidAmount": { + "type": "string", + "description": "Total amount of the void." + }, + "originalTransactionAmount": { + "type": "string", + "description": "Amount of the original transaction." + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + } + }, + "example": { + "_links": { + "self": { + "href": "/pts/v2/voids/4963015122056179201545", + "method": "GET" + } + }, + "id": "4963015122056179201545", + "submitTimeUtc": "2017-06-01T071832Z", + "status": "VOIDED", + "clientReferenceInformation": { + "code": "test_void" + }, + "orderInformation": { + "amountDetails": { + "currency": "USD" + } + }, + "voidAmountDetails": { + "currency": "usd", + "voidAmount": "102.21" + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "title": "ptsV2RefundsVoidsPost400Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - NOT_VOIDABLE\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_MERCHANT_CONFIGURATION", + "NOT_VOIDABLE" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "title": "ptsV2RefundsVoidsPost502Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Void a Refund", + "value": { + "clientReferenceInformation": { + "code": "test_void" + } + } + } + } + } + }, + "/pts/v2/credits/{id}/voids": { + "post": { + "summary": "Void a Credit", + "description": "Include the credit ID in the POST request to cancel the credit.", + "tags": [ + "void" + ], + "operationId": "voidCredit", + "x-devcenter-metaData": { + "categoryTag": "Payments" + }, + "parameters": [ + { + "name": "voidCreditRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "test_void" + } + } + } + }, + { + "name": "id", + "in": "path", + "description": "The credit ID returned from a previous credit request.", + "required": true, + "type": "string" + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "title": "ptsV2CreditsVoidsPost201Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - VOIDED\n", + "enum": [ + "VOIDED" + ] + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "submitLocalDateTime": { + "type": "string", + "maxLength": 14, + "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" + }, + "ownerMerchantId": { + "type": "string", + "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" + } + } + }, + "voidAmountDetails": { + "type": "object", + "properties": { + "voidAmount": { + "type": "string", + "description": "Total amount of the void." + }, + "originalTransactionAmount": { + "type": "string", + "description": "Amount of the original transaction." + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + } + }, + "example": { + "_links": { + "self": { + "href": "/pts/v2/voids/4963015122056179201545", + "method": "GET" + } + }, + "id": "4963015122056179201545", + "submitTimeUtc": "2017-06-01T071832Z", + "status": "VOIDED", + "clientReferenceInformation": { + "code": "test_void" + }, + "orderInformation": { + "amountDetails": { + "currency": "USD" + } + }, + "voidAmountDetails": { + "currency": "usd", + "voidAmount": "102.21" + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "title": "ptsV2CreditsVoidsPost400Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - NOT_VOIDABLE\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_MERCHANT_CONFIGURATION", + "NOT_VOIDABLE" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "title": "ptsV2CreditsVoidsPost502Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Void a Credit", + "value": { + "clientReferenceInformation": { + "code": "test_void" + } + } + } + } + } + }, + "/pts/v2/voids/": { + "post": { + "summary": "Merchant Initiated Void", + "description": "This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply.", + "tags": [ + "void" + ], + "operationId": "mitVoid", + "x-devcenter-metaData": { + "categoryTag": "Payments" + }, + "parameters": [ + { + "name": "mitVoidRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "transactionId": { + "type": "string", + "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations.\n\nSee page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf)\n" + }, + "comments": { + "type": "string", + "description": "Comments" + }, + "partner": { + "type": "object", + "properties": { + "originalTransactionId": { + "type": "string", + "maxLength": 32, + "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "test_void" + } + } + } + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - VOIDED\n", + "enum": [ + "VOIDED" + ] + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "submitLocalDateTime": { + "type": "string", + "maxLength": 14, + "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" + }, + "ownerMerchantId": { + "type": "string", + "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" + } + } + }, + "voidAmountDetails": { + "type": "object", + "properties": { + "voidAmount": { + "type": "string", + "description": "Total amount of the void." + }, + "originalTransactionAmount": { + "type": "string", + "description": "Amount of the original transaction." + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + } + }, + "example": { + "_links": { + "self": { + "href": "/pts/v2/voids/4963015122056179201545", + "method": "GET" + } + }, + "id": "4963015122056179201545", + "submitTimeUtc": "2017-06-01T071832Z", + "status": "VOIDED", + "clientReferenceInformation": { + "code": "test_void" + }, + "orderInformation": { + "amountDetails": { + "currency": "USD" + } + }, + "voidAmountDetails": { + "currency": "usd", + "voidAmount": "102.21" + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - NOT_VOIDABLE\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_MERCHANT_CONFIGURATION", + "NOT_VOIDABLE" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + } + } + }, + "/pts/v1/transaction-batches": { + "get": { + "summary": "Get a list of batch files", + "description": "Provide the search range", + "tags": [ + "TransactionBatches" + ], + "operationId": "getTransactionBatches", + "x-devcenter-metaData": { + "categoryTag": "Transaction_Batches" + }, + "x-queryParameterDefaults": { + "startTime": "2018-10-01T00:00:00.000Z", + "endTime": "2018-10-30T23:59:59.000Z" + }, + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "startTime", + "in": "query", + "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n", + "required": true, + "type": "string", + "format": "date-time" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "title": "ptsV1TransactionBatchesGet200Response", + "type": "object", + "properties": { + "transactionBatches": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier assigned to the batch file.", + "example": "psy8s1d", + "pattern": "^[a-zA-Z0-9_+-]*$", + "minLength": 1, + "maxLength": 8 + }, + "uploadDate": { + "type": "string", + "description": "Date when the batch template was update.", + "example": "2018-01-01" + }, + "completionDate": { + "type": "string", + "description": "The date when the batch template processing completed.", + "example": "2018-01-01" + }, + "transactionCount": { + "type": "integer", + "description": "Number of transactions in the transaction.", + "example": 7534 + }, + "acceptedTransactionCount": { + "type": "integer", + "description": "Number of transactions accepted.", + "example": 50013 + }, + "rejectedTransactionCount": { + "type": "string", + "description": "Number of transactions rejected.", + "example": 2508 + }, + "status": { + "type": "string", + "description": "The status of you batch template processing.", + "example": "Completed" + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "/pts/v1/transaction-batches" + }, + "method": { + "type": "string", + "example": "GET" + } + } + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "title": "ptsV1TransactionBatchesGet400Response", + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above.\n" + } + } + } + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + }, + "401": { + "description": "Not Authorized", + "schema": { + "title": "ptsV1TransactionBatchesGet401Response", + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above.\n" + } + } + } + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + }, + "403": { + "description": "No Authenticated", + "schema": { + "title": "ptsV1TransactionBatchesGet403Response", + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above.\n" + } + } + } + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + }, + "404": { + "description": "No Reports Found", + "schema": { + "title": "ptsV1TransactionBatchesGet404Response", + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above.\n" + } + } + } + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + }, + "500": { + "description": "Bad Gateway", + "schema": { + "title": "ptsV1TransactionBatchesGet500Response", + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The reason of status" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above." + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + } + } + } + }, + "/pts/v1/transaction-batches/{id}": { + "get": { + "summary": "Get individual batch file", + "description": "Provide the search range", + "tags": [ + "TransactionBatches" + ], + "operationId": "getTransactionBatchId", + "x-devcenter-metaData": { + "categoryTag": "Transaction_Batches" + }, + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "id", + "in": "path", + "description": "The batch id assigned for the template.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "title": "ptsV1TransactionBatchesIdGet200Response", "type": "object", "properties": { - "encryptionType": { + "id": { "type": "string", - "description": "How the card number should be encrypted in the subsequent Tokenize Card request. Possible values are RsaOaep256 or None (if using this value the card number must be in plain text when included in the Tokenize Card request). The Tokenize Card request uses a secure connection (TLS 1.2+) regardless of what encryption type is specified." + "description": "Unique identifier assigned to the batch file.", + "example": "psy8s1d", + "pattern": "^[a-zA-Z0-9_+-]*$", + "minLength": 1, + "maxLength": 8 }, - "targetOrigin": { + "uploadDate": { "type": "string", - "description": "This should only be used if using the Microform implementation. This is the protocol, URL, and if used, port number of the page that will host the Microform. Unless using http://localhost, the protocol must be https://. For example, if serving Microform on example.com, the targetOrigin is https://example.com The value is used to restrict the frame ancestor of the Microform. If there is a mismatch between this value and the frame ancestor, the Microfrom will not load." + "description": "Date when the batch template was update.", + "example": "2018-01-01" }, - "unmaskedLeft": { - "type": "integer", - "description": "Specifies the number of card number digits to be returned un-masked from the left. For example, setting this value to 6 will return: 411111XXXXXXXXXX Default value: 6 Maximum value: 6" + "completionDate": { + "type": "string", + "description": "The date when the batch template processing completed.", + "example": "2018-01-01" }, - "unmaskedRight": { + "transactionCount": { "type": "integer", - "description": "Specifies the number of card number digits to be returned un-masked from the right. For example, setting this value to 4 will return: 411111XXXXXX1111 Default value: 4 Maximum value: 4" + "description": "Number of transactions in the transaction.", + "example": 7534 }, - "enableBillingAddress": { - "type": "boolean", - "description": "Specifies whether or not 'dummy' address data should be specified in the create token request. If you have 'Relaxed AVS' enabled for your MID, this value can be set to False.Default value: true" + "acceptedTransactionCount": { + "type": "integer", + "description": "Number of transactions accepted.", + "example": 50013 }, - "currency": { + "rejectedTransactionCount": { "type": "string", - "description": "Three character ISO currency code to be associated with the token. Required for legacy integrations. Default value: USD." + "description": "Number of transactions rejected.", + "example": 2508 }, - "enableAutoAuth": { - "type": "boolean", - "description": "Specifies whether or not an account verification authorization ($0 Authorization) is carried out on token creation. Default is false, as it is assumed a full or zero amount authorization will be carried out in a separate call from your server." - } - } - } - } - ], - "x-example": { - "example0": { - "summary": "Generate Key", - "value": { - "encryptionType": "RsaOaep256" - } - } - }, - "responses": { - "200": { - "description": "Retrieved key.", - "schema": { - "title": "flexV1KeysPost200Response", - "properties": { - "keyId": { + "status": { "type": "string", - "description": "Unique identifier for the generated token. Used in the subsequent Tokenize Card request from your customer\u2019s device or browser." - }, - "der": { - "type": "object", - "description": "The public key in DER format. Used to validate the response from the Tokenize Card request. Additionally this format is useful for client side encryption in Android and iOS implementations.", - "properties": { - "format": { - "type": "string", - "description": "Specifies the format of the public key; currently X.509." - }, - "algorithm": { - "type": "string", - "description": "Algorithm used to encrypt the public key." - }, - "publicKey": { - "type": "string", - "description": "Base64 encoded public key value." - } - } + "description": "The status of you batch template processing.", + "example": "Completed" }, - "jwk": { + "_links": { "type": "object", - "description": "The public key in JSON Web Key (JWK) format. This format is useful for client side encryption in JavaScript based implementations.", - "properties": { - "kty": { - "type": "string", - "description": "Algorithm used to encrypt the public key." - }, - "use": { - "type": "string", - "description": "Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc." - }, - "kid": { - "type": "string", - "description": "The key ID in JWK format." - }, - "n": { - "type": "string", - "description": "JWK RSA Modulus" - }, - "e": { - "type": "string", - "description": "JWK RSA Exponent" - } - } - } - } - } - }, - "default": { - "description": "Error retrieving key.", - "schema": { - "type": "object", - "properties": { - "responseStatus": { "properties": { - "status": { - "type": "number", - "description": "HTTP Status code." - }, - "reason": { - "type": "string", - "description": "Error Reason Code." - }, - "message": { - "type": "string", - "description": "Error Message." - }, - "correlationId": { - "type": "string", - "description": "API correlation ID." - }, - "details": { + "transactions": { "type": "array", "items": { + "type": "object", "properties": { - "location": { + "href": { "type": "string", - "description": "Field name referred to for validation issues." + "description": "Self link for this request", + "example": "/tss/v2/transactions/5289798134206292501013" }, - "message": { - "type": "string", - "description": "Description or code of any error response." + "method": { + "type": "string" } } } } } - }, + } + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "title": "ptsV1TransactionBatchesIdGet400Response", + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above.\n" + } + } + } + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + }, + "401": { + "description": "Not Authorized", + "schema": { + "title": "ptsV1TransactionBatchesIdGet401Response", + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above.\n" + } + } + } + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + }, + "403": { + "description": "No Authenticated", + "schema": { + "title": "ptsV1TransactionBatchesIdGet403Response", + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above.\n" + } + } + } + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + }, + "404": { + "description": "No Reports Found", + "schema": { + "title": "ptsV1TransactionBatchesIdGet404Response", + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above.\n" + } + } + } + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + }, + "502": { + "description": "Bad Gateway", + "schema": { + "title": "ptsV1TransactionBatchesIdGet502Response", + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The reason of status" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above." + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + } + } + } + }, + "/pts/v1/transaction-batch-details": { + "get": { + "tags": [ + "TransactionBatches" + ], + "summary": "Filters batch response.\n", + "description": "Filters batch response.\n", + "operationId": "getTransactionBatchDetails", + "x-devcenter-metaData": { + "categoryTag": "Transaction_Batches" + }, + "produces": [ + "text/vnd.cybersource.map-csv" + ], + "parameters": [ + { + "name": "transactionBatchId", + "in": "query", + "description": "Transaction Batch Id, this is unique.", + "required": true, + "type": "string" + }, + { + "name": "uploadDate", + "in": "query", + "description": "Date in which the original batch file was uploaded. Date must be in ISO-8601 format.", + "required": false, + "type": "string", + "format": "date" + }, + { + "name": "status", + "in": "query", + "description": "Allows you to filter by rejected response.\n", + "required": false, + "type": "string", + "enum": [ + "Rejected" + ] + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above.\n" + } + } + } + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + }, + "401": { + "description": "Not Authorized", + "schema": { + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above.\n" + } + } + } + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + }, + "403": { + "description": "No Authenticated", + "schema": { + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above.\n" + } + } + } + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + }, + "404": { + "description": "No Reports Found", + "schema": { + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string" + }, + "message": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above.\n" + } + } + } + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + }, + "502": { + "description": "Bad Gateway", + "schema": { + "type": "object", + "properties": { + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The reason of status" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above." + } + } + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + } + } + } + } + } + } + }, + "/pts/v2/payouts": { + "post": { + "summary": "Process a Payout", + "description": "Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using\nan Original Credit Transaction (OCT).\n", + "tags": [ + "Payouts" + ], + "operationId": "octCreatePayment", + "x-devcenter-metaData": { + "categoryTag": "Payouts" + }, + "parameters": [ + { + "name": "octCreatePaymentRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "maxLength": 19, + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + }, + "surcharge": { + "type": "object", + "properties": { + "amount": { + "type": "string", + "maxLength": 15, + "description": "The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer.\n\nIf the amount is positive, then it is a debit for the customer.\\\nIf the amount is negative, then it is a credit for the customer.\n\n**NOTE**: This field is supported only for CyberSource through VisaNet (CtV) for Payouts. For CtV, the maximum string length is 8.\n\nFor processor-specific information, see the surcharge_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" + }, + "phoneType": { + "type": "string", + "enum": [ + "day", + "home", + "night", + "work" + ], + "description": "Customer's phone number type.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nPossible Values - \n* day\n* home\n* night\n* work\n" + } + } + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "categoryCode": { + "type": "integer", + "maximum": 9999, + "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" + }, + "submitLocalDateTime": { + "type": "string", + "maxLength": 6, + "minLength": 6, + "description": "Time that the transaction was submitted in local time. The time is in hhmmss format.\n" + }, + "vatRegistrationNumber": { + "type": "string", + "maxLength": 21, + "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "merchantDescriptor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" + }, + "locality": { + "type": "string", + "maxLength": 13, + "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 14, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "contact": { + "type": "string", + "maxLength": 14, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n" + } + } + } + } + }, + "recipientInformation": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 35, + "description": "First name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\n" + }, + "middleInitial": { + "type": "string", + "maxLength": 1, + "description": "Middle Initial of recipient. Required only for FDCCompass.\n" + }, + "lastName": { + "type": "string", + "maxLength": 35, + "description": "Last name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\n" + }, + "address1": { + "type": "string", + "maxLength": 50, + "description": "Recipient address information. Required only for FDCCompass." + }, + "locality": { + "type": "string", + "maxLength": 25, + "description": "Recipient city. Required only for FDCCompass." + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "Recipient State. Required only for FDCCompass." + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Recipient country code. Required only for FDCCompass." + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Recipient postal code. Required only for FDCCompass." + }, + "phoneNumber": { + "type": "string", + "maxLength": 20, + "description": "Recipient phone number. Required only for FDCCompass." + }, + "dateOfBirth": { + "type": "string", + "minLength": 8, + "maxLength": 8, + "description": "Recipient date of birth in YYYYMMDD format. Required only for FDCCompass." + } + } + }, + "senderInformation": { + "type": "object", + "properties": { + "referenceNumber": { + "type": "string", + "maxLength": 19, + "description": "Reference number generated by you that uniquely identifies the sender." + }, + "account": { + "type": "object", + "properties": { + "fundsSource": { + "type": "string", + "minLength": 2, + "maxLength": 2, + "description": "Source of funds. Possible values:\n\n Paymentech, CTV, FDC Compass:\n - 01: Credit card\n - 02: Debit card\n - 03: Prepaid card\n\n Paymentech, CTV -\n - 04: Cash\n - 05: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings\n accounts, and proprietary debit or ATM cards.\n - 06: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines\n of credit.\n\n FDCCompass -\n - 04: Deposit Account\n\n**Funds Disbursement**\n\nThis value is most likely 05 to identify that the originator used a deposit account to fund the\ndisbursement.\n\n**Credit Card Bill Payment**\n\nThis value must be 02, 03, 04, or 05.\n" + }, + "number": { + "type": "string", + "maxLength": 34, + "description": "The account number of the entity funding the transaction. It is the sender\u2019s account number. It can\nbe a debit/credit card account number or bank account number.\n\n**Funds disbursements**\n\nThis field is optional.\n\n**All other transactions**\n\nThis field is required when the sender funds the transaction with a financial instrument, for example\ndebit card.\nLength:\n* FDCCompass (<= 19)\n* Paymentech (<= 16)\n" + } + } + }, + "firstName": { + "type": "string", + "maxLength": 35, + "description": "First name of sender (Optional).\n* CTV (14)\n* Paymentech (30)\n" + }, + "middleInitial": { + "type": "string", + "maxLength": 1, + "description": "Recipient middle initial (Optional).\n" + }, + "lastName": { + "type": "string", + "maxLength": 35, + "description": "Recipient last name (Optional).\n* CTV (14)\n* Paymentech (30)\n" + }, + "name": { + "type": "string", + "maxLength": 24, + "description": "Name of sender.\n\n**Funds Disbursement**\n\nThis value is the name of the originator sending the funds disbursement.\n* CTV, Paymentech (30)\n" + }, + "address1": { + "type": "string", + "maxLength": 50, + "description": "Street address of sender.\n\n**Funds Disbursement**\n\nThis value is the address of the originator sending the funds disbursement.\n" + }, + "locality": { + "type": "string", + "maxLength": 25, + "description": "City of sender.\n\n**Funds Disbursement**\n\nThis value is the city of the originator sending the funds disbursement.\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "Sender\u2019s state. Use the State, Province, and Territory Codes for the United States and Canada.\n" + }, + "countryCode": { + "type": "string", + "maxLength": 2, + "description": "Country of sender. Use the ISO Standard Country Codes.\n* CTV (3)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Sender\u2019s postal code. Required only for FDCCompass." + }, + "phoneNumber": { + "type": "string", + "maxLength": 20, + "description": "Sender\u2019s phone number. Required only for FDCCompass." + }, + "dateOfBirth": { + "type": "string", + "minLength": 8, + "maxLength": 8, + "description": "Sender\u2019s date of birth in YYYYMMDD format. Required only for FDCCompass." + }, + "vatRegistrationNumber": { + "type": "string", + "maxLength": 13, + "description": "Customer's government-assigned tax identification number.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "businessApplicationId": { + "type": "string", + "maxLength": 2, + "description": "Payouts transaction type.\n\nApplicable Processors: FDC Compass, Paymentech, CtV\n\nPossible values:\n\n**Credit Card Bill Payment**\n\n - **CP**: credit card bill payment\n\n**Funds Disbursement**\n\n - **FD**: funds disbursement\n - **GD**: government disbursement\n - **MD**: merchant disbursement\n\n**Money Transfer**\n\n - **AA**: account to account. Sender and receiver are same person.\n - **PP**: person to person. Sender and receiver are different.\n\n**Prepaid Load**\n\n - **TU**: top up\n" + }, + "networkRoutingOrder": { + "type": "string", + "maxLength": 30, + "description": "This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only.\nThe networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order.\nNote: Supported only in US for domestic transactions involving Push Payments Gateway Service.\n\nVisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order.\nIf an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer\u2019s preference. \nIf an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer\u2019s routing priorities. \n\nSee https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code , under section 'Network ID and Sharing Group Code' on the left panel for available values\n" + }, + "commerceIndicator": { + "type": "string", + "maxLength": 13, + "description": "Type of transaction.\n\nSome payment card companies use this information when determining discount rates. When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value listed here.\n\nPossible value for Fast Payments transactions:\n - internet\n\n**Ingenico ePayments**\\\nIngenico ePayments was previously called _Global Collect_.\n\n**Payer Authentication Transactions**\\\nFor the possible values and requirements, see \"Payer Authentication,\" page 180.\n\n**Other Types of Transactions**\\\nSee Appendix G, \"Commerce Indicators,\" on page 353.\n" + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" + }, + "payoutsOptions": { + "type": "object", + "properties": { + "acquirerMerchantId": { + "type": "string", + "maxLength": 15, + "description": "This field identifies the card acceptor for defining the point of service terminal in both local and interchange environments. An acquirer-assigned code identifying the card acceptor for the transaction. \nDepending on the acquirer and merchant billing and reporting requirements, the code can represent a merchant, a specific merchant location, or a specific merchant location terminal.\nAcquiring Institution Identification Code uniquely identifies the merchant.\nThe value from the original is required in any subsequent messages, including reversals, chargebacks, and representments.\n* Applicable only for CTV for Payouts.\n" + }, + "acquirerBin": { + "type": "string", + "maxLength": 11, + "description": "This code identifies the financial institution acting as the acquirer of this customer transaction. The acquirer is the member or system user that signed the merchant or ADM or dispensed cash. \nThis number is usually Visa-assigned.\n* Applicable only for CTV for Payouts.\n" + }, + "retrievalReferenceNumber": { + "type": "string", + "maxLength": 12, + "description": "This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set.\n* Applicable only for CTV for Payouts.\n" + }, + "accountFundingReferenceId": { + "type": "string", + "maxLength": 15, + "description": "Visa-generated transaction identifier (TID) that is unique for each original authorization and financial request.\n* Applicable only for CTV for Payouts.\n" + } + } + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "card": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n" + }, + "number": { + "type": "string", + "maxLength": 20, + "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\nFor processor-specific information, see the `customer_cc_expmo` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`.\n\nFor processor-specific information, see the `customer_cc_expyr` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "sourceAccountType": { + "type": "string", + "maxLength": 20, + "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\nThis field is required in the following cases:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n - Applicable only for Visa Platform Connect (VPC).\n \n**Note**\\\nCombo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank\nidentification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or\ncredit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends\nthat you include this field for combo card transactions.\n\nPossible values include the following.\n\n - **CHECKING**: Checking account\n - **CREDIT**: Credit card account\n - **SAVING**: Saving account\n - **LINE_OF_CREDIT**: Line of credit or credit portion of combo card\n - **PREPAID**: Prepaid card account or prepaid portion of combo card\n - **UNIVERSAL**: Universal account\n" + } + } + }, + "customer": { + "type": "object", + "properties": { + "customerId": { + "type": "string", + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" + } + } + } + } + } + }, + "example": { + "clientReferenceInformation": { + "code": "33557799" + }, + "senderInformation": { + "referenceNumber": "1234567890", + "address1": "900 Metro Center Blvd.900", + "countryCode": "US", + "locality": "Foster City", + "name": "Thomas Jefferson", + "administrativeArea": "CA", + "account": { + "number": "1234567890123456789012345678901234", + "fundsSource": "01" + } + }, + "processingInformation": { + "commerceIndicator": "internet", + "businessApplicationId": "FD", + "networkRoutingOrder": "ECG" + }, + "payoutsOptions": { + "retrievalReferenceNumber": "123456789012", + "acquirerBin": "567890124" + }, + "reconciliationId": "1087488702VIAQNSPQ", + "orderInformation": { + "amountDetails": { + "totalAmount": "100.00", + "currency": "USD" + } + }, + "merchantInformation": { + "merchantCategoryCode": "123", + "merchantDescriptor": { + "country": "US", + "postalCode": "94440", + "locality": "FC", + "name": "Thomas", + "administrativeArea": "CA" + } + }, + "paymentInformation": { + "card": { + "expirationYear": "2025", + "number": "4111111111111111", + "expirationMonth": "12", + "type": "001", + "sourceAccountType": "CH" + } + }, + "recipientInformation": { + "firstName": "John", + "lastName": "Doe", + "address1": "Paseo Padre Boulevard", + "locality": "Foster City", + "administrativeArea": "CA", + "postalCode": "94400", + "phoneNumber": "6504320556", + "dateOfBirth": "19801009", + "country": "US" + } + } + } + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "title": "ptsV2PayoutsPost201Response", + "type": "object", + "properties": { "_links": { "type": "object", "properties": { - "next": { - "type": "array", - "items": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - }, - "documentation": { - "type": "array", - "items": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - }, "self": { + "type": "object", "properties": { "href": { "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." + "description": "This is the endpoint of the resource that was created by the successful request." }, "method": { "type": "string", - "description": "HTTP method of the linked resource." + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." } } } } - } - } - } - } - }, - "x-samplePayload": { - "encryptionType": "RsaOaep256" - }, - "x-sampleResponse": { - "keyId": "05BgbFie7vX5vzSMKOoqEAAdfpdR4kas", - "der": { - "format": "X.509", - "algorithm": "RSA", - "publicKey": "MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAgC1G6rVue4w/jjJrKPZusGN9G+Y7mWuLJ0O2/GHd94LvR51+ok7ahuQUVMZLdigixnspaGo/WVLvTTZ5J28Cc1uSx0o/BsxpNaAQD8/aBZL3nnAiBLACxI1JHAVo7SXbJQmz+mqVFYTppg9QmpB2ATTmXjUOQy+Fqkw3EByfCANHhHSNs4+HASovsfcRMUmmvDfTd5qBb23KzDJeDVqTYWa3XjUorlZOCJuLyPgeDEK8oOC9C4W9dn32z8FJ4E6Dz28M/2O3g8FLQD2F+NezkQJsl8MEYo4rl1nr7/oIkMsYLCCoG8jwmryErb7km9JWWgqZ80trkjijFqDAbHfUEwIDAQAB" - }, - "jwk": { - "kty": "RSA", - "use": "enc", - "kid": "05BgbFie7vX5vzSMKOoqEAAdfpdR4kas", - "n": "fC1G6rVue4w_jjJrKPZusGN9G-Y7mWuLJ0O2_GHd94LvR51-ok7ahuQUVMZLdigixnspaGo_WVLvTTZ5J28Cc1uSx0o_BsxpNaAQD8_aBZL3nnAiBLACxI1JHAVo7SXAJQmz-mqVFYTppg9QmpB2ATTmXjUOQy-Fqkw3EByfCANHhHSNs4-HASovsfcRMUmmvDfTd5qBb23KzDJeDVqTYWa3XjUorlZOCJuLyPgeDEK8oOC9C4W9dn32z8FJ4E6Dz28M_2O3g8FLQD2F-NezkQJsl8MEYo4rl1nr7_oIkMsYLCCoG8jwmryErb7km9JWWgqZ80trkjijFqDAbHfUEw", - "e": "AQAB" - } - } - } - }, - "/flex/v1/tokens/": { - "x-name": "Flex Tokenize Card", - "x-description": "Returns a token representing the supplied card details. The token replaces card data and can be used as the Subscription ID in the CyberSource Simple Order API or SCMP API. This is an unauthenticated call that you should initiate from your customer\u2019s device or browser.", - "post": { - "tags": [ - "FlexToken" - ], - "summary": "Flex Tokenize card", - "description": "Returns a token representing the supplied card details. The token replaces card data and can be used as the Subscription ID in the CyberSource Simple Order API or SCMP API. This is an unauthenticated call that you should initiate from your customer\u2019s device or browser.", - "operationId": "tokenize", - "produces": [ - "application/json" - ], - "parameters": [{ - "in": "body", - "name": "tokenizeRequest", - "schema": { - "type": "object", - "properties": { - "keyId": { - "type": "string", - "description": "Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key." - }, - "cardInfo": { - "type": "object", - "properties": { - "cardNumber": { - "type": "string", - "description": "Encrypted or plain text card number. If the encryption type of \u201cNone\u201d was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders\u2019 device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request." - }, - "cardExpirationMonth": { - "type": "string", - "description": "Two digit expiration month" - }, - "cardExpirationYear": { - "type": "string", - "description": "Four digit expiration year" - }, - "cardType": { - "type": "string", - "description": "Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types." - } - } - } - } - } - } - ], - "x-example": { - "example0": { - "summary": "Flex Tokenize Card", - "value": { - "keyId": "05BgbFie7vX5vzSMKOoqEAAdfpdR4kas", - "cardInfo": { - "cardNumber": "4111111111111111", - "cardExpirationMonth": "12", - "cardExpirationYear": "2031", - "cardType": "001" - } - } - } - }, - "responses": { - "200": { - "description": "Created payment token.", - "schema": { - "title": "flexV1TokensPost200Response", - "properties": { - "keyId": { - "type": "string", - "description": "The Key ID." }, - "token": { - "type": "string", - "description": "The generated token. The token replaces card data and is used as the Subscription ID in the CyberSource Simple Order API or SCMP API." - }, - "maskedPan": { + "id": { "type": "string", - "description": "The masked card number displaying the first 6 digits and the last 4 digits." + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." }, - "cardType": { + "submitTimeUtc": { "type": "string", - "description": "The card type." - }, - "timestamp": { - "type": "integer", - "format": "int64", - "description": "The UTC date and time in milliseconds at which the signature was generated." + "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" }, - "signedFields": { + "status": { "type": "string", - "description": "Indicates which fields from the response make up the data that is used when verifying the response signature. See the [sample code] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/java/com/cybersource/flex/application/CheckoutController.java) on how to verify the signature." + "description": "The status of the submitted transaction.\n\nPossible values:\n - ACCEPTED\n - DECLINED\n - INVALID_REQUEST\n", + "enum": [ + "ACCEPTED", + "DECLINED", + "INVALID_REQUEST" + ] }, - "signature": { + "reconciliationId": { "type": "string", - "description": "Flex-generated digital signature. To ensure the values have not been tampered with while passing through the client, verify this server-side using the public key generated from the /keys resource." + "maxLength": 25, + "description": "Cybersource or merchant generated transaction reference number. This is sent to the processor and is echoed back in the response to the merchant. This is\nThis value is used for reconciliation purposes.\n" }, - "discoverableServices": { + "errorInformation": { "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - } - }, - "default": { - "description": "Error creating token.", - "schema": { - "type": "object", - "properties": { - "responseStatus": { "properties": { - "status": { - "type": "number", - "description": "HTTP Status code." - }, "reason": { "type": "string", - "description": "Error Reason Code." + "description": "The reason of the status.\n\nPossible values:\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - STOLEN_LOST_CARD\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - INVALID_CVN\n - BLACKLISTED_CUSTOMER\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - RISK_CONTROL_DECLINE\n - PROCESSOR_RISK_CONTROL_DECLINE\n", + "enum": [ + "EXPIRED_CARD", + "PROCESSOR_DECLINED", + "STOLEN_LOST_CARD", + "UNAUTHORIZED_CARD", + "CVN_NOT_MATCH", + "INVALID_CVN", + "BLACKLISTED_CUSTOMER", + "INVALID_ACCOUNT", + "GENERAL_DECLINE", + "RISK_CONTROL_DECLINE", + "PROCESSOR_RISK_CONTROL_DECLINE" + ] }, "message": { "type": "string", - "description": "Error Message." - }, - "correlationId": { - "type": "string", - "description": "API correlation ID." + "description": "The detail message related to the status and reason listed above." }, "details": { "type": "array", "items": { + "type": "object", "properties": { - "location": { + "field": { "type": "string", - "description": "Field name referred to for validation issues." + "description": "This is the flattened JSON object field name/path that is either missing or invalid." }, - "message": { + "reason": { "type": "string", - "description": "Description or code of any error response." + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] } } } } } }, - "_links": { - "type": "object", - "properties": { - "next": { - "type": "array", - "items": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - }, - "documentation": { - "type": "array", - "items": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - }, - "self": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - } - } - } - } - } - }, - "x-samplePayload": { - "keyId": "05BgbFie7vX5vzSMKOoqEAAdfpdR4kas", - "cardDetails": { - "cardNumber": "ejbhIpMEgYnIODcB4//rrVxMHrqHcnLD6pDRF36jlEk72bETAfiOoxmpI9pGiidqMmkgAnvJfVgR3CLAV5EdG4Mu5IWK26QRnVtwvsVEUtpah7IylbxV9MLvXh2FjIJskKCWNLidb1G4PN5963hnV3IoZd2pF99JwV9lPhOHT5ymlNeg7sTzQQDN1I0/yJApds+t79hl9QVp4PusUDfSsPQTtR2frzlH4V3W+XjHDhmy5oNhiUaVxv27cyG1SWeCKkVC9tc8zLy4pvlgoplrLV8JRaS9hfWalJjv2xtk3DXmNT2urtFv2evcI3LM/S29KlJjPXZcBp0IYyB/taunCA==", - "cardType": "001" - } - }, - "x-sampleResponse": { - "keyId": "05BgbFie7vX5vzSMKOoqEAAdfpdR4kas", - "token": "0100153497304242", - "maskedPan": "424242XXXXXX4242", - "cardType": "001", - "timestamp": 1472733222651, - "signedFields": "token,cardType,maskedPan,timestamp", - "signature": "TcM7METFOIidwbxWG2Xhawx/5gZ7hZB0Lyrhg3NRJ+Pma+Nq7BugvsqLCE2R24+h13xnM6vpJXR2cqfQPkxhb6joJT8jcciEf+lj6h/KjvXuR4pJ4fMll4WS1Z4+574ps0ysV/5zs7kT2IAZj7i+szlYwFJxGhOGC0218x1N0NxELTDyU/HI6n+Aa+mYBqkMXth42t+GNQ7goVXkJWRgQSjp2v0WTh2d2plDnxEWPURZXz7GLdQXRIYUWWx/L5JSf88F1zgjYDpBitNSYBMMILKfDd3KEg+6nIruCln5kDMbTRD8LwPpGYC9tyM9+UM8MBINPHhaqdFp2wHF7dccKA==", - "discoverableServices": {} - } - } - }, - "/pts/v2/payments/": { - "post": { - "summary": "Process a Payment", - "description": "Authorize the payment for the transaction.\n", - "tags": [ - "payments" - ], - "operationId": "createPayment", - "x-devcenter-metaData": { - "categoryTag": "Payments" - }, - "parameters": [{ - "name": "createPaymentRequest", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { "clientReferenceInformation": { "type": "object", "properties": { "code": { "type": "string", "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" }, - "transactionId": { + "submitLocalDateTime": { "type": "string", - "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations\n.\nSee \"Merchant-Initiated Reversals and Voids,\" page 176.\n" + "maxLength": 14, + "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" }, - "comments": { + "ownerMerchantId": { "type": "string", - "description": "Comments" - }, - "partner": { - "type": "object", + "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { "properties": { - "originalTransactionId": { + "name": { "type": "string", - "maxLength": 32, - "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" }, - "developerId": { + "locality": { "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + "maxLength": 13, + "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" }, - "solutionId": { + "country": { "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + "maxLength": 2, + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" } } } } }, - "processingInformation": { + "orderInformation": { "type": "object", "properties": { - "capture": { - "type": "boolean", - "description": "Flag that specifies whether to also include capture service in the submitted request or not.\n\nPossible values:\n- **true**\n- **false** (default).\n", - "enum": [ - true, - false - ], - "default": false - }, - "processorId": { - "type": "string", - "maxLength": 3, - "description": "Value that identifies the processor/acquirer to use for the transaction. This value is supported only for\n**CyberSource through VisaNet**.\n\nContact CyberSource Customer Support to get the value for this field.\n" - }, - "businessApplicationId": { - "type": "string", - "description": "The description for this field is not available." - }, - "commerceIndicator": { - "type": "string", - "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates. When you\nomit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file\nfor you instead of the default value listed here.\n" - }, - "paymentSolution": { - "type": "string", - "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" - }, - "linkId": { - "type": "string", - "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n" - }, - "purchaseLevel": { - "type": "string", - "maxLength": 1, - "description": "Set this field to 3 to indicate that the request includes Level III data." - }, - "reportGroup": { - "type": "string", - "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n" - }, - "visaCheckoutId": { - "type": "string", - "maxLength": 48, - "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n" - }, - "authorizationOptions": { - "type": "object", - "properties": { - "authType": { - "type": "string", - "maxLength": 15, - "description": "Authorization type.\n\nPossible values:\n\n - **AUTOCAPTURE**: automatic capture.\n - **STANDARDCAPTURE**: standard capture.\n - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n**Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing**\\\nSet this field to _AUTOCAPTURE_ and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to STANDARDCAPTURE and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see \"Automatic Captures,\" page 33.\n\n**Forced Capture**\\\nSet this field to _VERBAL_ and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. For more information, see \"Forced Captures,\" page 123.\n\n**Verbal Authorization**\\\nSet this field to _VERBAL_ and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations,\" page 84.\n\nFor processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "verbalAuthCode": { - "type": "string", - "maxLength": 7, - "description": "Authorization code.\n\n**Forced Capture**\\\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n**Verbal Authorization**\\\nUse this field in CAPTURE API to send the verbally received authorization code.\n\nFor processor-specific information, see the _auth_code_ field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "verbalAuthTransactionId": { - "type": "string", - "maxLength": 15, - "description": "Transaction ID (TID)." - }, - "authIndicator": { - "type": "string", - "maxLength": 1, - "description": "Flag that specifies the purpose of the authorization.\n\nPossible values:\n - **0**: Preauthorization\n - **1**: Final authorization\n\nTo set the default for this field, contact CyberSource Customer Support.\nSee \"Final Authorization Indicator,\" page 119.\n\nBarclays and Elavon\nThe default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support.\n\nCyberSource through VisaNet\nWhen the value for this field is 0, it corresponds to the following data in the TC 33 capture file5:\n - Record: CP01 TCR0\n - Position: 164\n - Field: Additional Authorization Indicators\nWhen the value for this field is 1, it does not correspond to any data in the TC 33 capture file.\n\nFor processor-specific information, see the auth_indicator field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "partialAuthIndicator": { - "type": "boolean", - "description": "Flag that indicates whether the transaction is enabled for partial authorization or not. When your request\nincludes this field, this value overrides the information in your CyberSource account. For processor-specific\ninformation, see the _auth_partial_auth_indicator_ field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\\\nTo set the default for this field, contact CyberSource Customer Support.\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR0\n- Position: 164\n- Field: Additional Authorization Indicators\n\nPossible values:\n- **true** Enable the transaction for partial authorization.\n- **false** Do not enable the transaction for partial authorization.\n", - "enum": [ - true, - false - ] - }, - "balanceInquiry": { - "type": "boolean", - "description": "Flag that indicates whether to return balance information.\n\nPossible values:\n- **true**\n- **false**\n", - "enum": [ - true, - false - ] - }, - "ignoreAvsResult": { - "type": "boolean", - "description": "Flag that indicates whether to allow the capture service to run, even when the payment\nreceives an AVS decline.\n\nPossible values:\n- **true** Ignore the results of AVS checking and run the capture service.\n- **false** (default): If the authorization receives an AVS decline, do not run the capture service.\n", - "enum": [ - true, - false - ], - "default": false - }, - "declineAvsFlags": { - "type": "array", - "description": "An array of AVS flags that cause the reply flag to be returned.\n\n`Important` To receive declines for the AVS code N, include the value N in the array.\n\nPossible values:\n- D\n- A\n- V\n- S\n- N\n- O\n", - "items": { - "type": "string", - "enum": [ - "D", - "A", - "V", - "S", - "N", - "O" - ] - } - }, - "ignoreCvResult": { - "type": "boolean", - "description": "Flag that indicates whether to allow the capture service to run even when\nthe payment receives a CVN decline.\n\nPossible values:\n- **true** Ignore the results of CVN checking and run the capture service.\n- **false** (default) If the authorization receives a CVN decline, do not run the capture service.\n", - "enum": [ - true, - false - ], - "default": false - }, - "initiator": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction.\n\nValid values:\n- **customer**\n- **merchant**\n", - "enum": [ - "customer", - "merchant" - ] - }, - "credentialStoredOnFile": { - "type": "boolean", - "description": "Flag that indicates whether merchant intends to use this transaction to store payment credentials for follow-up\nmerchant-initiated transactions.\n\nValid values:\n- `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n- `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions.\n\nSee \"Merchant-Initiated Transactions,\" page 177.\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\nThis field is supported only for Visa transactions on CyberSource through VisaNet.\n", - "enum": [ - true, - false - ] - }, - "storedCredentialUsed": { - "type": "boolean", - "description": "Flag that indicates whether merchant is intend to use this transaction to store payment credential for follow-up\nmerchant-initiated transactions or not.\n\nPossible values:\n- **true**\n- **false**\n", - "enum": [ - true, - false - ] - }, - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "maxLength": 1, - "description": "Reason for the merchant-initiated transaction or incremental authorization. Possible values:\n- `1`: Resubmission\n- `2`: Delayed charge\n- `3`: Reauthorization for split shipment\n- `4`: No show\n- `5`: Account top up\nThis field is required only for the five kinds of transactions in the preceding list.\nThis field is supported only for merchant-initiated transactions and incremental authorizations.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR0\n- Position: 160-163\n- Field: Message Reason Code\n\n**All Processors**\\\nSee \"Merchant-Initiated Transactions,\" page 196. For CyberSource through VisaNet, see also \"Incremental Authorizations,\" page 40.\n" - }, - "previousTransactionId": { - "type": "string", - "maxLength": 15, - "description": "Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_\nin the reply message for either the original merchant-initiated payment in the series or the previous\nmerchant-initiated payment in the series.\n\nIf the current payment request includes a token instead of an account number, the following time limits apply for the value of this field:\n- For a **resubmission**, the transaction ID must be less than 14 days old.\n- For a **delayed charge** or **reauthorization**, the transaction ID must be less than 30 days old.\n\n**NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported\nonly for Visa transactions on CyberSource through VisaNet.\n" - } - } - } - } - }, - "billPayment": { - "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan. See \"Visa Bill Payments,\" page 220, and \"Visa Debt Repayments,\" page 221, for lists of processors that support these features.\n\nPossible values:\n- true: Bill payment or loan payment.\n- false (default): Not a bill payment or loan payment.\n" - }, - "billPaymentType": { - "type": "string", - "description": "Reason for the payment.\n\nPossible values:\n- 001: Utility payment\n- 002: Government services\n- 003: Mobile phone top-up\n- 004: Coupon payment\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR0\n- Position: 48-50\n- Field: Bill Payment Transaction Type Identifier\n\nThis field is supported only for bill payments in Brazil with Mastercard on CyberSource through VisaNet.\nSee Mastercard Bill Payments.\n\nNote For information about bill payments with Visa, see Visa Bill Payments.\n" - } - } - }, - "captureOptions": { - "type": "object", - "properties": { - "captureSequenceNumber": { - "type": "number", - "minimum": 1, - "maximum": 99, - "description": "Capture number when requesting multiple partial captures for one payment.\nUsed along with _totalCaptureCount_ to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n" - }, - "totalCaptureCount": { - "type": "number", - "minimum": 1, - "maximum": 99, - "description": "Total number of captures when requesting multiple partial captures for one payment.\nUsed along with _captureSequenceNumber_ which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n" - }, - "dateToCapture": { - "type": "string", - "maxLength": 4, - "description": "Date on which you want the capture to occur. This field is supported only for CyberSource through VisaNet.\\\n`Format: MMDD`\n" - } - } - }, - "recurringOptions": { - "type": "object", - "properties": { - "loanPayment": { - "type": "boolean", - "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- **true** Loan payment\n- **false** (default) Not a loan payment\n\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\n", - "enum": [ - true, - false - ], - "default": false - }, - "firstRecurringPayment": { - "type": "boolean", - "description": "Flag that indicates whether this transaction is the first in a series of recurring payments.\n\nThis field is supported only for **Atos**, **FDC Nashville Global**, and **OmniPay Direct**.\n\nPossible values:\n - **true** Indicates this is the first payment in a series of recurring payments\n - **false** (default) Indicates this is not the first payment in a series of recurring payments.\n\nFor more details, see \"Recurring Payments,\" page 198.\n", - "enum": [ - true, - false - ], - "default": false - } - } - }, - "bankTransferOptions": { + "amountDetails": { "type": "object", "properties": { - "declineAvsFlags": { + "totalAmount": { "type": "string", - "maxLength": 15, - "description": "List of AVS flags that cause the request to be declined for AVS reasons. Use a space to separate the flags in\nthe list. Important Make sure that you include the value N in the list if you want to receive declines for the\nAVS code N.\n" + "maxLength": 19, + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" }, - "secCode": { + "currency": { "type": "string", "maxLength": 3, - "description": "Authorization method used for the transaction. See \"SEC Codes,\" page 89.\n\nTeleCheck Accepts only the following values:\n- **PPD**\n- **TEL**\n- **WEB**\n" - }, - "terminalCity": { - "type": "string", - "maxLength": 4, - "description": "City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction\nwill be declined.\n\nYou cannot include any special characters.\n" - }, - "terminalState": { - "type": "string", - "maxLength": 2, - "description": "State in which the terminal is located. If more than two alphanumeric characters are submitted, the transaction\nwill be declined.\n\nYou cannot include any special characters.\n" - }, - "effectiveDate": { - "type": "string", - "maxLength": 8, - "description": "Effective date for the transaction. The effective date must be within 45 days of the current day. If you do not\ninclude this value, CyberSource sets the effective date to the next business day.\n\nFormat: `MMDDYYYY`\n\nSupported only for the CyberSource ACH Service.\n" - }, - "partialPaymentId": { - "type": "string", - "maxLength": 25, - "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order. See \"Multiple\nPartial Credits,\" page 41.\n" - }, - "customerMemo": { - "type": "string", - "maxLength": 80, - "description": "Payment related information.\n\nThis information is included on the customer\u2019s statement.\n" - }, - "paymentCategoryCode": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates whether to process the payment.\n\nUse with deferred payments. See \"Deferred and Partial Payments,\" page 37.\n\nPossible values:\n- **0**: Standard debit with immediate payment (default).\n- **1**: For deferred payments, indicates that this is a deferred payment and that you will send a debit request\nwith `paymentCategoryCode = 2` in the future.\n- **2**: For deferred payments, indicates notification to initiate payment.\n\nChase Paymentech Solutions and TeleCheck Use for deferred and partial payments.\n\nCyberSource ACH Service Not used.\n\nRBS WorldPay Atlanta Not used.\n" + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" }, - "settlementMethod": { + "settlementAmount": { "type": "string", - "maxLength": 1, - "description": "Method used for settlement.\n\nPossible values:\n- **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- **F**: Facsimile draft (U.S. dollars only)\n- **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nSee \"Settlement Delivery Methods,\" page 44.\n" + "maxLength": 12, + "description": "This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder\u2019s account.\n" }, - "fraudScreeningLevel": { + "settlementCurrency": { "type": "string", - "maxLength": 1, - "description": "Level of fraud screening.\n\nPossible values:\n- **1**: Validation \u2014 default if the field has not already been configured for your merchant ID\n- **2**: Verification\n\nFor a description of this feature and a list of supported processors, see \"Verification and Validation,\" page 24.\n" + "maxLength": 3, + "description": "This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account.\n" } } } } }, - "issuerInformation": { + "processorInformation": { "type": "object", "properties": { - "discretionaryData": { + "approvalCode": { "type": "string", - "maxLength": 255, - "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n" - } - } - }, - "paymentInformation": { - "type": "object", - "properties": { - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "maxLength": 20, - "description": "Customer\u2019s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field\nfor the encoded account number.\n\nFor processor-specific information, see the customer_cc_number field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the credit card expires.\n`Format: YYYY`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "type": { - "type": "string", - "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n" - }, - "useAs": { - "type": "string", - "maxLength": 20, - "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\n**Cielo** and **Comercio Latino**\n\nPossible values:\n\n - CREDIT: Credit card\n - DEBIT: Debit card\n\nThis field is required for:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n" - }, - "sourceAccountType": { - "type": "string", - "maxLength": 20, - "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\nThis field is required in the following cases:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n - Applicable only for Visa Platform Connect (VPC).\n \n**Note**\\\nCombo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank\nidentification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or\ncredit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends\nthat you include this field for combo card transactions.\n\nPossible values include the following.\n\n - **CHECKING**: Checking account\n - **CREDIT**: Credit card account\n - **SAVING**: Saving account\n - **LINE_OF_CREDIT**: Line of credit or credit portion of combo card\n - **PREPAID**: Prepaid card account or prepaid portion of combo card\n - **UNIVERSAL**: Universal account\n" - }, - "securityCode": { - "type": "string", - "maxLength": 4, - "description": "Card Verification Number.\n\n**Ingenico ePayments**\nDo not include this field when _commerceIndicator=recurring_.\n**Note** Ingenico ePayments was previously called Global Collect.\n" - }, - "securityCodeIndicator": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates whether a CVN code was sent. Possible values:\n\n - 0 (default): CVN service not requested. CyberSource uses this default value when you do not include\n _securityCode_ field in the request.\n - 1 (default): CVN service requested and supported. CyberSource uses this default value when you include\n _securityCode_ field in the request.\n - 2: CVN on credit card is illegible.\n - 9: CVN was not imprinted on credit card.\n" - }, - "accountEncoderId": { - "type": "string", - "maxLength": 3, - "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n" - }, - "issueNumber": { - "type": "string", - "maxLength": 5, - "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" - }, - "startMonth": { - "type": "string", - "maxLength": 2, - "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" - }, - "startYear": { - "type": "string", - "maxLength": 4, - "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" - }, - "productName": { - "type": "string", - "maxLength": 15, - "description": "Name of the card product.\n\nPossible value:\n- BNDES\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 115-120\n- Field: Brazil Country Data\n" - } - } + "maxLength": 6, + "description": "Issuer-generated approval code for the transaction." }, - "tokenizedCard": { - "type": "object", - "properties": { - "number": { - "type": "string", - "maxLength": 20, - "description": "Customer\u2019s payment network token value.\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the payment network token expires. `Format: YYYY`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "type": { - "type": "string", - "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n" - }, - "cryptogram": { - "type": "string", - "maxLength": 40, - "description": "This field is used internally." - }, - "requestorId": { - "type": "string", - "maxLength": 11, - "description": "Value that identifies your business and indicates that the cardholder\u2019s account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider\u2019s database.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n" - }, - "transactionType": { - "type": "string", - "maxLength": 1, - "description": "Type of transaction that provided the token data. This value does not specify the token service provider; it\nspecifies the entity that provided you with information about the token.\n\nSet the value for this field to 1. An application on the customer\u2019s mobile device provided the token data.\n" - }, - "assuranceLevel": { - "type": "string", - "maxLength": 2, - "description": "Confidence level of the tokenization. This value is assigned by the token service provider.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n" - }, - "storageMethod": { - "type": "string", - "maxLength": 3, - "description": "Type of technology used in the device to store token data. Possible values:\n\n - 001: Secure Element (SE)\n\nSmart card or memory with restricted access and encryption to prevent data tampering. For storing payment\ncredentials, a SE is tested against a set of requirements defined by the payment networks.\n\n`Note` This field is supported only for **FDC Compass**.\n\n- 002: Host Card Emulation (HCE)\n\nEmulation of a smart card by using software to create a virtual and exact representation of the card.\nSensitive data is stored in a database that is hosted in the cloud. For storing payment credentials, a database\nmust meet very stringent security requirements that exceed PCI DSS.\n\n`Note` This field is supported only for **FDC Compass**.\n" - }, - "securityCode": { - "type": "string", - "maxLength": 4, - "description": "Card Verification Number.\n\n**Ingenico ePayments**\nDo not include this field when _commerceIndicator=recurring_.\n**Note** Ingenico ePayments was previously called Global Collect. CVN.\n" - } - } + "responseCode": { + "type": "string", + "maxLength": 10, + "description": "Transaction status from the processor." }, - "fluidData": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The name of the merchant-defined data field. The range of this field starts at 1 and terminiates at 100." - }, - "descriptor": { - "type": "string", - "maxLength": 128, - "description": "The specific string for identifying the payment solution that is sending the encrypted payment data to CyberSource.\nValid values:\n- `Apple Pay`\n- `Samsung Pay`\n**NOTE**: For other payment solutions, the value may be specific to the customer's mobile device. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Merchant needs to pass in this value.\n" - }, - "value": { - "type": "string", - "maxLength": 3072, - "description": "Represents the encrypted payment data BLOB. The entry for this field is dependent on the payment solution a merchant uses.\n\nValid values:\n- Apple Pay: `RklEPUNPTU1PTi5BUFBMRS5JTkFQUC5QQVlNRU5U`\n- Samsung Pay: `RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ=`\n**NOTE**: For other payment solutions, the value of the descriptor may be specific to the customer's mobile device. For example, the descriptor for a Bluefin payment encryption would be a device-generated descriptor. Merchant needs to pass in this value.\n" - }, - "encoding": { - "type": "string", - "maxLength": 6, - "description": "Encoding method used to encrypt the payment data.\n\nValid value: Base64\n" - } - } + "transactionId": { + "type": "string", + "maxLength": 15, + "description": "Network transaction identifier (TID). This value can be used to identify a specific transaction when\nyou are discussing the transaction with your processor.\n" }, - "customer": { - "type": "object", - "properties": { - "customerId": { - "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" - } - } + "systemTraceAuditNumber": { + "type": "string", + "maxLength": 6, + "description": "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\n\n**American Express Direct**\n\nSystem trace audit number (STAN). This value identifies the transaction and is useful when investigating a\nchargeback dispute.\n\n**CyberSource through VisaNet**\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n" }, - "bank": { - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "type": { - "type": "string", - "maxLength": 1, - "description": "Account type.\n\nPossible values:\n - **C**: Checking.\n - **G**: General ledger. This value is supported only on Wells Fargo ACH.\n - **S**: Savings (U.S. dollars only).\n - **X**: Corporate checking (U.S. dollars only).\n" - }, - "number": { - "type": "string", - "maxLength": 17, - "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" - }, - "encoderId": { - "type": "string", - "maxLength": 3, - "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor. See \"Encoded Account Numbers,\" page 39.\n" - }, - "checkNumber": { - "type": "string", - "maxLength": 8, - "description": "Check number.\n\nChase Paymentech Solutions - Optional.\nCyberSource ACH Service - Not used.\nRBS WorldPay Atlanta - Optional on debits. Required on credits.\nTeleCheck - Strongly recommended on debit requests. Optional on credits.\n" - }, - "checkImageReferenceNumber": { - "type": "string", - "maxLength": 32, - "description": "Image reference number associated with the check. You cannot include any special characters.\n" - } - } - }, - "routingNumber": { - "type": "string", - "maxLength": 9, - "description": "Bank routing number.\n\nThis is also called the transit number.\n" - } - } + "responseCodeSource": { + "type": "string", + "maxLength": 1, + "description": "Used by Visa only and contains the response source/reason code that identifies the source of the response decision.\n" } } }, - "orderInformation": { + "recipientInformation": { "type": "object", "properties": { - "amountDetails": { + "card": { "type": "object", "properties": { - "totalAmount": { - "type": "string", - "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - }, - "discountAmount": { - "type": "string", - "maxLength": 15, - "description": "Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "dutyAmount": { - "type": "string", - "maxLength": 15, - "description": "Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAmount": { - "type": "string", - "maxLength": 12, - "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "nationalTaxIncluded": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAppliedAfterDiscount": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAppliedLevel": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxTypeCode": { - "type": "string", - "maxLength": 3, - "description": "For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "freightAmount": { - "type": "string", - "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "foreignAmount": { - "type": "string", - "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "foreignCurrency": { - "type": "string", - "maxLength": 5, - "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "exchangeRate": { - "type": "string", - "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "exchangeRateTimeStamp": { - "type": "string", - "maxLength": 14, - "description": "Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "surcharge": { - "type": "object", - "properties": { - "amount": { - "type": "string", - "maxLength": 15, - "description": "The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer.\n\nIf the amount is positive, then it is a debit for the customer.\\\nIf the amount is negative, then it is a credit for the customer.\n\n**NOTE**: This field is supported only for CyberSource through VisaNet (CtV) for Payouts. For CtV, the maximum string length is 8.\n\nFor processor-specific information, see the surcharge_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "description": { - "type": "string", - "description": "Merchant-defined field for describing the surcharge amount." - } - } - }, - "settlementAmount": { + "balance": { "type": "string", "maxLength": 12, - "description": "This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder\u2019s account.\n" + "description": "This field shows the available balance in the prepaid account. \nAcquirers always receive the available balance in the transaction currency.\n" }, - "settlementCurrency": { + "currency": { "type": "string", "maxLength": 3, - "description": "This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account.\n" - }, - "amexAdditionalAmounts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "amount": { - "type": "string", - "maxLength": 12, - "description": "Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - } - }, - "taxDetails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", - "enum": [ - "alternate", - "local", - "national", - "vat" - ] - }, - "amount": { - "type": "string", - "maxLength": 13, - "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" - }, - "rate": { - "type": "string", - "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" - }, - "code": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" - }, - "applied": { - "type": "boolean", - "description": "The tax is applied. Valid value is `true` or `false`." - }, - "exemptionCode": { - "type": "string", - "maxLength": 1, - "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" - } - } - } - }, - "serviceFeeAmount": { - "type": "string", - "maxLength": 15, - "description": "Service fee. Required for service fee transactions.\n" - }, - "originalAmount": { - "type": "string", - "maxLength": 15, - "description": "Amount in your original local pricing currency.\n\nThis value cannot be negative. You can include a decimal point (.) in this field to denote the currency\nexponent, but you cannot include any other special characters.\n\nIf needed, CyberSource truncates the amount to the correct number of decimal places.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n" - }, - "originalCurrency": { - "type": "string", - "maxLength": 15, - "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n" - } - } - }, - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "middleName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s middle name.\n" - }, - "nameSuffix": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s name suffix.\n" - }, - "title": { - "type": "string", - "maxLength": 60, - "description": "Title.\n" - }, - "company": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 60, - "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "address1": { - "type": "string", - "maxLength": 40, - "description": "First line in the street address of the company purchasing the product." - }, - "address2": { - "type": "string", - "maxLength": 40, - "description": "Additional address information for the company purchasing the product." - }, - "locality": { - "type": "string", - "maxLength": 30, - "description": "City in the address of the company purchasing the product." - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n" - } - } - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "address2": { - "type": "string", - "maxLength": 60, - "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "locality": { - "type": "string", - "maxLength": 50, - "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "district": { - "type": "string", - "maxLength": 50, - "description": "Customer\u2019s neighborhood, community, or region (a barrio in Brazil) within the city or municipality. This\nfield is available only on **Cielo**.\n" - }, - "buildingNumber": { - "type": "string", - "maxLength": 256, - "description": "Building number in the street address.\n\nFor example, if the street address is:\nRua da Quitanda 187\nthen the building number is 187.\n\nThis field is supported only for:\n - Cielo transactions.\n - Redecard customer validation with CyberSource Latin American Processing.\n" - }, - "email": { - "type": "string", - "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" - }, - "phoneType": { - "type": "string", - "enum": [ - "day", - "home", - "night", - "work" - ], - "description": "Customer's phone number type.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nPossible Values - \n* day\n* home\n* night\n* work\n" - } - } - }, - "shipTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Last name of the recipient.\n\n**Processor-specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "First line of the shipping address." - }, - "address2": { - "type": "string", - "maxLength": 60, - "description": "Second line of the shipping address." - }, - "locality": { - "type": "string", - "maxLength": 50, - "description": "City of the shipping address." - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the shipping address. Use the two character ISO Standard Country Codes." - }, - "district": { - "type": "string", - "maxLength": 50, - "description": "Neighborhood, community, or region within a city or municipality." - }, - "buildingNumber": { - "type": "string", - "maxLength": 15, - "description": "Building number in the street address. For example, the building number is 187 in the following address:\n\nRua da Quitanda 187\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Phone number for the shipping address." - }, - "company": { - "type": "string", - "maxLength": 60, - "description": "Name of the customer\u2019s company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - }, - "lineItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "productCode": { - "type": "string", - "maxLength": 255, - "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\n" - }, - "productName": { - "type": "string", - "maxLength": 255, - "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false` respectively), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other\nvalues that are related to shipping and/or handling.\n" - }, - "productSku": { - "type": "string", - "maxLength": 255, - "description": "Identification code for the product.\n\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n" - }, - "quantity": { - "type": "number", - "minimum": 1, - "maximum": 9999999999, - "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n", - "default": 1 - }, - "unitPrice": { - "type": "string", - "maxLength": 15, - "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" - }, - "unitOfMeasure": { - "type": "string", - "maxLength": 12, - "description": "Unit of measure, or unit of measure code, for the item.\n" - }, - "totalAmount": { - "type": "string", - "maxLength": 13, - "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n" - }, - "taxAmount": { - "type": "string", - "maxLength": 15, - "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nIf you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API.\n\nThis field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API.\n" - }, - "taxRate": { - "type": "string", - "maxLength": 7, - "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" - }, - "taxAppliedAfterDiscount": { - "type": "string", - "maxLength": 1, - "description": "Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n" - }, - "taxStatusIndicator": { - "type": "string", - "maxLength": 1, - "description": "Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n" - }, - "taxTypeCode": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "amountIncludesTax": { - "type": "boolean", - "description": "Flag that indicates whether the tax amount is included in the Line Item Total.\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "typeOfSupply": { - "type": "string", - "maxLength": 2, - "description": "Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n" - }, - "commodityCode": { - "type": "string", - "maxLength": 15, - "description": "Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n" - }, - "discountAmount": { - "type": "string", - "maxLength": 13, - "description": "Discount applied to the item." - }, - "discountApplied": { - "type": "boolean", - "description": "Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "discountRate": { - "type": "string", - "maxLength": 6, - "description": "Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n" - }, - "invoiceNumber": { - "type": "string", - "maxLength": 23, - "description": "Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n" - }, - "taxDetails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", - "enum": [ - "alternate", - "local", - "national", - "vat" - ] - }, - "amount": { - "type": "string", - "maxLength": 13, - "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" - }, - "rate": { - "type": "string", - "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" - }, - "code": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" - }, - "applied": { - "type": "boolean", - "description": "The tax is applied. Valid value is `true` or `false`." - }, - "exemptionCode": { - "type": "string", - "maxLength": 1, - "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" - } - } - } - }, - "fulfillmentType": { - "type": "string", - "description": "The description for this field is not available." - }, - "weight": { - "type": "string", - "maxLength": 9, - "description": "Weight of the item. See Numbered Elements." - }, - "weightIdentifier": { - "type": "string", - "maxLength": 1, - "description": "Type of weight. See Numbered Elements.\n\nPossible values:\n- B: Billed weight\n- N: Actual net weight\n" - }, - "weightUnit": { - "type": "string", - "maxLength": 2, - "description": "Code that specifies the unit of measurement for the weight amount. For example, OZ specifies ounce and LB\nspecifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC).\n\nSee Numbered Elements.\n" - }, - "referenceDataCode": { - "type": "string", - "maxLength": 2, - "description": "Code that identifies the value of the corresponding item_#_referenceData_#_number field. See Numbered Elements.\n\nPossible values:\n- AN: Client-defined asset code\n- MG: Manufacturer's part number\n- PO: Purchase order number\n- SK: Supplier stock keeping unit number\n- UP: Universal product code\n- VC: Supplier catalog number\n- VP: Vendor part number\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" - }, - "referenceDataNumber": { - "type": "string", - "maxLength": 30, - "description": "Reference number.\n\nThe meaning of this value is identified by the value of the corresponding `referenceDataCode` field.\nSee Numbered Elements.\n\nThe maximum length for this field depends on the value of the corresponding `referenceDataCode` field:\n- When the code is `PO`, the maximum length for the reference number is 22.\n- When the code is `VC`, the maximum length for the reference number is 20.\n- For all other codes, the maximum length for the reference number is 30.\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" - } - } - } - }, - "invoiceDetails": { - "type": "object", - "properties": { - "invoiceNumber": { - "type": "string", - "description": "Invoice Number." - }, - "barcodeNumber": { - "type": "string", - "description": "Barcode Number." - }, - "expirationDate": { - "type": "string", - "description": "Expiration Date." - }, - "purchaseOrderNumber": { - "type": "string", - "maxLength": 25, - "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "purchaseOrderDate": { - "type": "string", - "maxLength": 10, - "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "purchaseContactName": { - "type": "string", - "maxLength": 36, - "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxable": { - "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "vatInvoiceReferenceNumber": { - "type": "string", - "maxLength": 15, - "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "commodityCode": { - "type": "string", - "maxLength": 4, - "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "merchandiseCode": { - "type": "number", - "description": "Identifier for the merchandise. Possible value:\n\n - 1000: Gift card\n\nThis field is supported only for **American Express Direct**.\n" - }, - "transactionAdviceAddendum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "data": { - "type": "string", - "maxLength": 40, - "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n" - } - } - } - }, - "referenceDataCode": { - "type": "string", - "maxLength": 3, - "description": "Code that identifies the value of the reference_data_number field. For the possible values, see Reference Data\nCodes.\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" - }, - "referenceDataNumber": { - "type": "string", - "maxLength": 30, - "description": "Reference number. The meaning of this value is identified by the value of the referenceDataCode field.\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" - } - } - }, - "shippingDetails": { - "type": "object", - "properties": { - "giftWrap": { - "type": "boolean", - "description": "The description for this field is not available." - }, - "shippingMethod": { - "type": "string", - "maxLength": 10, - "description": "Shipping method for the product. Possible values:\n\n - `lowcost`: Lowest-cost service\n - `sameday`: Courier or same-day service\n - `oneday`: Next-day or overnight service\n - `twoday`: Two-day service\n - `threeday`: Three-day service\n - `pickup`: Store pick-up\n - `other`: Other shipping method\n - `none`: No shipping method because product is a service or subscription\n" - }, - "shipFromPostalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n" - } - } - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "merchantCustomerId": { - "type": "string", - "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "dateOfBirth": { - "type": "string", - "maxLength": 8, - "description": "Recipient\u2019s date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a pass-through, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 20, - "description": "Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "companyTaxId": { - "type": "string", - "maxLength": 9, - "description": "Company\u2019s tax identifier. This is only used for eCheck service.\n\n** TeleCheck **\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n** All Other Processors **\nNot used\n" - }, - "personalIdentification": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of the indentification.\n\nPossible values:\n - **NATIONAL**\n - **CPF**\n - **CURP**\n - **SSN**\n - **DRIVER_LICENSE**\n\nThis field is supported only on the processors listed in this description.\n\n**ComercioLatino**\\\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n**CyberSource Latin American Processing**\\\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n", - "enum": [ - "ssn", - "driverlicense" - ] - }, - "id": { - "type": "string", - "maxLength": 26, - "description": "Personal Identifier for the customer based on various type. This field is supported only on the processors\nlisted in this description.\n\n**ComercioLatino**\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n**CyberSource Latin American Processing**\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the personal_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "issuedBy": { - "type": "string", - "description": "If type = DRIVER_LICENSE, this is the State or province where the customer\u2019s driver\u2019s license was issued.\nUse the twocharacter State, Province, and Territory Codes for the United States and Canada.\n\n** TeleCheck **\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n** All Other Processors **\nNot used.\n" - } - } - } - }, - "hashedPassword": { - "type": "string", - "maxLength": 100, - "description": "The description for this field is not available.\n" - } - } - }, - "recipientInformation": { - "type": "object", - "properties": { - "accountId": { - "type": "string", - "maxLength": 10, - "description": "Identifier for the recipient\u2019s account. Use the first six digits and last four digits of the recipient\u2019s account\nnumber. This field is a pass-through, which means that CyberSource does not verify the value or modify it in\nany way before sending it to the processor. If the field is not required for the transaction, CyberSource does\nnot forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n" - }, - "lastName": { - "type": "string", - "maxLength": 6, - "description": "Recipient\u2019s last name. This field is a passthrough, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor. If the field is not required for the transaction,\nCyberSource does not forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 6, - "description": "Partial postal code for the recipient\u2019s address. For example, if the postal code is **NN5 7SG**, the value for\nthis field should be the first part of the postal code: **NN5**. This field is a pass-through, which means that\nCyberSource does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n" - } - } - }, - "deviceInformation": { - "type": "object", - "properties": { - "hostName": { - "type": "string", - "maxLength": 60, - "description": "DNS resolved hostname from above _ipAddress_." - }, - "ipAddress": { - "type": "string", - "maxLength": 15, - "description": "IP address of the customer." - }, - "userAgent": { - "type": "string", - "maxLength": 40, - "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n" - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" - }, - "alternateName": { - "type": "string", - "maxLength": 13, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "contact": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n" - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "locality": { - "type": "string", - "maxLength": 13, - "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - }, - "salesOrganizationId": { - "type": "string", - "maxLength": 11, - "description": "Company ID assigned to an independent sales organization. Get this value from Mastercard.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 106-116\n- Field: Mastercard Independent Sales Organization ID\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\nFor processor-specific information, see the sales_organization_ID field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "categoryCode": { - "type": "integer", - "maximum": 9999, - "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" - }, - "categoryCodeDomestic": { - "type": "integer", - "maximum": 9999, - "description": "Merchant category code for domestic transactions. The value for this field is a four-digit number that the payment\ncard industry uses to classify merchants into market segments. A payment card company assigned one or more of these\nvalues to your business when you started accepting the payment card company\u2019s cards. Including this field in a request\nfor a domestic transaction might reduce interchange fees.\n\nWhen you include this field in a request:\n- Do not include the merchantCategoryCode field.\n- The value for this field overrides the value in your CyberSource account.\n\nThis field is supported only for:\n- Domestic transactions with Mastercard in Spain. Domestic means that you and the cardholder are in the same country.\n- Merchants enrolled in the OmniPay Direct interchange program.\n- First Data Merchant Solutions (Europe) on OmniPay Direct.\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "cardAcceptorReferenceNumber": { - "type": "string", - "maxLength": 25, - "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "transactionLocalDateTime": { - "type": "string", - "maxLength": 14, - "description": "Local date and time at your physical location. Include both the date and time in this field or leave it blank.\nThis field is supported only for **CyberSource through VisaNet**.\n\nFor processor-specific information, see the transaction_local_date_time field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n`Format: YYYYMMDDhhmmss`, where:\n\n - YYYY = year\n - MM = month\n - DD = day\n - hh = hour\n - mm = minutes\n - ss = seconds\n\n For processor-specific information, see the _transaction_local_date_time_ field in Credit Card Services Using the SCMP API.\n" - }, - "serviceFeeDescriptor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 22, - "description": "Name of the service provider that is collecting the service fee. The service provider name must consist of\n3, 7, or 12 characters followed by an asterisk (*). This value must also include the words \u201cService Fee.\u201d\n\nWhen you include more than one consecutive space, extra spaces are removed. Use one of the following formats\nfor this value:\n- <3-character name>*Service Fee\n- <7-character name>*Service Fee\n- <12-character name>*Service Fee\n\nWhen payments are made in installments, this value must also include installment information such as\n\u201c1 of 5\u201d or \u201c3 of 7.\u201d For installment payments, use one of the following formats for this value:\n- <3-character name>*Service Fee* of \n- <7-character name>*Service Fee* of \n- <12-character name>*Service Fee* of \n\nwhere is the payment number and is the total number of payments.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource\naccount.\n\nThis value might be displayed on the cardholder\u2019s statement.\n" - }, - "contact": { - "type": "string", - "maxLength": 11, - "description": "Contact information for the service provider that is collecting the service fee. when you include more than one\nconsecutive space, extra spaces are removed.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder\u2019s statement.\n" - }, - "state": { - "type": "string", - "maxLength": 20, - "description": "State or territory in which the service provider is located.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder\u2019s statement.\n" - } - } - } - } - }, - "aggregatorInformation": { - "type": "object", - "properties": { - "aggregatorId": { - "type": "string", - "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "name": { - "type": "string", - "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "subMerchant": { - "type": "object", - "properties": { - "cardAcceptorId": { - "type": "string", - "maxLength": 15, - "description": "Unique identifier assigned by the payment card company to the sub-merchant." - }, - "name": { - "type": "string", - "maxLength": 37, - "description": "Sub-merchant\u2019s business name.\n\n**American Express Direct**\\\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\n**FDC Nashville Global**\\\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n" - }, - "address1": { - "type": "string", - "maxLength": 38, - "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "locality": { - "type": "string", - "maxLength": 21, - "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "region": { - "type": "string", - "maxLength": 3, - "description": "Sub-merchant\u2019s region.\n\n**Example**\\\n`NE` indicates that the sub-merchant is in the northeast region.\n\nSee \"Aggregator Support,\" page 110.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 15, - "description": "Partial postal code for the sub-merchant\u2019s address.\n\nSee \"Aggregator Support,\" page 100 for details.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "country": { - "type": "string", - "maxLength": 3, - "description": "Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nSee \"Aggregator Support,\" page 101.\n" - }, - "email": { - "type": "string", - "maxLength": 40, - "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 20, - "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n" - } - } - } - } - }, - "consumerAuthenticationInformation": { - "type": "object", - "properties": { - "cavv": { - "type": "string", - "maxLength": 40, - "description": "Cardholder authentication verification value (CAVV)." - }, - "cavvAlgorithm": { - "type": "string", - "maxLength": 1, - "description": "Algorithm used to generate the CAVV for Verified by Visa or the UCAF authentication data for Mastercard Identity Check.\n" - }, - "eciRaw": { - "type": "string", - "maxLength": 2, - "description": "Raw electronic commerce indicator (ECI). For the description and requirements, see \"Payer Authentication,\" page 180." - }, - "paresStatus": { - "type": "string", - "maxLength": 1, - "description": "Payer authentication response status. For the description and requirements, see \"Payer Authentication,\" page 180.\n" - }, - "veresEnrolled": { - "type": "string", - "maxLength": 1, - "description": "Verification response enrollment status. For the description and requirements, see \"Payer Authentication,\" page 180." - }, - "xid": { - "type": "string", - "maxLength": 40, - "description": "Transaction identifier. For the description and requirements, see \"Payer Authentication,\" page 180." - }, - "ucafAuthenticationData": { - "type": "string", - "maxLength": 32, - "description": "Universal cardholder authentication field (UCAF) data.\n\nFor the description and requirements, see \"Payer Authentication,\" page 180.\n" - }, - "ucafCollectionIndicator": { - "type": "string", - "maxLength": 1, - "description": "Universal cardholder authentication field (UCAF) collection indicator.\n\nFor the description and requirements, see \"Payer Authentication,\" page 180.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR7\n- Position: 5\n- Field: Mastercard Electronic Commerce Indicators\u2014-UCAF Collection Indicator\n" - } - } - }, - "pointOfSaleInformation": { - "type": "object", - "properties": { - "terminalId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the terminal at your retail location. You can define this value yourself, but consult the\nprocessor for requirements.\n\nFor Payouts: This field is applicable for CtV.\n" - }, - "terminalSerialNumber": { - "type": "string", - "maxLength": 32, - "description": "Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that\nis installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - }, - "laneNumber": { - "type": "string", - "maxLength": 8, - "description": "Identifier for an alternate terminal at your retail location. You define the value for this field.\n\nThis field is supported only for MasterCard transactions on FDC Nashville Global. Use the _terminalID_ field to\nidentify the main terminal at your retail location. If your retail location has multiple terminals, use this\n_alternateTerminalID_ field to identify the terminal used for the transaction.\n\nThis field is a pass-through, which means that CyberSource does not check the value or modify the value in any\nway before sending it to the processor.\n" - }, - "catLevel": { - "type": "integer", - "minimum": 1, - "maximum": 9, - "description": "Type of cardholder-activated terminal. Possible values:\n\n - 1: Automated dispensing machine\n - 2: Self-service terminal\n - 3: Limited amount terminal\n - 4: In-flight commerce (IFC) terminal\n - 5: Radio frequency device\n - 6: Mobile acceptance terminal\n - 7: Electronic cash register\n - 8: E-commerce device at your location\n - 9: Terminal or cash register that uses a dialup connection to connect to the transaction processing network\n * Applicable only for CTV for Payouts.\n" - }, - "entryMode": { - "type": "string", - "maxLength": 11, - "description": "Method of entering credit card information into the POS terminal. Possible values:\n\n - contact: Read from direct contact with chip card.\n - contactless: Read from a contactless interface using chip data.\n - keyed: Manually keyed into POS terminal.\n - msd: Read from a contactless interface using magnetic stripe data (MSD).\n - swiped: Read from credit card magnetic stripe.\n\nThe contact, contactless, and msd values are supported only for EMV transactions.\n* Applicable only for CTV for Payouts.\n" - }, - "terminalCapability": { - "type": "integer", - "minimum": 1, - "maximum": 5, - "description": "POS terminal\u2019s capability. Possible values:\n\n - 1: Terminal has a magnetic stripe reader only.\n - 2: Terminal has a magnetic stripe reader and manual entry capability.\n - 3: Terminal has manual entry capability only.\n - 4: Terminal can read chip cards.\n - 5: Terminal can read contactless chip cards.\n\nThe values of 4 and 5 are supported only for EMV transactions.\n* Applicable only for CTV for Payouts. \n" - }, - "pinEntryCapability": { - "type": "integer", - "minimum": 1, - "maximum": 1, - "description": "A one-digit code that identifies the capability of terminal to capture PINs. \nThis code does not necessarily mean that a PIN was entered or is included in this message. \nFor Payouts: This field is applicable for CtV.\n" - }, - "operatingEnvironment": { - "type": "string", - "maxLength": 1, - "description": "Operating environment. Possible values:\n\n - 0: No terminal used or unknown environment.\n - 1: On merchant premises, attended.\n - 2: On merchant premises, unattended, or cardholder terminal. Examples: oil, kiosks, self-checkout, home\n computer, mobile telephone, personal digital assistant (PDA). Cardholder terminal is supported only for\n MasterCard transactions on **CyberSource through VisaNet**.\n - 3: Off merchant premises, attended. Examples: portable POS devices at trade shows, at service calls, or in\n taxis.\n - 4: Off merchant premises, unattended, or cardholder terminal. Examples: vending machines, home computer,\n mobile telephone, PDA. Cardholder terminal is supported only for MasterCard transactions on **CyberSource\n through VisaNet**.\n - 5: On premises of cardholder, unattended.\n - 9: Unknown delivery mode.\n - S: Electronic delivery of product. Examples: music, software, or eTickets that are downloaded over the\n internet.\n - T: Physical delivery of product. Examples: music or software that is delivered by mail or by a courier.\n\nThis field is supported only for **American Express Direct** and **CyberSource through VisaNet**.\n\n**CyberSource through VisaNet**\\\nFor MasterCard transactions, the only valid values are 2 and 4.\n" - }, - "emv": { - "type": "object", - "properties": { - "tags": { - "type": "string", - "maxLength": 1998, - "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" - }, - "cardholderVerificationMethodUsed": { - "type": "number", - "description": "Method that was used to verify the cardholder's identity.\n\nPossible values:\n - **0**: No verification\n - **1**: Signature\n\nThis field is supported only on **American Express Direct**.\n" - }, - "cardSequenceNumber": { - "type": "string", - "maxLength": 3, - "description": "Number assigned to a specific card when two or more cards are associated with the same primary account number.\nThis value enables issuers to distinguish among multiple cards that are linked to the same account. This value\ncan also act as a tracking tool when reissuing cards. When this value is available, it is provided by the chip\nreader. When the chip reader does not provide this value, do not include this field in your request.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10.\n" - }, - "fallback": { - "type": "boolean", - "maxLength": 5, - "description": "Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.\n\nPossible values:\n - **true**\n - **false** (default)\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n", - "enum": [ - true, - false - ], - "default": false - }, - "fallbackCondition": { - "type": "number", - "description": "Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for\none of these reasons:\n\n - Technical failure: the EMV terminal or EMV card cannot read and process chip data.\n - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card.\n EMV terminals are coded to determine whether the terminal and EMV card have any applications in common.\n EMV terminals provide this information to you.\n\nPossible values:\n\n - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal either used information from a successful chip read or it was not a chip transaction.\n - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.\n\nThis field is supported only on **GPN**.\n\n**NOTE**: Merchants must include this field in a request whenever a transaction must fall back to swiped mode.\n" - } - } - }, - "amexCapnData": { - "type": "string", - "maxLength": 12, - "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n" - }, - "trackData": { - "type": "string", - "description": "Card\u2019s track 1 and 2 data. For all processors except FDMS Nashville, this value consists of\none of the following:\n\n - Track 1 data\n - Track 2 data\n - Data for both tracks 1 and 2\n\nFor FDMS Nashville, this value consists of one of the following:\n - Track 1 data\n - Data for both tracks 1 and 2\n\nExample: %B4111111111111111^SMITH/JOHN ^1612101976110000868000000?;4111111111111111=16121019761186800000?\n" - }, - "storeAndForwardIndicator": { - "type": "string", - "maxLength": 1, - "description": "When connectivity is unavailable, the client software that is installed on the POS terminal can store a\ntransaction in its memory and send it for authorization when connectivity is restored. This value is provided by\nthe client software that is installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nPossible values:\n- Y: Transaction was stored and then forwarded.\n- N (default): Transaction was not stored and then forwarded.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - }, - "cardholderVerificationMethod": { - "type": "array", - "items": { - "type": "string", - "description": "Complete list of cardholder verification methods (CVMs) supported by the terminal.\n\nPossible values:\n- PIN\n- Signature\n\n**NOTE**: You can submit one of the values or both in a request.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - }, - "example": [ - "PIN", - "Signature" - ] - }, - "terminalInputCapability": { - "type": "array", - "items": { - "description": "Complete list of card input methods supported by the terminal.\n\nPossible values:\n- Keyed: Terminal can accept card data that is entered manually.\n- Swiped: Terminal can accept card data from a magnetic stripe reader.\n- Contact: Terminal can accept card data in EMV contact mode.\n- Contactless: Terminal can accept card data in EMV contactless mode.\n- BarCode: Terminal can read bar codes.\n- QRcode: Terminal can read QR codes.\n- OCR: Terminal can perform optical character recognition (OCT).\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n", - "type": "string" - }, - "example": [ - "Keyed", - "Swiped", - "Contact", - "QRcode" - ] - }, - "terminalCardCaptureCapability": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether the terminal can capture the card.\n\nPossible values:\n- 1: Terminal can capture card.\n- 0: Terminal cannot capture card.\n\nThis field is supported only on American Express Direct.\n" - }, - "terminalOutputCapability": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether the terminal can print or display messages.\n\nPossible values:\n- 1: Neither\n- 2: Print only\n- 3: Display only\n- 4: Print and display\n\nThis field is supported only on American Express Direct.\n" - }, - "terminalPinCapability": { - "type": "integer", - "description": "Maximum PIN length that the terminal can capture.\n\nPossible values:\n- 0: No PIN capture capability\n- 1: PIN capture capability unknown\n- 4: Four characters\n- 5: Five characters\n- 6: Six characters\n- 7: Seven characters\n- 8: Eight characters\n- 9: Nine characters\n- 10: Ten characters\n- 11: Eleven characters\n- 12: Twelve characters\n\nThis field is supported only on American Express Direct and SIX.\n" - }, - "deviceId": { - "type": "string", - "maxLength": 32, - "description": "Value created by the client software that uniquely identifies the POS device. This value is provided by the\nclient software that is installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - }, - "pinBlockEncodingFormat": { - "type": "integer", - "maximum": 9, - "description": "Format that is used to encode the PIN block. This value is provided by the client software that is installed on\nthe POS terminal.\n\nPossible values:\n- 0: ISO 9564 format 0\n- 1: ISO 9564 format 1\n- 2: ISO 9564 format 2\n- 3: ISO 9564 format 3\n\nIn the Credit Card Guide for the auth service: This field is supported only on American Express Direct, FDC\nNashville Global, and SIX.\n" - }, - "encryptedPin": { - "type": "string", - "maxLength": 16, - "description": "Encrypted PIN.\n\nThis value is provided by the client software that is installed on the POS terminal.\n\nIn the Credit Card Guide for the auth service: This field is supported only on American Express Direct, FDC\nNashville Global, and SIX.\n" - }, - "encryptedKeySerialNumber": { - "type": "string", - "maxLength": 20, - "description": "This is a combination of the device's unique identifier and a transaction counter that is used in the process of\ndecrypting the encrypted PIN.\n\nFor all terminals that are using derived unique key per transaction (DUKPT) encryption, this is generated as a\nsingle number within the terminal.\n" - }, - "partnerSdkVersion": { - "type": "string", - "maxLength": 32, - "description": "Version of the software installed on the POS terminal. This value is provided by the client software that is\ninstalled on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - } - } - }, - "merchantDefinedInformation": { - "type": "array", - "description": "The description for this field is not available.", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "maxLength": 50, - "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n" - }, - "value": { - "type": "string", - "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" - } - } - } - }, - "installmentInformation": { - "type": "object", - "properties": { - "amount": { - "type": "string", - "maxLength": 12, - "description": "Amount for the current installment payment.\n\nThis field is supported only for CyberSource through VisaNet. See \"Installment Payments,\" page 127.\n" - }, - "frequency": { - "type": "string", - "maxLength": 1, - "description": "Installment Frequency of the installment payments.\n\nThis field is supported only for CyberSource through VisaNet. Possible values:\n- B: Biweekly\n- M: Monthly\n- W: Weekly\n\nSee \"Installment Payments,\" page 127.\n" - }, - "planType": { - "type": "string", - "maxLength": 1, - "description": "**American Express Direct, Cielo, and CyberSource Latin American Processing**\\\nFlag that indicates the type of funding for the installment plan associated with the payment.\n\nPossible values:\n- 1: Merchant-funded installment plan\n- 2: Issuer-funded installment plan\nIf you do not include this field in the request, CyberSource uses the value in your CyberSource account.\n\nTo change the value in your CyberSource account, contact CyberSource Customer Service. See \"Installment Payments,\" page 136.\n\n**CyberSource through VisaNet and American Express**\\\nDefined code that indicates the type of installment plan for this transaction.\n\nContact American Express for:\n- Information about the kinds of installment plans that American Express provides\n- Values for this field\n\nSee \"Installment Payments,\" page 125.\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 5-6\n- Field: Plan Type\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n\n**CyberSource through VisaNet with Visa or Mastercard**\\\nFlag indicating the type of funding for the installment plan associated with the payment.\nPossible values:\n- 1 or 01: Merchant-funded installment plan\n- 2 or 02: Issuer-funded installment plan\n- 43: Crediario installment plan\u2014only with Visa in Brazil\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 5-6\n- Field: Installment Type\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR5\n- Position: 39-40\n- Field: Installment Plan Type (Issuer or Merchant)\n" - }, - "sequence": { - "type": "integer", - "maximum": 99, - "description": "Installment number when making payments in installments. Used along with _totalCount_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\nSee \"Installment Payments,\" page 125.\n\n**Chase Paymentech Solutions and FDC Compass**\\\nThis field is optional because this value is required in the merchant descriptors. See \"Chase Paymentech\nSolutions Merchant Descriptors,\" page 142, and \"FDC Compass Merchant Descriptors,\" page 153.\n\n**CyberSource through VisaNet**\\\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" - }, - "totalAmount": { - "type": "string", - "maxLength": 12, - "description": "Total amount of the loan that is being paid in installments. This field is supported only for CyberSource\nthrough VisaNet. See \"Installment Payments,\" page 127.\n" - }, - "totalCount": { - "type": "integer", - "maximum": 99, - "description": "Total number of installments when making payments in installments. See \"Installment Payments,\" page 127.\n\n**Chase Paymentech Solutions and FDC Compass**\\\nThis field is optional because this value is required in the merchant descriptors. See \"Chase Paymentech\nSolutions Merchant Descriptors,\" page 144, and \"FDC Compass Merchant Descriptors,\" page 155.\n\n**American Express Direct, Cielo, and Comercio Latino**\\\nThis value is the total number of installments you approved.\n\n**CyberSource Latin American Processing in Brazil**\\\nThis value is the total number of installments that you approved. The default is 1.\n\n**All Other Processors**\\\nThis value is used along with _sequence_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\n**CyberSource through VisaNet**\\\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 23-25\n- Field: Number of Installments\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 7-8\n- Field: Number of Installments\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR1\n- Position: 7-8\n- Field: Number of Installments\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR5\n- Position: 20-22\n- Field: Installment Total Count\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" - }, - "firstInstallmentDate": { - "type": "string", - "maximum": 6, - "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a\nstring of six zeros (000000) to the processor. See Installment Payments on CyberSource through VisaNet.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" - }, - "invoiceData": { - "type": "string", - "maximum": 20, - "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n" - }, - "paymentType": { - "type": "string", - "maximum": 1, - "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" - }, - "eligibilityInquiry": { - "type": "string", - "maximum": 9, - "description": "Indicates whether the authorization request is a Crediario eligibility inquiry.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nSet the value for this field to `Crediario`.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n" - } - } - } - }, - "example": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "processingInformation": { - "commerceIndicator": "internet" - }, - "aggregatorInformation": { - "subMerchant": { - "cardAcceptorId": "1234567890", - "country": "US", - "phoneNumber": "650-432-0000", - "address1": "900 Metro Center", - "postalCode": "94404-2775", - "locality": "Foster City", - "name": "Visa Inc", - "administrativeArea": "CA", - "region": "PEN", - "email": "test@cybs.com" - }, - "name": "V-Internatio", - "aggregatorId": "123456789" - }, - "orderInformation": { - "billTo": { - "country": "US", - "lastName": "VDP", - "address2": "Address 2", - "address1": "201 S. Division St.", - "postalCode": "48104-2201", - "locality": "Ann Arbor", - "administrativeArea": "MI", - "firstName": "RTS", - "phoneNumber": "999999999", - "district": "MI", - "buildingNumber": "123", - "company": "Visa", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "102.21", - "currency": "USD" - } - }, - "paymentInformation": { - "card": { - "expirationYear": "2031", - "number": "5555555555554444", - "securityCode": "123", - "expirationMonth": "12", - "type": "002" - } - } - } - } - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "type": "object", - "title": "ptsV2PaymentsPost201Response", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - }, - "reversal": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - }, - "capture": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - }, - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - AUTHORIZED\n - PARTIAL_AUTHORIZED\n - AUTHORIZED_PENDING_REVIEW\n - DECLINED\n - INVALID_REQUEST\n", - "enum": [ - "AUTHORIZED", - "PARTIAL_AUTHORIZED", - "AUTHORIZED_PENDING_REVIEW", - "DECLINED", - "INVALID_REQUEST", - "PENDING" - ] - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" - }, - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - AVS_FAILED\n - CONTACT_PROCESSOR\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - INSUFFICIENT_FUND\n - STOLEN_LOST_CARD\n - ISSUER_UNAVAILABLE\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - EXCEEDS_CREDIT_LIMIT\n - INVALID_CVN\n - DECLINED_CHECK\n - BLACKLISTED_CUSTOMER\n - SUSPENDED_ACCOUNT\n - PAYMENT_REFUSED\n - CV_FAILED\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - INVALID_MERCHANT_CONFIGURATION\n", - "enum": [ - "AVS_FAILED", - "CONTACT_PROCESSOR", - "CV_FAILED", - "EXPIRED_CARD", - "PROCESSOR_DECLINED", - "INSUFFICIENT_FUND", - "STOLEN_LOST_CARD", - "ISSUER_UNAVAILABLE", - "UNAUTHORIZED_CARD", - "CVN_NOT_MATCH", - "EXCEEDS_CREDIT_LIMIT", - "INVALID_CVN", - "PAYMENT_REFUSED", - "INVALID_ACCOUNT", - "GENERAL_DECLINE" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "submitLocalDateTime": { - "type": "string", - "maxLength": 14, - "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" - }, - "ownerMerchantId": { - "type": "string", - "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "bankTransferOptions": { - "type": "object", - "properties": { - "settlementMethod": { - "type": "string", - "maxLength": 1, - "description": "Method used for settlement.\n\nPossible values:\n- **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- **F**: Facsimile draft (U.S. dollars only)\n- **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nSee \"Settlement Delivery Methods,\" page 44.\n" - }, - "fraudScreeningLevel": { - "type": "string", - "maxLength": 1, - "description": "Level of fraud screening.\n\nPossible values:\n- **1**: Validation \u2014 default if the field has not already been configured for your merchant ID\n- **2**: Verification\n\nFor a description of this feature and a list of supported processors, see \"Verification and Validation,\" page 24.\n" - } - } - } - } - }, - "processorInformation": { - "type": "object", - "properties": { - "authIndicator": { - "type": "string", - "maxLength": 1, - "description": "Flag that specifies the purpose of the authorization.\n\nPossible values:\n - **0**: Preauthorization\n - **1**: Final authorization\n\nFor processor-specific information, see the auth_indicator field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "approvalCode": { - "type": "string", - "description": "Authorization code. Returned only when the processor returns this value.\n" - }, - "transactionId": { - "type": "string", - "maxLength": 50, - "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n" - }, - "networkTransactionId": { - "type": "string", - "description": "The description for this field is not available." - }, - "providerTransactionId": { - "type": "string", - "description": "The description for this field is not available." - }, - "responseCode": { - "type": "string", - "maxLength": 10, - "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n" - }, - "responseCodeSource": { - "type": "string", - "maxLength": 1, - "description": "Used by Visa only and contains the response source/reason code that identifies the source of the response decision.\n" - }, - "responseDetails": { - "type": "string", - "maxLength": 255, - "description": "This field might contain information about a decline. This field is supported only for **CyberSource through\nVisaNet**.\n" - }, - "responseCategoryCode": { - "type": "string", - "maxLength": 32, - "description": "Processor-defined response category code. The associated detail error code is in the auth_auth_response\nfield or the auth_reversal_auth_ response field depending on which service you requested.\n\nThis field is supported only for:\n\n - Japanese issuers\n - Domestic transactions in Japan\n - Comercio Latino\u2014processor transaction ID required for troubleshooting\n\n**Maximum length for processors**:\n\n - Comercio Latino: 32\n - All other processors: 3\n" - }, - "forwardedAcquirerCode": { - "type": "string", - "maxLength": 32, - "description": "Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n" - }, - "avs": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "AVS result code.\n" - }, - "codeRaw": { - "type": "string", - "maxLength": 10, - "description": "AVS result code sent directly from the processor. Returned only when the processor returns this value.\nImportant Do not use this field to evaluate the result of AVS. Use for debugging purposes only.\n" - } - } - }, - "cardVerification": { - "type": "object", - "properties": { - "resultCode": { - "type": "string", - "maxLength": 1, - "description": "CVN result code.\n" - }, - "resultCodeRaw": { - "type": "string", - "maxLength": 10, - "description": "CVN result code sent directly from the processor. Returned only when the processor returns this value.\n\n`Important` Do not use this field to evaluate the result of card verification. Use for debugging purposes only.\n" - } - } - }, - "merchantAdvice": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 2, - "description": "Reason the recurring payment transaction was declined. For some processors, this field is used only for\nMastercard. For other processors, this field is used for Visa and Mastercard. And for other processors, this\nfield is not implemented.\n\nPossible values:\n\n - **00**: Response not provided.\n - **01**: New account information is available. Obtain the new information.\n - **02**: Try again later.\n - **03**: Do not try again. Obtain another type of payment from the customer.\n - **04**: Problem with a token or a partial shipment indicator.\n - **21**: Recurring payment cancellation service.\n - **99**: An unknown value was returned from the processor.\n" - }, - "codeRaw": { - "type": "string", - "maxLength": 2, - "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\nFor processor-specific information, see the auth_merchant_advice_code_raw field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - }, - "electronicVerificationResults": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer\u2019s name.\n" - }, - "codeRaw": { - "type": "string", - "maxLength": 1, - "description": "Raw Electronic Verification response code from the processor for the customer\u2019s last name" - }, - "email": { - "type": "string", - "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer\u2019s email address.\n" - }, - "emailRaw": { - "type": "string", - "maxLength": 1, - "description": "Raw Electronic Verification response code from the processor for the customer\u2019s email address." - }, - "phoneNumber": { - "type": "string", - "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer\u2019s phone number.\n" - }, - "phoneNumberRaw": { - "type": "string", - "maxLength": 1, - "description": "Raw Electronic Verification response code from the processor for the customer\u2019s phone number." - }, - "postalCode": { - "type": "string", - "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer\u2019s postal code.\n" - }, - "postalCodeRaw": { - "type": "string", - "maxLength": 1, - "description": "Raw Electronic Verification response code from the processor for the customer\u2019s postal code." - }, - "street": { - "type": "string", - "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer\u2019s street address.\n" - }, - "streetRaw": { - "type": "string", - "maxLength": 1, - "description": "Raw Electronic Verification response code from the processor for the customer\u2019s street address." - }, - "name": { - "type": "string", - "maxLength": 30, - "description": "The description for this field is not available.\n" - }, - "nameRaw": { - "type": "string", - "maxLength": 30, - "description": "The description for this field is not available." - } - } - }, - "achVerification": { - "type": "object", - "properties": { - "resultCode": { - "type": "string", - "maxLength": 2, - "description": "Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible\nvalues, see Appendix H, \"Verification Codes,\" on page 91.\n" - }, - "resultCodeRaw": { - "type": "string", - "maxLength": 10, - "description": "Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the\npossible values, see Appendix H, \"Verification Codes,\" on page 91.\n" - } - } - }, - "customer": { - "type": "object", - "properties": { - "personalIdResult": { - "type": "string", - "maxLength": 1, - "description": "Personal identifier result. This field is supported only for Redecard in Brazil for CyberSource Latin\nAmerican Processing. If you included _buyerInformation.personalIdentification[].ID_ in the request, this\nvalue indicates whether or not _buyerInformation.personalIdentification[].ID_ matched a value in a record\non file. Returned only when the personal ID result is returned by the processor.\n\nPossible values:\n\n - **Y**: Match\n - **N**: No match\n - **K**: Not supported\n - **U**: Unknown\n - **Z**: No response returned\n" - } - } - }, - "consumerAuthenticationResponse": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 3, - "description": "Mapped response code for Verified by Visa and American Express SafeKey:\n" - }, - "codeRaw": { - "type": "string", - "maxLength": 3, - "description": "Raw response code sent directly from the processor for Verified by Visa and American Express SafeKey:\n" - } - } - }, - "systemTraceAuditNumber": { - "type": "string", - "maxLength": 6, - "description": "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\n\n**American Express Direct**\n\nSystem trace audit number (STAN). This value identifies the transaction and is useful when investigating a\nchargeback dispute.\n\n**CyberSource through VisaNet**\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n" - }, - "paymentAccountReferenceNumber": { - "type": "string", - "maxLength": 32, - "description": "Visa-generated reference number that identifies a card-present transaction for which youprovided one of the\nfollowing:\n\n - Visa primary account number (PAN)\n - Visa-generated token for a PAN\n\nThis reference number serves as a link to the cardholder account and to all transactions for that account.\n" - }, - "transactionIntegrityCode": { - "type": "string", - "maxLength": 2, - "description": "Transaction integrity classification provided by Mastercard. This value specifies Mastercard\u2019s evaluation of\nthe transaction\u2019s safety and security. This field is returned only for **CyberSource through VisaNet**.\n\nFor card-present transactions, possible values:\n\n - **A1**: EMV or token in a secure, trusted environment\n - **B1**: EMV or chip equivalent\n - **C1**: Magnetic stripe\n - **E1**: Key entered\n - **U0**: Unclassified\n\nFor card-not-present transactions, possible values:\n\n - **A2**: Digital transactions\n - **B2**: Authenticated checkout\n - **C2**: Transaction validation\n - **D2**: Enhanced data\n - **E2**: Generic messaging\n - **U0**: Unclassified\n\nFor information about these values, contact Mastercard or your acquirer.\n" - }, - "amexVerbalAuthReferenceNumber": { - "type": "string", - "maxLength": 6, - "description": "Referral response number for a verbal authorization with FDMS Nashville when using an American Express card.\nGive this number to American Express when you call them for the verbal authorization.\n" - }, - "salesSlipNumber": { - "type": "number", - "maximum": 99999, - "description": "Transaction identifier that CyberSource generates. You have the option of printing the sales slip number on\nthe receipt.\n\nThis field is supported only for **JCN Gateway**.\n" - }, - "masterCardServiceCode": { - "type": "string", - "maxLength": 2, - "description": "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource.\n\nPossible value:\n - 53: Mastercard card-on-file token service\n" - }, - "masterCardServiceReplyCode": { - "type": "string", - "maxLength": 1, - "description": "Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **C**: Service completed successfully.\n - **F**: One of the following:\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or\n authorization reversal.\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.\n - Token requestor ID is missing or formatted incorrectly.\n - **I**: One of the following:\n - Invalid token requestor ID.\n - Suspended or deactivated token.\n - Invalid token (not in mapping table).\n - **T**: Invalid combination of token requestor ID and token.\n - **U**: Expired token.\n - **W**: Primary account number (PAN) listed in electronic warning bulletin.\n\nNote This field is returned only for **CyberSource through VisaNet**.\n" - }, - "masterCardAuthenticationType": { - "type": "string", - "maxLength": 1, - "description": "Type of authentication for which the transaction qualifies as determined by the Mastercard authentication\nservice, which confirms the identity of the cardholder. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **1**: Transaction qualifies for Mastercard authentication type 1.\n - **2**: Transaction qualifies for Mastercard authentication type 2.\n" - }, - "name": { - "type": "string", - "maxLength": 30, - "description": "Name of the Processor.\n" - }, - "routing": { - "type": "object", - "properties": { - "network": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether the transaction was routed on a credit network, a debit network, or the STAR signature debit\nnetwork.\n\nPossible values:\n- C: Credit network\n- D: Debit network (without signature)\n- S: STAR signature debit network\n\nThis field is supported only on FDC Nashville Global.\n" - }, - "networkName": { - "type": "string", - "maxLength": 10, - "description": "Name of the network on which the transaction was routed.\n\nThis field is supported only on FDC Nashville Global.\n" - }, - "customerSignatureRequired": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether you need to obtain the cardholder's signature.\n\nPossible values:\n- Y: You need to obtain the cardholder's signature.\n- N: You do not need to obtain the cardholder's signature.\n\nThis field is supported only on FDC Nashville Global.\n" - } - } - }, - "merchantNumber": { - "type": "string", - "maxLength": 15, - "description": "Identifier that was assigned to you by your acquirer.\n\nThis value must be printed on the receipt.\n\nThis field is supported only on **American Express Direct**, **FDC Nashville Global**, and **SIX**.\n" - } - } - }, - "issuerInformation": { - "type": "object", - "properties": { - "country": { - "type": "string", - "maxLength": 3, - "description": "Country in which the card was issued. This information enables you to determine whether the card was issued\ndomestically or internationally. Use the two-character ISO Standard Country Codes.\n\nThis field is supported for Visa, Mastercard, Discover, Diners Club, JCB, and Maestro (International) on Chase\nPaymentech Solutions.\n" - }, - "discretionaryData": { - "type": "string", - "maxLength": 255, - "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n" - }, - "responseCode": { - "type": "string", - "maxLength": 6, - "description": "Additional authorization code that must be printed on the receipt when returned by the processor.\n\nThis value is generated by the processor and is returned only for a successful transaction.\n\nThis field is supported only on FDC Nashville Global and SIX.\n" - } - } - }, - "paymentInformation": { - "type": "object", - "properties": { - "card": { - "type": "object", - "properties": { - "suffix": { - "type": "string", - "maxLength": 4, - "description": "Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n" - } - } - }, - "tokenizedCard": { - "type": "object", - "properties": { - "prefix": { - "type": "string", - "maxLength": 6, - "description": "First six digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n" - }, - "suffix": { - "type": "string", - "maxLength": 4, - "description": "Last four digits of token. CyberSource includes this field in the reply message when it decrypts the payment\nblob for the tokenized transaction.\n" - }, - "type": { - "type": "string", - "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n" - }, - "assuranceLevel": { - "type": "string", - "maxLength": 2, - "description": "Confidence level of the tokenization. This value is assigned by the token service provider.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the payment network token expires. `Format: YYYY`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "requestorId": { - "type": "string", - "maxLength": 11, - "description": "Value that identifies your business and indicates that the cardholder\u2019s account number is tokenized. This value\nis assigned by the token service provider and is unique within the token service provider\u2019s database.\n\n`Note` This field is supported only for **CyberSource through VisaNet** and **FDC Nashville Global**.\n" - } - } - }, - "accountFeatures": { - "type": "object", - "properties": { - "accountType": { - "type": "string", - "maxLength": 2, - "description": "Type of account. This value is returned only if you requested a balance inquiry. Possible values:\n\n - **00**: Not applicable or not specified\n - **10**: Savings account\n - **20**: Checking account\n - **30**: Credit card account\n - **40**: Universal account\n" - }, - "accountStatus": { - "type": "string", - "maxLength": 1, - "description": "Possible values:\n\n - **N**: Nonregulated\n - **R**: Regulated\n\n`Note` This field is returned only for CyberSource through VisaNet.\n" - }, - "balanceAmount": { - "type": "string", - "maxLength": 12, - "description": "Remaining balance on the account.\n" - }, - "balanceAmountType": { - "type": "string", - "maxLength": 2, - "description": "Type of amount. This value is returned only if you requested a balance inquiry. The issuer determines the value\nthat is returned. Possible values for deposit accounts:\n\n - **01**: Current ledger (posted) balance.\n - **02**: Current available balance, which is typically the ledger balance less outstanding authorizations.\n\nSome depository institutions also include pending deposits and the credit or overdraft line associated with the\naccount. Possible values for credit card accounts:\n\n - **01**: Credit amount remaining for customer (open to buy).\n - **02**: Credit limit.\n" - }, - "currency": { - "type": "string", - "maxLength": 5, - "description": "Currency of the remaining balance on the account. For the possible values, see the ISO Standard Currency Codes.\n" - }, - "balanceSign": { - "type": "string", - "maxLength": 1, - "description": "Sign for the remaining balance on the account. Returned only when the processor returns this value. Possible values:\n\nPossible values:\n - **+**\n - **-**\n", - "enum": [ - "+", - "-" - ] - }, - "affluenceIndicator": { - "type": "string", - "maxLength": 13, - "description": "**Chase Paymentech Solutions**\n\nIndicates whether a customer has high credit limits. This information enables you to market high cost items to\nthese customers and to understand the kinds of cards that high income customers are using.\n\nThis field is supported for Visa, Mastercard, Discover, and Diners Club. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n\n**Litle**\n\nFlag that indicates that a Visa cardholder or Mastercard cardholder is in one of the affluent categories.\nPossible values:\n\n - **AFFLUENT**: High income customer with high spending pattern (>100k USD annual income and >40k USD annual\n card usage).\n - **MASS AFFLUENT**: High income customer (>100k USD annual income).\n\n**Processor specific maximum length**:\n\n - Chase Paymentech Solutions: 1\n - Litle: 13\n" - }, - "category": { - "type": "string", - "maxLength": 7, - "description": "**CyberSource through VisaNet**\n\nVisa product ID.\n\n**GPN**\n\nVisa or Mastercard product ID.\n\n**Litle**\n\nType of card used in the transaction. The only possible value is:\n\n - PREPAID: Prepaid Card\n\n**RBS WorldPay Atlanta**\n\nType of card used in the transaction. Possible values:\n\n - **B**: Business Card\n - **O**: Noncommercial Card\n - **R**: Corporate Card\n - **S**: Purchase Card\n - **Blank**: Purchase card not supported\n\n**Maximum length for processors**:\n\n - CyberSource through VisaNet: 3\n - GPN: 3\n - Litle: 7\n - RBS WorldPay Atlanta: 1\n" - }, - "commercial": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether the card is a commercial card, which enables you to include Level II data in your transaction\nrequests. This field is supported for Visa and Mastercard on **Chase Paymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" - }, - "group": { - "type": "string", - "maxLength": 1, - "description": "Type of commercial card. This field is supported only for CyberSource through VisaNet. Possible values:\n\n - **B**: Business card\n - **R**: Corporate card\n - **S**: Purchasing card\n - **0**: Noncommercial card\n" - }, - "healthCare": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether the card is a healthcare card. This field is supported for Visa and Mastercard on **Chase\nPaymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" - }, - "payroll": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether the card is a payroll card. This field is supported for Visa, Discover, Diners Club, and JCB\non **Chase Paymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" - }, - "level3Eligible": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether the card is eligible for Level III interchange fees, which enables you to include Level III\ndata in your transaction requests. This field is supported for Visa and Mastercard on **Chase Paymentech\nSolutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" - }, - "pinlessDebit": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether the card is a PINless debit card. This field is supported for Visa and Mastercard on **Chase\nPaymentech Solutions**. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" - }, - "signatureDebit": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether the card is a signature debit card. This information enables you to alter the way an order is\nprocessed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might\nwant to perform reversals promptly for a signature debit card. This field is supported for Visa, Mastercard, and\nMaestro (International) on Chase Paymentech Solutions. Possible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" - }, - "prepaid": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or\nprepaid card is presented for use when establishing a new recurring, installment, or deferred billing\nrelationship.\n\nThis field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions.\nPossible values:\n\n - **Y**: Yes\n - **N**: No\n - **X**: Not applicable / Unknown\n" - }, - "regulated": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card\nissuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover,\nDiners Club, and JCB on Chase Paymentech Solutions. Possible values:\n\n - **Y**: Yes (assets greater than 10B USD)\n - **N**: No (assets less than 10B USD)\n - **X**: Not applicable / Unknown\n" - } - } - }, - "bank": { - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "correctedAccountNumber": { - "type": "string", - "maxLength": 17, - "description": "Corrected account number from the ACH verification service, which is described in \"ACH Verification,\" page 25.\n" - } - } - }, - "correctedRoutingNumber": { - "type": "string", - "maxLength": 9, - "description": "The description for this field is not available." - } - } - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "amountDetails": { - "type": "object", - "properties": { - "totalAmount": { - "type": "string", - "maxLength": 15, - "description": "Amount you requested for the payment or capture.\n\nThis value is returned for partial authorizations.\n" - }, - "authorizedAmount": { - "type": "string", - "maxLength": 15, - "description": "Amount that was authorized.\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - } - } - }, - "invoiceDetails": { - "type": "object", - "properties": { - "level3TransmissionStatus": { - "type": "boolean", - "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n", - "enum": [ - true, - false - ] - } - } - } - } - }, - "pointOfSaleInformation": { - "type": "object", - "properties": { - "emv": { - "type": "object", - "properties": { - "tags": { - "type": "string", - "maxLength": 1998, - "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" - } - } - }, - "amexCapnData": { - "type": "string", - "maxLength": 12, - "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n" - } - } - }, - "installmentInformation": { - "type": "object", - "properties": { - "additionalCosts": { - "type": "string", - "maxLength": 12, - "description": "Additional costs charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 128-139\n- Field: Total Other Costs\n" - }, - "additionalCostsPercentage": { - "type": "string", - "maxLength": 4, - "description": "Additional costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 140-143\n- Field: Percent of Total Other Costs\n" - }, - "amountFunded": { - "type": "string", - "maxLength": 12, - "description": "Amount funded.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 48-59\n- Field: Total Amount Funded\n" - }, - "amountRequestedPercentage": { - "type": "string", - "maxLength": 4, - "description": "Amount requested divided by the amount funded.\n\nFor example:\n- A value of 90.0 specifies 90%.\n- A value of 93.7 specifies 93.7%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 60-63\n- Field: Percent of Amount Requested\n" - }, - "annualFinancingCost": { - "type": "string", - "maxLength": 7, - "description": "Annual cost of financing the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 158-164\n- Field: Annual Total Cost of Financing\n" - }, - "annualInterestRate": { - "type": "string", - "maximum": 7, - "description": "Annual interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 151-157\n- Field: Annual Interest Rate\n" - }, - "expenses": { - "type": "string", - "maxLength": 12, - "description": "Expenses charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 64-75\n- Field: Total Expenses\n" - }, - "expensesPercentage": { - "type": "string", - "maxLength": 4, - "description": "Expenses divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 76-79\n- Field: Percent of Total Expenses\n" - }, - "fees": { - "type": "string", - "maxLength": 12, - "description": "Fees charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 80-91\n- Field: Total Fees\n" - }, - "feesPercentage": { - "type": "string", - "maxLength": 4, - "description": "Fees divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 92-95\n- Field: Percent of Total Fees\n" - }, - "insurance": { - "type": "string", - "maxLength": 12, - "description": "Insurance charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 112-123\n- Field: Total Insurance\n" - }, - "insurancePercentage": { - "type": "string", - "maxLength": 4, - "description": "Insurance costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 124-127\n- Field: Percent Of Total Insurance\n" - }, - "monthlyInterestRate": { - "type": "string", - "maximum": 7, - "description": "Monthly interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 144-150\n- Field: Monthly Interest Rate\n" - }, - "taxes": { - "type": "string", - "maxLength": 12, - "description": "Taxes collected by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 96-107\n- Field: Total Taxes\n" - }, - "taxesPercentage": { - "type": "string", - "maxLength": 4, - "description": "Taxes divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 108-111\n- Field: Percent of Total Taxes\n" - } - } - } - }, - "example": { - "_links": { - "self": { - "href": "/pts/v2/payments/4963015972176007901546", - "method": "GET" - }, - "authReversal": { - "href": "/pts/v2/payments/4963015972176007901546/reversals", - "method": "POST" - }, - "capture": { - "href": "/pts/v2/payments/4963015972176007901546/captures", - "method": "POST" - }, - "refund": { - "href": "/pts/v2/payments/4963015972176007901546/refunds", - "method": "POST" - }, - "void": { - "href": "/pts/v2/payments/4963015972176007901546/voids", - "method": "POST" - } - }, - "id": "4963015972176007901546", - "submitTimeUtc": "2017-06-01T071957Z", - "status": "200", - "reconciliationId": "39570726X3E1LBQR", - "statusInformation": { - "reason": "SUCCESS", - "message": "Successful transaction." - }, - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "orderInformation": { - "amountDetails": { - "authorizedAmount": "102.21", - "currency": "USD" - } - }, - "processorInformation": { - "approvalCode": "888888", - "cardVerification": { - "resultCode": "" - }, - "avs": { - "code": "X", - "codeRaw": "I1" - }, - "responseCode": "100" - } - } - } - }, - "400": { - "description": "Invalid request.", - "schema": { - "type": "object", - "title": "ptsV2PaymentsPost400Response", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", - "enum": [ - "INVALID_REQUEST" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - CARD_TYPE_NOT_ACCEPTED\n - INVALID_MERCHANT_CONFIGURATION\n - PROCESSOR_UNAVAILABLE\n - INVALID_AMOUNT\n - INVALID_CARD_TYPE\n - INVALID_PAYMENT_ID\n - DEBIT_CARD_USEAGE_EXCEEDD_LIMIT\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA", - "DUPLICATE_REQUEST", - "INVALID_CARD", - "CARD_TYPE_NOT_ACCEPTED", - "INVALID_MERCHANT_CONFIGURATION", - "PROCESSOR_UNAVAILABLE", - "INVALID_AMOUNT", - "INVALID_CARD_TYPE", - "DEBIT_CARD_USEAGE_EXCEEDD_LIMIT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - } - }, - "502": { - "description": "Unexpected system error or system timeout.", - "schema": { - "type": "object", - "title": "ptsV2PaymentsPost502Response", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", - "enum": [ - "SERVER_ERROR" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", - "enum": [ - "SYSTEM_ERROR", - "SERVER_TIMEOUT", - "SERVICE_TIMEOUT", - "PROCESSOR_TIMEOUT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - } - } - } - } - }, - "x-example": { - "example0": { - "summary": "Simple Authorization(Internet)", - "value": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "processingInformation": { - "commerceIndicator": "internet" - }, - "orderInformation": { - "billTo": { - "firstName": "John", - "lastName": "Doe", - "address2": "Address 2", - "address1": "1 Market St", - "postalCode": "94105", - "locality": "san francisco", - "administrativeArea": "CA", - "country": "US", - "phoneNumber": "4158880000", - "company": "Visa", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "102.21", - "currency": "USD" - } - }, - "paymentInformation": { - "card": { - "expirationYear": "2031", - "number": "4111111111111111", - "securityCode": "123", - "expirationMonth": "12" - } - } - } - }, - "example1": { - "summary": "Simple Authorization(Retail)", - "value": { - "clientReferenceInformation": { - "code": "TC50171_8" - }, - "pointOfSaleInformation": { - "terminalId": "001", - "cardPresent": "Y", - "entryMode": "keyed", - "terminalCapability": "2" - }, - "processingInformation": { - "commerceIndicator": "retail" - }, - "orderInformation": { - "billTo": { - "firstName": "John", - "lastName": "Doe", - "address2": "Address 2", - "address1": "1 Market St", - "postalCode": "94105", - "locality": "san francisco", - "administrativeArea": "CA", - "country": "US", - "phoneNumber": "4158880000", - "company": "Visa", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "108.00", - "currency": "USD" - } - }, - "paymentInformation": { - "card": { - "expirationYear": "2031", - "number": "5555555555554444", - "securityCode": "123", - "expirationMonth": "12", - "type": "002" - } - } - } - }, - "example2": { - "summary": "Payment with Payment Instrument Token", - "value": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "processingInformation": { - "commerceIndicator": "internet" - }, - "orderInformation": { - "billTo": { - "firstName": "John", - "lastName": "Doe", - "address1": "1 Market St", - "postalCode": "94105", - "locality": "san francisco", - "administrativeArea": "CA", - "country": "US", - "phoneNumber": "4158880000", - "company": "Visa", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "22", - "currency": "USD" - } - }, - "paymentInformation": { - "customer": { - "customerId": "7500BB199B4270EFE05340588D0AFCAD" - } - } - } - }, - "example3": { - "summary": "Payment Network Tokenization", - "value": { - "clientReferenceInformation": { - "code": "TC_123122" - }, - "processingInformation": { - "commerceIndicator": "internet" - }, - "orderInformation": { - "billTo": { - "firstName": "John", - "lastName": "Doe", - "address1": "1 Market St", - "postalCode": "94105", - "locality": "san francisco", - "administrativeArea": "CA", - "country": "US", - "phoneNumber": "4158880000", - "company": "Visa", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "100", - "currency": "USD" - } - }, - "paymentInformation": { - "tokenizedCard": { - "expirationYear": "2031", - "number": "4111111111111111", - "expirationMonth": "12", - "transactionType": "1" - } - }, - "consumerAuthenticationInformation": { - "cavv": "AAABCSIIAAAAAAACcwgAEMCoNh+=", - "xid": "T1Y0OVcxMVJJdkI0WFlBcXptUzE=" - } - } - }, - "example4": { - "summary": "Digital Payment - GooglePay", - "value": { - "clientReferenceInformation": { - "code": "TC_1231223" - }, - "processingInformation": { - "paymentSolution": "012", - "commerceIndicator": "internet" - }, - "orderInformation": { - "billTo": { - "country": "US", - "firstName": "John", - "lastName": "Deo", - "phoneNumber": "6504327113", - "address1": "901 Metro Center Blvd", - "postalCode": "94404", - "locality": "Foster City", - "company": "Visa", - "administrativeArea": "CA", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "20", - "currency": "USD" - } - }, - "paymentInformation": { - "tokenizedCard": { - "expirationYear": "2020", - "number": "4111111111111111", - "expirationMonth": "12", - "transactionType": "1", - "cryptogram": "EHuWW9PiBkWvqE5juRwDzAUFBAk=" - } - } - } - }, - "example5": { - "summary": "Digital Payments - ApplePay", - "value": { - "clientReferenceInformation": { - "code": "TC_1231223" - }, - "processingInformation": { - "paymentSolution": "001", - "commerceIndicator": "internet" - }, - "orderInformation": { - "billTo": { - "country": "US", - "firstName": "John", - "lastName": "Deo", - "phoneNumber": "6504327113", - "address2": "Desk M3-5573", - "address1": "901 Metro Center Blvd", - "postalCode": "94404", - "locality": "Foster City", - "company": "Visa", - "administrativeArea": "CA", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "10", - "currency": "USD" - } - }, - "paymentInformation": { - "tokenizedCard": { - "expirationYear": "2031", - "number": "4111111111111111", - "expirationMonth": "12", - "transactionType": "1", - "cryptogram": "AceY+igABPs3jdwNaDg3MAACAAA=" - } - } - } - }, - "example6": { - "summary": "CyberSource MPOS - EMV", - "value": { - "clientReferenceInformation": { - "code": "TC50171_16" - }, - "pointOfSaleInformation": { - "cardPresent": "Y", - "catLevel": "1", - "endlessAisleTransactionIndicator": "true", - "entryMode": "contact", - "terminalCapability": "1", - "emv": { - "fallbackCondition": "1", - "fallback": "Y" - } - }, - "processingInformation": { - "commerceIndicator": "retail", - "paymentSolution": "011" - }, - "orderInformation": { - "billTo": { - "firstName": "John", - "lastName": "Doe", - "address2": "Address 2", - "address1": "1 Market St", - "postalCode": "94105", - "locality": "san francisco", - "administrativeArea": "CA", - "country": "US", - "phoneNumber": "4158880000", - "company": "Visa", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "15.0", - "currency": "USD" - } - }, - "paymentInformation": { - "fluidData": { - "descriptor": "EMV.PAYMENT.AnywhereCommerce.Walker", - "value": "ewogICJkYXRhIiA6ICJOZmNwRURiK1dLdzBnQkpsaTRcL1hlWm1ITzdUSng0bnRoMnc2Mk9ITVJQK3hCRlFPdFE0WWpRcnY0RmFkOHh6VExqT2VFQm5iNHFzeGZMYTNyNXcxVEdXblFGQnNzMWtPYnA0XC95alNtVE1JSGVjbGc5OFROaEhNb0VRcjJkRkFqYVpBTFAxSlBsdVhKSVwvbTZKSmVwNGh3VHRWZE16Z2laSUhnaWFCYzNXZVd1ZnYzc1l0cGRaZDZYZENEUFdLeXFkYjBJdUtkdkpBPT0iLAogICJzaWduYXR1cmUiIDogIkFxck1pKzc0cm1GeVBKVE9HN3NuN2p5K1YxTlpBZUNJVE56TW01N1B5cmc9IiwKICAic2lnbmF0dXJlQWxnSW5mbyIgOiAiSE1BQ3dpdGhTSEEyNTYiLAogICJoZWFkZXIiIDogewogICAgInRyYW5zYWN0aW9uSWQiIDogIjE1MTU2MjI2NjIuMTcyMjIwIiwKICAgICJwdWJsaWNLZXlIYXNoIiA6ICJcLzdmdldqRVhMazJPRWpcL3Z5bk1jeEZvMmRWSTlpRXVoT2Nab0tHQnpGTmM9IiwKICAgICJhcHBsaWNhdGlvbkRhdGEiIDogIkN5YmVyU291cmNlLlZNcG9zS2l0IiwKICAgICJlcGhlbWVyYWxQdWJsaWNLZXkiIDogIk1Ga3dFd1lIS29aSXpqMENBUVlJS29aSXpqMERBUWNEUWdBRW1JN0tScnRNN2NNelk5Zmw2UWt2NEQzdE9jU0NYR1hoOFwvK2R4K2s5c1Zrbk05UFQrOXRqMzk2YWF6QjRcL0hYaWlLRW9DXC9jUzdoSzF6UFk3MVwvN0pUUT09IgogIH0sCiAgInZlcnNpb24iIDogIjEuMCIKfQ==" - } - } - } - }, - "example7": { - "summary": "Zero Dollar Authorization", - "value": { - "clientReferenceInformation": { - "code": "1234567890" - }, - "processingInformation": { - "commerceIndicator": "internet" - }, - "orderInformation": { - "billTo": { - "firstName": "John", - "lastName": "Doe", - "address1": "1 Market St", - "postalCode": "94105", - "locality": "san francisco", - "administrativeArea": "CA", - "country": "US", - "phoneNumber": "4158880000", - "company": "Visa", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": 0, - "currency": "USD" - } - }, - "paymentInformation": { - "card": { - "expirationYear": "2031", - "number": "5555555555554444", - "securityCode": "123", - "expirationMonth": "12" - } - } - } - }, - "example8": { - "summary": "Level II Data", - "value": { - "clientReferenceInformation": { - "code": "TC50171_12" - }, - "processingInformation": { - "commerceIndicator": "internet" - }, - "orderInformation": { - "billTo": { - "firstName": "John", - "lastName": "Doe", - "address1": "1 Market St", - "postalCode": "94105", - "locality": "san francisco", - "administrativeArea": "CA", - "country": "US", - "phoneNumber": "4158880000", - "company": "Visa", - "email": "test@cybs.com" - }, - "invoiceDetails": { - "purchaseOrderNumber": "LevelII Auth Po" - }, - "amountDetails": { - "totalAmount": "112.00", - "currency": "USD" - } - }, - "paymentInformation": { - "card": { - "expirationYear": "2031", - "number": "4111111111111111", - "securityCode": "123", - "expirationMonth": "12", - "type": "001" - } - } - } - }, - "example9": { - "summary": "Level III Data", - "value": { - "clientReferenceInformation": { - "code": "TC50171_14" - }, - "processingInformation": { - "commerceIndicator": "internet", - "purchaseLevel": "3" - }, - "orderInformation": { - "billTo": { - "firstName": "John", - "lastName": "Doe", - "address1": "1 Market St", - "postalCode": "94105", - "locality": "san francisco", - "administrativeArea": "CA", - "country": "US", - "phoneNumber": "4158880000", - "company": "Visa", - "email": "test@cybs.com" - }, - "invoiceDetails": { - "purchaseOrderNumber": "LevelIII Auth Po" - }, - "lineItems": [{ - "discountApplied": "false", - "quantity": "10", - "unitPrice": "10.00", - "totalAmount": "100", - "productCode": "default", - "amountIncludesTax": "false" - } - ], - "amountDetails": { - "totalAmount": "100.00", - "currency": "USD" - } - }, - "paymentInformation": { - "card": { - "expirationYear": "2031", - "number": "4111111111111111", - "securityCode": "123", - "expirationMonth": "12", - "type": "001" - } - } - } - }, - "example10": { - "summary": "Partial Authorization", - "value": { - "clientReferenceInformation": { - "code": "1234567890" - }, - "pointOfSaleInformation": { - "cardPresent": "true", - "catLevel": "6", - "emv": { - "fallbackCondition": "swiped", - "fallback": "N" - }, - "terminalCapability": "4" - }, - "orderInformation": { - "billTo": { - "firstName": "John", - "lastName": "Doe", - "address1": "1 Market St", - "postalCode": "94105", - "locality": "san francisco", - "administrativeArea": "CA", - "country": "US", - "phoneNumber": "4158880000", - "company": "Visa", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "7012.00", - "currency": "USD" - } - }, - "paymentInformation": { - "card": { - "expirationYear": "2031", - "number": "4111111111111111", - "securityCode": "123", - "expirationMonth": "12" - } - } - } - }, - "example11": { - "summary": "Electronic Check Debits", - "value": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "processingInformation": { - "commerceIndicator": "internet" - }, - "orderInformation": { - "billTo": { - "firstName": "John", - "lastName": "Doe", - "address1": "1 Market St", - "postalCode": "94105", - "locality": "san francisco", - "administrativeArea": "CA", - "country": "US", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "100", - "currency": "USD" - } - }, - "paymentInformation": { - "bank": { - "account": { - "number": "4100", - "type": "C" - }, - "routingNumber": "071923284" - } - } - } - }, - "example12": { - "summary": "Service Fees with Credit Card transaction", - "value": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "processingInformation": { - "commerceIndicator": "internet" - }, - "orderInformation": { - "billTo": { - "firstName": "John", - "lastName": "Doe", - "address1": "1 Market St", - "postalCode": "94105", - "locality": "san francisco", - "administrativeArea": "CA", - "country": "US", - "phoneNumber": "4158880000", - "company": "Visa", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "2325.00", - "currency": "USD", - "serviceFeeAmount": "30.0" - } - }, - "paymentInformation": { - "card": { - "expirationYear": "2031", - "number": "4111111111111111", - "securityCode": "123", - "expirationMonth": "12" - } - }, - "merchantInformation": { - "serviceFeeDescriptor": { - "name": "CyberVacations Service Fee", - "contact": "800-999-9999", - "state": "CA" - } - } - } - } - } - } - }, - "/pts/v2/payments/{id}/reversals": { - "post": { - "summary": "Process an Authorization Reversal", - "description": "Include the payment ID in the POST request to reverse the payment amount.", - "tags": [ - "reversal" - ], - "operationId": "authReversal", - "x-devcenter-metaData": { - "categoryTag": "Payments" - }, - "parameters": [{ - "name": "id", - "in": "path", - "description": "The payment ID returned from a previous payment request.", - "required": true, - "type": "string" - }, { - "name": "authReversalRequest", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "comments": { - "type": "string", - "description": "Comments" - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" - }, - "solutionId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" - } - } - } - } - }, - "reversalInformation": { - "type": "object", - "properties": { - "amountDetails": { - "type": "object", - "properties": { - "totalAmount": { - "type": "string", - "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - } - } - }, - "reason": { - "type": "string", - "description": "Reason for the authorization reversal. Possible value:\n\n - 34: Suspected fraud\n\nCyberSource ignores this field for processors that do not support this value.\n" - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "paymentSolution": { - "type": "string", - "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" - }, - "linkId": { - "type": "string", - "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n" - }, - "reportGroup": { - "type": "string", - "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n" - }, - "visaCheckoutId": { - "type": "string", - "maxLength": 48, - "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n" - }, - "issuer": { - "type": "object", - "properties": { - "discretionaryData": { - "type": "string", - "maxLength": 255, - "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n" - } - } - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "amountDetails": { - "type": "object", - "properties": { - "serviceFeeAmount": { - "type": "string", - "maxLength": 15, - "description": "Service fee. Required for service fee transactions.\n" - } - } - }, - "lineItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "quantity": { - "type": "number", - "minimum": 1, - "maximum": 9999999999, - "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n", - "default": 1 - }, - "unitPrice": { - "type": "string", - "maxLength": 15, - "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" - } - } - } - } - } - }, - "pointOfSaleInformation": { - "type": "object", - "properties": { - "emv": { - "type": "object", - "properties": { - "tags": { - "type": "string", - "maxLength": 1998, - "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" - } - } - } - } - } - }, - "example": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "reversalInformation": { - "reason": "testing", - "amountDetails": { - "totalAmount": "102.21" - } - } - } - } - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "type": "object", - "title": "ptsV2PaymentsReversalsPost201Response", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - }, - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - REVERSED\n", - "enum": [ - "REVERSED" - ] - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "submitLocalDateTime": { - "type": "string", - "maxLength": 14, - "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" - }, - "ownerMerchantId": { - "type": "string", - "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" - } - } - }, - "reversalAmountDetails": { - "type": "object", - "properties": { - "reversedAmount": { - "type": "string", - "maxLength": 15, - "description": "Total reversed amount." - }, - "originalTransactionAmount": { - "type": "string", - "maxLength": 15, - "description": "Amount of the original transaction." - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - } - } - }, - "processorInformation": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "maxLength": 18, - "description": "Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n" - }, - "responseCode": { - "type": "string", - "maxLength": 10, - "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n" - }, - "responseCategoryCode": { - "type": "string", - "maxLength": 32, - "description": "Processor-defined response category code. The associated detail error code is in the auth_auth_response\nfield or the auth_reversal_auth_ response field depending on which service you requested.\n\nThis field is supported only for:\n\n - Japanese issuers\n - Domestic transactions in Japan\n - Comercio Latino\u2014processor transaction ID required for troubleshooting\n\n**Maximum length for processors**:\n\n - Comercio Latino: 32\n - All other processors: 3\n" - }, - "forwardedAcquirerCode": { - "type": "string", - "maxLength": 32, - "description": "Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n" - }, - "masterCardServiceCode": { - "type": "string", - "maxLength": 2, - "description": "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource.\n\nPossible value:\n - 53: Mastercard card-on-file token service\n" - }, - "masterCardServiceReplyCode": { - "type": "string", - "maxLength": 1, - "description": "Result of the Mastercard card-on-file token service. Mastercard provides this value to CyberSource.\n\nPossible values:\n\n - **C**: Service completed successfully.\n - **F**: One of the following:\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 81 for an authorization or\n authorization reversal.\n - Incorrect Mastercard POS entry mode. The Mastercard POS entry mode should be 01 for a tokenized request.\n - Token requestor ID is missing or formatted incorrectly.\n - **I**: One of the following:\n - Invalid token requestor ID.\n - Suspended or deactivated token.\n - Invalid token (not in mapping table).\n - **T**: Invalid combination of token requestor ID and token.\n - **U**: Expired token.\n - **W**: Primary account number (PAN) listed in electronic warning bulletin.\n\nNote This field is returned only for **CyberSource through VisaNet**.\n" - } - } - }, - "issuerInformation": { - "type": "object", - "properties": { - "responseCode": { - "type": "string", - "maxLength": 6, - "description": "Additional authorization code that must be printed on the receipt when returned by the processor.\n\nThis value is generated by the processor and is returned only for a successful transaction.\n\nThis field is supported only on FDC Nashville Global and SIX.\n" - } - } - }, - "authorizationInformation": { - "type": "object", - "properties": { - "approvalCode": { - "type": "string", - "maxLength": 6, - "description": "The authorization code returned by the processor." - }, - "reasonCode": { - "type": "string", - "maxLength": 50, - "description": "Reply flag for the original transaction." - }, - "reversalSubmitted": { - "type": "string", - "maxLength": 1, - "description": "Flag indicating whether a full authorization reversal was successfully submitted.\n\nPossible values:\n- Y: The authorization reversal was successfully submitted.\n- N: The authorization reversal was not successfully submitted. You must send a credit request for a refund.\n\nThis field is supported only for **FDC Nashville Global**.\n" - } - } - }, - "pointOfSaleInformation": { - "type": "object", - "properties": { - "emv": { - "type": "object", - "properties": { - "tags": { - "type": "string", - "maxLength": 1998, - "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" - } - } - } - } - } - }, - "example": { - "_links": { - "self": { - "href": "/pts/v2/reversals/4963015523026180001545", - "method": "GET" - } - }, - "id": "4963015523026180001545", - "submitTimeUtc": "2017-06-01T071912Z", - "status": "200", - "statusInformation": { - "reason": "SUCCESS", - "message": "Successful transaction." - }, - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "orderInformation": { - "amountDetails": { - "currency": "USD" - } - }, - "processorInformation": { - "responseCode": "100" - }, - "reversalAmountDetails": { - "reversedAmount": "102.21", - "currency": "USD" - } - } - } - }, - "400": { - "description": "Invalid request.", - "schema": { - "type": "object", - "title": "ptsV2PaymentsReversalsPost400Response", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", - "enum": [ - "INVALID_REQUEST" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - PROCESSOR_UNAVAILABLE\n - AUTH_ALREADY_REVERSED\n - TRANSACTION_ALREADY_SETTLED\n - INVALID_AMOUNT\n - MISSING_AUTH\n - TRANSACTION_ALREADY_REVERSED_OR_SETTLED\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA", - "DUPLICATE_REQUEST", - "INVALID_MERCHANT_CONFIGURATION", - "AUTH_ALREADY_REVERSED", - "MISSING_AUTH", - "TRANSACTION_ALREADY_REVERSED_OR_SETTLED" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - } - }, - "502": { - "description": "Unexpected system error or system timeout.", - "schema": { - "type": "object", - "title": "ptsV2PaymentsReversalsPost502Response", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", - "enum": [ - "SERVER_ERROR" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", - "enum": [ - "SYSTEM_ERROR", - "SERVER_TIMEOUT", - "SERVICE_TIMEOUT", - "PROCESSOR_TIMEOUT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - } - } - } - } - }, - "x-example": { - "example0": { - "summary": "Process an Authorization Reversal", - "value": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "reversalInformation": { - "reason": "testing", - "amountDetails": { - "totalAmount": "102.21" - } - } - } - }, - "example1": { - "summary": "Service Fees Authorization Reversal", - "value": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "reversalInformation": { - "reason": "34", - "amountDetails": { - "totalAmount": "2325.00", - "serviceFeeAmount": "30.0" - } - } - } - } - } - } - }, - "/pts/v2/payments/{id}/captures": { - "post": { - "summary": "Capture a Payment", - "description": "Include the payment ID in the POST request to capture the payment amount.", - "tags": [ - "capture" - ], - "operationId": "capturePayment", - "x-devcenter-metaData": { - "categoryTag": "Payments" - }, - "parameters": [{ - "name": "capturePaymentRequest", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "transactionId": { - "type": "string", - "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations\n.\nSee \"Merchant-Initiated Reversals and Voids,\" page 176.\n" - }, - "comments": { - "type": "string", - "description": "Comments" - }, - "partner": { - "type": "object", - "properties": { - "originalTransactionId": { - "type": "string", - "maxLength": 32, - "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - }, - "developerId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" - }, - "solutionId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" - } - } - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "paymentSolution": { - "type": "string", - "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" - }, - "linkId": { - "type": "string", - "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n" - }, - "reportGroup": { - "type": "string", - "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n" - }, - "visaCheckoutId": { - "type": "string", - "maxLength": 48, - "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n" - }, - "purchaseLevel": { - "type": "string", - "maxLength": 1, - "description": "Set this field to 3 to indicate that the request includes Level III data." - }, - "issuer": { - "type": "object", - "properties": { - "discretionaryData": { - "type": "string", - "maxLength": 255, - "description": "Data defined by the issuer.\n\nThe value for this reply field will probably be the same as the value that you submitted in the authorization request, but it is possible for the processor, issuer, or acquirer to modify the value.\n\nThis field is supported only for Visa transactions on **CyberSource through VisaNet**.\n\nFor more information, see Appendix K, \"Formats for Discretionary Data,\" on page 359.\n" - } - } - }, - "authorizationOptions": { - "type": "object", - "properties": { - "authType": { - "type": "string", - "maxLength": 15, - "description": "Authorization type.\n\nPossible values:\n\n - **AUTOCAPTURE**: automatic capture.\n - **STANDARDCAPTURE**: standard capture.\n - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n**Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing**\\\nSet this field to _AUTOCAPTURE_ and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to STANDARDCAPTURE and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see \"Automatic Captures,\" page 33.\n\n**Forced Capture**\\\nSet this field to _VERBAL_ and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. For more information, see \"Forced Captures,\" page 123.\n\n**Verbal Authorization**\\\nSet this field to _VERBAL_ and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations,\" page 84.\n\nFor processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "verbalAuthCode": { - "type": "string", - "maxLength": 7, - "description": "Authorization code.\n\n**Forced Capture**\\\nUse this field to send the authorization code you received from a payment that you authorized\noutside the CyberSource system.\n\n**Verbal Authorization**\\\nUse this field in CAPTURE API to send the verbally received authorization code.\n\nFor processor-specific information, see the _auth_code_ field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "verbalAuthTransactionId": { - "type": "string", - "maxLength": 15, - "description": "Transaction ID (TID)." - } - } - }, - "captureOptions": { - "type": "object", - "properties": { - "captureSequenceNumber": { - "type": "number", - "minimum": 1, - "maximum": 99, - "description": "Capture number when requesting multiple partial captures for one payment.\nUsed along with _totalCaptureCount_ to track which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n" - }, - "totalCaptureCount": { - "type": "number", - "minimum": 1, - "maximum": 99, - "description": "Total number of captures when requesting multiple partial captures for one payment.\nUsed along with _captureSequenceNumber_ which capture is being processed.\n\nFor example, the second of five captures would be passed to CyberSource as:\n - _captureSequenceNumber_ = 2, and\n - _totalCaptureCount_ = 5\n" - } - } - } - } - }, - "paymentInformation": { - "type": "object", - "properties": { - "customer": { - "type": "object", - "properties": { - "customerId": { - "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" - } - } - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "amountDetails": { - "type": "object", - "properties": { - "totalAmount": { - "type": "string", - "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - }, - "discountAmount": { - "type": "string", - "maxLength": 15, - "description": "Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "dutyAmount": { - "type": "string", - "maxLength": 15, - "description": "Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAmount": { - "type": "string", - "maxLength": 12, - "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "nationalTaxIncluded": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAppliedAfterDiscount": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAppliedLevel": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxTypeCode": { - "type": "string", - "maxLength": 3, - "description": "For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "freightAmount": { - "type": "string", - "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "foreignAmount": { - "type": "string", - "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "foreignCurrency": { - "type": "string", - "maxLength": 5, - "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "exchangeRate": { - "type": "string", - "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "exchangeRateTimeStamp": { - "type": "string", - "maxLength": 14, - "description": "Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "amexAdditionalAmounts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "amount": { - "type": "string", - "maxLength": 12, - "description": "Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - } - }, - "taxDetails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", - "enum": [ - "alternate", - "local", - "national", - "vat" - ] - }, - "amount": { - "type": "string", - "maxLength": 13, - "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" - }, - "rate": { - "type": "string", - "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" - }, - "code": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" - }, - "applied": { - "type": "boolean", - "description": "The tax is applied. Valid value is `true` or `false`." - }, - "exemptionCode": { - "type": "string", - "maxLength": 1, - "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" - } - } - } - }, - "serviceFeeAmount": { - "type": "string", - "maxLength": 15, - "description": "Service fee. Required for service fee transactions.\n" - }, - "originalCurrency": { - "type": "string", - "maxLength": 15, - "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n" - } - } - }, - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "company": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 60, - "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "address1": { - "type": "string", - "maxLength": 40, - "description": "First line in the street address of the company purchasing the product." - }, - "address2": { - "type": "string", - "maxLength": 40, - "description": "Additional address information for the company purchasing the product." - }, - "locality": { - "type": "string", - "maxLength": 30, - "description": "City in the address of the company purchasing the product." - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n" - } - } - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "address2": { - "type": "string", - "maxLength": 60, - "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "locality": { - "type": "string", - "maxLength": 50, - "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "email": { - "type": "string", - "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" - } - } - }, - "shipTo": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the shipping address. Use the two character ISO Standard Country Codes." - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" - } - } - }, - "lineItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "productCode": { - "type": "string", - "maxLength": 255, - "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\n" - }, - "productName": { - "type": "string", - "maxLength": 255, - "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false` respectively), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other\nvalues that are related to shipping and/or handling.\n" - }, - "productSku": { - "type": "string", - "maxLength": 255, - "description": "Identification code for the product.\n\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n" - }, - "quantity": { - "type": "number", - "minimum": 1, - "maximum": 9999999999, - "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n", - "default": 1 - }, - "unitPrice": { - "type": "string", - "maxLength": 15, - "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" - }, - "unitOfMeasure": { - "type": "string", - "maxLength": 12, - "description": "Unit of measure, or unit of measure code, for the item.\n" - }, - "totalAmount": { - "type": "string", - "maxLength": 13, - "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n" - }, - "taxAmount": { - "type": "string", - "maxLength": 15, - "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nIf you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API.\n\nThis field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API.\n" - }, - "taxRate": { - "type": "string", - "maxLength": 7, - "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" - }, - "taxAppliedAfterDiscount": { - "type": "string", - "maxLength": 1, - "description": "Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n" - }, - "taxStatusIndicator": { - "type": "string", - "maxLength": 1, - "description": "Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n" - }, - "taxTypeCode": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "amountIncludesTax": { - "type": "boolean", - "description": "Flag that indicates whether the tax amount is included in the Line Item Total.\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "typeOfSupply": { - "type": "string", - "maxLength": 2, - "description": "Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n" - }, - "commodityCode": { - "type": "string", - "maxLength": 15, - "description": "Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n" - }, - "discountAmount": { - "type": "string", - "maxLength": 13, - "description": "Discount applied to the item." - }, - "discountApplied": { - "type": "boolean", - "description": "Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "discountRate": { - "type": "string", - "maxLength": 6, - "description": "Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n" - }, - "invoiceNumber": { - "type": "string", - "maxLength": 23, - "description": "Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n" - }, - "taxDetails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", - "enum": [ - "alternate", - "local", - "national", - "vat" - ] - }, - "amount": { - "type": "string", - "maxLength": 13, - "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" - }, - "rate": { - "type": "string", - "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" - }, - "code": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" - }, - "applied": { - "type": "boolean", - "description": "The tax is applied. Valid value is `true` or `false`." - }, - "exemptionCode": { - "type": "string", - "maxLength": 1, - "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" - } - } - } - }, - "fulfillmentType": { - "type": "string", - "description": "The description for this field is not available." - }, - "weight": { - "type": "string", - "maxLength": 9, - "description": "Weight of the item. See Numbered Elements." - }, - "weightIdentifier": { - "type": "string", - "maxLength": 1, - "description": "Type of weight. See Numbered Elements.\n\nPossible values:\n- B: Billed weight\n- N: Actual net weight\n" - }, - "weightUnit": { - "type": "string", - "maxLength": 2, - "description": "Code that specifies the unit of measurement for the weight amount. For example, OZ specifies ounce and LB\nspecifies pound. The possible values are defined by the ANSI Accredited Standards Committee (ASC).\n\nSee Numbered Elements.\n" - }, - "referenceDataCode": { - "type": "string", - "maxLength": 2, - "description": "Code that identifies the value of the corresponding item_#_referenceData_#_number field. See Numbered Elements.\n\nPossible values:\n- AN: Client-defined asset code\n- MG: Manufacturer's part number\n- PO: Purchase order number\n- SK: Supplier stock keeping unit number\n- UP: Universal product code\n- VC: Supplier catalog number\n- VP: Vendor part number\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" - }, - "referenceDataNumber": { - "type": "string", - "maxLength": 30, - "description": "Reference number.\n\nThe meaning of this value is identified by the value of the corresponding `referenceDataCode` field.\nSee Numbered Elements.\n\nThe maximum length for this field depends on the value of the corresponding `referenceDataCode` field:\n- When the code is `PO`, the maximum length for the reference number is 22.\n- When the code is `VC`, the maximum length for the reference number is 20.\n- For all other codes, the maximum length for the reference number is 30.\n\nThis field is a pass-through, which means that CyberSource does not verify the value or modify it in any way\nbefore sending it to the processor.\n" - } - } - } - }, - "invoiceDetails": { - "type": "object", - "properties": { - "purchaseOrderNumber": { - "type": "string", - "maxLength": 25, - "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "purchaseOrderDate": { - "type": "string", - "maxLength": 10, - "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "purchaseContactName": { - "type": "string", - "maxLength": 36, - "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxable": { - "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "vatInvoiceReferenceNumber": { - "type": "string", - "maxLength": 15, - "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "commodityCode": { - "type": "string", - "maxLength": 4, - "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "transactionAdviceAddendum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "data": { - "type": "string", - "maxLength": 40, - "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n" - } - } - } - } - } - }, - "shippingDetails": { - "type": "object", - "properties": { - "shipFromPostalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n" - } - } - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "merchantCustomerId": { - "type": "string", - "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 20, - "description": "Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - } - } - }, - "deviceInformation": { - "type": "object", - "properties": { - "hostName": { - "type": "string", - "maxLength": 60, - "description": "DNS resolved hostname from above _ipAddress_." - }, - "ipAddress": { - "type": "string", - "maxLength": 15, - "description": "IP address of the customer." - }, - "userAgent": { - "type": "string", - "maxLength": 40, - "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n" - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" - }, - "alternateName": { - "type": "string", - "maxLength": 13, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "contact": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n" - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "locality": { - "type": "string", - "maxLength": 13, - "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - }, - "cardAcceptorReferenceNumber": { - "type": "string", - "maxLength": 25, - "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "categoryCode": { - "type": "integer", - "maximum": 9999, - "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "serviceFeeDescriptor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 22, - "description": "Name of the service provider that is collecting the service fee. The service provider name must consist of\n3, 7, or 12 characters followed by an asterisk (*). This value must also include the words \u201cService Fee.\u201d\n\nWhen you include more than one consecutive space, extra spaces are removed. Use one of the following formats\nfor this value:\n- <3-character name>*Service Fee\n- <7-character name>*Service Fee\n- <12-character name>*Service Fee\n\nWhen payments are made in installments, this value must also include installment information such as\n\u201c1 of 5\u201d or \u201c3 of 7.\u201d For installment payments, use one of the following formats for this value:\n- <3-character name>*Service Fee* of \n- <7-character name>*Service Fee* of \n- <12-character name>*Service Fee* of \n\nwhere is the payment number and is the total number of payments.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource\naccount.\n\nThis value might be displayed on the cardholder\u2019s statement.\n" - }, - "contact": { - "type": "string", - "maxLength": 11, - "description": "Contact information for the service provider that is collecting the service fee. when you include more than one\nconsecutive space, extra spaces are removed.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder\u2019s statement.\n" - }, - "state": { - "type": "string", - "maxLength": 20, - "description": "State or territory in which the service provider is located.\n\nWhen you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.\n\nThis value might be displayed on the cardholder\u2019s statement.\n" - } - } - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" - } - } - }, - "aggregatorInformation": { - "type": "object", - "properties": { - "aggregatorId": { - "type": "string", - "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "name": { - "type": "string", - "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "subMerchant": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 37, - "description": "Sub-merchant\u2019s business name.\n\n**American Express Direct**\\\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\n**FDC Nashville Global**\\\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n" - }, - "address1": { - "type": "string", - "maxLength": 38, - "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "locality": { - "type": "string", - "maxLength": 21, - "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 15, - "description": "Partial postal code for the sub-merchant\u2019s address.\n\nSee \"Aggregator Support,\" page 100 for details.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "country": { - "type": "string", - "maxLength": 3, - "description": "Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nSee \"Aggregator Support,\" page 101.\n" - }, - "email": { - "type": "string", - "maxLength": 40, - "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 20, - "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n" - } - } - } - } - }, - "pointOfSaleInformation": { - "type": "object", - "properties": { - "emv": { - "type": "object", - "properties": { - "tags": { - "type": "string", - "maxLength": 1998, - "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" - }, - "fallback": { - "type": "boolean", - "maxLength": 5, - "description": "Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.\n\nPossible values:\n - **true**\n - **false** (default)\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n", - "enum": [ - true, - false - ], - "default": false - } - } - }, - "amexCapnData": { - "type": "string", - "maxLength": 12, - "description": "Point-of-sale details for the transaction. This value is returned only for **American Express Direct**.\nCyberSource generates this value, which consists of a series of codes that identify terminal capability,\nsecurity data, and specific conditions present at the time the transaction occurred. To comply with the CAPN\nrequirements, this value must be included in all subsequent follow-on requests, such as captures and follow-on\ncredits.\n\nWhen you perform authorizations, captures, and credits through CyberSource, CyberSource passes this value from\nthe authorization service to the subsequent services for you. However, when you perform authorizations through\nCyberSource and perform subsequent services through other financial institutions, you must ensure that your\nrequests for captures and credits include this value.\n" - } - } - }, - "merchantDefinedInformation": { - "type": "array", - "description": "The description for this field is not available.", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "maxLength": 50, - "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n" - }, - "value": { - "type": "string", - "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" - } - } - } - }, - "installmentInformation": { - "type": "object", - "properties": { - "firstInstallmentDate": { - "type": "string", - "maximum": 6, - "description": "Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a\nstring of six zeros (000000) to the processor. See Installment Payments on CyberSource through VisaNet.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR9\n- Position: 42-47\n- Field: Date of First Installment\n" - }, - "invoiceData": { - "type": "string", - "maxLength": 20, - "description": "Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is\nthe same for all installment payments for one purchase.\n\nThis field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR4\n- Position: 51-70\n- Field: Purchase Identification\n" - }, - "paymentType": { - "type": "string", - "maxLength": 1, - "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nSee Installment Payments on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n" - }, - "additionalCosts": { - "type": "string", - "maxLength": 12, - "description": "Additional costs charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 128-139\n- Field: Total Other Costs\n" - }, - "additionalCostsPercentage": { - "type": "string", - "maxLength": 4, - "description": "Additional costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 140-143\n- Field: Percent of Total Other Costs\n" - }, - "amountFunded": { - "type": "string", - "maxLength": 12, - "description": "Amount funded.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 48-59\n- Field: Total Amount Funded\n" - }, - "amountRequestedPercentage": { - "type": "string", - "maxLength": 4, - "description": "Amount requested divided by the amount funded.\n\nFor example:\n- A value of 90.0 specifies 90%.\n- A value of 93.7 specifies 93.7%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 60-63\n- Field: Percent of Amount Requested\n" - }, - "annualFinancingCost": { - "type": "string", - "maxLength": 7, - "description": "Annual cost of financing the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 158-164\n- Field: Annual Total Cost of Financing\n" - }, - "annualInterestRate": { - "type": "string", - "maximum": 7, - "description": "Annual interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 151-157\n- Field: Annual Interest Rate\n" - }, - "expenses": { - "type": "string", - "maxLength": 12, - "description": "Expenses charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 64-75\n- Field: Total Expenses\n" - }, - "expensesPercentage": { - "type": "string", - "maxLength": 4, - "description": "Expenses divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 76-79\n- Field: Percent of Total Expenses\n" - }, - "fees": { - "type": "string", - "maxLength": 12, - "description": "Fees charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 80-91\n- Field: Total Fees\n" - }, - "feesPercentage": { - "type": "string", - "maxLength": 4, - "description": "Fees divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 92-95\n- Field: Percent of Total Fees\n" - }, - "insurance": { - "type": "string", - "maxLength": 12, - "description": "Insurance charged by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 112-123\n- Field: Total Insurance\n" - }, - "insurancePercentage": { - "type": "string", - "maxLength": 4, - "description": "Insurance costs divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 124-127\n- Field: Percent Of Total Insurance\n" - }, - "monthlyInterestRate": { - "type": "string", - "maximum": 7, - "description": "Monthly interest rate.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 144-150\n- Field: Monthly Interest Rate\n" - }, - "taxes": { - "type": "string", - "maxLength": 12, - "description": "Taxes collected by the issuer to fund the installment payments.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 96-107\n- Field: Total Taxes\n" - }, - "taxesPercentage": { - "type": "string", - "maxLength": 4, - "description": "Taxes divided by the amount funded.\n\nFor example:\n- A value of 1.0 specifies 1%.\n- A value of 4.0 specifies 4%.\n\nThis field is included in the authorization reply for the Crediario eligibility request when the issuer approves\nthe cardholder's request for Crediario installment payments in Brazil. See Installment Payments on CyberSource\nthrough VisaNet.\n\nThis field is supported only for `Crediario` installment payments in Brazil on **CyberSource through VisaNet**.\n\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR9\n- Position: 108-111\n- Field: Percent of Total Taxes\n" - } - } - } - }, - "example": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "orderInformation": { - "amountDetails": { - "totalAmount": "102.21", - "currency": "USD" - } - } - }, - "x-example": { - "example0": { - "summary": "Capture a Payment", - "value": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "orderInformation": { - "amountDetails": { - "totalAmount": "102.21", - "currency": "USD" - } - } - } - }, - "example1": { - "summary": "Capture a Payment - Service Fee", - "value": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "orderInformation": { - "amountDetails": { - "totalAmount": "2325.00", - "currency": "USD", - "serviceFeeAmount": "30.0" - } - }, - "merchantInformation": { - "serviceFeeDescriptor": { - "name": "CyberVacations Service Fee", - "contact": "800-999-9999", - "state": "CA" - } - } - } - } - } - } - }, { - "name": "id", - "in": "path", - "description": "The payment ID returned from a previous payment request. This ID links the capture to the payment.\n", - "required": true, - "type": "string" - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "type": "object", - "title": "ptsV2PaymentsCapturesPost201Response", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - }, - "void": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - }, - "refund": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - }, - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - PENDING\n", - "enum": [ - "PENDING" - ] - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "submitLocalDateTime": { - "type": "string", - "maxLength": 14, - "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" - }, - "ownerMerchantId": { - "type": "string", - "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" - } - } - }, - "processorInformation": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "maxLength": 18, - "description": "Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n" - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "amountDetails": { - "type": "object", - "properties": { - "totalAmount": { - "type": "string", - "maxLength": 15, - "description": "Amount you requested for the capture.\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - } - } - }, - "invoiceDetails": { - "type": "object", - "properties": { - "level3TransmissionStatus": { - "type": "boolean", - "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n", - "enum": [ - true, - false - ] - } - } - } - } - } - }, - "example": { - "_links": { - "self": { - "href": "/pts/v2/captures/4963014519526177701545", - "method": "GET" - }, - "refund": { - "href": "/pts/v2/captures/4963014519526177701545/refunds", - "method": "POST" - }, - "void": { - "href": "/pts/v2/captures/4963014519526177701545/voids", - "method": "POST" - } - }, - "id": "4963014519526177701545", - "submitTimeUtc": "2017-06-01T071731Z", - "status": "200", - "reconciliationId": "39570715X3E1LBQA", - "statusInformation": { - "reason": "SUCCESS", - "message": "Successful transaction." - }, - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "orderInformation": { - "amountDetails": { - "totalAmount": "102.21", - "currency": "USD" - } - } - } - } - }, - "400": { - "description": "Invalid request.", - "schema": { - "type": "object", - "title": "ptsV2PaymentsCapturesPost400Response", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", - "enum": [ - "INVALID_REQUEST" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - EXCEEDS_AUTH_AMOUNT\n - AUTH_ALREADY_REVERSED\n - TRANSACTION_ALREADY_SETTLED\n - INVALID_AMOUNT\n - MISSING_AUTH\n - TRANSACTION_ALREADY_REVERSED_OR_SETTLED\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA", - "DUPLICATE_REQUEST", - "INVALID_MERCHANT_CONFIGURATION", - "EXCEEDS_AUTH_AMOUNT", - "AUTH_ALREADY_REVERSED", - "TRANSACTION_ALREADY_SETTLED", - "MISSING_AUTH", - "TRANSACTION_ALREADY_REVERSED_OR_SETTLED" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - } - }, - "502": { - "description": "Unexpected system error or system timeout.", - "schema": { - "type": "object", - "title": "ptsV2PaymentsCapturesPost502Response", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", - "enum": [ - "SERVER_ERROR" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", - "enum": [ - "SYSTEM_ERROR", - "SERVER_TIMEOUT", - "SERVICE_TIMEOUT", - "PROCESSOR_TIMEOUT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - } - } - } - } - }, - "x-example": { - "example0": { - "summary": "Capture a Payment", - "value": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "orderInformation": { - "amountDetails": { - "totalAmount": "102.21", - "currency": "USD" - } - } - } - }, - "example1": { - "summary": "Capture a Payment - Service Fee", - "value": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "orderInformation": { - "amountDetails": { - "totalAmount": "2325.00", - "currency": "USD", - "serviceFeeAmount": "30.0" - } - }, - "merchantInformation": { - "serviceFeeDescriptor": { - "name": "CyberVacations Service Fee", - "contact": "800-999-9999", - "state": "CA" - } - } - } - } - } - } - }, - "/pts/v2/payments/{id}/refunds": { - "post": { - "summary": "Refund a Payment", - "description": "Include the payment ID in the POST request to refund the payment amount.\n", - "tags": [ - "refund" - ], - "operationId": "refundPayment", - "x-devcenter-metaData": { - "categoryTag": "Payments" - }, - "parameters": [{ - "name": "refundPaymentRequest", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "transactionId": { - "type": "string", - "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations\n.\nSee \"Merchant-Initiated Reversals and Voids,\" page 176.\n" - }, - "comments": { - "type": "string", - "description": "Comments" - }, - "partner": { - "type": "object", - "properties": { - "originalTransactionId": { - "type": "string", - "maxLength": 32, - "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - }, - "developerId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" - }, - "solutionId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" - } - } - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "paymentSolution": { - "type": "string", - "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" - }, - "linkId": { - "type": "string", - "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n" - }, - "reportGroup": { - "type": "string", - "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n" - }, - "visaCheckoutId": { - "type": "string", - "maxLength": 48, - "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n" - }, - "purchaseLevel": { - "type": "string", - "maxLength": 1, - "description": "Set this field to 3 to indicate that the request includes Level III data." - }, - "recurringOptions": { - "type": "object", - "properties": { - "loanPayment": { - "type": "boolean", - "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- **true** Loan payment\n- **false** (default) Not a loan payment\n\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\n", - "enum": [ - true, - false - ], - "default": false - } - } - } - } - }, - "paymentInformation": { - "type": "object", - "properties": { - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "maxLength": 20, - "description": "Customer\u2019s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field\nfor the encoded account number.\n\nFor processor-specific information, see the customer_cc_number field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the credit card expires.\n`Format: YYYY`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "type": { - "type": "string", - "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n" - }, - "accountEncoderId": { - "type": "string", - "maxLength": 3, - "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n" - }, - "issueNumber": { - "type": "string", - "maxLength": 5, - "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" - }, - "startMonth": { - "type": "string", - "maxLength": 2, - "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" - }, - "startYear": { - "type": "string", - "maxLength": 4, - "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" - } - } - }, - "bank": { - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "type": { - "type": "string", - "maxLength": 1, - "description": "Account type.\n\nPossible values:\n - **C**: Checking.\n - **G**: General ledger. This value is supported only on Wells Fargo ACH.\n - **S**: Savings (U.S. dollars only).\n - **X**: Corporate checking (U.S. dollars only).\n" - }, - "number": { - "type": "string", - "maxLength": 17, - "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" - }, - "encoderId": { - "type": "string", - "maxLength": 3, - "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor. See \"Encoded Account Numbers,\" page 39.\n" - }, - "checkNumber": { - "type": "string", - "maxLength": 8, - "description": "Check number.\n\nChase Paymentech Solutions - Optional.\nCyberSource ACH Service - Not used.\nRBS WorldPay Atlanta - Optional on debits. Required on credits.\nTeleCheck - Strongly recommended on debit requests. Optional on credits.\n" - }, - "checkImageReferenceNumber": { - "type": "string", - "maxLength": 32, - "description": "Image reference number associated with the check. You cannot include any special characters.\n" - } - } - }, - "routingNumber": { - "type": "string", - "maxLength": 9, - "description": "Bank routing number.\n\nThis is also called the transit number.\n" - } - } - }, - "customer": { - "type": "object", - "properties": { - "customerId": { - "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" - } - } - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "amountDetails": { - "type": "object", - "properties": { - "totalAmount": { - "type": "string", - "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - }, - "discountAmount": { - "type": "string", - "maxLength": 15, - "description": "Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "dutyAmount": { - "type": "string", - "maxLength": 15, - "description": "Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAmount": { - "type": "string", - "maxLength": 12, - "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "nationalTaxIncluded": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAppliedAfterDiscount": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAppliedLevel": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxTypeCode": { - "type": "string", - "maxLength": 3, - "description": "For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "freightAmount": { - "type": "string", - "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "foreignAmount": { - "type": "string", - "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "foreignCurrency": { - "type": "string", - "maxLength": 5, - "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "exchangeRate": { - "type": "string", - "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "exchangeRateTimeStamp": { - "type": "string", - "maxLength": 14, - "description": "Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "amexAdditionalAmounts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "amount": { - "type": "string", - "maxLength": 12, - "description": "Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - } - }, - "taxDetails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", - "enum": [ - "alternate", - "local", - "national", - "vat" - ] - }, - "amount": { - "type": "string", - "maxLength": 13, - "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" - }, - "rate": { - "type": "string", - "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" - }, - "code": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" - }, - "applied": { - "type": "boolean", - "description": "The tax is applied. Valid value is `true` or `false`." - }, - "exemptionCode": { - "type": "string", - "maxLength": 1, - "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" - } - } - } - }, - "serviceFeeAmount": { - "type": "string", - "maxLength": 15, - "description": "Service fee. Required for service fee transactions.\n" - }, - "originalCurrency": { - "type": "string", - "maxLength": 15, - "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n" - } - } - }, - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "company": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 60, - "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "address1": { - "type": "string", - "maxLength": 40, - "description": "First line in the street address of the company purchasing the product." - }, - "address2": { - "type": "string", - "maxLength": 40, - "description": "Additional address information for the company purchasing the product." - }, - "locality": { - "type": "string", - "maxLength": 30, - "description": "City in the address of the company purchasing the product." - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n" - } - } - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "address2": { - "type": "string", - "maxLength": 60, - "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "locality": { - "type": "string", - "maxLength": 50, - "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "email": { - "type": "string", - "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" - } - } - }, - "shipTo": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the shipping address. Use the two character ISO Standard Country Codes." - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" - } - } - }, - "lineItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "productCode": { - "type": "string", - "maxLength": 255, - "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\n" - }, - "productName": { - "type": "string", - "maxLength": 255, - "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false` respectively), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other\nvalues that are related to shipping and/or handling.\n" - }, - "productSku": { - "type": "string", - "maxLength": 255, - "description": "Identification code for the product.\n\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n" - }, - "quantity": { - "type": "number", - "minimum": 1, - "maximum": 9999999999, - "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n", - "default": 1 - }, - "unitPrice": { - "type": "string", - "maxLength": 15, - "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" - }, - "unitOfMeasure": { - "type": "string", - "maxLength": 12, - "description": "Unit of measure, or unit of measure code, for the item.\n" - }, - "totalAmount": { - "type": "string", - "maxLength": 13, - "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n" - }, - "taxAmount": { - "type": "string", - "maxLength": 15, - "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nIf you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API.\n\nThis field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API.\n" - }, - "taxRate": { - "type": "string", - "maxLength": 7, - "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" - }, - "taxAppliedAfterDiscount": { - "type": "string", - "maxLength": 1, - "description": "Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n" - }, - "taxStatusIndicator": { - "type": "string", - "maxLength": 1, - "description": "Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n" - }, - "taxTypeCode": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "amountIncludesTax": { - "type": "boolean", - "description": "Flag that indicates whether the tax amount is included in the Line Item Total.\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "typeOfSupply": { - "type": "string", - "maxLength": 2, - "description": "Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n" - }, - "commodityCode": { - "type": "string", - "maxLength": 15, - "description": "Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n" - }, - "discountAmount": { - "type": "string", - "maxLength": 13, - "description": "Discount applied to the item." - }, - "discountApplied": { - "type": "boolean", - "description": "Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "discountRate": { - "type": "string", - "maxLength": 6, - "description": "Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n" - }, - "invoiceNumber": { - "type": "string", - "maxLength": 23, - "description": "Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n" - }, - "taxDetails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", - "enum": [ - "alternate", - "local", - "national", - "vat" - ] - }, - "amount": { - "type": "string", - "maxLength": 13, - "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" - }, - "rate": { - "type": "string", - "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" - }, - "code": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" - }, - "applied": { - "type": "boolean", - "description": "The tax is applied. Valid value is `true` or `false`." - }, - "exemptionCode": { - "type": "string", - "maxLength": 1, - "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" - } - } - } - } - } - } - }, - "invoiceDetails": { - "type": "object", - "properties": { - "purchaseOrderNumber": { - "type": "string", - "maxLength": 25, - "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "purchaseOrderDate": { - "type": "string", - "maxLength": 10, - "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "purchaseContactName": { - "type": "string", - "maxLength": 36, - "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxable": { - "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "vatInvoiceReferenceNumber": { - "type": "string", - "maxLength": 15, - "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "commodityCode": { - "type": "string", - "maxLength": 4, - "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "transactionAdviceAddendum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "data": { - "type": "string", - "maxLength": 40, - "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n" - } - } - } - } - } - }, - "shippingDetails": { - "type": "object", - "properties": { - "shipFromPostalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n" - } - } - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "merchantCustomerId": { - "type": "string", - "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 20, - "description": "Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - } - } - }, - "deviceInformation": { - "type": "object", - "properties": { - "hostName": { - "type": "string", - "maxLength": 60, - "description": "DNS resolved hostname from above _ipAddress_." - }, - "ipAddress": { - "type": "string", - "maxLength": 15, - "description": "IP address of the customer." - }, - "userAgent": { - "type": "string", - "maxLength": 40, - "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n" - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" - }, - "alternateName": { - "type": "string", - "maxLength": 13, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "contact": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n" - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "locality": { - "type": "string", - "maxLength": 13, - "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - }, - "categoryCode": { - "type": "integer", - "maximum": 9999, - "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "cardAcceptorReferenceNumber": { - "type": "string", - "maxLength": 25, - "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" - } - } - }, - "aggregatorInformation": { - "type": "object", - "properties": { - "aggregatorId": { - "type": "string", - "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "name": { - "type": "string", - "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "subMerchant": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 37, - "description": "Sub-merchant\u2019s business name.\n\n**American Express Direct**\\\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\n**FDC Nashville Global**\\\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n" - }, - "address1": { - "type": "string", - "maxLength": 38, - "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "locality": { - "type": "string", - "maxLength": 21, - "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 15, - "description": "Partial postal code for the sub-merchant\u2019s address.\n\nSee \"Aggregator Support,\" page 100 for details.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "country": { - "type": "string", - "maxLength": 3, - "description": "Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nSee \"Aggregator Support,\" page 101.\n" - }, - "email": { - "type": "string", - "maxLength": 40, - "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 20, - "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n" - } - } - } - } - }, - "pointOfSaleInformation": { - "type": "object", - "properties": { - "emv": { - "type": "object", - "properties": { - "tags": { - "type": "string", - "maxLength": 1998, - "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" - }, - "fallback": { - "type": "boolean", - "maxLength": 5, - "description": "Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.\n\nPossible values:\n - **true**\n - **false** (default)\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n", - "enum": [ - true, - false - ], - "default": false - } - } - } - } - }, - "merchantDefinedInformation": { - "type": "array", - "description": "The description for this field is not available.", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "maxLength": 50, - "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n" - }, - "value": { - "type": "string", - "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" - } - } - } - } - }, - "example": { - "clientReferenceInformation": { - "code": "Testing-VDP-Payments-Refund" - }, - "orderInformation": { - "amountDetails": { - "totalAmount": "102.21", - "currency": "USD" - } - } - } - } - }, { - "name": "id", - "in": "path", - "description": "The payment ID. This ID is returned from a previous payment request.", - "required": true, - "type": "string" - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "type": "object", - "title": "ptsV2PaymentsRefundPost201Response", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - }, - "void": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - }, - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - PENDING\n", - "enum": [ - "PENDING" - ] - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "submitLocalDateTime": { - "type": "string", - "maxLength": 14, - "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" - }, - "ownerMerchantId": { - "type": "string", - "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" - } - } - }, - "refundAmountDetails": { - "type": "object", - "properties": { - "refundAmount": { - "type": "string", - "maxLength": 15, - "description": "Total amount of the refund." - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - } - } - }, - "processorInformation": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "maxLength": 18, - "description": "Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n" - }, - "forwardedAcquirerCode": { - "type": "string", - "maxLength": 32, - "description": "Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n" - }, - "merchantNumber": { - "type": "string", - "maxLength": 15, - "description": "Identifier that was assigned to you by your acquirer.\n\nThis value must be printed on the receipt.\n\nThis field is supported only on **American Express Direct**, **FDC Nashville Global**, and **SIX**.\n" - }, - "responseCode": { - "type": "string", - "maxLength": 10, - "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n" - }, - "achVerification": { - "type": "object", - "properties": { - "resultCode": { - "type": "string", - "maxLength": 2, - "description": "Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible\nvalues, see Appendix H, \"Verification Codes,\" on page 91.\n" - }, - "resultCodeRaw": { - "type": "string", - "maxLength": 10, - "description": "Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the\npossible values, see Appendix H, \"Verification Codes,\" on page 91.\n" - } - } - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "invoiceDetails": { - "type": "object", - "properties": { - "level3TransmissionStatus": { - "type": "boolean", - "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n", - "enum": [ - true, - false - ] - } - } - } - } - } - }, - "example": { - "_links": { - "self": { - "href": "/pts/v2/refunds/4963014779006178301545", - "method": "GET" - }, - "void": { - "href": "/pts/v2/refunds/4963014779006178301545/voids", - "method": "POST" - } - }, - "id": "4963014779006178301545", - "submitTimeUtc": "2017-06-01T071757Z", - "status": "200", - "reconciliationId": "39571012D3DFEKS0", - "statusInformation": { - "reason": "SUCCESS", - "message": "Successful transaction." - }, - "clientReferenceInformation": { - "code": "Testing-VDP-Payments-Refund" - }, - "orderInformation": { - "amountDetails": { - "currency": "USD" - } - }, - "refundAmountDetails": { - "currency": "USD", - "refundAmount": "102.21" - } - } - } - }, - "400": { - "description": "Invalid request.", - "schema": { - "type": "object", - "title": "ptsV2PaymentsRefundPost400Response", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", - "enum": [ - "INVALID_REQUEST" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - INVALID_MERCHANT_CONFIGURATION\n - INVALID_AMOUNT\n - CAPTURE_ALREADY_VOIDED\n - ACCOUNT_NOT_ALLOWED_CREDIT\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA", - "DUPLICATE_REQUEST", - "INVALID_CARD", - "INVALID_MERCHANT_CONFIGURATION", - "CAPTURE_ALREADY_VOIDED", - "ACCOUNT_NOT_ALLOWED_CREDIT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - } - }, - "502": { - "description": "Unexpected system error or system timeout.", - "schema": { - "type": "object", - "title": "ptsV2PaymentsRefundPost502Response", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", - "enum": [ - "SERVER_ERROR" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", - "enum": [ - "SYSTEM_ERROR", - "SERVER_TIMEOUT", - "SERVICE_TIMEOUT", - "PROCESSOR_TIMEOUT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - } - } - } - } - }, - "x-example": { - "example0": { - "summary": "Refund a Payment", - "value": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "orderInformation": { - "amountDetails": { - "totalAmount": "10", - "currency": "USD" - } - } - } - } - } - } - }, - "/pts/v2/captures/{id}/refunds": { - "post": { - "summary": "Refund a Capture", - "description": "Include the capture ID in the POST request to refund the captured amount.\n", - "tags": [ - "refund" - ], - "operationId": "refundCapture", - "x-devcenter-metaData": { - "categoryTag": "Payments" - }, - "parameters": [{ - "name": "refundCaptureRequest", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "transactionId": { - "type": "string", - "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations\n.\nSee \"Merchant-Initiated Reversals and Voids,\" page 176.\n" - }, - "comments": { - "type": "string", - "description": "Comments" - }, - "partner": { - "type": "object", - "properties": { - "originalTransactionId": { - "type": "string", - "maxLength": 32, - "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - }, - "developerId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" - }, - "solutionId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" - } - } - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "paymentSolution": { - "type": "string", - "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" - }, - "linkId": { - "type": "string", - "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n" - }, - "reportGroup": { - "type": "string", - "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n" - }, - "visaCheckoutId": { - "type": "string", - "maxLength": 48, - "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n" - }, - "purchaseLevel": { - "type": "string", - "maxLength": 1, - "description": "Set this field to 3 to indicate that the request includes Level III data." - }, - "recurringOptions": { - "type": "object", - "properties": { - "loanPayment": { - "type": "boolean", - "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- **true** Loan payment\n- **false** (default) Not a loan payment\n\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\n", - "enum": [ - true, - false - ], - "default": false - } - } - } - } - }, - "paymentInformation": { - "type": "object", - "properties": { - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "maxLength": 20, - "description": "Customer\u2019s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field\nfor the encoded account number.\n\nFor processor-specific information, see the customer_cc_number field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the credit card expires.\n`Format: YYYY`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "type": { - "type": "string", - "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n" - }, - "accountEncoderId": { - "type": "string", - "maxLength": 3, - "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n" - }, - "issueNumber": { - "type": "string", - "maxLength": 5, - "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" - }, - "startMonth": { - "type": "string", - "maxLength": 2, - "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" - }, - "startYear": { - "type": "string", - "maxLength": 4, - "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" - } - } - }, - "bank": { - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "type": { - "type": "string", - "maxLength": 1, - "description": "Account type.\n\nPossible values:\n - **C**: Checking.\n - **G**: General ledger. This value is supported only on Wells Fargo ACH.\n - **S**: Savings (U.S. dollars only).\n - **X**: Corporate checking (U.S. dollars only).\n" - }, - "number": { - "type": "string", - "maxLength": 17, - "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" - }, - "encoderId": { - "type": "string", - "maxLength": 3, - "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor. See \"Encoded Account Numbers,\" page 39.\n" - }, - "checkNumber": { - "type": "string", - "maxLength": 8, - "description": "Check number.\n\nChase Paymentech Solutions - Optional.\nCyberSource ACH Service - Not used.\nRBS WorldPay Atlanta - Optional on debits. Required on credits.\nTeleCheck - Strongly recommended on debit requests. Optional on credits.\n" - }, - "checkImageReferenceNumber": { - "type": "string", - "maxLength": 32, - "description": "Image reference number associated with the check. You cannot include any special characters.\n" - } - } - }, - "routingNumber": { - "type": "string", - "maxLength": 9, - "description": "Bank routing number.\n\nThis is also called the transit number.\n" - } - } - }, - "customer": { - "type": "object", - "properties": { - "customerId": { - "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" - } - } - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "amountDetails": { - "type": "object", - "properties": { - "totalAmount": { - "type": "string", - "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - }, - "discountAmount": { - "type": "string", - "maxLength": 15, - "description": "Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "dutyAmount": { - "type": "string", - "maxLength": 15, - "description": "Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAmount": { - "type": "string", - "maxLength": 12, - "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "nationalTaxIncluded": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAppliedAfterDiscount": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAppliedLevel": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxTypeCode": { - "type": "string", - "maxLength": 3, - "description": "For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "freightAmount": { - "type": "string", - "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "foreignAmount": { - "type": "string", - "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "foreignCurrency": { - "type": "string", - "maxLength": 5, - "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "exchangeRate": { - "type": "string", - "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "exchangeRateTimeStamp": { - "type": "string", - "maxLength": 14, - "description": "Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "amexAdditionalAmounts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "amount": { - "type": "string", - "maxLength": 12, - "description": "Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - } - }, - "taxDetails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", - "enum": [ - "alternate", - "local", - "national", - "vat" - ] - }, - "amount": { - "type": "string", - "maxLength": 13, - "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" - }, - "rate": { - "type": "string", - "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" - }, - "code": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" - }, - "applied": { - "type": "boolean", - "description": "The tax is applied. Valid value is `true` or `false`." - }, - "exemptionCode": { - "type": "string", - "maxLength": 1, - "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" - } - } - } - }, - "serviceFeeAmount": { - "type": "string", - "maxLength": 15, - "description": "Service fee. Required for service fee transactions.\n" - }, - "originalCurrency": { - "type": "string", - "maxLength": 15, - "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n" - } - } - }, - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "company": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 60, - "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "address1": { - "type": "string", - "maxLength": 40, - "description": "First line in the street address of the company purchasing the product." - }, - "address2": { - "type": "string", - "maxLength": 40, - "description": "Additional address information for the company purchasing the product." - }, - "locality": { - "type": "string", - "maxLength": 30, - "description": "City in the address of the company purchasing the product." - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n" - } - } - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "address2": { - "type": "string", - "maxLength": 60, - "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "locality": { - "type": "string", - "maxLength": 50, - "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "email": { - "type": "string", - "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" - } - } - }, - "shipTo": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the shipping address. Use the two character ISO Standard Country Codes." - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" - } - } - }, - "lineItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "productCode": { - "type": "string", - "maxLength": 255, - "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\n" - }, - "productName": { - "type": "string", - "maxLength": 255, - "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false` respectively), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other\nvalues that are related to shipping and/or handling.\n" - }, - "productSku": { - "type": "string", - "maxLength": 255, - "description": "Identification code for the product.\n\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n" - }, - "quantity": { - "type": "number", - "minimum": 1, - "maximum": 9999999999, - "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n", - "default": 1 - }, - "unitPrice": { - "type": "string", - "maxLength": 15, - "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" - }, - "unitOfMeasure": { - "type": "string", - "maxLength": 12, - "description": "Unit of measure, or unit of measure code, for the item.\n" - }, - "totalAmount": { - "type": "string", - "maxLength": 13, - "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n" - }, - "taxAmount": { - "type": "string", - "maxLength": 15, - "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nIf you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API.\n\nThis field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API.\n" - }, - "taxRate": { - "type": "string", - "maxLength": 7, - "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" - }, - "taxAppliedAfterDiscount": { - "type": "string", - "maxLength": 1, - "description": "Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n" - }, - "taxStatusIndicator": { - "type": "string", - "maxLength": 1, - "description": "Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n" - }, - "taxTypeCode": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "amountIncludesTax": { - "type": "boolean", - "description": "Flag that indicates whether the tax amount is included in the Line Item Total.\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "typeOfSupply": { - "type": "string", - "maxLength": 2, - "description": "Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n" - }, - "commodityCode": { - "type": "string", - "maxLength": 15, - "description": "Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n" - }, - "discountAmount": { - "type": "string", - "maxLength": 13, - "description": "Discount applied to the item." - }, - "discountApplied": { - "type": "boolean", - "description": "Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "discountRate": { - "type": "string", - "maxLength": 6, - "description": "Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n" - }, - "invoiceNumber": { - "type": "string", - "maxLength": 23, - "description": "Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n" - }, - "taxDetails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", - "enum": [ - "alternate", - "local", - "national", - "vat" - ] - }, - "amount": { - "type": "string", - "maxLength": 13, - "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" - }, - "rate": { - "type": "string", - "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" - }, - "code": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" - }, - "applied": { - "type": "boolean", - "description": "The tax is applied. Valid value is `true` or `false`." - }, - "exemptionCode": { - "type": "string", - "maxLength": 1, - "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" - } - } - } - } - } - } - }, - "invoiceDetails": { - "type": "object", - "properties": { - "purchaseOrderNumber": { - "type": "string", - "maxLength": 25, - "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "purchaseOrderDate": { - "type": "string", - "maxLength": 10, - "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "purchaseContactName": { - "type": "string", - "maxLength": 36, - "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxable": { - "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "vatInvoiceReferenceNumber": { - "type": "string", - "maxLength": 15, - "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "commodityCode": { - "type": "string", - "maxLength": 4, - "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "transactionAdviceAddendum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "data": { - "type": "string", - "maxLength": 40, - "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n" - } - } - } - } - } - }, - "shippingDetails": { - "type": "object", - "properties": { - "shipFromPostalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n" - } - } - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "merchantCustomerId": { - "type": "string", - "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 20, - "description": "Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - } - } - }, - "deviceInformation": { - "type": "object", - "properties": { - "hostName": { - "type": "string", - "maxLength": 60, - "description": "DNS resolved hostname from above _ipAddress_." - }, - "ipAddress": { - "type": "string", - "maxLength": 15, - "description": "IP address of the customer." - }, - "userAgent": { - "type": "string", - "maxLength": 40, - "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n" - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" - }, - "alternateName": { - "type": "string", - "maxLength": 13, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "contact": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n" - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "locality": { - "type": "string", - "maxLength": 13, - "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - }, - "categoryCode": { - "type": "integer", - "maximum": 9999, - "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "cardAcceptorReferenceNumber": { - "type": "string", - "maxLength": 25, - "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" - } - } - }, - "aggregatorInformation": { - "type": "object", - "properties": { - "aggregatorId": { - "type": "string", - "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "name": { - "type": "string", - "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "subMerchant": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 37, - "description": "Sub-merchant\u2019s business name.\n\n**American Express Direct**\\\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\n**FDC Nashville Global**\\\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n" - }, - "address1": { - "type": "string", - "maxLength": 38, - "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "locality": { - "type": "string", - "maxLength": 21, - "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 15, - "description": "Partial postal code for the sub-merchant\u2019s address.\n\nSee \"Aggregator Support,\" page 100 for details.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "country": { - "type": "string", - "maxLength": 3, - "description": "Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nSee \"Aggregator Support,\" page 101.\n" - }, - "email": { - "type": "string", - "maxLength": 40, - "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 20, - "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n" - } - } - } - } - }, - "pointOfSaleInformation": { - "type": "object", - "properties": { - "emv": { - "type": "object", - "properties": { - "tags": { - "type": "string", - "maxLength": 1998, - "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" - }, - "fallback": { - "type": "boolean", - "maxLength": 5, - "description": "Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.\n\nPossible values:\n - **true**\n - **false** (default)\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n", - "enum": [ - true, - false - ], - "default": false - } - } - } - } - }, - "merchantDefinedInformation": { - "type": "array", - "description": "The description for this field is not available.", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "maxLength": 50, - "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n" - }, - "value": { - "type": "string", - "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" - } - } - } - } - }, - "example": { - "clientReferenceInformation": { - "code": "Testing-VDP-Payments-Refund" - }, - "orderInformation": { - "amountDetails": { - "totalAmount": "102.21", - "currency": "USD" - } - } - } - } - }, { - "name": "id", - "in": "path", - "description": "The capture ID. This ID is returned from a previous capture request.", - "required": true, - "type": "string" - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "type": "object", - "title": "ptsV2CapturesRefundsPost201Response", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - }, - "void": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - }, - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - PENDING\n", - "enum": [ - "PENDING" - ] - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "submitLocalDateTime": { - "type": "string", - "maxLength": 14, - "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" - }, - "ownerMerchantId": { - "type": "string", - "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" - } - } - }, - "refundAmountDetails": { - "type": "object", - "properties": { - "refundAmount": { - "type": "string", - "maxLength": 15, - "description": "Total amount of the refund." - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - } - } - }, - "processorInformation": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "maxLength": 18, - "description": "Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n" - }, - "forwardedAcquirerCode": { - "type": "string", - "maxLength": 32, - "description": "Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n" - }, - "merchantNumber": { - "type": "string", - "maxLength": 15, - "description": "Identifier that was assigned to you by your acquirer.\n\nThis value must be printed on the receipt.\n\nThis field is supported only on **American Express Direct**, **FDC Nashville Global**, and **SIX**.\n" - }, - "responseCode": { - "type": "string", - "maxLength": 10, - "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n" - }, - "achVerification": { - "type": "object", - "properties": { - "resultCode": { - "type": "string", - "maxLength": 2, - "description": "Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible\nvalues, see Appendix H, \"Verification Codes,\" on page 91.\n" - }, - "resultCodeRaw": { - "type": "string", - "maxLength": 10, - "description": "Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the\npossible values, see Appendix H, \"Verification Codes,\" on page 91.\n" - } - } - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "invoiceDetails": { - "type": "object", - "properties": { - "level3TransmissionStatus": { - "type": "boolean", - "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n", - "enum": [ - true, - false - ] - } - } - } - } - } - }, - "example": { - "_links": { - "self": { - "href": "/pts/v2/refunds/4963014779006178301545", - "method": "GET" - }, - "void": { - "href": "/pts/v2/refunds/4963014779006178301545/voids", - "method": "POST" - } - }, - "id": "4963014779006178301545", - "submitTimeUtc": "2017-06-01T071757Z", - "status": "200", - "reconciliationId": "39571012D3DFEKS0", - "statusInformation": { - "reason": "SUCCESS", - "message": "Successful transaction." - }, - "clientReferenceInformation": { - "code": "Testing-VDP-Payments-Refund" - }, - "orderInformation": { - "amountDetails": { - "currency": "USD" - } - }, - "refundAmountDetails": { - "currency": "USD", - "refundAmount": "102.21" - } - } - } - }, - "400": { - "description": "Invalid request.", - "schema": { - "title": "ptsV2CapturesRefundsPost400Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", - "enum": [ - "INVALID_REQUEST" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - INVALID_MERCHANT_CONFIGURATION\n - INVALID_AMOUNT\n - CAPTURE_ALREADY_VOIDED\n - ACCOUNT_NOT_ALLOWED_CREDIT\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA", - "DUPLICATE_REQUEST", - "INVALID_CARD", - "INVALID_MERCHANT_CONFIGURATION", - "CAPTURE_ALREADY_VOIDED", - "ACCOUNT_NOT_ALLOWED_CREDIT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - } - }, - "502": { - "description": "Unexpected system error or system timeout.", - "schema": { - "title": "ptsV2CapturesRefundsPost502Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", - "enum": [ - "SERVER_ERROR" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", - "enum": [ - "SYSTEM_ERROR", - "SERVER_TIMEOUT", - "SERVICE_TIMEOUT", - "PROCESSOR_TIMEOUT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - } - } - } - } - }, - "x-example": { - "example0": { - "summary": "Refund a Capture", - "value": { - "clientReferenceInformation": { - "code": "TC50171_3" - }, - "orderInformation": { - "amountDetails": { - "totalAmount": "102.21", - "currency": "USD" - } - } - } - } - } - } - }, - "/pts/v2/credits/": { - "post": { - "summary": "Process a Credit", - "description": "POST to the credit resource to credit funds to a specified credit card.", - "tags": [ - "credit" - ], - "operationId": "createCredit", - "x-devcenter-metaData": { - "categoryTag": "Payments" - }, - "parameters": [{ - "name": "createCreditRequest", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "transactionId": { - "type": "string", - "description": "Identifier that you assign to the transaction.\n\n**Note** Use this field only if you want to support merchant-initiated reversal and void operations\n.\nSee \"Merchant-Initiated Reversals and Voids,\" page 176.\n" - }, - "comments": { - "type": "string", - "description": "Comments" - }, - "partner": { - "type": "object", - "properties": { - "originalTransactionId": { - "type": "string", - "maxLength": 32, - "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - }, - "developerId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" - }, - "solutionId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" - } - } - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "commerceIndicator": { - "type": "string", - "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates. When you\nomit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file\nfor you instead of the default value listed here.\n" - }, - "processorId": { - "type": "string", - "maxLength": 3, - "description": "Value that identifies the processor/acquirer to use for the transaction. This value is supported only for\n**CyberSource through VisaNet**.\n\nContact CyberSource Customer Support to get the value for this field.\n" - }, - "paymentSolution": { - "type": "string", - "maxLength": 12, - "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" - }, - "linkId": { - "type": "string", - "maxLength": 26, - "description": "Value that links the current authorization request to the original authorization request. Set this value\nto the ID that was returned in the reply message from the original authorization request.\n\nThis value is used for:\n\n - Partial authorizations: See \"Partial Authorizations,\" page 88.\n - Split shipments: See \"Split Shipments,\" page 210.\n" - }, - "reportGroup": { - "type": "string", - "maxLength": 25, - "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nSee \"Report Groups,\" page 234.\n" - }, - "visaCheckoutId": { - "type": "string", - "maxLength": 48, - "description": "Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in\nthe Visa Checkout **callID** field.\n\nFor more details, see Visa Checkout Using the SCMP API.\n" - }, - "purchaseLevel": { - "type": "string", - "maxLength": 1, - "description": "Set this field to 3 to indicate that the request includes Level III data." - }, - "recurringOptions": { - "type": "object", - "properties": { - "loanPayment": { - "type": "boolean", - "description": "Flag that indicates whether this is a payment towards an existing contractual loan.\n\nPossible values:\n- **true** Loan payment\n- **false** (default) Not a loan payment\n\nSee \"Visa Debt Repayments,\" page 218, for a list of processors that support this feature.\n", - "enum": [ - true, - false - ], - "default": false - } - } - }, - "bankTransferOptions": { - "type": "object", - "properties": { - "customerMemo": { - "type": "string", - "maxLength": 80, - "description": "Payment related information.\n\nThis information is included on the customer\u2019s statement.\n" - }, - "secCode": { - "type": "string", - "maxLength": 3, - "description": "Authorization method used for the transaction. See \"SEC Codes,\" page 89.\n\nTeleCheck Accepts only the following values:\n- **PPD**\n- **TEL**\n- **WEB**\n" - }, - "terminalCity": { - "type": "string", - "maxLength": 4, - "description": "City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction\nwill be declined.\n\nYou cannot include any special characters.\n" - }, - "terminalState": { - "type": "string", - "maxLength": 2, - "description": "State in which the terminal is located. If more than two alphanumeric characters are submitted, the transaction\nwill be declined.\n\nYou cannot include any special characters.\n" - }, - "effectiveDate": { - "type": "string", - "maxLength": 8, - "description": "Effective date for the transaction. The effective date must be within 45 days of the current day. If you do not\ninclude this value, CyberSource sets the effective date to the next business day.\n\nFormat: `MMDDYYYY`\n\nSupported only for the CyberSource ACH Service.\n" - }, - "partialPaymentId": { - "type": "string", - "maxLength": 25, - "description": "Identifier for a partial payment or partial credit.\n\nThe value for each debit request or credit request must be unique within the scope of the order. See \"Multiple\nPartial Credits,\" page 41.\n" - }, - "settlementMethod": { - "type": "string", - "maxLength": 1, - "description": "Method used for settlement.\n\nPossible values:\n- **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- **F**: Facsimile draft (U.S. dollars only)\n- **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nSee \"Settlement Delivery Methods,\" page 44.\n" - } - } - } - } - }, - "paymentInformation": { - "type": "object", - "properties": { - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "maxLength": 20, - "description": "Customer\u2019s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field\nfor the encoded account number.\n\nFor processor-specific information, see the customer_cc_number field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the credit card expires.\n`Format: YYYY`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "type": { - "type": "string", - "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n" - }, - "accountEncoderId": { - "type": "string", - "maxLength": 3, - "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n" - }, - "issueNumber": { - "type": "string", - "maxLength": 5, - "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" - }, - "startMonth": { - "type": "string", - "maxLength": 2, - "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" - }, - "startYear": { - "type": "string", - "maxLength": 4, - "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" - } - } - }, - "bank": { - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "type": { - "type": "string", - "maxLength": 1, - "description": "Account type.\n\nPossible values:\n - **C**: Checking.\n - **G**: General ledger. This value is supported only on Wells Fargo ACH.\n - **S**: Savings (U.S. dollars only).\n - **X**: Corporate checking (U.S. dollars only).\n" - }, - "number": { - "type": "string", - "maxLength": 17, - "description": "Account number.\n\nWhen processing encoded account numbers, use this field for the encoded account number.\n" - }, - "encoderId": { - "type": "string", - "maxLength": 3, - "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor. See \"Encoded Account Numbers,\" page 39.\n" - }, - "checkNumber": { - "type": "string", - "maxLength": 8, - "description": "Check number.\n\nChase Paymentech Solutions - Optional.\nCyberSource ACH Service - Not used.\nRBS WorldPay Atlanta - Optional on debits. Required on credits.\nTeleCheck - Strongly recommended on debit requests. Optional on credits.\n" - }, - "checkImageReferenceNumber": { - "type": "string", - "maxLength": 32, - "description": "Image reference number associated with the check. You cannot include any special characters.\n" - } - } - }, - "routingNumber": { - "type": "string", - "maxLength": 9, - "description": "Bank routing number.\n\nThis is also called the transit number.\n" - } - } - }, - "customer": { - "type": "object", - "properties": { - "customerId": { - "type": "string", - "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" - } - } - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "amountDetails": { - "type": "object", - "properties": { - "totalAmount": { - "type": "string", - "maxLength": 19, - "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - }, - "discountAmount": { - "type": "string", - "maxLength": 15, - "description": "Total discount amount applied to the order.\n\nFor processor-specific information, see the order_discount_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "dutyAmount": { - "type": "string", - "maxLength": 15, - "description": "Total charges for any import or export duties included in the order.\n\nFor processor-specific information, see the duty_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAmount": { - "type": "string", - "maxLength": 12, - "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "nationalTaxIncluded": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates whether a national tax is included in the order total.\n\nPossible values:\n\n - **0**: national tax not included\n - **1**: national tax included\n\nFor processor-specific information, see the national_tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAppliedAfterDiscount": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates how the merchant manages discounts.\n\nPossible values:\n\n - **0**: no invoice level discount included\n - **1**: tax calculated on the postdiscount invoice total\n - **2**: tax calculated on the prediscount invoice total\n\nFor processor-specific information, see the order_discount_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxAppliedLevel": { - "type": "string", - "maxLength": 1, - "description": "Flag that indicates how you calculate tax.\n\nPossible values:\n\n - **0**: net prices with tax calculated at line item level\n - **1**: net prices with tax calculated at invoice level\n - **2**: gross prices with tax provided at line item level\n - **3**: gross prices with tax provided at invoice level\n - **4**: no tax applies on the invoice for the transaction\n\nFor processor-specific information, see the tax_management_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxTypeCode": { - "type": "string", - "maxLength": 3, - "description": "For tax amounts that can be categorized as one tax type.\n\nThis field contains the tax type code that corresponds to the entry in the _lineItems.taxAmount_ field.\n\nPossible values:\n\n - **056**: sales tax (U.S only)\n - **TX~**: all taxes (Canada only) Note ~ = space.\n\nFor processor-specific information, see the total_tax_type_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "freightAmount": { - "type": "string", - "maxLength": 13, - "description": "Total freight or shipping and handling charges for the order. When you include this field in your request, you\nmust also include the **totalAmount** field.\n\nFor processor-specific information, see the freight_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "foreignAmount": { - "type": "string", - "maxLength": 15, - "description": "Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "foreignCurrency": { - "type": "string", - "maxLength": 5, - "description": "Your customer\u2019s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\nFor processor-specific information, see the foreign_currency field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "exchangeRate": { - "type": "string", - "maxLength": 13, - "description": "Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.\n\nFor details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n\nFor processor-specific information, see the exchange_rate field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "exchangeRateTimeStamp": { - "type": "string", - "maxLength": 14, - "description": "Time stamp for the exchange rate. This value is returned by the DCC service.\n\nFormat: `YYYYMMDD~HH:MM` where ~ denotes a space.\n\nFor processor-specific information, see the exchange_rate_timestamp field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "amexAdditionalAmounts": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 3, - "description": "Additional amount type. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "amount": { - "type": "string", - "maxLength": 12, - "description": "Additional amount. This field is supported only for **American Express Direct**.\n\nFor processor-specific information, see the additional_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - } - }, - "taxDetails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", - "enum": [ - "alternate", - "local", - "national", - "vat" - ] - }, - "amount": { - "type": "string", - "maxLength": 13, - "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" - }, - "rate": { - "type": "string", - "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" - }, - "code": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" - }, - "applied": { - "type": "boolean", - "description": "The tax is applied. Valid value is `true` or `false`." - }, - "exemptionCode": { - "type": "string", - "maxLength": 1, - "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" - } - } - } - }, - "serviceFeeAmount": { - "type": "string", - "maxLength": 15, - "description": "Service fee. Required for service fee transactions.\n" - }, - "originalCurrency": { - "type": "string", - "maxLength": 15, - "description": "Your local pricing currency code.\n\nFor the possible values, see the ISO Standard Currency Codes.\n\nFor details, see Dynamic Currency Conversion with a Third Party Provider.\n" - } - } - }, - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "company": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 60, - "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "address1": { - "type": "string", - "maxLength": 40, - "description": "First line in the street address of the company purchasing the product." - }, - "address2": { - "type": "string", - "maxLength": 40, - "description": "Additional address information for the company purchasing the product." - }, - "locality": { - "type": "string", - "maxLength": 30, - "description": "City in the address of the company purchasing the product." - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n" - } - } - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "address2": { - "type": "string", - "maxLength": 60, - "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "locality": { - "type": "string", - "maxLength": 50, - "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "email": { - "type": "string", - "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" - } - } - }, - "shipTo": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the shipping address. Use the two character ISO Standard Country Codes." - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" - } - } - }, - "lineItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "productCode": { - "type": "string", - "maxLength": 255, - "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\n\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\n" - }, - "productName": { - "type": "string", - "maxLength": 255, - "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false` respectively), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other\nvalues that are related to shipping and/or handling.\n" - }, - "productSku": { - "type": "string", - "maxLength": 255, - "description": "Identification code for the product.\n\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n" - }, - "quantity": { - "type": "number", - "minimum": 1, - "maximum": 9999999999, - "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n", - "default": 1 - }, - "unitPrice": { - "type": "string", - "maxLength": 15, - "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" - }, - "unitOfMeasure": { - "type": "string", - "maxLength": 12, - "description": "Unit of measure, or unit of measure code, for the item.\n" - }, - "totalAmount": { - "type": "string", - "maxLength": 13, - "description": "Total amount for the item. Normally calculated as the unit price x quantity.\n" - }, - "taxAmount": { - "type": "string", - "maxLength": 15, - "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n 1. You include each line item in your request.\n ..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n ..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n 2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nIf you want to include the tax amount and also request the ics_tax service, see Tax Calculation Service Using the SCMP API.\n\nThis field is frequently used for Level II and Level III transactions. See Level II and Level III Processing Using the SCMP API.\n" - }, - "taxRate": { - "type": "string", - "maxLength": 7, - "description": "Tax rate applied to the item. See \"Numbered Elements,\" page 14.\n\nVisa: Valid range is 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated).\n\nMastercard: Valid range is 0.00001 to 0.99999 (0.001% to 99.999%).\n" - }, - "taxAppliedAfterDiscount": { - "type": "string", - "maxLength": 1, - "description": "Flag to indicate how you handle discount at the line item level.\n\n - 0: no line level discount provided\n - 1: tax was calculated on the post-discount line item total\n - 2: tax was calculated on the pre-discount line item total\n\n`Note` Visa will inset 0 (zero) if an invalid value is included in this field.\n\nThis field relates to the value in the _lineItems[].discountAmount_ field.\n" - }, - "taxStatusIndicator": { - "type": "string", - "maxLength": 1, - "description": "Flag to indicate whether tax is exempted or not included.\n\n - 0: tax not included\n - 1: tax included\n - 2: transaction is not subject to tax\n" - }, - "taxTypeCode": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "amountIncludesTax": { - "type": "boolean", - "description": "Flag that indicates whether the tax amount is included in the Line Item Total.\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "typeOfSupply": { - "type": "string", - "maxLength": 2, - "description": "Flag to indicate whether the purchase is categorized as goods or services.\nPossible values:\n\n - 00: goods\n - 01: services\n" - }, - "commodityCode": { - "type": "string", - "maxLength": 15, - "description": "Commodity code or International description code used to classify the item. Contact your acquirer for a list of\ncodes.\n" - }, - "discountAmount": { - "type": "string", - "maxLength": 13, - "description": "Discount applied to the item." - }, - "discountApplied": { - "type": "boolean", - "description": "Flag that indicates whether the amount is discounted.\n\nIf you do not provide a value but you set Discount Amount to a value greater than zero, then CyberSource sets\nthis field to **true**.\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "discountRate": { - "type": "string", - "maxLength": 6, - "description": "Rate the item is discounted. Maximum of 2 decimal places.\n\nExample 5.25 (=5.25%)\n" - }, - "invoiceNumber": { - "type": "string", - "maxLength": 23, - "description": "Field to support an invoice number for a transaction. You must specify the number of line items that will\ninclude an invoice number. By default, the first line item will include an invoice number field. The invoice\nnumber field can be included for up to 10 line items.\n" - }, - "taxDetails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "This is used to determine what type of tax related data should be inclued under _taxDetails_ object.\n\nPossible values:\n - alternate\n - local\n - national\n - vat\n", - "enum": [ - "alternate", - "local", - "national", - "vat" - ] - }, - "amount": { - "type": "string", - "maxLength": 13, - "description": "Please see below table for related decription based on above _type_ field.\n\n| type | type description |\n|-----------|--------------------|\n| alternate | Total amount of alternate tax for the order. |\n| local | Sales tax for the order. |\n| national | National tax for the order. |\n| vat | Total amount of VAT or other tax included in the order. |\n| other | Other tax. |\n" - }, - "rate": { - "type": "string", - "maxLength": 6, - "description": "Rate of VAT or other tax for the order.\n\nExample 0.040 (=4%)\n\nValid range: 0.01 to 0.99 (1% to 99%, with only whole percentage values accepted; values with additional\ndecimal places will be truncated)\n" - }, - "code": { - "type": "string", - "maxLength": 4, - "description": "Type of tax being applied to the item. Possible values:\n\nBelow values are used by **RBS WorldPay Atlanta**, **FDC Nashville Global**, **Litle**\n\n - 0000: unknown tax type\n - 0001: federal/national sales tax\n - 0002: state sales tax\n - 0003: city sales tax\n - 0004: local sales tax\n - 0005: municipal sales tax\n - 0006: other tax\n - 0010: value-added tax (VAT)\n - 0011: goods and services tax (GST)\n - 0012: provincial sales tax\n - 0013: harmonized sales tax\n - 0014: Quebec sales tax (QST)\n - 0020: room tax\n - 0021: occupancy tax\n - 0022: energy tax\n - 0023: city tax\n - 0024: county or parish sales tax\n - 0025: county tax\n - 0026: environment tax\n - 0027: state and local sales tax (combined)\n - Blank: Tax not supported on line item.\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your tax ID number to use for the alternate tax amount. Required if you set alternate tax amount to any value,\nincluding zero. You may send this field without sending alternate tax amount.\n" - }, - "applied": { - "type": "boolean", - "description": "The tax is applied. Valid value is `true` or `false`." - }, - "exemptionCode": { - "type": "string", - "maxLength": 1, - "description": "Code for exemption from sales and use tax. This field is a pass-through, which means that CyberSource does not\nverify the value or modify it in any way before sending it to the processor.\n\nFor possible values, see Exemption Status Values. See Numbered Elements.\n\nImportant For information about using this field, see Item-Level Tax Fields.\n" - } - } - } - } - } - } - }, - "invoiceDetails": { - "type": "object", - "properties": { - "purchaseOrderNumber": { - "type": "string", - "maxLength": 25, - "description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n\nFor processor-specific information, see the user_po field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "purchaseOrderDate": { - "type": "string", - "maxLength": 10, - "description": "Date the order was processed. `Format: YYYY-MM-DD`.\n\nFor processor-specific information, see the purchaser_order_date field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "purchaseContactName": { - "type": "string", - "maxLength": 36, - "description": "The name of the individual or the company contacted for company authorized purchases.\n\nFor processor-specific information, see the authorized_contact_name field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxable": { - "type": "boolean", - "description": "Flag that indicates whether an order is taxable. This value must be true if the sum of all _lineItems[].taxAmount_ values > 0.\n\nIf you do not include any _lineItems[].taxAmount_ values in your request, CyberSource does not include\n_invoiceDetails.taxable_ in the data it sends to the processor.\n\nFor processor-specific information, see the tax_indicator field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n - **true**\n - **false**\n", - "enum": [ - true, - false - ] - }, - "vatInvoiceReferenceNumber": { - "type": "string", - "maxLength": 15, - "description": "VAT invoice number associated with the transaction.\n\nFor processor-specific information, see the vat_invoice_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "commodityCode": { - "type": "string", - "maxLength": 4, - "description": "International description code of the overall order\u2019s goods or services or the Categorizes purchases for VAT\nreporting. Contact your acquirer for a list of codes.\n\nFor processor-specific information, see the summary_commodity_code field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "transactionAdviceAddendum": { - "type": "array", - "items": { - "type": "object", - "properties": { - "data": { - "type": "string", - "maxLength": 40, - "description": "Four Transaction Advice Addendum (TAA) fields. These fields are used to display descriptive information\nabout a transaction on the customer\u2019s American Express card statement. When you send TAA fields, start\nwith amexdata_taa1, then ...taa2, and so on. Skipping a TAA field causes subsequent TAA fields to be\nignored.\n\nTo use these fields, contact CyberSource Customer Support to have your account enabled for this feature.\n" - } - } - } - } - } - }, - "shippingDetails": { - "type": "object", - "properties": { - "shipFromPostalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the address from which the goods are shipped, which is used to establish nexus. The default is\nthe postal code associated with your CyberSource account.\n\nThe postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code\nmust follow this format:\n\n`[5 digits][dash][4 digits]`\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n\n`[alpha][numeric][alpha][space] [numeric][alpha][numeric]`\n\nExample A1B 2C3\n\nThis field is frequently used for Level II and Level III transactions.\n" - } - } - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "merchantCustomerId": { - "type": "string", - "maxLength": 100, - "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 20, - "description": "Customer\u2019s government-assigned tax identification number.\n\nFor processor-specific information, see the purchaser_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - } - } - }, - "deviceInformation": { - "type": "object", - "properties": { - "hostName": { - "type": "string", - "maxLength": 60, - "description": "DNS resolved hostname from above _ipAddress_." - }, - "ipAddress": { - "type": "string", - "maxLength": 15, - "description": "IP address of the customer." - }, - "userAgent": { - "type": "string", - "maxLength": 40, - "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n" - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" - }, - "alternateName": { - "type": "string", - "maxLength": 13, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "contact": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n" - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "locality": { - "type": "string", - "maxLength": 13, - "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - }, - "categoryCode": { - "type": "integer", - "maximum": 9999, - "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR4\n- Position: 150-153\n- Field: Merchant Category Code\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "cardAcceptorReferenceNumber": { - "type": "string", - "maxLength": 25, - "description": "Reference number that facilitates card acceptor/corporation communication and record keeping.\n\nFor processor-specific information, see the card_acceptor_ref_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "taxId": { - "type": "string", - "maxLength": 15, - "description": "Your Cadastro Nacional da Pessoa Jur\u00eddica (CNPJ) number.\n\nThis field is supported only for BNDES transactions on CyberSource through VisaNet. See BNDES.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR6\n- Position: 40-59\n- Field: BNDES Reference Field 1\n" - } - } - }, - "aggregatorInformation": { - "type": "object", - "properties": { - "aggregatorId": { - "type": "string", - "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n**CyberSource through VisaNet**\\\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCR6\n- Position: 95-105\n- Field: MasterCard Payment Facilitator ID\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nccAuthService\\\n**American Express Direct**: R for all aggregator transactions.\\\n**CyberSource through VisaNet**: R for Mastercard aggregator transactions and for American Express aggregator authorizations; otherwise, not used.\\\n**FDC Compass**: R for all aggregator transactions.\\\n**FDC Nashville Global**: R for all aggregator transactions.\n\nFor processor-specific information, see the aggregator_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "name": { - "type": "string", - "maxLength": 37, - "description": "Your payment aggregator business name.\n\n**American Express Direct**\\\nThe maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters.\\\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the aggregator name depends on the length of the sub-merchant name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor processor-specific information, see the aggregator_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "subMerchant": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 37, - "description": "Sub-merchant\u2019s business name.\n\n**American Express Direct**\\\nThe maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters.\n\n**CyberSource through VisaNet**\\\nWith American Express, the maximum length of the sub-merchant name depends on the length of the aggregator name. The combined length for both values must not exceed 36 characters. The value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\n**FDC Nashville Global**\\\nWith Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name:\n- If aggregator name length is 1 through 3, maximum sub-merchant name length is 21.\n- If aggregator name length is 4 through 7, maximum sub-merchant name length is 17.\n- If aggregator name length is 8 through 12, maximum sub-merchant name length is 12.\n" - }, - "address1": { - "type": "string", - "maxLength": 38, - "description": "First line of the sub-merchant\u2019s street address.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "locality": { - "type": "string", - "maxLength": 21, - "description": "Sub-merchant\u2019s city.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nFor details, see \"Aggregator Support,\" page 100.\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Sub-merchant\u2019s state or province. Use the State, Province, and Territory Codes for the United States and Canada.\n\nSee \"Aggregator Support,\" page 100.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 15, - "description": "Partial postal code for the sub-merchant\u2019s address.\n\nSee \"Aggregator Support,\" page 100 for details.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file5.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n" - }, - "country": { - "type": "string", - "maxLength": 3, - "description": "Sub-merchant\u2019s country. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\\\nThe value for this field does not map to the TC 33 capture file.\n\n**FDC Compass**\\\nThis value must consist of uppercase characters.\n\nSee \"Aggregator Support,\" page 101.\n" - }, - "email": { - "type": "string", - "maxLength": 40, - "description": "Sub-merchant\u2019s email address.\n\n**Maximum length for processors**\n\n - American Express Direct: 40\n - CyberSource through VisaNet: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCRB\n- Position: 25-64\n- Field: American Express Seller E-mail Address\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 20, - "description": "Sub-merchant\u2019s telephone number.\n\n**Maximum length for procesors**\n\n - American Express Direct: 20\n - CyberSource through VisaNet: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n**CyberSource through VisaNet**\\\nWith American Express, the value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP01 TCRB\n- Position: 5-24\n- Field: American Express Seller Telephone Number\n\n**FDC Compass**\\\nThis value must consist of uppercase characters. Use one of these recommended formats:\\\n`NNN-NNN-NNNN`\\\n`NNN-AAAAAAA`\n" - } - } - } - } - }, - "pointOfSaleInformation": { - "type": "object", - "properties": { - "emv": { - "type": "object", - "properties": { - "tags": { - "type": "string", - "maxLength": 1998, - "description": "EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV\ndata is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.\n\nSee \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the \u201cApplication Specification\u201d section in the EMV 4.3 Specifications: http://emvco.com\n\n**Important** The following tags contain sensitive information and **must not** be included in this field:\n\n - **56**: Track 1 equivalent data\n - **57**: Track 2 equivalent data\n - **5A**: Application PAN\n - **5F20**: Cardholder name\n - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)\n - **99**: Transaction PIN\n - **9F0B**: Cardholder name (extended)\n - **9F1F**: Track 1 discretionary data\n - **9F20**: Track 2 discretionary data\n\nFor captures, this field is required for contact EMV transactions. Otherwise, it is optional.\n\nFor credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits.\nOtherwise, it is optional.\n\n**Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits,\nyou must include the following tags in this field. For all other types of EMV transactions, the following tags\nare optional.\n\n - **95**: Terminal verification results\n - **9F10**: Issuer application data\n - **9F26**: Application cryptogram\n" - }, - "fallback": { - "type": "boolean", - "maxLength": 5, - "description": "Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.\n\nPossible values:\n - **true**\n - **false** (default)\n\nThis field is supported only on **Chase Paymentech Solutions** and **GPN**.\n", - "enum": [ - true, - false - ], - "default": false - }, - "fallbackCondition": { - "type": "number", - "description": "Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for\none of these reasons:\n\n - Technical failure: the EMV terminal or EMV card cannot read and process chip data.\n - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card.\n EMV terminals are coded to determine whether the terminal and EMV card have any applications in common.\n EMV terminals provide this information to you.\n\nPossible values:\n\n - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal either used information from a successful chip read or it was not a chip transaction.\n - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the\n EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.\n\nThis field is supported only on **GPN**.\n\n**NOTE**: Merchants must include this field in a request whenever a transaction must fall back to swiped mode.\n" - } - } - }, - "partnerSdkVersion": { - "type": "string", - "maxLength": 32, - "description": "Version of the software installed on the POS terminal. This value is provided by the client software that is\ninstalled on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - }, - "storeAndForwardIndicator": { - "type": "string", - "maxLength": 1, - "description": "When connectivity is unavailable, the client software that is installed on the POS terminal can store a\ntransaction in its memory and send it for authorization when connectivity is restored. This value is provided by\nthe client software that is installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nPossible values:\n- Y: Transaction was stored and then forwarded.\n- N (default): Transaction was not stored and then forwarded.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - }, - "cardholderVerificationMethod": { - "type": "array", - "items": { - "type": "string", - "description": "Complete list of cardholder verification methods (CVMs) supported by the terminal.\n\nPossible values:\n- PIN\n- Signature\n\n**NOTE**: You can submit one of the values or both in a request.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - }, - "example": [ - "PIN", - "Signature" - ] - }, - "terminalInputCapability": { - "type": "array", - "items": { - "description": "Complete list of card input methods supported by the terminal.\n\nPossible values:\n- Keyed: Terminal can accept card data that is entered manually.\n- Swiped: Terminal can accept card data from a magnetic stripe reader.\n- Contact: Terminal can accept card data in EMV contact mode.\n- Contactless: Terminal can accept card data in EMV contactless mode.\n- BarCode: Terminal can read bar codes.\n- QRcode: Terminal can read QR codes.\n- OCR: Terminal can perform optical character recognition (OCT).\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n", - "type": "string" - }, - "example": [ - "Keyed", - "Swiped", - "Contact", - "QRcode" - ] - }, - "terminalSerialNumber": { - "type": "string", - "maxLength": 32, - "description": "Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that\nis installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - }, - "terminalCardCaptureCapability": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether the terminal can capture the card.\n\nPossible values:\n- 1: Terminal can capture card.\n- 0: Terminal cannot capture card.\n\nThis field is supported only on American Express Direct.\n" - }, - "terminalOutputCapability": { - "type": "string", - "maxLength": 1, - "description": "Indicates whether the terminal can print or display messages.\n\nPossible values:\n- 1: Neither\n- 2: Print only\n- 3: Display only\n- 4: Print and display\n\nThis field is supported only on American Express Direct.\n" - }, - "terminalPinCapability": { - "type": "integer", - "description": "Maximum PIN length that the terminal can capture.\n\nPossible values:\n- 0: No PIN capture capability\n- 1: PIN capture capability unknown\n- 4: Four characters\n- 5: Five characters\n- 6: Six characters\n- 7: Seven characters\n- 8: Eight characters\n- 9: Nine characters\n- 10: Ten characters\n- 11: Eleven characters\n- 12: Twelve characters\n\nThis field is supported only on American Express Direct and SIX.\n" - }, - "deviceId": { - "type": "string", - "maxLength": 32, - "description": "Value created by the client software that uniquely identifies the POS device. This value is provided by the\nclient software that is installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" - } - } - }, - "merchantDefinedInformation": { - "type": "array", - "description": "The description for this field is not available.", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "maxLength": 50, - "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n" - }, - "value": { - "type": "string", - "maxLength": 255, - "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" - } - } - } - } - }, - "example": { - "clientReferenceInformation": { - "code": "12345678" - }, - "orderInformation": { - "billTo": { - "country": "US", - "firstName": "Test", - "lastName": "test", - "phoneNumber": "9999999999", - "address1": "test", - "postalCode": "48104-2201", - "locality": "Ann Arbor", - "administrativeArea": "MI", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "200", - "currency": "usd" - } - }, - "paymentInformation": { - "card": { - "expirationYear": "2031", - "number": "4111111111111111", - "expirationMonth": "03", - "type": "001" - } - } - } - } - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "title": "ptsV2CreditsPost201Response", - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - }, - "void": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - }, - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - PENDING\n", - "enum": [ - "PENDING" - ] - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "submitLocalDateTime": { - "type": "string", - "maxLength": 14, - "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" - }, - "ownerMerchantId": { - "type": "string", - "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" - } - } - }, - "creditAmountDetails": { - "type": "object", - "properties": { - "creditAmount": { - "type": "string", - "maxLength": 15, - "description": "Total amount of the credit." - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "bankTransferOptions": { - "type": "object", - "properties": { - "settlementMethod": { - "type": "string", - "maxLength": 1, - "description": "Method used for settlement.\n\nPossible values:\n- **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars)\n- **F**: Facsimile draft (U.S. dollars only)\n- **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your\nmerchant ID)\n\nSee \"Settlement Delivery Methods,\" page 44.\n" - } - } - } - } - }, - "processorInformation": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "maxLength": 18, - "description": "Processor transaction ID.\n\nThis value identifies the transaction on a host system. This value is supported only for Moneris. It contains\nthis information:\n\n - Terminal used to process the transaction\n - Shift during which the transaction took place\n - Batch number\n - Transaction number within the batch\n\nYou must store this value. If you give the customer a receipt, display this value on the receipt.\n\nExample For the value 66012345001069003:\n\n - Terminal ID = 66012345\n - Shift number = 001\n - Batch number = 069\n - Transaction number = 003\n" - }, - "forwardedAcquirerCode": { - "type": "string", - "maxLength": 32, - "description": "Name of the Japanese acquirer that processed the transaction. Returned only for CCS (CAFIS) and JCN Gateway.\nPlease contact the CyberSource Japan Support Group for more information.\n" - }, - "merchantNumber": { - "type": "string", - "maxLength": 15, - "description": "Identifier that was assigned to you by your acquirer.\n\nThis value must be printed on the receipt.\n\nThis field is supported only on **American Express Direct**, **FDC Nashville Global**, and **SIX**.\n" - }, - "responseCode": { - "type": "string", - "maxLength": 10, - "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n" - }, - "achVerification": { - "type": "object", - "properties": { - "resultCode": { - "type": "string", - "maxLength": 2, - "description": "Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible\nvalues, see Appendix H, \"Verification Codes,\" on page 91.\n" - }, - "resultCodeRaw": { - "type": "string", - "maxLength": 10, - "description": "Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the\npossible values, see Appendix H, \"Verification Codes,\" on page 91.\n" - } - } - } - } - }, - "paymentInformation": { - "type": "object", - "properties": { - "bank": { - "type": "object", - "properties": { - "account": { - "type": "object", - "properties": { - "correctedAccountNumber": { - "type": "string", - "maxLength": 17, - "description": "Corrected account number from the ACH verification service, which is described in \"ACH Verification,\" page 25.\n" - } - } - }, - "correctedRoutingNumber": { - "type": "string", - "maxLength": 9, - "description": "The description for this field is not available." - } - } - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "invoiceDetails": { - "type": "object", - "properties": { - "level3TransmissionStatus": { - "type": "boolean", - "description": "Indicates whether CyberSource sent the Level III information to the processor. The possible values are:\n\nIf your account is not enabled for Level III data or if you did not include the purchasing level field in your\nrequest, CyberSource does not include the Level III data in the request sent to the processor.\n\nFor processor-specific information, see the bill_purchasing_level3_enabled field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n\nPossible values:\n- **true**\n- **false**\n", - "enum": [ - true, - false - ] - } - } - } - } - } - }, - "example": { - "_links": { - "self": { - "href": "/pts/v2/credits/4963014324246004901546", - "method": "GET" - }, - "void": { - "href": "/pts/v2/credits/4963014324246004901546/voids", - "method": "POST" - } - }, - "id": "4963014324246004901546", - "submitTimeUtc": "2017-06-01T071712Z", - "status": "200", - "reconciliationId": "39570714X3E1LBQ8", - "statusInformation": { - "reason": "SUCCESS", - "message": "Successful transaction." - }, - "clientReferenceInformation": { - "code": "12345678" - }, - "creditAmountDetails": { - "currency": "usd", - "creditAmount": "200.00" - }, - "orderInformation": { - "amountDetails": { - "currency": "usd" - } - } - } - } - }, - "400": { - "description": "Invalid request.", - "schema": { - "title": "ptsV2CreditsPost400Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", - "enum": [ - "INVALID_REQUEST" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - INVALID_MERCHANT_CONFIGURATION\n - INVALID_AMOUNT\n - CAPTURE_ALREADY_VOIDED\n - ACCOUNT_NOT_ALLOWED_CREDIT\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA", - "DUPLICATE_REQUEST", - "INVALID_CARD", - "INVALID_MERCHANT_CONFIGURATION", - "CAPTURE_ALREADY_VOIDED", - "ACCOUNT_NOT_ALLOWED_CREDIT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - } - }, - "502": { - "description": "Unexpected system error or system timeout.", - "schema": { - "title": "ptsV2CreditsPost502Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", - "enum": [ - "SERVER_ERROR" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", - "enum": [ - "SYSTEM_ERROR", - "SERVER_TIMEOUT", - "SERVICE_TIMEOUT", - "PROCESSOR_TIMEOUT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - } - } - } - } - }, - "x-example": { - "example0": { - "summary": "Credit", - "value": { - "clientReferenceInformation": { - "code": "12345678" - }, - "orderInformation": { - "billTo": { - "country": "US", - "firstName": "John", - "lastName": "Deo", - "phoneNumber": "9321499232", - "address1": "900 Metro Center Blvd", - "postalCode": "48104-2201", - "locality": "Foster City", - "administrativeArea": "CA", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "200", - "currency": "usd" - } - }, - "paymentInformation": { - "card": { - "expirationYear": "2031", - "number": "4111111111111111", - "expirationMonth": "03", - "type": "001" - } - } - } - }, - "example1": { - "summary": "Electronic Check Stand-Alone Credits", - "value": { - "clientReferenceInformation": { - "code": "TC46125-1" - }, - "processingInformation": { - "commerceIndicator": "internet" - }, - "orderInformation": { - "billTo": { - "firstName": "John", - "lastName": "Doe", - "address1": "1 Market St", - "postalCode": "94105", - "locality": "san francisco", - "administrativeArea": "CA", - "country": "US", - "phoneNumber": "4158880000", - "company": "Visa", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "100", - "currency": "USD" - } - }, - "paymentInformation": { - "bank": { - "account": { - "number": "4100", - "type": "C", - "checkNumber": "123456" - }, - "routingNumber": "071923284" - } - } - } - }, - "example2": { - "summary": "Service Fees Credit", - "value": { - "clientReferenceInformation": { - "code": "12345678" - }, - "orderInformation": { - "billTo": { - "firstName": "John", - "lastName": "Doe", - "address1": "1 Market St", - "postalCode": "94105", - "locality": "san francisco", - "administrativeArea": "CA", - "country": "US", - "phoneNumber": "4158880000", - "company": "Visa", - "email": "test@cybs.com" - }, - "amountDetails": { - "totalAmount": "2325.00", - "currency": "usd", - "serviceFeeAmount": "30.0" - } - }, - "paymentInformation": { - "card": { - "expirationYear": "2031", - "number": "4111111111111111", - "expirationMonth": "03" - } - } - } - } - } - } - }, - "/pts/v2/payments/{id}/voids": { - "post": { - "summary": "Void a Payment", - "description": "Include the payment ID in the POST request to cancel the payment.", - "tags": [ - "void" - ], - "operationId": "voidPayment", - "x-devcenter-metaData": { - "categoryTag": "Payments" - }, - "parameters": [{ - "name": "voidPaymentRequest", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "comments": { - "type": "string", - "description": "Comments" - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" - }, - "solutionId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" - } - } - } - } - } - }, - "example": { - "clientReferenceInformation": { - "code": "test_void" - } - } - } - }, { - "name": "id", - "in": "path", - "description": "The payment ID returned from a previous payment request.", - "required": true, - "type": "string" - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "title": "ptsV2PaymentsVoidsPost201Response", - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - }, - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - VOIDED\n", - "enum": [ - "VOIDED" - ] - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "submitLocalDateTime": { - "type": "string", - "maxLength": 14, - "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" - }, - "ownerMerchantId": { - "type": "string", - "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" - } - } - }, - "voidAmountDetails": { - "type": "object", - "properties": { - "voidAmount": { - "type": "string", - "description": "Total amount of the void." - }, - "originalTransactionAmount": { - "type": "string", - "description": "Amount of the original transaction." - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - } - } - } - }, - "example": { - "_links": { - "self": { - "href": "/pts/v2/voids/4963015122056179201545", - "method": "GET" - } - }, - "id": "4963015122056179201545", - "submitTimeUtc": "2017-06-01T071832Z", - "status": "VOIDED", - "clientReferenceInformation": { - "code": "test_void" - }, - "orderInformation": { - "amountDetails": { - "currency": "USD" - } - }, - "voidAmountDetails": { - "currency": "usd", - "voidAmount": "102.21" - } - } - } - }, - "400": { - "description": "Invalid request.", - "schema": { - "title": "ptsV2PaymentsVoidsPost400Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", - "enum": [ - "INVALID_REQUEST" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - NOT_VOIDABLE\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA", - "DUPLICATE_REQUEST", - "INVALID_MERCHANT_CONFIGURATION", - "NOT_VOIDABLE" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - } - }, - "502": { - "description": "Unexpected system error or system timeout.", - "schema": { - "title": "ptsV2PaymentsVoidsPost502Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", - "enum": [ - "SERVER_ERROR" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", - "enum": [ - "SYSTEM_ERROR", - "SERVER_TIMEOUT", - "SERVICE_TIMEOUT", - "PROCESSOR_TIMEOUT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - } - } - } - } - }, - "x-example": { - "example0": null, - "summary": "Void a Payment", - "value": { - "clientReferenceInformation": { - "code": "test_void" - } - } - } - } - }, - "/pts/v2/captures/{id}/voids": { - "post": { - "summary": "Void a Capture", - "description": "Include the capture ID in the POST request to cancel the capture.", - "tags": [ - "void" - ], - "operationId": "voidCapture", - "x-devcenter-metaData": { - "categoryTag": "Payments" - }, - "parameters": [{ - "name": "voidCaptureRequest", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "comments": { - "type": "string", - "description": "Comments" - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" - }, - "solutionId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" - } - } - } - } - } - }, - "example": { - "clientReferenceInformation": { - "code": "test_void" - } - } - } - }, { - "name": "id", - "in": "path", - "description": "The capture ID returned from a previous capture request.", - "required": true, - "type": "string" - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "title": "ptsV2CapturesVoidsPost201Response", - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - }, - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - VOIDED\n", - "enum": [ - "VOIDED" - ] - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "submitLocalDateTime": { - "type": "string", - "maxLength": 14, - "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" - }, - "ownerMerchantId": { - "type": "string", - "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" - } - } - }, - "voidAmountDetails": { - "type": "object", - "properties": { - "voidAmount": { - "type": "string", - "description": "Total amount of the void." - }, - "originalTransactionAmount": { - "type": "string", - "description": "Amount of the original transaction." - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - } - } - } - }, - "example": { - "_links": { - "self": { - "href": "/pts/v2/voids/4963015122056179201545", - "method": "GET" - } - }, - "id": "4963015122056179201545", - "submitTimeUtc": "2017-06-01T071832Z", - "status": "VOIDED", - "clientReferenceInformation": { - "code": "test_void" - }, - "orderInformation": { - "amountDetails": { - "currency": "USD" - } - }, - "voidAmountDetails": { - "currency": "usd", - "voidAmount": "102.21" - } - } - } - }, - "400": { - "description": "Invalid request.", - "schema": { - "title": "ptsV2CapturesVoidsPost400Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", - "enum": [ - "INVALID_REQUEST" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - NOT_VOIDABLE\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA", - "DUPLICATE_REQUEST", - "INVALID_MERCHANT_CONFIGURATION", - "NOT_VOIDABLE" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - } - }, - "502": { - "description": "Unexpected system error or system timeout.", - "schema": { - "title": "ptsV2CapturesVoidsPost502Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", - "enum": [ - "SERVER_ERROR" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", - "enum": [ - "SYSTEM_ERROR", - "SERVER_TIMEOUT", - "SERVICE_TIMEOUT", - "PROCESSOR_TIMEOUT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - } - } - } - } - }, - "x-example": { - "example0": null, - "summary": "Void a Capture", - "value": { - "clientReferenceInformation": { - "code": "test_void" - } - } - } - } - }, - "/pts/v2/refunds/{id}/voids": { - "post": { - "summary": "Void a Refund", - "description": "Include the refund ID in the POST request to cancel the refund.", - "tags": [ - "void" - ], - "operationId": "voidRefund", - "x-devcenter-metaData": { - "categoryTag": "Payments" - }, - "parameters": [{ - "name": "voidRefundRequest", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "comments": { - "type": "string", - "description": "Comments" - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" - }, - "solutionId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" - } - } - } - } - } - }, - "example": { - "clientReferenceInformation": { - "code": "test_void" - } - } - } - }, { - "name": "id", - "in": "path", - "description": "The refund ID returned from a previous refund request.", - "required": true, - "type": "string" - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "title": "ptsV2RefundsVoidsPost201Response", - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - }, - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - VOIDED\n", - "enum": [ - "VOIDED" - ] - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "submitLocalDateTime": { - "type": "string", - "maxLength": 14, - "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" - }, - "ownerMerchantId": { - "type": "string", - "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" - } - } - }, - "voidAmountDetails": { - "type": "object", - "properties": { - "voidAmount": { - "type": "string", - "description": "Total amount of the void." - }, - "originalTransactionAmount": { - "type": "string", - "description": "Amount of the original transaction." - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - } - } - } - }, - "example": { - "_links": { - "self": { - "href": "/pts/v2/voids/4963015122056179201545", - "method": "GET" - } - }, - "id": "4963015122056179201545", - "submitTimeUtc": "2017-06-01T071832Z", - "status": "VOIDED", - "clientReferenceInformation": { - "code": "test_void" - }, - "orderInformation": { - "amountDetails": { - "currency": "USD" - } - }, - "voidAmountDetails": { - "currency": "usd", - "voidAmount": "102.21" - } - } - } - }, - "400": { - "description": "Invalid request.", - "schema": { - "title": "ptsV2RefundsVoidsPost400Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", - "enum": [ - "INVALID_REQUEST" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - NOT_VOIDABLE\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA", - "DUPLICATE_REQUEST", - "INVALID_MERCHANT_CONFIGURATION", - "NOT_VOIDABLE" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - } - }, - "502": { - "description": "Unexpected system error or system timeout.", - "schema": { - "title": "ptsV2RefundsVoidsPost502Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", - "enum": [ - "SERVER_ERROR" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", - "enum": [ - "SYSTEM_ERROR", - "SERVER_TIMEOUT", - "SERVICE_TIMEOUT", - "PROCESSOR_TIMEOUT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - } - } - } - } - }, - "x-example": { - "example0": { - "summary": "Void a Refund", - "value": { - "clientReferenceInformation": { - "code": "test_void" - } - } - } - } - } - }, - "/pts/v2/credits/{id}/voids": { - "post": { - "summary": "Void a Credit", - "description": "Include the credit ID in the POST request to cancel the credit.", - "tags": [ - "void" - ], - "operationId": "voidCredit", - "x-devcenter-metaData": { - "categoryTag": "Payments" - }, - "parameters": [{ - "name": "voidCreditRequest", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "comments": { - "type": "string", - "description": "Comments" - }, - "partner": { - "type": "object", - "properties": { - "developerId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" - }, - "solutionId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" - } - } - } - } - } - }, - "example": { - "clientReferenceInformation": { - "code": "test_void" - } - } - } - }, { - "name": "id", - "in": "path", - "description": "The credit ID returned from a previous credit request.", - "required": true, - "type": "string" - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "title": "ptsV2CreditsVoidsPost201Response", - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - }, - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - VOIDED\n", - "enum": [ - "VOIDED" - ] - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API.\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" - }, - "submitLocalDateTime": { - "type": "string", - "maxLength": 14, - "description": "Date and time at your physical location.\n\nFormat: `YYYYMMDDhhmmss`, where YYYY = year, MM = month, DD = day, hh = hour, mm = minutes ss = seconds\n" - }, - "ownerMerchantId": { - "type": "string", - "description": "Merchant ID that was used to create the subscription or customer profile for which the service was requested.\n\nIf your CyberSource account is enabled for Recurring Billing, this field is returned only if you are using\nsubscription sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the subscription sharing information in Recurring Billing Using the Simple Order API.\n\nIf your CyberSource account is enabled for Payment Tokenization, this field is returned only if you are using\nprofile sharing and if your merchant ID is in the same merchant ID pool as the owner merchant ID.\n\nSee the profile sharing information in Payment Tokenization Using the Simple Order API.\n" - } - } - }, - "voidAmountDetails": { - "type": "object", - "properties": { - "voidAmount": { - "type": "string", - "description": "Total amount of the void." - }, - "originalTransactionAmount": { - "type": "string", - "description": "Amount of the original transaction." - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" - } - } - } - }, - "example": { - "_links": { - "self": { - "href": "/pts/v2/voids/4963015122056179201545", - "method": "GET" - } - }, - "id": "4963015122056179201545", - "submitTimeUtc": "2017-06-01T071832Z", - "status": "VOIDED", - "clientReferenceInformation": { - "code": "test_void" - }, - "orderInformation": { - "amountDetails": { - "currency": "USD" - } - }, - "voidAmountDetails": { - "currency": "usd", - "voidAmount": "102.21" - } - } - } - }, - "400": { - "description": "Invalid request.", - "schema": { - "title": "ptsV2CreditsVoidsPost400Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", - "enum": [ - "INVALID_REQUEST" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - NOT_VOIDABLE\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA", - "DUPLICATE_REQUEST", - "INVALID_MERCHANT_CONFIGURATION", - "NOT_VOIDABLE" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - } - }, - "502": { - "description": "Unexpected system error or system timeout.", - "schema": { - "title": "ptsV2CreditsVoidsPost502Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", - "enum": [ - "SERVER_ERROR" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", - "enum": [ - "SYSTEM_ERROR", - "SERVER_TIMEOUT", - "SERVICE_TIMEOUT", - "PROCESSOR_TIMEOUT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - } - } - } - } - }, - "x-example": { - "example0": { - "summary": "Void a Credit", - "value": { - "clientReferenceInformation": { - "code": "test_void" - } - } - } - } - } - }, - "/pts/v1/transaction-batches": { - "get": { - "summary": "Get a list of batch files", - "description": "Provide the search range", - "operationId": "getTransactionBatches", - "tags": [ - "TransactionBatches" - ], - "x-devcenter-metaData": { - "categoryTag": "Transaction_Batches" - }, - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "startTime", - "in": "query", - "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n", - "required": true, - "type": "string", - "format": "date-time" - }, { - "name": "endTime", - "in": "query", - "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n", - "required": true, - "type": "string", - "format": "date-time" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "title": "ptsV1TransactionBatchesGet200Response", - "type": "object", - "properties": { - "transactionBatches": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier assigned to the batch file.", - "example": "psy8s1d", - "pattern": "^[a-zA-Z0-9_+-]*$", - "minLength": 1, - "maxLength": 8 - }, - "uploadDate": { - "type": "string", - "description": "Date when the batch template was update.", - "example": "2018-01-01" - }, - "completionDate": { - "type": "string", - "description": "The date when the batch template processing completed.", - "example": "2018-01-01" - }, - "transactionCount": { - "type": "integer", - "description": "Number of transactions in the transaction.", - "example": 7534 - }, - "acceptedTransactionCount": { - "type": "integer", - "description": "Number of transactions accepted.", - "example": 50013 - }, - "rejectedTransactionCount": { - "type": "string", - "description": "Number of transactions rejected.", - "example": 2508 - }, - "status": { - "type": "string", - "description": "The status of you batch template processing.", - "example": "Completed" - } - } - } - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "/pts/v1/transaction-batches" - }, - "method": { - "type": "string", - "example": "GET" - } - } - } - } - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - } - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "title": "ptsV1TransactionBatchesGet400Response", - "type": "object", - "properties": { - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string" - }, - "message": { - "type": "string" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" - }, - "message": { - "type": "string", - "description": "The detailed message related to the status and reason listed above.\n" - } - } - } - } - } - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - } - } - } - }, - "401": { - "description": "Not Authorized", - "schema": { - "title": "ptsV1TransactionBatchesGet401Response", - "type": "object", - "properties": { - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string" - }, - "message": { - "type": "string" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" - }, - "message": { - "type": "string", - "description": "The detailed message related to the status and reason listed above.\n" - } - } - } - } - } - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - } - } - } - }, - "403": { - "description": "No Authenticated", - "schema": { - "title": "ptsV1TransactionBatchesGet403Response", - "type": "object", - "properties": { - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string" - }, - "message": { - "type": "string" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" - }, - "message": { - "type": "string", - "description": "The detailed message related to the status and reason listed above.\n" - } - } - } - } - } - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - } - } - } - }, - "404": { - "description": "No Reports Found", - "schema": { - "title": "ptsV1TransactionBatchesGet404Response", - "type": "object", - "properties": { - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string" - }, - "message": { - "type": "string" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" - }, - "message": { - "type": "string", - "description": "The detailed message related to the status and reason listed above.\n" - } - } - } - } - } - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - } - } - } - }, - "500": { - "description": "Bad Gateway", - "schema": { - "title": "ptsV1TransactionBatchesGet500Response", - "type": "object", - "properties": { - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "description": "The reason of status" - }, - "message": { - "type": "string", - "description": "The detailed message related to the status and reason listed above." - } - } - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - } - } - } - } - } - } - }, - "/pts/v1/transaction-batches/{id}": { - "get": { - "summary": "Get individual batch file", - "description": "Provide the search range", - "operationId": "getTransactionBatchId", - "tags": [ - "TransactionBatches" - ], - "x-devcenter-metaData": { - "categoryTag": "Transaction_Batches" - }, - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "id", - "in": "path", - "description": "The batch id assigned for the template.", - "required": true, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "title": "ptsV1TransactionBatchesIdGet200Response", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Unique identifier assigned to the batch file.", - "example": "psy8s1d", - "pattern": "^[a-zA-Z0-9_+-]*$", - "minLength": 1, - "maxLength": 8 - }, - "uploadDate": { - "type": "string", - "description": "Date when the batch template was update.", - "example": "2018-01-01" - }, - "completionDate": { - "type": "string", - "description": "The date when the batch template processing completed.", - "example": "2018-01-01" - }, - "transactionCount": { - "type": "integer", - "description": "Number of transactions in the transaction.", - "example": 7534 - }, - "acceptedTransactionCount": { - "type": "integer", - "description": "Number of transactions accepted.", - "example": 50013 - }, - "rejectedTransactionCount": { - "type": "string", - "description": "Number of transactions rejected.", - "example": 2508 - }, - "status": { - "type": "string", - "description": "The status of you batch template processing.", - "example": "Completed" - }, - "_links": { - "type": "object", - "properties": { - "transactions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "Self link for this request", - "example": "v1/payments/5289798134206292501013" - }, - "method": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "400": { - "description": "Bad Request", - "schema": { - "title": "ptsV1TransactionBatchesIdGet400Response", - "type": "object", - "properties": { - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string" - }, - "message": { - "type": "string" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" - }, - "message": { - "type": "string", - "description": "The detailed message related to the status and reason listed above.\n" - } - } - } - } - } - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - } - } - } - }, - "401": { - "description": "Not Authorized", - "schema": { - "title": "ptsV1TransactionBatchesIdGet401Response", - "type": "object", - "properties": { - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string" - }, - "message": { - "type": "string" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" - }, - "message": { - "type": "string", - "description": "The detailed message related to the status and reason listed above.\n" - } - } - } - } - } - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - } - } - } - }, - "403": { - "description": "No Authenticated", - "schema": { - "title": "ptsV1TransactionBatchesIdGet403Response", - "type": "object", - "properties": { - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string" - }, - "message": { - "type": "string" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" - }, - "message": { - "type": "string", - "description": "The detailed message related to the status and reason listed above.\n" - } - } - } - } - } - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - } - } - } - }, - "404": { - "description": "No Reports Found", - "schema": { - "title": "ptsV1TransactionBatchesIdGet404Response", - "type": "object", - "properties": { - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string" - }, - "message": { - "type": "string" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid.\n" - }, - "message": { - "type": "string", - "description": "The detailed message related to the status and reason listed above.\n" - } - } - } - } - } - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - } - } - } - }, - "502": { - "description": "Bad Gateway", - "schema": { - "title": "ptsV1TransactionBatchesIdGet502Response", - "type": "object", - "properties": { - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "description": "The reason of status" - }, - "message": { - "type": "string", - "description": "The detailed message related to the status and reason listed above." - } - } - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - } - } - } - } - } - } - }, - "/pts/v2/payouts/": { - "post": { - "summary": "Process a Payout", - "description": "Send funds from a selected funding source to a designated credit/debit card account or a prepaid card using\nan Original Credit Transaction (OCT).\n", - "operationId": "octCreatePayment", - "parameters": [{ - "name": "octCreatePaymentRequest", - "in": "body", - "required": true, - "schema": { - "title": "ptsV2PayoutsPostResponse", - "type": "object", - "properties": { - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n" - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "amountDetails": { - "type": "object", - "properties": { - "totalAmount": { - "type": "string", - "maxLength": 19, - "description": "Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n" - }, - "surcharge": { - "type": "object", - "properties": { - "amount": { - "type": "string", - "maxLength": 15, - "description": "The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer\nand acquirer for tracking. The issuer can provide information about the surcharge amount to the customer.\n\n- Applicable only for CTV for Payouts.\n- CTV (<= 08)\n\nFor processor-specific information, see the surcharge_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - } - } - }, - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "address2": { - "type": "string", - "maxLength": 60, - "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "locality": { - "type": "string", - "maxLength": 50, - "description": "City of the billing address.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "phoneType": { - "type": "string", - "enum": [ - "day", - "home", - "night", - "work" - ], - "description": "Customer's phone number type.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nPossible Values - \n* day\n* home\n* night\n* work\n" - } - } - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "categoryCode": { - "type": "integer", - "maximum": 9999, - "description": "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned\none or more of these values to your business when you started accepting Visa cards.\n\nIf you do not include this field in your request, CyberSource uses the value in your CyberSource account.\n\nFor processor-specific information, see the merchant_category_code field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "submitLocalDateTime": { - "type": "string", - "maxLength": 6, - "description": "Time that the transaction was submitted in local time. The time is in hhmmss format.\n" - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 21, - "description": "Your government-assigned tax identification number.\n\nFor CtV processors, the maximum length is 20.\n\nFor other processor-specific information, see the merchant_vat_registration_number field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "merchantDescriptor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" - }, - "locality": { - "type": "string", - "maxLength": 13, - "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Merchant State. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "contact": { - "type": "string", - "maxLength": 14, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n* FDCCompass (13)\n* Paymentech (13)\n" - } - } - } - } - }, - "recipientInformation": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 35, - "description": "First name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\n" - }, - "middleInitial": { - "type": "string", - "maxLength": 1, - "description": "Middle Initial of recipient. Required only for FDCCompass.\n" - }, - "lastName": { - "type": "string", - "maxLength": 35, - "description": "Last name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\n" - }, - "address1": { - "type": "string", - "maxLength": 50, - "description": "Recipient address information. Required only for FDCCompass." - }, - "locality": { - "type": "string", - "maxLength": 25, - "description": "Recipient city. Required only for FDCCompass." - }, - "administrativeArea": { - "type": "string", - "maxLength": 3, - "description": "Recipient State. Required only for FDCCompass." - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Recipient country code. Required only for FDCCompass." - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Recipient postal code. Required only for FDCCompass." - }, - "phoneNumber": { - "type": "string", - "maxLength": 20, - "description": "Recipient phone number. Required only for FDCCompass." - }, - "dateOfBirth": { - "type": "string", - "minLength": 8, - "maxLength": 8, - "description": "Recipient date of birth in YYYYMMDD format. Required only for FDCCompass." - } - } - }, - "senderInformation": { - "type": "object", - "properties": { - "referenceNumber": { - "type": "string", - "maxLength": 19, - "description": "Reference number generated by you that uniquely identifies the sender." - }, - "account": { - "type": "object", - "properties": { - "fundsSource": { - "type": "string", - "minLength": 2, - "maxLength": 2, - "description": "Source of funds. Possible values:\n\n Paymentech, CTV, FDC Compass:\n - 01: Credit card\n - 02: Debit card\n - 03: Prepaid card\n\n Paymentech, CTV -\n - 04: Cash\n - 05: Debit or deposit account that is not linked to a Visa card. Includes checking accounts, savings\n accounts, and proprietary debit or ATM cards.\n - 06: Credit account that is not linked to a Visa card. Includes credit cards and proprietary lines\n of credit.\n\n FDCCompass -\n - 04: Deposit Account\n\n**Funds Disbursement**\n\nThis value is most likely 05 to identify that the originator used a deposit account to fund the\ndisbursement.\n\n**Credit Card Bill Payment**\n\nThis value must be 02, 03, 04, or 05.\n" - }, - "number": { - "type": "string", - "maxLength": 34, - "description": "The account number of the entity funding the transaction. It is the sender\u2019s account number. It can\nbe a debit/credit card account number or bank account number.\n\n**Funds disbursements**\n\nThis field is optional.\n\n**All other transactions**\n\nThis field is required when the sender funds the transaction with a financial instrument, for example\ndebit card.\nLength:\n* FDCCompass (<= 19)\n* Paymentech (<= 16)\n" - } - } - }, - "firstName": { - "type": "string", - "maxLength": 35, - "description": "First name of sender (Optional).\n* CTV (14)\n* Paymentech (30)\n" - }, - "middleInitial": { - "type": "string", - "maxLength": 1, - "description": "Recipient middle initial (Optional).\n" - }, - "lastName": { - "type": "string", - "maxLength": 35, - "description": "Recipient last name (Optional).\n* CTV (14)\n* Paymentech (30)\n" - }, - "name": { - "type": "string", - "maxLength": 24, - "description": "Name of sender.\n\n**Funds Disbursement**\n\nThis value is the name of the originator sending the funds disbursement.\n* CTV, Paymentech (30)\n" - }, - "address1": { - "type": "string", - "maxLength": 50, - "description": "Street address of sender.\n\n**Funds Disbursement**\n\nThis value is the address of the originator sending the funds disbursement.\n" - }, - "locality": { - "type": "string", - "maxLength": 25, - "description": "City of sender.\n\n**Funds Disbursement**\n\nThis value is the city of the originator sending the funds disbursement.\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "Sender\u2019s state. Use the State, Province, and Territory Codes for the United States and Canada.\n" - }, - "countryCode": { - "type": "string", - "maxLength": 2, - "description": "Country of sender. Use the ISO Standard Country Codes.\n* CTV (3)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Sender\u2019s postal code. Required only for FDCCompass." - }, - "phoneNumber": { - "type": "string", - "maxLength": 20, - "description": "Sender\u2019s phone number. Required only for FDCCompass." - }, - "dateOfBirth": { - "type": "string", - "minLength": 8, - "maxLength": 8, - "description": "Sender\u2019s date of birth in YYYYMMDD format. Required only for FDCCompass." - }, - "vatRegistrationNumber": { - "type": "string", - "maxLength": 13, - "description": "Customer's government-assigned tax identification number.\n" - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "businessApplicationId": { - "type": "string", - "maxLength": 2, - "description": "Payouts transaction type.\n\nApplicable Processors: FDC Compass, Paymentech, CtV\n\nPossible values:\n\n**Credit Card Bill Payment**\n\n - **CP**: credit card bill payment\n\n**Funds Disbursement**\n\n - **FD**: funds disbursement\n - **GD**: government disbursement\n - **MD**: merchant disbursement\n\n**Money Transfer**\n\n - **AA**: account to account. Sender and receiver are same person.\n - **PP**: person to person. Sender and receiver are different.\n\n**Prepaid Load**\n\n - **TU**: top up\n" - }, - "networkRoutingOrder": { - "type": "string", - "maxLength": 30, - "description": "This field is optionally used by Push Payments Gateway participants (merchants and acquirers) to get the attributes for specified networks only.\nThe networks specified in this field must be a subset of the information provided during program enrollment. Refer to Sharing Group Code/Network Routing Order.\nNote: Supported only in US for domestic transactions involving Push Payments Gateway Service.\n\nVisaNet checks to determine if there are issuer routing preferences for any of the networks specified by the network routing order.\nIf an issuer preference exists for one of the specified debit networks, VisaNet makes a routing selection based on the issuer\u2019s preference. \nIf an issuer preference exists for more than one of the specified debit networks, or if no issuer preference exists, VisaNet makes a selection based on the acquirer\u2019s routing priorities. \n\nSee https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code , under section 'Network ID and Sharing Group Code' on the left panel for available values\n" - }, - "commerceIndicator": { - "type": "string", - "maxLength": 13, - "description": "Type of transaction. Possible value for Fast Payments transactions:\n\n - internet\n" - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "Please check with Cybersource customer support to see if your merchant account is configured correctly so you\ncan include this field in your request.\n* For Payouts: max length for FDCCompass is String (22).\n" - }, - "payoutsOptions": { - "type": "object", - "properties": { - "acquirerMerchantId": { - "type": "string", - "maxLength": 15, - "description": "This field identifies the card acceptor for defining the point of service terminal in both local and interchange environments. An acquirer-assigned code identifying the card acceptor for the transaction. \nDepending on the acquirer and merchant billing and reporting requirements, the code can represent a merchant, a specific merchant location, or a specific merchant location terminal.\nAcquiring Institution Identification Code uniquely identifies the merchant.\nThe value from the original is required in any subsequent messages, including reversals, chargebacks, and representments.\n* Applicable only for CTV for Payouts.\n" - }, - "acquirerBin": { - "type": "string", - "maxLength": 11, - "description": "This code identifies the financial institution acting as the acquirer of this customer transaction. The acquirer is the member or system user that signed the merchant or ADM or dispensed cash. \nThis number is usually Visa-assigned.\n* Applicable only for CTV for Payouts.\n" - }, - "retrievalReferenceNumber": { - "type": "string", - "maxLength": 12, - "description": "This field contains a number that is used with other data elements as a key to identify and track all messages related to a given cardholder transaction; that is, to a given transaction set.\n* Applicable only for CTV for Payouts.\n" - }, - "accountFundingReferenceId": { - "type": "string", - "maxLength": 15, - "description": "Visa-generated transaction identifier (TID) that is unique for each original authorization and financial request.\n* Applicable only for CTV for Payouts.\n" - } - } - } - } - }, - "paymentInformation": { - "type": "object", - "properties": { - "card": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n" - }, - "number": { - "type": "string", - "maxLength": 20, - "description": "Customer\u2019s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field\nfor the encoded account number.\n\nFor processor-specific information, see the customer_cc_number field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the credit card expires. `Format: YYYY`.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "sourceAccountType": { - "type": "string", - "maxLength": 2, - "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process. This field is required in the following cases.\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n - Applicable only for CTV.\n \n**Note**\nCombo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank\nidentification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or\ncredit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends\nthat you include this field for combo card transactions.\n\nPossible values include the following.\n\n - CHECKING: Checking account\n - CREDIT: Credit card account\n - SAVING: Saving account\n - LINE_OF_CREDIT: Line of credit\n - PREPAID: Prepaid card account\n - UNIVERSAL: Universal account\n" - } - } - } - } - } - }, - "example": { - "clientReferenceInformation": { - "code": "33557799" - }, - "senderInformation": { - "referenceNumber": "1234567890", - "address1": "900 Metro Center Blvd.900", - "countryCode": "US", - "locality": "Foster City", - "name": "Thomas Jefferson", - "administrativeArea": "CA", - "account": { - "number": "1234567890123456789012345678901234", - "fundsSource": "01" - } - }, - "processingInformation": { - "commerceIndicator": "internet", - "businessApplicationId": "FD", - "networkRoutingOrder": "ECG" - }, - "payoutsOptions": { - "retrievalReferenceNumber": "123456789012", - "acquirerBin": "567890124" - }, - "reconciliationId": "1087488702VIAQNSPQ", - "orderInformation": { - "amountDetails": { - "totalAmount": "100.00", - "currency": "USD" - } - }, - "merchantInformation": { - "merchantCategoryCode": "123", - "merchantDescriptor": { - "country": "US", - "postalCode": "94440", - "locality": "FC", - "name": "Thomas", - "administrativeArea": "CA" - } - }, - "paymentInformation": { - "card": { - "expirationYear": "2025", - "number": "4111111111111111", - "expirationMonth": "12", - "type": "001", - "sourceAccountType": "CH" - } - }, - "recipientInformation": { - "firstName": "John", - "lastName": "Doe", - "address1": "Paseo Padre Boulevard", - "locality": "Foster City", - "administrativeArea": "CA", - "postalCode": "94400", - "phoneNumber": "6504320556", - "dateOfBirth": "19801009", - "country": "US" - } - } - } - } - ], - "tags": [ - "Process a Payout" - ], - "x-example": { - "example0": { - "summary": "Process a Payout", - "value": { - "clientReferenceInformation": { - "code": "33557799" - }, - "senderInformation": { - "referenceNumber": "1234567890", - "address1": "900 Metro Center Blvd.900", - "countryCode": "US", - "locality": "Foster City", - "name": "Company Name", - "administrativeArea": "CA", - "account": { - "fundsSource": "05" - } - }, - "processingInformation": { - "commerceIndicator": "internet", - "businessApplicationId": "FD" - }, - "orderInformation": { - "amountDetails": { - "totalAmount": "100.00", - "currency": "USD" - } - }, - "merchantInformation": { - "merchantDescriptor": { - "country": "US", - "postalCode": "94440", - "locality": "FC", - "name": "Sending Company Name", - "administrativeArea": "CA" - } - }, - "paymentInformation": { - "card": { - "expirationYear": "2025", - "number": "4111111111111111", - "expirationMonth": "12", - "type": "001" - } - }, - "recipientInformation": { - "firstName": "John", - "lastName": "Doe", - "address1": "Paseo Padre Boulevard", - "locality": "Foster City", - "administrativeArea": "CA", - "postalCode": "94400", - "phoneNumber": "6504320556", - "country": "US" - } - } - } - }, - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "title": "ptsV2PayoutsPost201Response", - "type": "object", - "properties": { - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - }, - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.", - "enum": [ - "ACCEPTED", - "DECLINED" - ] - }, - "reconciliationId": { - "type": "string", - "maxLength": 25, - "description": "Cybersource or merchant generated transaction reference number. This is sent to the processor and is echoed back in the response to the merchant. This is\nThis value is used for reconciliation purposes.\n" - }, - "statusInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "description": "The reason of the status.\n", - "enum": [ - "SUCCESS", - "CONTACT_PROCESSOR" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above. Possible value is:\n\n - Transaction was successful.\n - You must call the issuing bank to proceed with the transaction.\n" - } - } - }, - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "description": "The reason of the status.\n", - "enum": [ - "EXPIRED_CARD", - "PROCESSOR_DECLINED", - "STOLEN_LOST_CARD", - "UNAUTHORIZED_CARD", - "CVN_NOT_MATCH", - "INVALID_CVN", - "BLACKLISTED_CUSTOMER", - "INVALID_ACCOUNT", - "GENERAL_DECLINE", - "RISK_CONTROL_DECLINE", - "PROCESSOR_RISK_CONTROL_DECLINE" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n" - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "properties": { - "name": { - "type": "string", - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" - }, - "locality": { - "type": "string", - "maxLength": 13, - "description": "Merchant City. For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "amountDetails": { - "type": "object", - "properties": { - "totalAmount": { - "type": "string", - "maxLength": 19, - "description": "Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n" - }, - "settlementAmount": { - "type": "string", - "maxLength": 12, - "description": "This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder\u2019s account.\n" - }, - "settlementCurrency": { - "type": "string", - "maxLength": 3, - "description": "This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account.\n" - } - } - } - } - }, - "processorInformation": { - "type": "object", - "properties": { - "approvalCode": { - "type": "string", - "maxLength": 6, - "description": "Issuer-generated approval code for the transaction." - }, - "responseCode": { - "type": "string", - "maxLength": 10, - "description": "Transaction status from the processor." - }, - "transactionId": { - "type": "string", - "maxLength": 15, - "description": "Network transaction identifier (TID). This value can be used to identify a specific transaction when\nyou are discussing the transaction with your processor.\n" - }, - "systemTraceAuditNumber": { - "type": "string", - "maxLength": 6, - "description": "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\n\n**American Express Direct**\n\nSystem trace audit number (STAN). This value identifies the transaction and is useful when investigating a\nchargeback dispute.\n\n**CyberSource through VisaNet**\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n" - }, - "responseCodeSource": { - "type": "string", - "maxLength": 1, - "description": "Used by Visa only and contains the response source/reason code that identifies the source of the response decision.\n" - } - } - }, - "recipientInformation": { - "type": "object", - "properties": { - "card": { - "type": "object", - "properties": { - "balance": { - "type": "string", - "maxLength": 12, - "description": "This field shows the available balance in the prepaid account. \nAcquirers always receive the available balance in the transaction currency.\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer.\n" - } - } - } - } - } - }, - "example": { - "_links": { - "self": { - "href": "/pts/v2/payouts/5287556536256000401540", - "method": "GET" - } - }, - "clientReferenceInformation": { - "code": "1528755653559" - }, - "id": "5287556536256000401540", - "orderInformation": { - "amountDetails": { - "totalAmount": "100.00", - "currency": "USD" - } - }, - "processorInformation": { - "systemTraceAuditNumber": "897596", - "approvalCode": "831000", - "transactionId": "016153570198200", - "responseCode": "00", - "responseCodeSource": "5" - }, - "reconciliationId": "1087488702VIAQNSPQ", - "status": "ACCEPTED", - "submitTimeUtc": "2018-06-11T222054Z" - } - } - }, - "400": { - "description": "Invalid request.", - "schema": { - "title": "ptsV2PayoutsPost400Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction." - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA", - "DUPLICATE_REQUEST", - "INVALID_MERCHANT_CONFIGURATION", - "INVALID_AMOUNT", - "DEBIT_CARD_USEAGE_EXCEEDD_LIMIT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above. Possible value is:\n\n - Your aggregator or acquirer is not accepting transactions from you at this time.\n - Your aggregator or acquirer is not accepting this transaction.\n - CyberSource declined the request because the credit card has expired. You might also receive this value if\n the expiration date you provided does not match the date the issuing bank has on file.\n - The bank declined the transaction.\n - The merchant reference number for this authorization request matches the merchant reference number of\n another authorization request that you sent within the past 15 minutes. Resend the request with a unique\n merchant reference number.\n - The credit card number did not pass CyberSource basic checks.\n - Data provided is not consistent with the request. For example, you requested a product with negative cost.\n - The request is missing a required field.\n" - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - } - }, - "502": { - "description": "Unexpected system error or system timeout.", - "schema": { - "title": "ptsV2PayoutsPost502Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.", - "enum": [ - "SERVER_ERROR" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n", - "enum": [ - "SYSTEM_ERROR", - "SERVER_TIMEOUT", - "SERVICE_TIMEOUT", - "PROCESSOR_TIMEOUT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - } - } - } - } - } - } - }, - "/reporting/v3/report-downloads": { - "get": { - "tags": [ - "ReportDownloads" - ], - "summary": "Download a report", - "description": "Download a report using the unique report name and date.\n", - "operationId": "downloadReport", - "x-devcenter-metaData": { - "categoryTag": "Reporting" - }, - "x-queryParameterDefaults": { - "organizationId": "testrest", - "reportName": "testrest_v2", - "reportDate": "2019-01-02" - }, - "produces": [ - "application/xml", - "text/csv" - ], - "parameters": [{ - "name": "organizationId", - "in": "query", - "description": "Valid Cybersource Organization Id", - "pattern": "[a-zA-Z0-9-_]+", - "required": false, - "type": "string", - "minLength": 1, - "maxLength": 32 - }, { - "name": "reportDate", - "in": "query", - "description": "Valid date on which to download the report in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd\n", - "required": true, - "type": "string", - "format": "date" - }, { - "name": "reportName", - "in": "query", - "description": "Name of the report to download", - "type": "string", - "required": true - } - ], - "responses": { - "200": { - "description": "OK" - }, - "400": { - "description": "Invalid Request", - "schema": { - "title": "reportingv3ReportDownloadsGet400Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "404": { - "description": "No Reports Found" - } - } - } - }, - "/reporting/v3/reports": { - "get": { - "tags": [ - "Reports" - ], - "summary": "Retrieve available reports", - "description": "Retrieve a list of the available reports to which\nyou are subscribed. This will also give you the reportId value,\nwhich you can also use to download a report.\n", - "operationId": "searchReports", - "x-devcenter-metaData": { - "categoryTag": "Reporting" - }, - "x-queryParameterDefaults": { - "startTime": "2018-10-01T00:00:00.0Z", - "endTime": "2018-10-30T23:59:59.0Z", - "timeQueryType": "executedTime", - "reportMimeType": "application/xml" - }, - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "organizationId", - "in": "query", - "description": "Valid Cybersource Organization Id", - "pattern": "[a-zA-Z0-9-_]+", - "required": false, - "type": "string", - "minLength": 1, - "maxLength": 32 - }, { - "name": "startTime", - "in": "query", - "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n", - "required": true, - "type": "string", - "format": "date-time" - }, { - "name": "endTime", - "in": "query", - "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n", - "required": true, - "type": "string", - "format": "date-time" - }, { - "name": "timeQueryType", - "in": "query", - "description": "Specify time you would like to search", - "required": true, - "type": "string", - "enum": [ - "reportTimeFrame", - "executedTime" - ] - }, { - "name": "reportMimeType", - "in": "query", - "description": "Valid Report Format", - "required": false, - "type": "string", - "enum": [ - "application/xml", - "text/csv" - ] - }, { - "name": "reportFrequency", - "in": "query", - "description": "Valid Report Frequency", - "required": false, - "type": "string", - "enum": [ - "DAILY", - "WEEKLY", - "MONTHLY", - "ADHOC" - ] - }, { - "name": "reportName", - "in": "query", - "description": "Valid Report Name", - "required": false, - "type": "string" - }, { - "name": "reportDefinitionId", - "in": "query", - "description": "Valid Report Definition Id", - "required": false, - "type": "integer", - "format": "int32" - }, { - "name": "reportStatus", - "in": "query", - "description": "Valid Report Status", - "required": false, - "type": "string", - "enum": [ - "COMPLETED", - "PENDING", - "QUEUED", - "RUNNING", - "ERROR", - "NO_DATA" - ] - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "title": "reportingV3ReportsGet200Response", - "type": "object", - "properties": { - "reports": { - "type": "array", - "items": { - "type": "object", - "properties": { - "reportDefinitionId": { - "type": "string", - "description": "Unique Report Identifier of each report type", - "example": "210" - }, - "reportName": { - "type": "string", - "description": "Name of the report specified by merchant while creating the report", - "example": "My Transaction Request Detail Report" - }, - "reportMimeType": { - "type": "string", - "example": "application/xml", - "description": "Format of the report to get generated", - "enum": [ - "application/xml", - "text/csv" - ] - }, - "reportFrequency": { - "type": "string", - "example": "DAILY", - "description": "Frequency of the report to get generated", - "enum": [ - "DAILY", - "WEEKLY", - "MONTHLY", - "ADHOC" - ] - }, - "status": { - "type": "string", - "description": "Status of the report", - "enum": [ - "COMPLETED", - "PENDING", - "QUEUED", - "RUNNING", - "ERROR", - "NO_DATA" - ] - }, - "reportStartTime": { - "type": "string", - "format": "date-time", - "example": "2017-10-01T10:10:10+05:00", - "description": "Specifies the report start time in ISO 8601 format" - }, - "reportEndTime": { - "type": "string", - "format": "date-time", - "example": "2017-10-02T10:10:10+05:00", - "description": "Specifies the report end time in ISO 8601 format" - }, - "timezone": { - "type": "string", - "example": "America/Chicago", - "description": "Time Zone" - }, - "reportId": { - "type": "string", - "example": "6d9cb5b6-0e97-2d03-e053-7cb8d30af52e", - "description": "Unique identifier generated for every reports" - }, - "organizationId": { - "type": "string", - "example": "Test_MerchantId", - "description": "CyberSource Merchant Id" - }, - "queuedTime": { - "type": "string", - "format": "date-time", - "example": "2017-10-03T10:10:10+05:00", - "description": "Specifies the time of the report in queued in ISO 8601 format" - }, - "reportGeneratingTime": { - "type": "string", - "format": "date-time", - "example": "2017-10-03T10:10:10+05:00", - "description": "Specifies the time of the report started to generate in ISO 8601 format" - }, - "reportCompletedTime": { - "type": "string", - "format": "date-time", - "example": "2017-10-03T10:10:10+05:00", - "description": "Specifies the time of the report completed the generation in ISO 8601 format" - }, - "subscriptionType": { - "type": "string", - "example": "CUSTOM", - "description": "Specifies whether the subscription created is either Custom, Standard or Classic\n" - }, - "groupId": { - "type": "string", - "example": "12345", - "description": "Id for selected group." - } - }, - "description": "Report Search Result Bean" - } - } - } - } - }, - "400": { - "description": "Invalid Request", - "schema": { - "title": "reportingV3ReportsGet400Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "404": { - "description": "No Reports Found" - } - } - }, - "post": { - "tags": [ - "Reports" - ], - "summary": "Create Adhoc Report", - "description": "Create a one-time report. You must specify the\ntype of report in reportDefinitionName. For a list of values for\nreportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation)\n", - "operationId": "createReport", - "x-devcenter-metaData": { - "categoryTag": "Reporting" - }, - "x-queryParameterDefaults": { - "organizationId": "testrest" - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "organizationId", - "in": "query", - "description": "Valid Cybersource Organization Id", - "pattern": "[a-zA-Z0-9-_]+", - "required": false, - "type": "string", - "minLength": 1, - "maxLength": 32 - }, { - "in": "body", - "name": "requestBody", - "description": "Report subscription request payload", - "required": true, - "schema": { - "type": "object", - "properties": { - "organizationId": { - "type": "string", - "description": "Valid CyberSource Organization Id", - "pattern": "[a-zA-Z0-9-_]+", - "example": "Test_Merchatnt_id" - }, - "reportDefinitionName": { - "type": "string", - "minLength": 1, - "maxLength": 80, - "pattern": "[a-zA-Z0-9-]+", - "example": "TransactionRequestClass" - }, - "reportFields": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of fields which needs to get included in a report", - "example": [ - "Request.RequestID", - "Request.TransactionDate", - "Request.MerchantID" - ] - }, - "reportMimeType": { - "type": "string", - "description": " Format of the report", - "example": "application/xml", - "enum": [ - "application/xml", - "text/csv" - ] - }, - "reportName": { - "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "[a-zA-Z0-9-_ ]+", - "description": "Name of the report", - "example": "My Transaction Request report" - }, - "timezone": { - "type": "string", - "description": "Timezone of the report", - "example": "America/Chicago" - }, - "reportStartTime": { - "type": "string", - "format": "date-time", - "description": "Start time of the report", - "example": "2017-10-01T10:10:10+05:00" - }, - "reportEndTime": { - "type": "string", - "format": "date-time", - "description": "End time of the report", - "example": "2017-10-02T10:10:10+05:00" - }, - "reportFilters": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": "List of filters to apply", - "example": { - "Application.Name": [ - "ics_auth", - "ics_bill" - ] - } - }, - "reportPreferences": { - "type": "object", - "properties": { - "signedAmounts": { - "type": "boolean", - "description": "Indicator to determine whether negative sign infront of amount for all refunded transaction" - }, - "fieldNameConvention": { - "type": "string", - "description": "Specify the field naming convention to be followed in reports (applicable to only csv report formats", - "enum": [ - "SOAPI", - "SCMP" - ] - } - }, - "description": "Report Preferences" - }, - "groupName": { - "type": "string", - "pattern": "[0-9]*", - "description": "Specifies the group name", - "example": "myGroup" - } - } - } - } - ], - "responses": { - "201": { - "description": "Created" - }, - "304": { - "description": "Not Modified" - }, - "400": { - "description": "Invalid request", - "schema": { - "title": "reportingV3ReportsPost400Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - } - }, - "x-example": { - "example0": { - "summary": "Create Adhoc Report", - "value": { - "reportDefinitionName": "TransactionRequestClass", - "reportFields": [ - "Request.RequestID", - "Request.TransactionDate", - "Request.MerchantID" - ], - "reportMimeType": "application/xml", - "reportName": "testrest_v2", - "timezone": "GMT", - "reportStartTime": "2018-09-01T12:00:00+05:00", - "reportEndTime": "2018-09-02T12:00:00+05:00", - "reportPreferences": { - "signedAmounts": "true", - "fieldNameConvention": "SOAPI" - } - } - } - } - } - }, - "/reporting/v3/reports/{reportId}": { - "get": { - "tags": [ - "Reports" - ], - "summary": "Get Report based on reportId", - "description": "Download a report using the reportId value. If\nyou don\u2019t already know this value, you can obtain it using the\nRetrieve available reports call.\n", - "operationId": "getReportByReportId", - "x-devcenter-metaData": { - "categoryTag": "Reporting" - }, - "x-queryParameterDefaults": { - "organizationId": "testrest" - }, - "produces": [ - "application/hal+json", - "application/xml" - ], - "parameters": [{ - "name": "reportId", - "in": "path", - "description": "Valid Report Id", - "required": true, - "type": "string" - }, { - "name": "organizationId", - "in": "query", - "description": "Valid Cybersource Organization Id", - "pattern": "[a-zA-Z0-9-_]+", - "required": false, - "type": "string", - "minLength": 1, - "maxLength": 32 - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "title": "reportingV3ReportsIdGet200Response", - "type": "object", - "properties": { - "organizationId": { - "type": "string", - "description": "CyberSource merchant id", - "example": "myMerchantId" - }, - "reportId": { - "type": "string", - "description": "Report ID Value", - "example": "6da01922-bb8e-a1fb-e053-7cb8d30ade29" - }, - "reportDefinitionId": { - "type": "string", - "description": "Report definition Id", - "example": "210" - }, - "reportName": { - "type": "string", - "description": "Report Name", - "example": "My Transaction Request report" - }, - "reportMimeType": { - "type": "string", - "example": "application/xml", - "description": "Report Format", - "enum": [ - "application/xml", - "text/csv" - ] - }, - "reportFrequency": { - "type": "string", - "example": "DAILY", - "description": "Report Frequency Value", - "enum": [ - "DAILY", - "WEEKLY", - "MONTHLY", - "ADHOC" - ] - }, - "reportFields": { - "type": "array", - "description": "List of Integer Values", - "items": { - "type": "string" - }, - "example": [ - "Request.RequestID", - "Request.TransactionDate", - "Request.MerchantID" - ] - }, - "reportStatus": { - "type": "string", - "description": "Report Status Value", - "enum": [ - "COMPLETED", - "PENDING", - "QUEUED", - "RUNNING", - "ERROR", - "NO_DATA", - "RERUN" - ] - }, - "reportStartTime": { - "type": "string", - "format": "date-time", - "example": "2017-10-01T10:10:10+05:00", - "description": "Report Start Time Value" - }, - "reportEndTime": { - "type": "string", - "format": "date-time", - "example": "2017-10-02T10:10:10+05:00", - "description": "Report End Time Value" - }, - "timezone": { - "type": "string", - "description": "Time Zone Value", - "example": "America/Chicago" - }, - "reportFilters": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": "List of filters to apply", - "example": { - "Application.Name": [ - "ics_auth", - "ics_bill" - ] - } - }, - "reportPreferences": { - "description": "Report Preferences", - "type": "object", - "properties": { - "signedAmounts": { - "type": "boolean", - "description": "Indicator to determine whether negative sign infron of amount for all refunded transaction" - }, - "fieldNameConvention": { - "type": "string", - "description": "Specify the field naming convention to be followed in reports (applicable to only csv report formats", - "enum": [ - "SOAPI", - "SCMP" - ] - } - } - }, - "groupId": { - "type": "string", - "description": "Id for selected group.", - "example": "12345" - } - }, - "description": "Report Log" - } - }, - "400": { - "description": "Invalid Request", - "schema": { - "title": "reportingV3ReportsIdPost400Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "404": { - "description": "No Reports Found" - } - } - } - }, - "/reporting/v3/report-definitions/{reportDefinitionName}": { - "get": { - "tags": [ - "ReportDefinitions" - ], - "summary": "Get report definition", - "description": "View the attributes of an individual report type.\nFor a list of values for reportDefinitionName, see the\n[Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation/)\n", - "operationId": "getResourceInfoByReportDefinition", - "x-devcenter-metaData": { - "categoryTag": "Reporting" - }, - "x-queryParameterDefaults": { - "organizationId": "testrest" - }, - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "reportDefinitionName", - "in": "path", - "description": "Name of the Report definition to retrieve", - "required": true, - "type": "string" - }, { - "name": "organizationId", - "in": "query", - "description": "Valid Cybersource Organization Id", - "pattern": "[a-zA-Z0-9-_]+", - "required": false, - "type": "string", - "minLength": 1, - "maxLength": 32 - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "title": "reportingV3ReportDefinitionsNameGet200Response", - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "reportDefinitionId": { - "type": "integer", - "format": "int32" - }, - "reportDefintionName": { - "type": "string" - }, - "attributes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string" - }, - "filterType": { - "type": "string", - "description": "Attribute Filter Type.", - "example": "MULTI" - }, - "default": { - "type": "boolean" - }, - "required": { - "type": "boolean" - }, - "supportedType": { - "type": "string", - "description": "Valid values for the filter.", - "example": [ - "ics_score", - "ics_ap_auth", - "ics_ap_auth_reversal", - "ics_ap_billing_agreement", - "ics_ap_cancel", - "ics_ap_capture", - "ics_ap_initiate", - "ics_ap_options", - "ics_ap_order", - "ics_ap_refund", - "ics_ap_sale", - "ics_ap_sessions", - "ics_ap_check_status", - "ics_auto_auth_reversal", - "ics_bank_transfer", - "ics_bank_transfer_real_time", - "ics_bank_transfer_refund", - "ics_bin_lookup", - "ics_boleto_payment", - "ics_cm_action", - "ics_china_payment", - "ics_china_refund", - "ics_auth", - "ics_auto_full_auth_reversal", - "ics_auth_refresh", - "ics_auth_reversal", - "ics_credit", - "ics_bill", - "ics_risk_update", - "ics_dcc", - "ics_dcc_update", - "ics_decision", - "ics_dm_event", - "ics_direct_debit", - "ics_direct_debit_mandate", - "ics_direct_debit_refund", - "ics_direct_debit_validate", - "ics_ecp_authenticate", - "ics_ecp_credit", - "ics_ecp_debit", - "ics_get_masterpass_data", - "ics_get_visa_checkout_data", - "ics_create_isv", - "ics_get_isv_history", - "ics_add_value_to_isv", - "ics_get_isv_info", - "ics_modify_isv", - "ics_get_isv_profiles", - "ics_redeem_isv", - "ics_ifs_setup", - "ics_ifs_update", - "ics_ipgeo", - "ics_oct", - "ics_pa_enroll", - "ics_pa_validate", - "paypal_mip_agreement_ipn", - "ics_paypal_button_create", - "ics_paypal_credit", - "ics_paypal_authorization", - "ics_paypal_create_agreement", - "ics_paypal_update_agreement", - "ics_paypal_ec_order_setup", - "ics_paypal_auth_reversal", - "ics_paypal_ec_do_payment", - "ics_paypal_do_ref_transaction", - "ics_paypal_refund", - "ics_paypal_do_capture", - "paypal_ipn", - "ics_paypal_preapproved_payment", - "ics_pinless_debit", - "ics_pinless_debit_validate", - "ics_pinless_debit_reversal", - "ics_export", - "ics_service_fee_auth", - "ics_service_fee_auth_reversal", - "ics_service_fee_bill", - "ics_service_fee_credit", - "ics_service_fee_ecp_credit", - "ics_service_fee_ecp_debit", - "ics_pay_subscription_create", - "ics_pay_subscription_create_dup", - "ics_pay_subscription_delete", - "ics_pay_subscription_update", - "ics_dav", - "ics_download", - "ics_tax", - "ics_timeout_auth_reversal", - "ics_timeout_oct_reversal", - "ics_void", - "ics_pin_debit_purchase", - "ics_pin_debit_credit", - "ics_pin_debit_reversal", - "ics_timeout_pin_debit_reversal", - "ics_gift_card_activation", - "ics_gift_card_balance_inquiry", - "ics_gift_card_redemption", - "ics_gift_card_refund", - "ics_gift_card_reload", - "ics_gift_card_void", - "ics_gift_card_reversal" - ] - } - } - } - }, - "supportedFormats": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "application/xml", - "text/csv" - ] - } - }, - "description": { - "type": "string" - } - } - } - }, - "400": { - "description": "Invalid request", - "schema": { - "title": "reportingV3ReportDefinitionsNameGet400Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "404": { - "description": "Report not found" - } - } - } - }, - "/reporting/v3/report-definitions": { - "get": { - "tags": [ - "ReportDefinitions" - ], - "summary": "Get reporting resource information", - "description": "View a list of supported reports and their attributes before subscribing to them.\n", - "operationId": "getResourceV2Info", - "x-devcenter-metaData": { - "categoryTag": "Reporting" - }, - "x-queryParameterDefaults": { - "organizationId": "testrest" - }, - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "organizationId", - "in": "query", - "description": "Valid Cybersource Organization Id", - "pattern": "[a-zA-Z0-9-_]+", - "required": false, - "type": "string", - "minLength": 1, - "maxLength": 32 - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "title": "reportingV3ReportDefinitionsGet200Response", - "type": "object", - "properties": { - "reportDefinitions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "reportDefinitionId": { - "type": "integer", - "format": "int32", - "description": "| Id | Definition Class |\n| --- | --------------------------------- |\n| 210 | TransactionRequestClass |\n| 211 | PaymentBatchDetailClass |\n| 212 | ExceptionDetailClass |\n| 213 | ProcessorSettlementDetailClass |\n| 214 | ProcessorEventsDetailClass |\n| 215 | FundingDetailClass |\n| 216 | AgingDetailClass |\n| 217 | ChargebackAndRetrievalDetailClass |\n| 218 | DepositDetailClass |\n| 219 | FeeDetailClass |\n| 220 | InvoiceSummaryClass |\n| 221 | PayerAuthDetailClass |\n| 222 | ConversionDetailClass |\n| 270 | JPTransactionDetailClass |\n| 271 | ServiceFeeDetailClass |\n| 310 | GatewayTransactionRequestClass |\n| 400 | DecisionManagerEventDetailClass |\n| 401 | DecisionManagerDetailClass |\n| 410 | FeeSummaryClass |\n| 420 | TaxCalculationClass |\n| 520 | POSTerminalExceptionClass |\n| 620 | SubscriptionDetailClass |\n" - }, - "reportDefintionName": { - "type": "string" - }, - "supportedFormats": { - "type": "array", - "uniqueItems": true, - "items": { - "type": "string", - "enum": [ - "application/xml", - "text/csv" - ] - } - }, - "description": { - "type": "string" - } - } - } - } - } - } - }, - "400": { - "description": "Invalid request", - "schema": { - "title": "reportingV3ReportDefinitionsGet400Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "404": { - "description": "Report not found" - } - } - } - }, - "/reporting/v3/report-subscriptions": { - "get": { - "tags": [ - "ReportSubscriptions" - ], - "summary": "Get all subscriptions", - "description": "View a summary of all report subscriptions.\n", - "operationId": "getAllSubscriptions", - "x-devcenter-metaData": { - "categoryTag": "Reporting" - }, - "produces": [ - "application/hal+json" - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "title": "reportingV3ReportSubscriptionsGet200Response", - "type": "object", - "properties": { - "subscriptions": { - "type": "array", - "items": { - "type": "object", - "properties": { - "organizationId": { - "type": "string", - "description": "Selected Organization Id", - "example": "Merchant 1" - }, - "reportDefinitionId": { - "type": "string", - "description": "Report Definition Id", - "example": "210" - }, - "reportDefinitionName": { - "type": "string", - "description": "Report Definition Class", - "example": "TransactionRequestDetailClass" - }, - "reportMimeType": { - "type": "string", - "example": "application/xml", - "description": "Report Format", - "enum": [ - "application/xml", - "text/csv" - ] - }, - "reportFrequency": { - "type": "string", - "example": "DAILY", - "description": "Report Frequency", - "enum": [ - "DAILY", - "WEEKLY", - "MONTHLY" - ] - }, - "reportName": { - "type": "string", - "description": "Report Name", - "example": "My Transaction Request Detail Report" - }, - "timezone": { - "type": "string", - "description": "Time Zone", - "example": "America/Chicago" - }, - "startTime": { - "type": "string", - "description": "Start Time", - "format": "date-time", - "example": "2017-10-01T10:10:10+05:00" - }, - "startDay": { - "type": "integer", - "format": "int32", - "description": "Start Day", - "example": 1 - }, - "reportFields": { - "type": "array", - "example": [ - "Request.RequestID", - "Request.TransactionDate", - "Request.MerchantID" - ], - "description": "List of all fields String values", - "items": { - "type": "string" - } - }, - "reportFilters": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": "List of filters to apply", - "example": { - "Application.Name": [ - "ics_auth", - "ics_bill" - ] - } - }, - "reportPreferences": { - "type": "object", - "properties": { - "signedAmounts": { - "type": "boolean", - "description": "Indicator to determine whether negative sign infron of amount for all refunded transaction" - }, - "fieldNameConvention": { - "type": "string", - "description": "Specify the field naming convention to be followed in reports (applicable to only csv report formats", - "enum": [ - "SOAPI", - "SCMP" - ] - } - }, - "description": "Report Preferences" - }, - "groupId": { - "type": "string", - "example": "12345", - "description": "Id for the selected group." - } - }, - "description": "Subscription Details" - } - } - } - } - }, - "400": { - "description": "Invalid request", - "schema": { - "title": "reportingV3ReportSubscriptionsGet400Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "404": { - "description": "Subscriptions not found" - } - } - }, - "put": { - "tags": [ - "ReportSubscriptions" - ], - "summary": "Create Report Subscription for a report name by organization", - "description": "Create a report subscription for your organization. The report name must be unique.\n", - "operationId": "createSubscription", - "x-devcenter-metaData": { - "categoryTag": "Reporting" - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "organizationId", - "in": "query", - "description": "Valid Cybersource Organization Id", - "pattern": "[a-zA-Z0-9-_]+", - "required": false, - "type": "string", - "minLength": 1, - "maxLength": 32 - }, { - "in": "body", - "name": "requestBody", - "description": "Report subscription request payload", - "required": true, - "schema": { - "type": "object", - "required": [ - "reportDefinitionName", - "reportFields", - "reportName", - "startTime", - "timezone", - "reportFrequency", - "reportMimeType" - ], - "properties": { - "organizationId": { - "type": "string", - "pattern": "[a-zA-Z0-9-_]+", - "description": "Valid CyberSource organizationId", - "example": "Merchant 1" - }, - "reportDefinitionName": { - "type": "string", - "minLength": 1, - "maxLength": 80, - "pattern": "[a-zA-Z0-9-]+", - "description": "Valid Report Definition Name", - "example": "TransactionDetailReportClass" - }, - "reportFields": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "Request.RequestID", - "Request.TransactionDate", - "Request.MerchantID" - ] - }, - "reportMimeType": { - "type": "string", - "example": "application/xml", - "enum": [ - "application/xml", - "text/csv" - ] - }, - "reportFrequency": { - "type": "string", - "description": "The frequency for which subscription is created.", - "example": "DAILY", - "enum": [ - "DAILY", - "WEEKLY", - "MONTHLY" - ] - }, - "reportName": { - "type": "string", - "minLength": 1, - "maxLength": 128, - "pattern": "[a-zA-Z0-9-_ ]+", - "example": "My Daily Subdcription" - }, - "timezone": { - "type": "string", - "example": "America/Chicago" - }, - "startTime": { - "type": "string", - "description": "The hour at which the report generation should start. It should be in hhmm format.", - "example": "0900" - }, - "startDay": { - "type": "integer", - "minimum": 1, - "maximum": 31, - "description": "This is the start day if the frequency is WEEKLY or MONTHLY. The value varies from 1-7 for WEEKLY and 1-31 for MONTHLY. For WEEKLY 1 means Sunday and 7 means Saturday. By default the value is 1." - }, - "reportFilters": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": "List of filters to apply", - "example": { - "Application.Name": [ - "ics_auth", - "ics_bill" - ] - } - }, - "reportPreferences": { - "type": "object", - "properties": { - "signedAmounts": { - "type": "boolean", - "description": "Indicator to determine whether negative sign infron of amount for all refunded transaction" - }, - "fieldNameConvention": { - "type": "string", - "description": "Specify the field naming convention to be followed in reports (applicable to only csv report formats", - "enum": [ - "SOAPI", - "SCMP" - ] - } - }, - "description": "Report Preferences" - }, - "groupName": { - "type": "string", - "pattern": "[a-zA-Z0-9-_ ]+", - "description": "Valid GroupName", - "example": "CEMEA Group" - } - } - } - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "304": { - "description": "NOT MODIFIED" - }, - "400": { - "description": "Invalid request", - "schema": { - "type": "object", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "Error code" - }, - "message": { - "type": "string", - "description": "Error message" - }, - "localizationKey": { - "type": "string", - "description": "Localization Key Name" - }, - "correlationId": { - "type": "string", - "description": "Correlation Id" - }, - "detail": { - "type": "string", - "description": "Error Detail" - }, - "fields": { - "type": "array", - "description": "Error fields List", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "Path of the failed property" - }, - "message": { - "type": "string", - "description": "Error description about validation failed field" - }, - "localizationKey": { - "type": "string", - "description": "Localized Key Name" - } - }, - "description": "Provide validation failed input field details" - } - } - }, - "description": "Error Bean" - } - } - }, - "x-example": { - "example0": { - "summary": "Create Report Subscription", - "value": { - "reportDefinitionName": "TransactionRequestClass", - "reportFields": [ - "Request.RequestID", - "Request.TransactionDate", - "Request.MerchantID" - ], - "reportMimeType": "application/xml", - "reportFrequency": "WEEKLY", - "reportName": "testrest_subcription_v1", - "timezone": "GMT", - "startTime": "0900", - "startDay": "1" - } - } - } - } - }, - "/reporting/v3/report-subscriptions/{reportName}": { - "get": { - "tags": [ - "ReportSubscriptions" - ], - "summary": "Get subscription for report name", - "description": "View the details of a report subscription, such as\nthe report format or report frequency, using the report\u2019s\nunique name.\n", - "operationId": "getSubscription", - "x-devcenter-metaData": { - "categoryTag": "Reporting" - }, - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "reportName", - "in": "path", - "description": "Name of the Report to Retrieve", - "required": true, - "type": "string", - "maxLength": 80, - "minLength": 1, - "pattern": "[a-zA-Z0-9-_+]+" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "title": "reportingV3ReportsSbscriptionsNameGet200Response", - "type": "object", - "properties": { - "organizationId": { - "type": "string", - "description": "Selected Organization Id", - "example": "Merchant 1" - }, - "reportDefinitionId": { - "type": "string", - "description": "Report Definition Id", - "example": "210" - }, - "reportDefinitionName": { - "type": "string", - "description": "Report Definition Class", - "example": "TransactionRequestDetailClass" - }, - "reportMimeType": { - "type": "string", - "example": "application/xml", - "description": "Report Format", - "enum": [ - "application/xml", - "text/csv" - ] - }, - "reportFrequency": { - "type": "string", - "example": "DAILY", - "description": "Report Frequency", - "enum": [ - "DAILY", - "WEEKLY", - "MONTHLY" - ] - }, - "reportName": { - "type": "string", - "description": "Report Name", - "example": "My Transaction Request Detail Report" - }, - "timezone": { - "type": "string", - "description": "Time Zone", - "example": "America/Chicago" - }, - "startTime": { - "type": "string", - "description": "Start Time", - "format": "date-time", - "example": "2017-10-01T10:10:10+05:00" - }, - "startDay": { - "type": "integer", - "format": "int32", - "description": "Start Day", - "example": 1 - }, - "reportFields": { - "type": "array", - "example": [ - "Request.RequestID", - "Request.TransactionDate", - "Request.MerchantID" - ], - "description": "List of all fields String values", - "items": { - "type": "string" - } - }, - "reportFilters": { - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "description": "List of filters to apply", - "example": { - "Application.Name": [ - "ics_auth", - "ics_bill" - ] - } - }, - "reportPreferences": { - "type": "object", - "properties": { - "signedAmounts": { - "type": "boolean", - "description": "Indicator to determine whether negative sign infron of amount for all refunded transaction" - }, - "fieldNameConvention": { - "type": "string", - "description": "Specify the field naming convention to be followed in reports (applicable to only csv report formats", - "enum": [ - "SOAPI", - "SCMP" - ] - } - }, - "description": "Report Preferences" - }, - "groupId": { - "type": "string", - "example": "12345", - "description": "Id for the selected group." - } - }, - "description": "Subscription Details" - } - }, - "400": { - "description": "Invalid request", - "schema": { - "title": "reportingV3ReportSubscriptionsNameGet400Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "404": { - "description": "Subscription not found" - } - } - }, - "delete": { - "tags": [ - "ReportSubscriptions" - ], - "summary": "Delete subscription of a report name by organization", - "description": "Delete a report subscription for your\norganization. You must know the unique name of the report\nyou want to delete.\n", - "operationId": "deleteSubscription", - "x-devcenter-metaData": { - "categoryTag": "Reporting" - }, - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "reportName", - "in": "path", - "description": "Name of the Report to Delete", - "required": true, - "type": "string", - "maxLength": 80, - "minLength": 1, - "pattern": "[a-zA-Z0-9-_+]+" - } - ], - "responses": { - "200": { - "description": "Ok" - }, - "400": { - "description": "Invalid request", - "schema": { - "title": "reportingV3ReportSubscriptionsNameDelete400Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "404": { - "description": "Subscription not found", - "schema": { - "title": "reportingV3ReportSubscriptionsnameDelete404Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - } - } - } - }, - "/reporting/v3/notification-of-changes": { - "get": { - "tags": [ - "NotificationOfChanges" - ], - "summary": "Get Notification Of Changes", - "description": "Download the Notification of Change report. This\nreport shows eCheck-related fields updated as a result of a\nresponse to an eCheck settlement transaction.\n", - "operationId": "getNotificationOfChangeReport", - "x-devcenter-metaData": { - "categoryTag": "Reporting" - }, - "x-queryParameterDefaults": { - "startTime": "2018-05-01T12:00:00-05:00", - "endTime": "2018-05-30T12:00:00-05:00" - }, - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "startTime", - "in": "query", - "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n", - "required": true, - "type": "string", - "format": "date-time" - }, { - "name": "endTime", - "in": "query", - "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n", - "required": true, - "type": "string", - "format": "date-time" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "title": "reportingV3NotificationofChangesGet200Response", - "type": "object", - "properties": { - "notificationOfChanges": { - "type": "array", - "description": "List of Notification Of Change Info values", - "items": { - "type": "object", - "properties": { - "merchantReferenceNumber": { - "type": "string", - "example": "TC30877-10", - "description": "Merchant Reference Number" - }, - "transactionReferenceNumber": { - "type": "string", - "example": "55563", - "description": "Transaction Reference Number" - }, - "time": { - "type": "string", - "example": "2017-10-01T10:10:10+05:00", - "format": "date-time", - "description": "Notification Of Change Date(ISO 8601 Extended)" - }, - "code": { - "type": "string", - "example": "TC30877-10", - "description": "Merchant Reference Number" - }, - "accountType": { - "type": "string", - "example": "Checking Account", - "description": "Account Type" - }, - "routingNumber": { - "type": "string", - "example": "123456789", - "description": "Routing Number" - }, - "accountNumber": { - "type": "string", - "example": "############1234", - "description": "Account Number" - }, - "consumerName": { - "type": "string", - "example": "Consumer Name", - "description": "Consumer Name" - } - }, - "description": "Notification Of Change" - } - } - } - } - }, - "400": { - "description": "Invalid request", - "schema": { - "title": "reportingV3NotificationofChangesGet400Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "401": { - "description": "Unauthorized. Token provided is no more valid." - }, - "404": { - "description": "Report not found", - "schema": { - "title": "reportingV3NotificationofChangesGet404Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "500": { - "description": "Internal Server Error", - "schema": { - "title": "reportingV3NotificationofChangesGet500Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - } - } - } - }, - "/reporting/v3/purchase-refund-details": { - "get": { - "tags": [ - "PurchaseAndRefundDetails" - ], - "summary": "Get Purchase and Refund details", - "description": "Download the Purchase and Refund Details\nreport. This report report includes all purchases and refund\ntransactions, as well as all activities related to transactions\nresulting in an adjustment to the net proceeds.\n", - "operationId": "getPurchaseAndRefundDetails", - "x-devcenter-metaData": { - "categoryTag": "Reporting" - }, - "x-queryParameterDefaults": { - "organizationId": "testrest", - "startTime": "2018-05-01T12:00:00-05:00", - "endTime": "2018-05-30T12:00:00-05:00", - "groupName": "groupName", - "paymentSubtype": "VI", - "viewBy": "requestDate", - "offset": "20", - "limit": "2000" - }, - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "startTime", - "in": "query", - "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n", - "required": true, - "type": "string", - "format": "date-time" - }, { - "name": "endTime", - "in": "query", - "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n", - "required": true, - "type": "string", - "format": "date-time" - }, { - "name": "organizationId", - "in": "query", - "description": "Valid Cybersource Organization Id", - "pattern": "[a-zA-Z0-9-_]+", - "required": false, - "type": "string", - "minLength": 1, - "maxLength": 32 - }, { - "name": "paymentSubtype", - "in": "query", - "description": "Payment Subtypes.\n - **ALL**: All Payment Subtypes\n - **VI** : Visa\n - **MC** : Master Card\n - **AX** : American Express\n - **DI** : Discover\n - **DP** : Pinless Debit\n", - "required": false, - "type": "string", - "default": "ALL", - "enum": [ - "ALL", - "VI", - "MC", - "AX", - "DI", - "DP" - ] - }, { - "name": "viewBy", - "in": "query", - "description": "View results by Request Date or Submission Date.\n - **requestDate** : Request Date\n - **submissionDate**: Submission Date\n", - "required": false, - "type": "string", - "default": "requestDate", - "enum": [ - "requestDate", - "submissionDate" - ] - }, { - "name": "groupName", - "in": "query", - "description": "Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds", - "required": false, - "type": "string" - }, { - "name": "offset", - "in": "query", - "description": "Offset of the Purchase and Refund Results.", - "required": false, - "type": "integer", - "format": "int32" - }, { - "name": "limit", - "in": "query", - "description": "Results count per page. Range(1-2000)", - "required": false, - "type": "integer", - "minimum": 1, - "maximum": 2000, - "default": 2000, - "format": "int32" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "title": "reportingV3PurchaseRefundDetailsGet200Response", - "type": "object", - "properties": { - "offset": { - "type": "integer" - }, - "limit": { - "type": "integer" - }, - "pageResults": { - "type": "integer" - }, - "requestDetails": { - "type": "array", - "description": "List of Request Info values", - "items": { - "type": "object", - "properties": { - "requestId": { - "type": "string", - "example": "12345678901234567890123456", - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "cybersourceMerchantId": { - "type": "string", - "example": "Cybersource Merchant Id", - "description": "Cybersource Merchant Id" - }, - "processorMerchantId": { - "type": "string", - "example": "Processor Merchant Id", - "description": "Cybersource Processor Merchant Id" - }, - "groupName": { - "type": "string", - "example": "996411990498708810001", - "description": "Group Name" - }, - "transactionReferenceNumber": { - "type": "string", - "example": "RZ3J9WCS9J33", - "description": "Transaction Reference Number" - }, - "merchantReferenceNumber": { - "type": "string", - "example": "47882339", - "description": "Merchant Reference Number" - } - }, - "description": "Request Info Section" - } - }, - "settlements": { - "type": "array", - "description": "List of Settlement Info values", - "items": { - "type": "object", - "properties": { - "requestId": { - "type": "string", - "example": "12345678901234567890123456", - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "transactionType": { - "type": "string", - "example": "Purchases", - "description": "Transaction Type" - }, - "submissionTime": { - "type": "string", - "example": "2017-10-01T10:10:10+05:00", - "description": "Submission Date", - "format": "date-time" - }, - "amount": { - "type": "string", - "example": "23.00", - "description": "Amount" - }, - "currencyCode": { - "type": "string", - "example": "USD", - "description": "Valid ISO 4217 ALPHA-3 currency code" - }, - "paymentMethod": { - "type": "string", - "example": "VISA", - "description": "payment method" - }, - "walletType": { - "type": "string", - "example": "V.me", - "description": "Solution Type (Wallet)" - }, - "paymentType": { - "type": "string", - "example": "credit card", - "description": "Payment Type" - }, - "accountSuffix": { - "type": "string", - "example": "0004", - "description": "Account Suffix" - }, - "cybersourceBatchTime": { - "type": "string", - "example": "2017-10-01T10:10:10+05:00", - "description": "Cybersource Batch Time", - "format": "date-time" - }, - "cybersourceBatchId": { - "type": "string", - "example": "123123123123123", - "description": "Cybersource Batch Id" - }, - "cardType": { - "type": "string", - "example": "null", - "description": "Card Type" - }, - "debitNetwork": { - "type": "string", - "example": "", - "description": "Debit Network" - } - } - } - }, - "authorizations": { - "type": "array", - "description": "List of Authorization Info values", - "items": { - "type": "object", - "properties": { - "requestId": { - "type": "string", - "example": "12345678901234567890123456", - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "transactionReferenceNumber": { - "type": "string", - "example": "RZ3J9WCS9J27", - "description": "Authorization Transaction Reference Number" - }, - "time": { - "type": "string", - "example": "2017-10-01T10:10:10+05:00", - "description": "Authorization Date", - "format": "date-time" - }, - "authorizationRequestId": { - "type": "string", - "example": "12345678901234567890123459", - "description": "Authorization Request Id" - }, - "amount": { - "type": "string", - "example": "2.50", - "description": "Authorization Amount" - }, - "currencyCode": { - "type": "string", - "example": "USD", - "description": "Valid ISO 4217 ALPHA-3 currency code" - }, - "code": { - "type": "string", - "example": "160780", - "description": "Authorization Code" - }, - "rcode": { - "type": "string", - "example": "1", - "description": "Authorization RCode" - } - }, - "description": "Authorization Info Values" - } - }, - "feeAndFundingDetails": { - "type": "array", - "description": "List of Fee Funding Info values", - "items": { - "type": "object", - "properties": { - "requestId": { - "type": "string", - "maxLength": 26, - "example": "12345678901234567890123456", - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "interchangePerItemFee": { - "type": "string", - "example": "2.7", - "description": "interchange Per Item Fee" - }, - "discountPercentage": { - "type": "string", - "example": "2.39", - "description": "Discount Percentage" - }, - "discountAmount": { - "type": "string", - "example": "0.429", - "description": "Discount Amount" - }, - "discountPerItemFee": { - "type": "string", - "example": "0.002", - "description": "Discount Per Item Fee" - }, - "totalFee": { - "type": "string", - "example": "0.429", - "description": "Total Fee" - }, - "feeCurrency": { - "type": "string", - "example": "1", - "description": "Fee Currency" - }, - "duesAssessments": { - "type": "string", - "example": "0", - "description": "Dues Assessments" - }, - "fundingAmount": { - "type": "string", - "example": "2.50", - "description": "Funding Amount" - }, - "fundingCurrency": { - "type": "string", - "example": "USD", - "description": "Funding Currency (ISO 4217)" - } - }, - "description": "Fee Funding Section" - } - }, - "others": { - "type": "array", - "description": "List of Other Info values", - "items": { - "type": "object", - "properties": { - "requestId": { - "type": "string", - "maxLength": 26, - "example": "12345678901234567890123456", - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "merchantData1": { - "type": "string", - "example": "Merchant Defined Data", - "description": "Merchant Defined Data" - }, - "merchantData2": { - "type": "string", - "example": "Merchant Defined Data", - "description": "Merchant Defined Data" - }, - "merchantData3": { - "type": "string", - "example": "Merchant Defined Data", - "description": "Merchant Defined Data" - }, - "merchantData4": { - "type": "string", - "example": "Merchant Defined Data", - "description": "Merchant Defined Data" - }, - "firstName": { - "type": "string", - "example": "First Name", - "description": "First Name" - }, - "lastName": { - "type": "string", - "example": "Last Name", - "description": "Last Name" - } - }, - "description": "Other Merchant Details Values." - } - }, - "settlementStatuses": { - "type": "array", - "description": "List of Settlement Status Info values", - "items": { - "type": "object", - "properties": { - "requestId": { - "type": "string", - "maxLength": 26, - "example": "12345678901234567890123456", - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "status": { - "type": "string", - "example": "Settlement Status", - "description": "Settlement Status" - }, - "settlementTime": { - "type": "string", - "example": "2017-10-01T10:10:10+05:00", - "format": "date-time", - "description": "Settlement Date" - }, - "reasonCode": { - "example": "reasonCode", - "type": "string", - "description": "ReasonCode" - }, - "errorText": { - "example": "errorText", - "type": "string", - "description": "errorText" - } - }, - "description": "Settlement Status Section Values." - } - } - } - } - }, - "400": { - "description": "Invalid request", - "schema": { - "title": "reportingV3PurchaseRefundDetailsGet400Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "401": { - "description": "Unauthorized", - "schema": { - "title": "reportingV3PurchaseRefundDetailsGet401Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "404": { - "description": "Report not found", - "schema": { - "title": "reportingV3PurchaseRefundDetailsGet404Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "500": { - "description": "Internal Server Error", - "schema": { - "title": "reportingV3PurchaseRefundDetailsGet500Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - }, - "examples": { - "application/json": { - "code": "SERVER_ERROR", - "correlationId": null, - "detail": "Internal Server Error. Please contact the customer support.", - "localizationKey": "cybsapi.server.error", - "message": "Error encountered while processing request" - } - } - } - } - } - }, - "/reporting/v3/conversion-details": { - "get": { - "tags": [ - "ConversionDetails" - ], - "summary": "Get conversion detail transactions", - "description": "Get conversion detail of transactions for a merchant.", - "operationId": "getConversionDetail", - "x-devcenter-metaData": { - "categoryTag": "Reporting", - "isClientSideApi": true - }, - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "startTime", - "in": "query", - "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n", - "required": true, - "type": "string", - "format": "date-time" - }, { - "name": "endTime", - "in": "query", - "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n", - "required": true, - "type": "string", - "format": "date-time" - }, { - "name": "organizationId", - "in": "query", - "description": "Valid Cybersource Organization Id", - "pattern": "[a-zA-Z0-9-_]+", - "required": false, - "type": "string", - "minLength": 1, - "maxLength": 32 - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "title": "reportingV3ConversionDetailsGet200Response", - "type": "object", - "properties": { - "organizationId": { - "type": "string", - "description": "Merchant Id", - "example": "testMerchantId" - }, - "startTime": { - "type": "string", - "format": "date-time", - "example": "2017-10-01T10:10:10+05:00" - }, - "endTime": { - "type": "string", - "format": "date-time", - "example": "2017-10-01T10:10:10+05:00" - }, - "conversionDetails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "merchantReferenceNumber": { - "type": "string", - "description": "Merchant reference number of a merchant", - "example": "1234567890" - }, - "conversionTime": { - "type": "string", - "format": "date-time", - "description": "Date of conversion", - "example": "2017-10-01T10:10:10+05:00" - }, - "requestId": { - "type": "string", - "description": "Cybersource Transation request id", - "example": "1234567890123456789012" - }, - "originalDecision": { - "type": "string", - "description": "Original decision", - "example": "REVIEW" - }, - "newDecision": { - "type": "string", - "description": "New decision", - "example": "ACCEPT" - }, - "reviewer": { - "type": "string", - "description": "User name of the reviewer", - "example": "testuserId" - }, - "reviewerComments": { - "type": "string", - "description": "Comments of the reviewer", - "example": "Verified order." - }, - "queue": { - "type": "string", - "description": "Name of the queue", - "example": "Review Queue" - }, - "profile": { - "type": "string", - "description": "Name of the profile", - "example": "Test Profile" - }, - "notes": { - "type": "array", - "items": { - "type": "object", - "properties": { - "time": { - "type": "string", - "format": "date-time", - "description": "Time of the note added by reviewer", - "example": "2017-10-01T10:10:10+05:00" - }, - "addedBy": { - "type": "string", - "description": "Note added by reviewer", - "example": "testuserId" - }, - "comments": { - "type": "string", - "description": "Comments given by the reviewer", - "example": "Verified the order and accepted." - } - }, - "xml": { - "name": "note" - } - } - } - }, - "xml": { - "name": "conversionDataPoint" - } - } - } - }, - "xml": { - "name": "conversionDetailResponse" - } - } - }, - "400": { - "description": "Invalid request", - "schema": { - "title": "reportingV3ConversionDetailsGet400Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "404": { - "description": "Conversion detail not found", - "schema": { - "title": "reportingV3ConversionDetailsGet404Response" - } - } - } - } - }, - "/reporting/v3/net-fundings": { - "get": { - "tags": [ - "NetFundings" - ], - "summary": "Get Netfunding information for an account or a merchant", - "description": "Get Netfunding information for an account or a merchant.", - "operationId": "getNetFundingInfo", - "x-devcenter-metaData": { - "categoryTag": "Reporting", - "isClientSideApi": true - }, - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "startTime", - "in": "query", - "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n", - "required": true, - "type": "string", - "format": "date-time" - }, { - "name": "endTime", - "in": "query", - "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ssXXX\n", - "required": true, - "type": "string", - "format": "date-time" - }, { - "name": "organizationId", - "in": "query", - "description": "Valid Cybersource Organization Id", - "pattern": "[a-zA-Z0-9-_]+", - "required": false, - "type": "string", - "minLength": 1, - "maxLength": 32 - }, { - "name": "groupName", - "in": "query", - "description": "Valid CyberSource Group Name.", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "title": "reportingV3NetFundingsGet200Response", - "type": "object", - "properties": { - "startTime": { - "type": "string", - "description": "Valid report Start Date in **ISO 8601 format**.\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n**Example:**\n- yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n", - "example": "2017-10-01T10:10:10+05:00", - "format": "date-time", - "xml": { - "attribute": true - } - }, - "endTime": { - "type": "string", - "description": "Valid report End Date in **ISO 8601 format**\n**Example date format:**\n- yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n", - "example": "2018-04-12T23:20:50.52Z", - "format": "date-time", - "xml": { - "attribute": true - } - }, - "netFundingSummaries": { - "type": "array", - "description": "List of Netfunding summary objects", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "enum": [ - "PURCHASES", - "REFUNDS", - "FEES", - "CHARGEBACKS" - ], - "example": "PURCHASES" - }, - "paymentSubType": { - "type": "string", - "example": "VI" - }, - "conveyedCount": { - "type": "integer", - "example": 10 - }, - "conveyedAmount": { - "type": "string", - "example": "100.50" - }, - "settledCount": { - "type": "integer", - "example": 10 - }, - "fundedCount": { - "type": "integer", - "example": 10 - }, - "fundedAmount": { - "type": "string", - "example": "150.50" - }, - "currencyCode": { - "type": "string", - "description": "Valid ISO 4217 ALPHA-3 currency code", - "example": "USD" - } - }, - "xml": { - "name": "NetFundingSummary" - } - }, - "xml": { - "name": "NetFundingSummaries", - "wrapped": true - } - }, - "totalPurchases": { - "type": "array", - "description": "List of total purchases currency wise", - "items": { - "type": "object", - "required": [ - "currency", - "value" - ], - "properties": { - "currency": { - "type": "string", - "description": "Valid ISO 4217 ALPHA-3 currency code", - "example": "USD" - }, - "value": { - "type": "string", - "example": "10.01" - } - }, - "xml": { - "name": "Amount" - } - }, - "xml": { - "name": "totalPurchases", - "wrapped": true - } - }, - "totalRefunds": { - "type": "array", - "description": "List of total refunds currency wise", - "items": { - "type": "object", - "required": [ - "currency", - "value" - ], - "properties": { - "currency": { - "type": "string", - "description": "Valid ISO 4217 ALPHA-3 currency code", - "example": "USD" - }, - "value": { - "type": "string", - "example": "10.01" - } - }, - "xml": { - "name": "Amount" - } - }, - "xml": { - "name": "totalRefunds", - "wrapped": true - } - }, - "totalFees": { - "type": "array", - "description": "List of total fees currency wise", - "items": { - "type": "object", - "required": [ - "currency", - "value" - ], - "properties": { - "currency": { - "type": "string", - "description": "Valid ISO 4217 ALPHA-3 currency code", - "example": "USD" - }, - "value": { - "type": "string", - "example": "10.01" - } - }, - "xml": { - "name": "Amount" - } - }, - "xml": { - "name": "totalFees", - "wrapped": true - } - }, - "totalChargebacks": { - "type": "array", - "description": "List of total chargebacks currency wise", - "items": { - "type": "object", - "required": [ - "currency", - "value" - ], - "properties": { - "currency": { - "type": "string", - "description": "Valid ISO 4217 ALPHA-3 currency code", - "example": "USD" - }, - "value": { - "type": "string", - "example": "10.01" - } - }, - "xml": { - "name": "Amount" - } - }, - "xml": { - "name": "totalChargebacks", - "wrapped": true - } - }, - "netTotal": { - "type": "array", - "description": "List of new total currency wise", - "items": { - "type": "object", - "required": [ - "currency", - "value" - ], - "properties": { - "currency": { - "type": "string", - "description": "Valid ISO 4217 ALPHA-3 currency code", - "example": "USD" - }, - "value": { - "type": "string", - "example": "10.01" - } - }, - "xml": { - "name": "Amount" - } - }, - "xml": { - "name": "netTotal", - "wrapped": true - } - } - } - } - }, - "400": { - "description": "Invalid request", - "schema": { - "title": "reportingV3NetFundingsGet400Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - } - }, - "401": { - "description": "Unauthorized", - "schema": { - "title": "reportingV3NetFundingsGet401Response" - } - }, - "403": { - "description": "Forbidden", - "schema": { - "title": "reportingV3NetFundingsGet403Response" - } - }, - "404": { - "description": "Report not found", - "schema": { - "title": "reportingV3NetFundingsGet404Response" - } - }, - "500": { - "description": "Internal Server Error", - "schema": { - "title": "reportingV3NetFundingsGet500Response", - "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC\n", - "example": "1549650141000" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" - }, - "message": { - "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" - }, - "details": { - "type": "array", - "description": "Error field list\n", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "Field in request that caused an error\n" - }, - "reason": { - "type": "string", - "description": "Documented reason code\n" - } - }, - "description": "Provides failed validation input field detail\n" - } - } - }, - "description": "HTTP status code for client application" - }, - "examples": { - "application/json": { - "code": "SERVER_ERROR", - "correlationId": null, - "detail": null, - "fields": [], - "localizationKey": "cybsapi.server.error", - "message": "Error encountered while processing request" - } - } - } - } - } - }, - "/sfs/v1/file-details": { - "get": { - "tags": [ - "SecureFileShare" - ], - "summary": "Get list of files", - "description": "Get list of files and it's information of them available inside the report directory", - "operationId": "getFileDetails", - "produces": [ - "application/hal+json" - ], - "parameters": [{ - "name": "startDate", - "in": "query", - "description": "Valid start date in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd\n", - "required": true, - "type": "string", - "format": "date" - }, { - "name": "endDate", - "in": "query", - "description": "Valid end date in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd\n", - "required": true, - "type": "string", - "format": "date" - }, { - "name": "organizationId", - "in": "query", - "description": "Valid Cybersource Organization Id", - "pattern": "[a-zA-Z0-9-_]+", - "required": false, - "type": "string", - "minLength": 1, - "maxLength": 32 - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "type": "object", - "title": "V1FileDetailsGet200Response", - "properties": { - "fileDetails": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fileId": { - "type": "string", - "description": "Unique identifier of a file", - "example": "AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B" - }, - "name": { - "type": "string", - "description": "Name of the file", - "example": "MyTransactionDetailreport.xml" - }, - "createdTime": { - "type": "string", - "format": "date-time", - "description": "Date and time for the file in PST", - "example": "2017-10-01T00:00:00+05:00" - }, - "lastModifiedTime": { - "type": "string", - "format": "date-time", - "description": "Date and time for the file in PST", - "example": "2017-10-01T00:00:00+05:00" - }, - "date": { - "type": "string", - "format": "date", - "description": "Date and time for the file in PST", - "example": "2017-10-05" - }, - "mimeType": { - "type": "string", - "description": "File extension", - "enum": [ - "application/xml", - "text/csv", - "application/pdf", - "application/octet-stream" - ], - "example": "application/xml" - }, - "size": { - "type": "integer", - "description": "Size of the file in bytes", - "example": 2245397 - } - } - } - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "/sfs/v1/file-details?startDate=2018-01-01&endDate=2018-01-02" - }, - "method": { - "type": "string", - "example": "GET" - } - } - }, - "files": { - "type": "array", - "items": { - "type": "object", - "properties": { - "fileId": { - "type": "string", - "description": "Unique identifier for each file", - "example": "AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B" - }, - "href": { - "type": "string", - "example": "/sfs/v1/files/AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B" - }, - "method": { - "type": "string", - "example": "GET" - } - } - } - } - } - } - } - } - }, - "400": { - "description": "Invalid request", - "schema": { - "type": "object", - "title": "V1FileDetailsGet400Response", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "Error code" - }, - "message": { - "type": "string", - "description": "Error message" - }, - "localizationKey": { - "type": "string", - "description": "Localization Key Name" - }, - "correlationId": { - "type": "string", - "description": "Correlation Id" - }, - "detail": { - "type": "string", - "description": "Error Detail" - }, - "fields": { - "type": "array", - "description": "Error fields List", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "Path of the failed property" - }, - "message": { - "type": "string", - "description": "Error description about validation failed field" - }, - "localizationKey": { - "type": "string", - "description": "Localized Key Name" - } - }, - "description": "Provide validation failed input field details" - } - } - }, - "description": "Error Bean" - }, - "examples": { - "application/json": { - "code": "VALIDATION_ERROR", - "correlationId": null, - "detail": null, - "fields": [{ - "path": "startTime", - "message": "Start date should not precede 18 months from current time in GMT", - "localizationKey": null - } - ], - "localizationKey": "cybsapi.validation.errors", - "message": "Field validation errors" - } - } - }, - "401": { - "description": "Ok", - "schema": { - "type": "object", - "title": "V1FileDetailsGet401Response", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "Error code" - }, - "message": { - "type": "string", - "description": "Error message" - }, - "localizationKey": { - "type": "string", - "description": "Localization Key Name" - }, - "correlationId": { - "type": "string", - "description": "Correlation Id" - }, - "detail": { - "type": "string", - "description": "Error Detail" - }, - "fields": { - "type": "array", - "description": "Error fields List", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "Path of the failed property" - }, - "message": { - "type": "string", - "description": "Error description about validation failed field" - }, - "localizationKey": { - "type": "string", - "description": "Localized Key Name" - } - }, - "description": "Provide validation failed input field details" - } - } - }, - "description": "Error Bean" - }, - "examples": { - "application/json": { - "code": "VALIDATION_ERROR", - "correlationId": null, - "detail": null, - "fields": [{ - "path": "organizationId", - "message": "Organization doesn't has access to File details", - "localizationKey": null - } - ], - "localizationKey": "cybsapi.validation.errors", - "message": "Field validation errors" - } - } - }, - "404": { - "description": "Files Info not found", - "schema": { - "type": "object", - "title": "V1FileDetailsGet404Response", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "Error code" - }, - "message": { - "type": "string", - "description": "Error message" - }, - "localizationKey": { - "type": "string", - "description": "Localization Key Name" - }, - "correlationId": { - "type": "string", - "description": "Correlation Id" - }, - "detail": { - "type": "string", - "description": "Error Detail" - }, - "fields": { - "type": "array", - "description": "Error fields List", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "Path of the failed property" - }, - "message": { - "type": "string", - "description": "Error description about validation failed field" - }, - "localizationKey": { - "type": "string", - "description": "Localized Key Name" - } - }, - "description": "Provide validation failed input field details" - } - } - }, - "description": "Error Bean" - }, - "examples": { - "application/json": { - "code": "RESOURCE_NOTFOUND", - "correlationId": null, - "detail": "The requested resource is not found. Please try again later.", - "localizationKey": "cybsapi.resource.notfound", - "message": "Files Info not found for requested input values" - } - } - }, - "500": { - "description": "Internal Server Error", - "schema": { - "type": "object", - "title": "V1FileDetailsGet500Response", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "Error code" - }, - "message": { - "type": "string", - "description": "Error message" - }, - "localizationKey": { - "type": "string", - "description": "Localization Key Name" - }, - "correlationId": { - "type": "string", - "description": "Correlation Id" - }, - "detail": { - "type": "string", - "description": "Error Detail" - }, - "fields": { - "type": "array", - "description": "Error fields List", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "Path of the failed property" - }, - "message": { - "type": "string", - "description": "Error description about validation failed field" - }, - "localizationKey": { - "type": "string", - "description": "Localized Key Name" - } - }, - "description": "Provide validation failed input field details" - } - } - }, - "description": "Error Bean" - }, - "examples": { - "application/json": { - "code": "SERVER_ERROR", - "correlationId": null, - "detail": "Internal Server Error. Please contact the customer support.", - "localizationKey": "cybsapi.server.error", - "message": "Error encountered while processing request" - } - } - } - } - } - }, - "/sfs/v1/files/{fileId}": { - "get": { - "tags": [ - "SecureFileShare" - ], - "summary": "Download a file with file identifier", - "description": "Download a file for the given file identifier", - "operationId": "getFile", - "produces": [ - "application/xml", - "text/csv", - "application/pdf" - ], - "parameters": [{ - "name": "fileId", - "in": "path", - "description": "Unique identifier for each file", - "required": true, - "type": "string" - }, { - "name": "organizationId", - "in": "query", - "description": "Valid Cybersource Organization Id", - "pattern": "[a-zA-Z0-9-_]+", - "required": false, - "type": "string", - "minLength": 1, - "maxLength": 32 - } - ], - "responses": { - "200": { - "description": "OK" - }, - "400": { - "description": "Invalid Request", - "schema": { - "type": "object", - "title": "V1FilesGet400Response", - "required": [ - "code", - "message" - ], - "properties": { - "code": { - "type": "string", - "description": "Error code" - }, - "message": { - "type": "string", - "description": "Error message" - }, - "localizationKey": { - "type": "string", - "description": "Localization Key Name" - }, - "correlationId": { - "type": "string", - "description": "Correlation Id" - }, - "detail": { - "type": "string", - "description": "Error Detail" - }, - "fields": { - "type": "array", - "description": "Error fields List", - "items": { - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "Path of the failed property" - }, - "message": { - "type": "string", - "description": "Error description about validation failed field" - }, - "localizationKey": { - "type": "string", - "description": "Localized Key Name" - } - }, - "description": "Provide validation failed input field details" - } - } - }, - "description": "Error Bean" - } - }, - "404": { - "description": "No Reports Found" - } - } - } - }, - "/tms/v1/instrumentidentifiers": { - "post": { - "summary": "Create an Instrument Identifier", - "operationId": "tmsV1InstrumentidentifiersPost", - "parameters": [{ - "name": "profile-id", - "in": "header", - "description": "The id of a profile containing user specific TMS configuration.", - "required": true, - "type": "string", - "minLength": 36, - "maxLength": 36 - }, { - "name": "Body", - "in": "body", - "description": "Please specify either a Card or Bank Account.", - "required": true, - "schema": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "id": { - "type": "string", - "readOnly": true, - "example": "1234567890123456800", - "description": "Unique identification number assigned by CyberSource to the submitted request." - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "instrumentIdentifier" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Credit card number (PAN)." - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Bank account number." - }, - "routingNumber": { - "type": "string", - "example": "123456789", - "minLength": 1, - "maxLength": 9, - "description": "Routing number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." - } - } - } - } - } - } - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - } - } - } - } - ], - "tags": [ - "InstrumentIdentifiers" - ], - "x-example": { - "example0": { - "summary": "Create an Instrument Identifier", - "value": { - "card": { - "number": "1234567890987654" - }, - "processingInformation": { - "authorizationOptions": { - "initiator": { - "merchantInitiatedTransaction": { - "previousTransactionId": "123456789012345" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "An existing Instrument Identifier holding the same supplied data has been returned.", - "headers": { - "Location": { - "description": "Link to the Instrument Identifier.", - "type": "string" - }, - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "object", - "title": "tmsV1InstrumentidentifiersPost200Response", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "id": { - "type": "string", - "readOnly": true, - "example": "1234567890123456800", - "description": "Unique identification number assigned by CyberSource to the submitted request." - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "instrumentIdentifier" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Credit card number (PAN)." - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Bank account number." - }, - "routingNumber": { - "type": "string", - "example": "123456789", - "minLength": 1, - "maxLength": 9, - "description": "Routing number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." - } - } - } - } - } - } - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - } - } - }, - "examples": { - "application/json": { - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - }, - "paymentInstruments": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments" - }, - "id": "1234567890123456789", - "object": "instrumentIdentifier", - "state": "ACTIVE", - "card": { - "number": "444444XXXXXX4444" - }, - "processingInformation": { - "authorizationOptions": { - "initiator": { - "merchantInitiatedTransaction": { - "previousTransactionId": "123456789012345" - } - } - } - }, - "metadata": { - "creator": "user" - } - } - } - }, - "201": { - "description": "A new Instrument Identifier has been created.", - "headers": { - "Location": { - "description": "Link to the Instrument identifier.", - "type": "string" - }, - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "object", - "title": "tmsV1InstrumentidentifiersPost201Response", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "id": { - "type": "string", - "readOnly": true, - "example": "1234567890123456800", - "description": "Unique identification number assigned by CyberSource to the submitted request." - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "instrumentIdentifier" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Credit card number (PAN)." - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Bank account number." - }, - "routingNumber": { - "type": "string", - "example": "123456789", - "minLength": 1, - "maxLength": 9, - "description": "Routing number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." - } - } - } - } - } - } - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - } - } - }, - "examples": { - "application/json": { - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - }, - "paymentInstruments": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments" - } - }, - "id": "1234567890123456789", - "object": "instrumentIdentifier", - "state": "ACTIVE", - "card": { - "number": "444444XXXXXX4444" - }, - "processingInformation": { - "authorizationOptions": { - "initiator": { - "merchantInitiatedTransaction": { - "previousTransactionId": "123456789012345" - } - } - } - }, - "metadata": { - "creator": "user" - } - } - } - }, - "400": { - "description": "Bad Request: e.g. A required header value could be missing.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPost400Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "Missing Headers": { - "errors": [{ - "type": "missingHeaders", - "message": "Missing header values" - } - ] - } - } - }, - "403": { - "description": "Forbidden: e.g. The profile might not have permission to perform the token operation.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPost403Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "forbidden", - "message": "Request not permitted" - } - ] - } - } - }, - "424": { - "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPost424Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Profile not found" - } - ] - } - } - }, - "500": { - "description": "Unexpected error.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "serverError", - "message": "Internal server error" - } - ] - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPost500Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - } - } - } - } - }, - "/tms/v1/instrumentidentifiers/{tokenId}": { - "get": { - "summary": "Retrieve an Instrument Identifier", - "operationId": "tmsV1InstrumentidentifiersTokenIdGet", - "parameters": [{ - "name": "profile-id", - "in": "header", - "description": "The id of a profile containing user specific TMS configuration.", - "required": true, - "type": "string", - "minLength": 36, - "maxLength": 36 - }, { - "name": "tokenId", - "in": "path", - "description": "The TokenId of an Instrument Identifier.", - "required": true, - "type": "string", - "minLength": 16, - "maxLength": 32 - } - ], - "tags": [ - "InstrumentIdentifier" - ], - "responses": { - "200": { - "description": "An existing Instrument Identifier associated with the supplied tokenId has been returned.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "object", - "title": "tmsV1InstrumentidentifiersGet200Response", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "id": { - "type": "string", - "readOnly": true, - "example": "1234567890123456800", - "description": "Unique identification number assigned by CyberSource to the submitted request." - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "instrumentIdentifier" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Credit card number (PAN)." - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Bank account number." - }, - "routingNumber": { - "type": "string", - "example": "123456789", - "minLength": 1, - "maxLength": 9, - "description": "Routing number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." - } - } - } - } - } - } - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - } - } - }, - "x-examples": { - "application/json": { - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - }, - "paymentInstruments": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments" - } - }, - "id": "1234567890123456789", - "object": "instrumentIdentifier", - "state": "ACTIVE", - "card": { - "number": "444444XXXXXX4444" - }, - "processingInformation": { - "authorizationOptions": { - "initiator": { - "merchantInitiatedTransaction": { - "previousTransactionId": "123456789012345" - } - } - } - }, - "metadata": { - "creator": "user" - } - } - } - }, - "400": { - "description": "Bad Request: e.g. A required header value could be missing.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersGet400Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "Missing Headers": { - "errors": [{ - "type": "missingHeaders", - "message": "Missing header values" - } - ] - } - } - }, - "403": { - "description": "Forbidden: e.g. The profile might not have permission to perform the token operation.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersGet403Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "forbidden", - "message": "Request not permitted" - } - ] - } - } - }, - "404": { - "description": "Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersGet404Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Token not found" - } - ] - } - } - }, - "410": { - "description": "Token Not Available: e.g. The token has been deleted.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersGet410Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notAvailable", - "message": "Token not available" - } - ] - } - } - }, - "424": { - "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersGet424Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Profile not found" - } - ] - } - } - }, - "500": { - "description": "Unexpected error.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "serverError", - "message": "Internal server error" - } - ] - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersGet500Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - } - } - } - }, - "patch": { - "summary": "Update a Instrument Identifier", - "operationId": "tmsV1InstrumentidentifiersTokenIdPatch", - "parameters": [{ - "name": "profile-id", - "in": "header", - "description": "The id of a profile containing user specific TMS configuration.", - "required": true, - "type": "string", - "minLength": 36, - "maxLength": 36 - }, { - "name": "tokenId", - "in": "path", - "description": "The TokenId of an Instrument Identifier.", - "required": true, - "type": "string", - "minLength": 16, - "maxLength": 32 - }, { - "name": "Body", - "in": "body", - "description": "Please specify the previous transaction Id to update.", - "required": true, - "schema": { - "type": "object", - "properties": { - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." - } - } - } - } - } - } - } - } - } - } - } - } - ], - "tags": [ - "InstrumentIdentifier" - ], - "x-example": { - "example0": { - "summary": "Create an Instrument Identifier", - "value": { - "processingInformation": { - "authorizationOptions": { - "initiator": { - "merchantInitiatedTransaction": { - "previousTransactionId": "123456789012345" - } - } - } - } - } - } - }, - "responses": { - "200": { - "description": "The updated Instrument Identifier has been returned.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "object", - "title": "tmsV1InstrumentidentifiersPatch200Response", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "id": { - "type": "string", - "readOnly": true, - "example": "1234567890123456800", - "description": "Unique identification number assigned by CyberSource to the submitted request." - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "instrumentIdentifier" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Credit card number (PAN)." - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Bank account number." - }, - "routingNumber": { - "type": "string", - "example": "123456789", - "minLength": 1, - "maxLength": 9, - "description": "Routing number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." - } - } - } - } - } - } - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - } - } - }, - "examples": { - "application/json": { - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500" - } - }, - "id": "58FEBAEFD2EEFCE1E0539399D30A7500", - "object": "instrumentIdentifier", - "state": "ACTIVE", - "card": { - "number": "424242XXXXXX4242" - }, - "processingInformation": { - "authorizationOptions": { - "initiator": { - "merchantInitiatedTransaction": { - "previousTransactionId": 123456789012345 - } - } - } - }, - "metadata": { - "creator": "user" - } - } - } - }, - "400": { - "description": "Bad Request: e.g. A required header value could be missing.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPatch400Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "Missing Headers": { - "errors": [{ - "type": "missingHeaders", - "message": "Missing header values" - } - ] - }, - "Invalid Parameters": { - "errors": [{ - "type": "invalidParameters", - "message": "Invalid parameter values", - "details": [{ - "name": "id" - } - ] - } - ] - }, - "Unknown Field": { - "errors": [{ - "type": "unknownField", - "message": "Unknown body values", - "details": [{ - "name": "id" - } - ] - } - ] - }, - "Unsupported Fields": { - "errors": [{ - "type": "unsupportedFields", - "message": "Unsupported body values for this action", - "details": [{ - "name": "bankAccount" - }, { - "name": "card" - } - ] - } - ] - } - } - }, - "403": { - "description": "Forbidden: e.g. The profile might not have permission to perform the token operation.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPatch403Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "forbidden", - "message": "Request not permitted" - } - ] - } - } - }, - "404": { - "description": "Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPatch404Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Token not found" - } - ] - } - } - }, - "410": { - "description": "Token Not Available: e.g. The token has been deleted.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPatch410Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notAvailable", - "message": "Token not available" - } - ] - } - } - }, - "424": { - "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPatch424Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Profile not found" - } - ] - } - } - }, - "500": { - "description": "Unexpected error.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "serverError", - "message": "Internal server error" - } - ] - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPatch500Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete an Instrument Identifier", - "operationId": "tmsV1InstrumentidentifiersTokenIdDelete", - "tags": [ - "InstrumentIdentifier" - ], - "parameters": [{ - "name": "profile-id", - "in": "header", - "description": "The id of a profile containing user specific TMS configuration.", - "required": true, - "type": "string", - "minLength": 36, - "maxLength": 36 - }, { - "name": "tokenId", - "in": "path", - "description": "The TokenId of an Instrument Identifier.", - "required": true, - "type": "string", - "minLength": 16, - "maxLength": 32 - } - ], - "responses": { - "204": { - "description": "An existing Instrument Identifier associated with the supplied tokenId has been deleted.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - } - }, - "403": { - "description": "Forbidden: e.g. The profile might not have permission to perform the token operation.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersDelete403Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "forbidden", - "message": "Request not permitted" - } - ] - } - } - }, - "404": { - "description": "Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersDelete404Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Token not found" - } - ] - } - } - }, - "409": { - "description": "Conflict: e.g. The token is linked to a Payment Instrument.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersDelete409Response", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "paymentInstruments": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments" - } - } - } - } - } - }, - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "_links": { - "paymentInstruments": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/7010000000001621111/paymentinstruments" - } - }, - "errors": [{ - "type": "instrumentIdentifierDeletionError", - "message": "Action cannot be performed as the InstrumentIdentifier is associated with one or more PaymentInstruments." - } - ] - } - } - }, - "410": { - "description": "Token Not Available: e.g. The token has been deleted.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersDelete410Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notAvailable", - "message": "Token not available" - } - ] - } - } - }, - "424": { - "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersDelete424Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Profile not found" - } - ] - } - } - }, - "500": { - "description": "Unexpected error.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "serverError", - "message": "Internal server error" - } - ] - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersDelete500Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - } - } - } - } - }, - "/tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments": { - "get": { - "summary": "Retrieve all Payment Instruments associated with an Instrument Identifier", - "operationId": "tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet", - "parameters": [{ - "name": "profile-id", - "in": "header", - "description": "The id of a profile containing user specific TMS configuration.", - "required": true, - "type": "string", - "minLength": 36, - "maxLength": 36 - }, { - "name": "tokenId", - "in": "path", - "description": "The TokenId of an Instrument Identifier.", - "required": true, - "type": "string", - "minLength": 16, - "maxLength": 32 - }, { - "name": "offset", - "in": "query", - "description": "Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0.", - "required": false, - "type": "string", - "minimum": 0 - }, { - "name": "limit", - "in": "query", - "description": "The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100.", - "required": false, - "type": "string", - "default": "20", - "minimum": 1, - "maximum": 100 - } - ], - "tags": [ - "PaymentInstruments" - ], - "responses": { - "200": { - "description": "Returns an array of Payment Instruments associated with the supplied Instrument Identifier.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - }, - "x-Total-Count": { - "description": "The total number of Payment Instruments associated with the Instrument Identifier in the zero-based dataset.", - "type": "string" - } - }, - "schema": { - "type": "object", - "title": "tmsV1InstrumentidentifiersPaymentinstrumentsGet200Response", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "A link to the current requested collection.", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=20&limit=5\"" - } - } - }, - "first": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "A link to the collection starting at offset zero for the supplied limit.", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=0&limit=5" - } - } - }, - "prev": { - "type": "object", - "description": "A link to the previous collection starting at the supplied offset minus the supplied limit.", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=15&limit=5" - } - } - }, - "next": { - "type": "object", - "properties": { - "href": { - "description": "A link to the next collection starting at the supplied offset plus the supplied limit.", - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=25&limit=5" - } - } - }, - "last": { - "type": "object", - "properties": { - "href": { - "description": "A link to the last collection containing the remaining objects.", - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=35&limit=5" - } - } - } - } - }, - "object": { - "type": "string", - "readOnly": true, - "example": "collection", - "description": "Shows the response is a collection of objects.", - "enum": [ - "collection" - ] - }, - "offset": { - "type": "string", - "readOnly": true, - "example": "20", - "description": "The offset parameter supplied in the request." - }, - "limit": { - "type": "string", - "readOnly": true, - "example": "1", - "description": "The limit parameter supplied in the request." - }, - "count": { - "type": "string", - "readOnly": true, - "example": "1", - "description": "The number of Payment Instruments returned in the array." - }, - "total": { - "type": "string", - "readOnly": true, - "example": "39", - "description": "The total number of Payment Instruments associated with the Instrument Identifier in the zero-based dataset." - }, - "_embedded": { - "type": "object", - "description": "Array of Payment Instruments returned for the supplied Instrument Identifier.", - "items": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "id": { - "type": "string", - "readOnly": true, - "example": "1234567890123456800", - "description": "Unique identification number assigned by CyberSource to the submitted request." - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "paymentInstrument" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "bankAccount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "savings", - "description": "Type of Bank Account." - } - } - }, - "card": { - "type": "object", - "properties": { - "expirationMonth": { - "type": "string", - "example": "12", - "minimum": 1, - "maximum": 12, - "description": "Credit card expiration month." - }, - "expirationYear": { - "type": "string", - "example": "2022", - "minimum": 1900, - "maximum": 2099, - "description": "Credit card expiration year." - }, - "type": { - "type": "string", - "example": "visa", - "description": "Credit card brand.", - "enum": [ - "visa", - "mastercard", - "american express", - "discover", - "diners club", - "carte blanche", - "jcb", - "optima", - "twinpay credit", - "twinpay debit", - "walmart", - "enroute", - "lowes consumer", - "home depot consumer", - "mbna", - "dicks sportswear", - "casual corner", - "sears", - "jal", - "disney", - "maestro uk domestic", - "sams club consumer", - "sams club business", - "nicos", - "bill me later", - "bebe", - "restoration hardware", - "delta online", - "solo", - "visa electron", - "dankort", - "laser", - "carte bleue", - "carta si", - "pinless debit", - "encoded account", - "uatp", - "household", - "maestro international", - "ge money uk", - "korean cards", - "style", - "jcrew", - "payease china processing ewallet", - "payease china processing bank transfer", - "meijer private label", - "hipercard", - "aura", - "redecard", - "orico", - "elo", - "capital one private label", - "synchrony private label", - "china union pay" - ] - }, - "issueNumber": { - "type": "string", - "example": "01", - "minimum": 0, - "maximum": 99, - "description": "Credit card issue number." - }, - "startMonth": { - "type": "string", - "example": "12", - "minimum": 1, - "maximum": 12, - "description": "Credit card start month." - }, - "startYear": { - "type": "string", - "example": "12", - "minimum": 1900, - "maximum": 2099, - "description": "Credit card start year." - }, - "useAs": { - "type": "string", - "example": "pinless debit", - "description": "Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens." - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "companyTaxID": { - "type": "string", - "example": "1234567890123456800", - "maxLength": 9, - "description": "Company Tax ID." - }, - "currency": { - "type": "string", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "description": "Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha" - }, - "dateOBirth": { - "type": "string", - "example": "1960-12-30", - "description": "Date of birth YYYY-MM-DD." - }, - "personalIdentification": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1234567890", - "description": "Identification Number." - }, - "type": { - "type": "string", - "example": "driver license", - "description": "Type of personal identification." - }, - "issuedBy": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "example": "CA", - "description": "State or province where the identification was issued." - } - } - } - } - } - } - } - }, - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "example": "John", - "maxLength": 60, - "description": "Bill to First Name." - }, - "lastName": { - "type": "string", - "example": "Smith", - "maxLength": 60, - "description": "Bill to Last Name." - }, - "company": { - "type": "string", - "example": "CyberSource", - "maxLength": 60, - "description": "Bill to Company." - }, - "address1": { - "type": "string", - "example": "12 Main Street", - "maxLength": 60, - "description": "Bill to Address Line 1." - }, - "address2": { - "type": "string", - "example": "20 My Street", - "maxLength": 60, - "description": "Bill to Address Line 2." - }, - "locality": { - "type": "string", - "example": "Foster City", - "maxLength": 50, - "description": "Bill to City." - }, - "administrativeArea": { - "type": "string", - "example": "CA", - "maxLength": 20, - "description": "Bill to State." - }, - "postalCode": { - "type": "string", - "example": "90200", - "maxLength": 10, - "description": "Bill to Postal Code." - }, - "country": { - "type": "string", - "example": "US", - "minLength": 2, - "maxLength": 3, - "description": "Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2" - }, - "email": { - "type": "string", - "example": "john.smith@example.com", - "maxLength": 320, - "description": "Valid Bill to Email." - }, - "phoneNumber": { - "type": "string", - "example": "555123456", - "minLength": 6, - "maxLength": 32, - "description": "Bill to Phone Number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "billPaymentProgramEnabled": { - "type": "boolean", - "example": true, - "description": "Bill Payment Program Enabled." - }, - "bankTransferOptions": { - "type": "object", - "properties": { - "SECCode": { - "type": "string", - "example": "WEB", - "description": "Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB)." - } - } - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "alternateName": { - "type": "string", - "example": "Branch Name", - "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." - } - } - } - } - }, - "metaData": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - }, - "instrumentIdentifier": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "instrumentIdentifier" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "id": { - "type": "string", - "example": "1234567890123456789", - "minLength": 16, - "maxLength": 32, - "description": "The id of the existing instrument identifier to be linked to the newly created payment instrument." - }, - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Credit card number (PAN)." - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Bank account number." - }, - "routingNumber": { - "type": "string", - "example": "123456789", - "minLength": 1, - "maxLength": 9, - "description": "Routing number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." - } - } - } - } - } - } - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - } - } - } - } - } - } - } - }, - "examples": { - "application/json": { - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=20&limit=1" - }, - "first": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=0&limit=1" - }, - "prev": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=19&limit=1" - }, - "next": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=21&limit=1\"" - }, - "last": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=38&limit=1" - } - }, - "object": "collection", - "offset": 20, - "limit": 1, - "count": 1, - "total": 39, - "_embedded": { - "paymentInstruments": [{ - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/paymentinstruments/6036673B73B12F19E0539399D30A2566" - } - }, - "id": "6036673B73B12F19E0539399D30A2566", - "object": "paymentInstrument", - "state": "ACTIVE", - "card": { - "expirationMonth": "09", - "expirationYear": "2027", - "type": "visa", - "issueNumber": "01", - "startMonth": "01", - "startYear": "2017" - }, - "buyerInformation": { - "companyTaxId": "12345", - "currency": "USD" - }, - "billTo": { - "firstName": "John", - "lastName": "Smith", - "company": "CyberSource", - "address1": "1 My Apartment", - "address2": "Main Street", - "locality": "San Francisco", - "administrativeArea": "CA", - "postalCode": "90211", - "country": "US", - "email": "john.smith@test.com", - "phoneNumber": "+44 2890447777" - }, - "processingInformation": { - "billPaymentProgramEnabled": true - }, - "metadata": { - "creator": "user" - }, - "_embedded": { - "instrumentIdentifier": { - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1" - } - }, - "id": "5B32CE6167B09343E05333B9D30A53E1", - "object": "instrumentIdentifier", - "state": "ACTIVE", - "card": { - "number": "424242XXXXXX1237" - }, - "processingInformation": { - "authorizationOptions": { - "initiator": { - "merchantInitiatedTransaction": { - "previousTransactionId": "123456789012345" - } - } - } - }, - "metadata": { - "creator": "user" - } - } - } - } - ] - } - } - } - }, - "400": { - "description": "Bad Request: e.g. A required header value could be missing.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPaymentinstrumentsGet400Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "Missing Headers": { - "errors": [{ - "type": "missingHeaders", - "message": "Missing header values" - } - ] - } - } - }, - "403": { - "description": "Forbidden: e.g. The profile might not have permission to perform the token operation.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPaymentinstrumentsGet403Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "forbidden", - "message": "Request not permitted" - } - ] - } - } - }, - "404": { - "description": "Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPaymentinstrumentsGet404Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Token not found" - } - ] - } - } - }, - "410": { - "description": "Token Not Available: e.g. The token has been deleted.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPaymentinstrumentsGet410Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notAvailable", - "message": "Token not available" - } - ] - } - } - }, - "424": { - "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPaymentinstrumentsGet424Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Profile not found" - } - ] - } - } - }, - "500": { - "description": "Unexpected error.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "serverError", - "message": "Internal server error" - } - ] - } - }, - "schema": { - "type": "array", - "title": "tmsV1InstrumentidentifiersPaymentinstrumentsGet500Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - } - } - } - } - }, - "/tms/v1/paymentinstruments": { - "post": { - "summary": "Create a Payment Instrument", - "operationId": "tmsV1PaymentinstrumentsPost", - "parameters": [{ - "name": "profile-id", - "in": "header", - "description": "The id of a profile containing user specific TMS configuration.", - "required": true, - "type": "string", - "minLength": 36, - "maxLength": 36 - }, { - "name": "Body", - "in": "body", - "description": "Please specify the customers payment details for card or bank account.", - "required": true, - "schema": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "id": { - "type": "string", - "readOnly": true, - "example": "1234567890123456800", - "description": "Unique identification number assigned by CyberSource to the submitted request." - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "paymentInstrument" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "bankAccount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "savings", - "description": "Type of Bank Account." - } - } - }, - "card": { - "type": "object", - "properties": { - "expirationMonth": { - "type": "string", - "example": "12", - "minimum": 1, - "maximum": 12, - "description": "Credit card expiration month." - }, - "expirationYear": { - "type": "string", - "example": "2022", - "minimum": 1900, - "maximum": 2099, - "description": "Credit card expiration year." - }, - "type": { - "type": "string", - "example": "visa", - "description": "Credit card brand.", - "enum": [ - "visa", - "mastercard", - "american express", - "discover", - "diners club", - "carte blanche", - "jcb", - "optima", - "twinpay credit", - "twinpay debit", - "walmart", - "enroute", - "lowes consumer", - "home depot consumer", - "mbna", - "dicks sportswear", - "casual corner", - "sears", - "jal", - "disney", - "maestro uk domestic", - "sams club consumer", - "sams club business", - "nicos", - "bill me later", - "bebe", - "restoration hardware", - "delta online", - "solo", - "visa electron", - "dankort", - "laser", - "carte bleue", - "carta si", - "pinless debit", - "encoded account", - "uatp", - "household", - "maestro international", - "ge money uk", - "korean cards", - "style", - "jcrew", - "payease china processing ewallet", - "payease china processing bank transfer", - "meijer private label", - "hipercard", - "aura", - "redecard", - "orico", - "elo", - "capital one private label", - "synchrony private label", - "china union pay" - ] - }, - "issueNumber": { - "type": "string", - "example": "01", - "minimum": 0, - "maximum": 99, - "description": "Credit card issue number." - }, - "startMonth": { - "type": "string", - "example": "12", - "minimum": 1, - "maximum": 12, - "description": "Credit card start month." - }, - "startYear": { - "type": "string", - "example": "12", - "minimum": 1900, - "maximum": 2099, - "description": "Credit card start year." - }, - "useAs": { - "type": "string", - "example": "pinless debit", - "description": "Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens." - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "companyTaxID": { - "type": "string", - "example": "1234567890123456800", - "maxLength": 9, - "description": "Company Tax ID." - }, - "currency": { - "type": "string", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "description": "Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha" - }, - "dateOBirth": { - "type": "string", - "example": "1960-12-30", - "description": "Date of birth YYYY-MM-DD." - }, - "personalIdentification": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1234567890", - "description": "Identification Number." - }, - "type": { - "type": "string", - "example": "driver license", - "description": "Type of personal identification." - }, - "issuedBy": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "example": "CA", - "description": "State or province where the identification was issued." - } - } - } - } - } - } - } - }, - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "example": "John", - "maxLength": 60, - "description": "Bill to First Name." - }, - "lastName": { - "type": "string", - "example": "Smith", - "maxLength": 60, - "description": "Bill to Last Name." - }, - "company": { - "type": "string", - "example": "CyberSource", - "maxLength": 60, - "description": "Bill to Company." - }, - "address1": { - "type": "string", - "example": "12 Main Street", - "maxLength": 60, - "description": "Bill to Address Line 1." - }, - "address2": { - "type": "string", - "example": "20 My Street", - "maxLength": 60, - "description": "Bill to Address Line 2." - }, - "locality": { - "type": "string", - "example": "Foster City", - "maxLength": 50, - "description": "Bill to City." - }, - "administrativeArea": { - "type": "string", - "example": "CA", - "maxLength": 20, - "description": "Bill to State." - }, - "postalCode": { - "type": "string", - "example": "90200", - "maxLength": 10, - "description": "Bill to Postal Code." - }, - "country": { - "type": "string", - "example": "US", - "minLength": 2, - "maxLength": 3, - "description": "Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2" - }, - "email": { - "type": "string", - "example": "john.smith@example.com", - "maxLength": 320, - "description": "Valid Bill to Email." - }, - "phoneNumber": { - "type": "string", - "example": "555123456", - "minLength": 6, - "maxLength": 32, - "description": "Bill to Phone Number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "billPaymentProgramEnabled": { - "type": "boolean", - "example": true, - "description": "Bill Payment Program Enabled." - }, - "bankTransferOptions": { - "type": "object", - "properties": { - "SECCode": { - "type": "string", - "example": "WEB", - "description": "Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB)." - } - } - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "alternateName": { - "type": "string", - "example": "Branch Name", - "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." - } - } - } - } - }, - "metaData": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - }, - "instrumentIdentifier": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "instrumentIdentifier" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "id": { - "type": "string", - "example": "1234567890123456789", - "minLength": 16, - "maxLength": 32, - "description": "The id of the existing instrument identifier to be linked to the newly created payment instrument." - }, - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Credit card number (PAN)." - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Bank account number." - }, - "routingNumber": { - "type": "string", - "example": "123456789", - "minLength": 1, - "maxLength": 9, - "description": "Routing number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." - } - } - } - } - } - } - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - } - } - } - } - } - } - ], - "tags": [ - "PaymentInstruments" - ], - "x-example": { - "example0": { - "summary": "Create an payment Identifier", - "value": { - "card": { - "expirationMonth": "09", - "expirationYear": "2022", - "type": "visa" - }, - "billTo": { - "firstName": "John", - "lastName": "Smith", - "company": "CyberSource", - "address1": "12 Main Street", - "address2": "20 My Street", - "locality": "Foster City", - "administrativeArea": "CA", - "postalCode": "90200", - "country": "US", - "email": "john.smith@example.com", - "phoneNumber": "555123456" - }, - "instrumentIdentifier": { - "card": { - "number": "4111111111111111" - } - } - } - } - }, - "responses": { - "201": { - "description": "A new Payment Instrument has been created.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "object", - "title": "tmsV1PaymentinstrumentsPost201Response", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "id": { - "type": "string", - "readOnly": true, - "example": "1234567890123456800", - "description": "Unique identification number assigned by CyberSource to the submitted request." - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "paymentInstrument" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "bankAccount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "savings", - "description": "Type of Bank Account." - } - } - }, - "card": { - "type": "object", - "properties": { - "expirationMonth": { - "type": "string", - "example": "12", - "minLength": 1, - "maxLength": 12, - "description": "Credit card expiration month." - }, - "expirationYear": { - "type": "string", - "example": "2022", - "minimum": 1900, - "maximum": 2099, - "description": "Credit card expiration year." - }, - "type": { - "type": "string", - "example": "visa", - "description": "Credit card brand.", - "enum": [ - "visa", - "mastercard", - "american express", - "discover", - "diners club", - "carte blanche", - "jcb", - "optima", - "twinpay credit", - "twinpay debit", - "walmart", - "enroute", - "lowes consumer", - "home depot consumer", - "mbna", - "dicks sportswear", - "casual corner", - "sears", - "jal", - "disney", - "maestro uk domestic", - "sams club consumer", - "sams club business", - "nicos", - "bill me later", - "bebe", - "restoration hardware", - "delta online", - "solo", - "visa electron", - "dankort", - "laser", - "carte bleue", - "carta si", - "pinless debit", - "encoded account", - "uatp", - "household", - "maestro international", - "ge money uk", - "korean cards", - "style", - "jcrew", - "payease china processing ewallet", - "payease china processing bank transfer", - "meijer private label", - "hipercard", - "aura", - "redecard", - "orico", - "elo", - "capital one private label", - "synchrony private label", - "china union pay" - ] - }, - "issueNumber": { - "type": "string", - "example": "01", - "minimum": 0, - "maximum": 99, - "description": "Credit card issue number." - }, - "startMonth": { - "type": "string", - "example": "12", - "minimum": 1, - "maximum": 12, - "description": "Credit card start month." - }, - "startYear": { - "type": "string", - "example": "12", - "minimum": 1900, - "maximum": 2099, - "description": "Credit card start year." - }, - "useAs": { - "type": "string", - "example": "pinless debit", - "description": "Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens." - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "companyTaxID": { - "type": "string", - "example": "1234567890123456800", - "maxLength": 9, - "description": "Company Tax ID." - }, - "currency": { - "type": "string", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "description": "Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha" - }, - "dateOBirth": { - "type": "string", - "example": "1960-12-30", - "description": "Date of birth YYYY-MM-DD." - }, - "personalIdentification": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1234567890", - "description": "Identification Number." - }, - "type": { - "type": "string", - "example": "driver license", - "description": "Type of personal identification." - }, - "issuedBy": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "example": "CA", - "description": "State or province where the identification was issued." - } - } - } - } - } - } - } - }, - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "example": "John", - "maxLength": 60, - "description": "Bill to First Name." - }, - "lastName": { - "type": "string", - "example": "Smith", - "maxLength": 60, - "description": "Bill to Last Name." - }, - "company": { - "type": "string", - "example": "CyberSource", - "maxLength": 60, - "description": "Bill to Company." - }, - "address1": { - "type": "string", - "example": "12 Main Street", - "maxLength": 60, - "description": "Bill to Address Line 1." - }, - "address2": { - "type": "string", - "example": "20 My Street", - "maxLength": 60, - "description": "Bill to Address Line 2." - }, - "locality": { - "type": "string", - "example": "Foster City", - "maxLength": 50, - "description": "Bill to City." - }, - "administrativeArea": { - "type": "string", - "example": "CA", - "maxLength": 20, - "description": "Bill to State." - }, - "postalCode": { - "type": "string", - "example": "90200", - "maxLength": 10, - "description": "Bill to Postal Code." - }, - "country": { - "type": "string", - "example": "US", - "minLength": 2, - "maxLength": 3, - "description": "Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2" - }, - "email": { - "type": "string", - "example": "john.smith@example.com", - "maxLength": 320, - "description": "Valid Bill to Email." - }, - "phoneNumber": { - "type": "string", - "example": "555123456", - "minLength": 6, - "maxLength": 32, - "description": "Bill to Phone Number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "billPaymentProgramEnabled": { - "type": "boolean", - "example": true, - "description": "Bill Payment Program Enabled." - }, - "bankTransferOptions": { - "type": "object", - "properties": { - "SECCode": { - "type": "string", - "example": "WEB", - "description": "Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB)." - } - } - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "alternateName": { - "type": "string", - "example": "Branch Name", - "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." - } - } - } - } - }, - "metaData": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - }, - "instrumentIdentifier": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "instrumentIdentifier" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "id": { - "type": "string", - "example": "1234567890123456789", - "minLength": 16, - "maxLength": 32, - "description": "The id of the existing instrument identifier to be linked to the newly created payment instrument." - }, - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Credit card number (PAN)." - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Bank account number." - }, - "routingNumber": { - "type": "string", - "example": "123456789", - "minLength": 1, - "maxLength": 9, - "description": "Routing number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." - } - } - } - } - } - } - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - } - } - } - } - }, - "examples": { - "application/json": { - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/paymentinstruments/5910683634E6B035E0539399D30A4B46" - } - }, - "id": "5910683634E6B035E0539399D30A4B46", - "object": "paymentInstrument", - "state": "ACTIVE", - "card": { - "expirationMonth": 11, - "expirationYear": 2020, - "type": "visa", - "issueNumber": 1, - "startMonth": 12, - "startYear": 2017 - }, - "buyerInformation": { - "companyTaxID": 12345, - "currency": "USD" - }, - "billTo": { - "firstName": "John", - "lastName": "Smith", - "company": "Cybersource", - "address1": "1 My Apartment", - "address2": "20 My Street", - "locality": "San Francisco", - "administrativeArea": "CA", - "postalCode": 90210, - "country": "US", - "email": "ohn.smith@test.com", - "phoneNumber": "+44 289044795" - }, - "processingInformation": { - "billPaymentProgramEnabled": true - }, - "metadata": { - "creator": "user" - }, - "_embedded": { - "instrumentIdentifier": { - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500" - } - }, - "id": "58FEBAEFD2EEFCE1E0539399D30A7500", - "object": "instrumentIdentifier", - "state": "ACTIVE", - "card": { - "number": "424242XXXXXX4242" - }, - "processingInformation": { - "authorizationOptions": { - "initiator": { - "merchantInitiatedTransaction": { - "previousTransactionId": 123456789012345 - } - } - } - }, - "metadata": { - "creator": "user" - } - } - } - } - } - }, - "400": { - "description": "Bad Request: e.g. A required header value could be missing.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsPost400Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "Missing Headers": { - "errors": [{ - "type": "missingHeaders", - "message": "Missing header values" - } - ] - }, - "Payment Instrument cannot be linked to instrument identifier because it does not exist": { - "errors": [{ - "type": "instrumentIdentifierNotFound", - "message": "Action cannot be performed as the InstrumentIdentifier is not found" - } - ] - }, - "Payment Instrument cannot be linked to instrument identifier because it has been deleted": { - "errors": [{ - "type": "instrumentIdentifierGone", - "message": "Action cannot be performed as the InstrumentIdentifier has gone" - } - ] - }, - "Payment Instrument cannot be linked to instrument identifier due to a token type mismatch": { - "errors": [{ - "type": "invalidCombination", - "message": "The combination is invalid", - "details": [{ - "name": "bankAccount" - }, { - "name": "card", - "location": "instrumentIdentifier" - } - ] - } - ] - }, - "Payment Instrument cannot be created due to invalid combination of Instrument Identifier fields": { - "errors": [{ - "type": "invalidCombination", - "message": "The combination is invalid", - "details": [{ - "name": "id", - "location": "instrumentIdentifier" - }, { - "name": "card", - "location": "instrumentIdentifier" - } - ] - } - ] - } - } - }, - "403": { - "description": "Forbidden: e.g. The profile might not have permission to perform the token operation.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsPost403Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "forbidden", - "message": "Request not permitted" - } - ] - } - } - }, - "424": { - "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsPost424Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Profile not found" - } - ] - } - } - }, - "500": { - "description": "Unexpected error.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "serverError", - "message": "Internal server error" - } - ] - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsPost500Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - } - } - } - } - }, - "/tms/v1/paymentinstruments/{tokenId}": { - "patch": { - "summary": "Update a Payment Instrument", - "operationId": "tmsV1PaymentinstrumentsTokenIdPatch", - "parameters": [{ - "name": "profile-id", - "in": "header", - "description": "The id of a profile containing user specific TMS configuration.", - "required": true, - "type": "string", - "minLength": 36, - "maxLength": 36 - }, { - "name": "tokenId", - "in": "path", - "description": "The TokenId of a Payment Instrument.", - "required": true, - "type": "string", - "minLength": 16, - "maxLength": 32 - }, { - "name": "Body", - "in": "body", - "description": "Please specify the customers payment details.", - "required": true, - "schema": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "id": { - "type": "string", - "readOnly": true, - "example": "1234567890123456800", - "description": "Unique identification number assigned by CyberSource to the submitted request." - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "paymentInstrument" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "bankAccount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "savings", - "description": "Type of Bank Account." - } - } - }, - "card": { - "type": "object", - "properties": { - "expirationMonth": { - "type": "string", - "example": "12", - "minimum": 1, - "maximum": 12, - "description": "Credit card expiration month." - }, - "expirationYear": { - "type": "string", - "example": "2022", - "minimum": 1900, - "maximum": 2099, - "description": "Credit card expiration year." - }, - "type": { - "type": "string", - "example": "visa", - "description": "Credit card brand.", - "enum": [ - "visa", - "mastercard", - "american express", - "discover", - "diners club", - "carte blanche", - "jcb", - "optima", - "twinpay credit", - "twinpay debit", - "walmart", - "enroute", - "lowes consumer", - "home depot consumer", - "mbna", - "dicks sportswear", - "casual corner", - "sears", - "jal", - "disney", - "maestro uk domestic", - "sams club consumer", - "sams club business", - "nicos", - "bill me later", - "bebe", - "restoration hardware", - "delta online", - "solo", - "visa electron", - "dankort", - "laser", - "carte bleue", - "carta si", - "pinless debit", - "encoded account", - "uatp", - "household", - "maestro international", - "ge money uk", - "korean cards", - "style", - "jcrew", - "payease china processing ewallet", - "payease china processing bank transfer", - "meijer private label", - "hipercard", - "aura", - "redecard", - "orico", - "elo", - "capital one private label", - "synchrony private label", - "china union pay" - ] - }, - "issueNumber": { - "type": "string", - "example": "01", - "minimum": 0, - "maximum": 99, - "description": "Credit card issue number." - }, - "startMonth": { - "type": "string", - "example": "12", - "minimum": 1, - "maximum": 12, - "description": "Credit card start month." - }, - "startYear": { - "type": "string", - "example": "12", - "minimum": 1900, - "maximum": 2099, - "description": "Credit card start year." - }, - "useAs": { - "type": "string", - "example": "pinless debit", - "description": "Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens." - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "companyTaxID": { - "type": "string", - "example": "1234567890123456800", - "maxLength": 9, - "description": "Company Tax ID." - }, - "currency": { - "type": "string", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "description": "Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha" - }, - "dateOBirth": { - "type": "string", - "example": "1960-12-30", - "description": "Date of birth YYYY-MM-DD." - }, - "personalIdentification": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1234567890", - "description": "Identification Number." - }, - "type": { - "type": "string", - "example": "driver license", - "description": "Type of personal identification." - }, - "issuedBy": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "example": "CA", - "description": "State or province where the identification was issued." - } - } - } - } - } - } - } - }, - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "example": "John", - "maxLength": 60, - "description": "Bill to First Name." - }, - "lastName": { - "type": "string", - "example": "Smith", - "maxLength": 60, - "description": "Bill to Last Name." - }, - "company": { - "type": "string", - "example": "CyberSource", - "maxLength": 60, - "description": "Bill to Company." - }, - "address1": { - "type": "string", - "example": "12 Main Street", - "maxLength": 60, - "description": "Bill to Address Line 1." - }, - "address2": { - "type": "string", - "example": "20 My Street", - "maxLength": 60, - "description": "Bill to Address Line 2." - }, - "locality": { - "type": "string", - "example": "Foster City", - "maxLength": 50, - "description": "Bill to City." - }, - "administrativeArea": { - "type": "string", - "example": "CA", - "maxLength": 20, - "description": "Bill to State." - }, - "postalCode": { - "type": "string", - "example": "90200", - "maxLength": 10, - "description": "Bill to Postal Code." - }, - "country": { - "type": "string", - "example": "US", - "minLength": 2, - "maxLength": 3, - "description": "Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2" - }, - "email": { - "type": "string", - "example": "john.smith@example.com", - "maxLength": 320, - "description": "Valid Bill to Email." - }, - "phoneNumber": { - "type": "string", - "example": "555123456", - "minLength": 6, - "maxLength": 32, - "description": "Bill to Phone Number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "billPaymentProgramEnabled": { - "type": "boolean", - "example": true, - "description": "Bill Payment Program Enabled." - }, - "bankTransferOptions": { - "type": "object", - "properties": { - "SECCode": { - "type": "string", - "example": "WEB", - "description": "Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB)." - } - } - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "alternateName": { - "type": "string", - "example": "Branch Name", - "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." - } - } - } - } - }, - "metaData": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - }, - "instrumentIdentifier": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "instrumentIdentifier" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "id": { - "type": "string", - "example": "1234567890123456789", - "minLength": 16, - "maxLength": 32, - "description": "The id of the existing instrument identifier to be linked to the newly created payment instrument." - }, - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Credit card number (PAN)." - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Bank account number." - }, - "routingNumber": { - "type": "string", - "example": "123456789", - "minLength": 1, - "maxLength": 9, - "description": "Routing number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." - } - } - } - } - } - } - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - } - } - } - } - } - } - ], - "tags": [ - "PaymentInstruments" - ], - "x-example": { - "example0": { - "summary": "Update Payment Instrument", - "value": { - "card": { - "expirationMonth": "09", - "expirationYear": "2022", - "type": "visa" - }, - "billTo": { - "firstName": "John", - "lastName": "Smith", - "company": "CyberSource", - "address1": "12 Main Street", - "address2": "20 My Street", - "locality": "Foster City", - "administrativeArea": "CA", - "postalCode": "90200", - "country": "US", - "email": "john.smith@example.com", - "phoneNumber": "555123456" - }, - "instrumentIdentifier": { - "card": { - "number": "4111111111111111" - } - } - } - } - }, - "responses": { - "200": { - "description": "The updated Payment Instrument has been returned.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "object", - "title": "tmsV1PaymentinstrumentsPatch200Response", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "id": { - "type": "string", - "readOnly": true, - "example": "1234567890123456800", - "description": "Unique identification number assigned by CyberSource to the submitted request." - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "paymentInstrument" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "bankAccount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "savings", - "description": "Type of Bank Account." - } - } - }, - "card": { - "type": "object", - "properties": { - "expirationMonth": { - "type": "string", - "example": "12", - "minimum": 1, - "maximum": 12, - "description": "Credit card expiration month." - }, - "expirationYear": { - "type": "string", - "example": "2022", - "minimum": 1900, - "maximum": 2099, - "description": "Credit card expiration year." - }, - "type": { - "type": "string", - "example": "visa", - "description": "Credit card brand.", - "enum": [ - "visa", - "mastercard", - "american express", - "discover", - "diners club", - "carte blanche", - "jcb", - "optima", - "twinpay credit", - "twinpay debit", - "walmart", - "enroute", - "lowes consumer", - "home depot consumer", - "mbna", - "dicks sportswear", - "casual corner", - "sears", - "jal", - "disney", - "maestro uk domestic", - "sams club consumer", - "sams club business", - "nicos", - "bill me later", - "bebe", - "restoration hardware", - "delta online", - "solo", - "visa electron", - "dankort", - "laser", - "carte bleue", - "carta si", - "pinless debit", - "encoded account", - "uatp", - "household", - "maestro international", - "ge money uk", - "korean cards", - "style", - "jcrew", - "payease china processing ewallet", - "payease china processing bank transfer", - "meijer private label", - "hipercard", - "aura", - "redecard", - "orico", - "elo", - "capital one private label", - "synchrony private label", - "china union pay" - ] - }, - "issueNumber": { - "type": "string", - "example": "01", - "minimum": 0, - "maximum": 99, - "description": "Credit card issue number." - }, - "startMonth": { - "type": "string", - "example": "12", - "minimum": 1, - "maximum": 12, - "description": "Credit card start month." - }, - "startYear": { - "type": "string", - "example": "12", - "minimum": 1900, - "maximum": 2099, - "description": "Credit card start year." - }, - "useAs": { - "type": "string", - "example": "pinless debit", - "description": "Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens." - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "companyTaxID": { - "type": "string", - "example": "1234567890123456800", - "maxLength": 9, - "description": "Company Tax ID." - }, - "currency": { - "type": "string", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "description": "Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha" - }, - "dateOBirth": { - "type": "string", - "example": "1960-12-30", - "description": "Date of birth YYYY-MM-DD." - }, - "personalIdentification": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1234567890", - "description": "Identification Number." - }, - "type": { - "type": "string", - "example": "driver license", - "description": "Type of personal identification." - }, - "issuedBy": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "example": "CA", - "description": "State or province where the identification was issued." - } - } - } - } - } - } - } - }, - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "example": "John", - "maxLength": 60, - "description": "Bill to First Name." - }, - "lastName": { - "type": "string", - "example": "Smith", - "maxLength": 60, - "description": "Bill to Last Name." - }, - "company": { - "type": "string", - "example": "CyberSource", - "maxLength": 60, - "description": "Bill to Company." - }, - "address1": { - "type": "string", - "example": "12 Main Street", - "maxLength": 60, - "description": "Bill to Address Line 1." - }, - "address2": { - "type": "string", - "example": "20 My Street", - "maxLength": 60, - "description": "Bill to Address Line 2." - }, - "locality": { - "type": "string", - "example": "Foster City", - "maxLength": 50, - "description": "Bill to City." - }, - "administrativeArea": { - "type": "string", - "example": "CA", - "maxLength": 20, - "description": "Bill to State." - }, - "postalCode": { - "type": "string", - "example": "90200", - "maxLength": 10, - "description": "Bill to Postal Code." - }, - "country": { - "type": "string", - "example": "US", - "minLength": 2, - "maxLength": 3, - "description": "Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2" - }, - "email": { - "type": "string", - "example": "john.smith@example.com", - "maxLength": 320, - "description": "Valid Bill to Email." - }, - "phoneNumber": { - "type": "string", - "example": "555123456", - "minLength": 6, - "maxLength": 32, - "description": "Bill to Phone Number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "billPaymentProgramEnabled": { - "type": "boolean", - "example": true, - "description": "Bill Payment Program Enabled." - }, - "bankTransferOptions": { - "type": "object", - "properties": { - "SECCode": { - "type": "string", - "example": "WEB", - "description": "Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB)." - } - } - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "alternateName": { - "type": "string", - "example": "Branch Name", - "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." - } - } - } - } - }, - "metaData": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - }, - "instrumentIdentifier": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "instrumentIdentifier" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "id": { - "type": "string", - "example": "1234567890123456789", - "minLength": 16, - "maxLength": 32, - "description": "The id of the existing instrument identifier to be linked to the newly created payment instrument." - }, - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Credit card number (PAN)." - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Bank account number." - }, - "routingNumber": { - "type": "string", - "example": "123456789", - "minLength": 1, - "maxLength": 9, - "description": "Routing number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." - } - } - } - } - } - } - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - } - } - } - } - }, - "examples": { - "application/json": { - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/paymentinstruments/5910683634E6B035E0539399D30A4B46" - } - }, - "id": "5910683634E6B035E0539399D30A4B46", - "object": "paymentInstrument", - "state": "ACTIVE", - "card": { - "expirationMonth": 11, - "expirationYear": 2020, - "type": "visa", - "issueNumber": 1, - "startMonth": 12, - "startYear": 2017 - }, - "buyerInformation": { - "companyTaxID": 12345, - "currency": "USD" - }, - "billTo": { - "firstName": "John", - "lastName": "Smith", - "company": "Cybersource", - "address1": "1 My Apartment", - "address2": "20 My Street", - "locality": "San Francisco", - "administrativeArea": "CA", - "postalCode": 90210, - "country": "US", - "email": "ohn.smith@test.com", - "phoneNumber": "+44 289044795" - }, - "processingInformation": { - "billPaymentProgramEnabled": true - }, - "metadata": { - "creator": "user" - }, - "_embedded": { - "instrumentIdentifier": { - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500" - } - }, - "id": "58FEBAEFD2EEFCE1E0539399D30A7500", - "object": "instrumentIdentifier", - "state": "ACTIVE", - "card": { - "number": "424242XXXXXX4242" - }, - "processingInformation": { - "authorizationOptions": { - "initiator": { - "merchantInitiatedTransaction": { - "previousTransactionId": 123456789012345 - } - } - } - }, - "metadata": { - "creator": "user" - } - } - } - } - } - }, - "400": { - "description": "Bad Request: e.g. A required header value could be missing.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsPatch400Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "Missing Headers": { - "errors": [{ - "type": "missingHeaders", - "message": "Missing header values" - } - ] - }, - "Payment Instrument cannot be linked to instrument identifier because it does not exist": { - "errors": [{ - "type": "instrumentIdentifierNotFound", - "message": "Action cannot be performed as the InstrumentIdentifier is not found" - } - ] - }, - "Payment Instrument cannot be linked to instrument identifier because it has been deleted": { - "errors": [{ - "type": "instrumentIdentifierGone", - "message": "Action cannot be performed as the InstrumentIdentifier has gone" - } - ] - }, - "Payment Instrument cannot be linked to instrument identifier due to a token type mismatch": { - "errors": [{ - "type": "invalidCombination", - "message": "The combination is invalid", - "details": [{ - "name": "bankAccount" - }, { - "name": "card", - "location": "instrumentIdentifier" - } - ] - } - ] - }, - "Payment Instrument cannot be created due to invalid combination of Instrument Identifier fields": { - "errors": [{ - "type": "invalidCombination", - "message": "The combination is invalid", - "details": [{ - "name": "id", - "location": "instrumentIdentifier" - }, { - "name": "card", - "location": "instrumentIdentifier" - } - ] - } - ] - } - } - }, - "403": { - "description": "Forbidden: e.g. The profile might not have permission to perform the token operation.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsPatch403Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "forbidden", - "message": "Request not permitted" - } - ] - } - } - }, - "404": { - "description": "Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsPatch404Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Token not found" - } - ] - } - } - }, - "410": { - "description": "Token Not Available: e.g. The token has been deleted.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsPatch410Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notAvailable", - "message": "Token not available" - } - ] - } - } - }, - "424": { - "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsPatch424Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Profile not found" - } - ] - } - } - }, - "500": { - "description": "Unexpected error.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "serverError", - "message": "Internal server error" - } - ] - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsPatch500Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - } - } - } - }, - "get": { - "summary": "Retrieve a Payment Instrument", - "operationId": "tmsV1PaymentinstrumentsTokenIdGet", - "parameters": [{ - "name": "profile-id", - "in": "header", - "description": "The id of a profile containing user specific TMS configuration.", - "required": true, - "type": "string", - "minLength": 36, - "maxLength": 36 - }, { - "name": "tokenId", - "in": "path", - "description": "The TokenId of a Payment Instrument.", - "required": true, - "type": "string", - "minLength": 16, - "maxLength": 32 - } - ], - "tags": [ - "PaymentInstruments" - ], - "responses": { - "200": { - "description": "An existing Payment Instrument associated with the supplied tokenId has been returned.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "object", - "title": "tmsV1PaymentinstrumentsGet200Response", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "id": { - "type": "string", - "readOnly": true, - "example": "1234567890123456800", - "description": "Unique identification number assigned by CyberSource to the submitted request." - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "paymentInstrument" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "bankAccount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "example": "savings", - "description": "Type of Bank Account." - } - } - }, - "card": { - "type": "object", - "properties": { - "expirationMonth": { - "type": "string", - "example": "12", - "minimum": 1, - "maximum": 12, - "description": "Credit card expiration month." - }, - "expirationYear": { - "type": "string", - "example": "2022", - "minimum": 1900, - "maximum": 2099, - "description": "Credit card expiration year." - }, - "type": { - "type": "string", - "example": "visa", - "description": "Credit card brand.", - "enum": [ - "visa", - "mastercard", - "american express", - "discover", - "diners club", - "carte blanche", - "jcb", - "optima", - "twinpay credit", - "twinpay debit", - "walmart", - "enroute", - "lowes consumer", - "home depot consumer", - "mbna", - "dicks sportswear", - "casual corner", - "sears", - "jal", - "disney", - "maestro uk domestic", - "sams club consumer", - "sams club business", - "nicos", - "bill me later", - "bebe", - "restoration hardware", - "delta online", - "solo", - "visa electron", - "dankort", - "laser", - "carte bleue", - "carta si", - "pinless debit", - "encoded account", - "uatp", - "household", - "maestro international", - "ge money uk", - "korean cards", - "style", - "jcrew", - "payease china processing ewallet", - "payease china processing bank transfer", - "meijer private label", - "hipercard", - "aura", - "redecard", - "orico", - "elo", - "capital one private label", - "synchrony private label", - "china union pay" - ] - }, - "issueNumber": { - "type": "string", - "example": "01", - "minimum": 0, - "maximum": 99, - "description": "Credit card issue number." - }, - "startMonth": { - "type": "string", - "example": "12", - "minimum": 1, - "maximum": 12, - "description": "Credit card start month." - }, - "startYear": { - "type": "string", - "example": "12", - "minimum": 1900, - "maximum": 2099, - "description": "Credit card start year." - }, - "useAs": { - "type": "string", - "example": "pinless debit", - "description": "Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens." - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "companyTaxID": { - "type": "string", - "example": "1234567890123456800", - "maxLength": 9, - "description": "Company Tax ID." - }, - "currency": { - "type": "string", - "example": "USD", - "minLength": 3, - "maxLength": 3, - "description": "Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha" - }, - "dateOBirth": { - "type": "string", - "example": "1960-12-30", - "description": "Date of birth YYYY-MM-DD." - }, - "personalIdentification": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "example": "1234567890", - "description": "Identification Number." - }, - "type": { - "type": "string", - "example": "driver license", - "description": "Type of personal identification." - }, - "issuedBy": { - "type": "object", - "properties": { - "administrativeArea": { - "type": "string", - "example": "CA", - "description": "State or province where the identification was issued." - } - } - } - } - } - } - } - }, - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "example": "John", - "maxLength": 60, - "description": "Bill to First Name." - }, - "lastName": { - "type": "string", - "example": "Smith", - "maxLength": 60, - "description": "Bill to Last Name." - }, - "company": { - "type": "string", - "example": "CyberSource", - "maxLength": 60, - "description": "Bill to Company." - }, - "address1": { - "type": "string", - "example": "12 Main Street", - "maxLength": 60, - "description": "Bill to Address Line 1." - }, - "address2": { - "type": "string", - "example": "20 My Street", - "maxLength": 60, - "description": "Bill to Address Line 2." - }, - "locality": { - "type": "string", - "example": "Foster City", - "maxLength": 50, - "description": "Bill to City." - }, - "administrativeArea": { - "type": "string", - "example": "CA", - "maxLength": 20, - "description": "Bill to State." - }, - "postalCode": { - "type": "string", - "example": "90200", - "maxLength": 10, - "description": "Bill to Postal Code." - }, - "country": { - "type": "string", - "example": "US", - "minLength": 2, - "maxLength": 3, - "description": "Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2" - }, - "email": { - "type": "string", - "example": "john.smith@example.com", - "maxLength": 320, - "description": "Valid Bill to Email." - }, - "phoneNumber": { - "type": "string", - "example": "555123456", - "minLength": 6, - "maxLength": 32, - "description": "Bill to Phone Number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "billPaymentProgramEnabled": { - "type": "boolean", - "example": true, - "description": "Bill Payment Program Enabled." - }, - "bankTransferOptions": { - "type": "object", - "properties": { - "SECCode": { - "type": "string", - "example": "WEB", - "description": "Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB)." - } - } - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "alternateName": { - "type": "string", - "example": "Branch Name", - "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." - } - } - } - } - }, - "metaData": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - }, - "instrumentIdentifier": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - } - } - }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.", - "enum": [ - "instrumentIdentifier" - ] - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "Current state of the token.", - "enum": [ - "ACTIVE", - "CLOSED" - ] - }, - "id": { - "type": "string", - "example": "1234567890123456789", - "minLength": 16, - "maxLength": 32, - "description": "The id of the existing instrument identifier to be linked to the newly created payment instrument." - }, - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Credit card number (PAN)." - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Bank account number." - }, - "routingNumber": { - "type": "string", - "example": "123456789", - "minLength": 1, - "maxLength": 9, - "description": "Routing number." - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "authorizationOptions": { - "type": "object", - "properties": { - "initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." - } - } - } - } - } - } - } - } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } - } - } - } - } - }, - "x-examples": { - "application/json": { - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/paymentinstruments/5910683634E6B035E0539399D30A4B46" - } - }, - "id": "5910683634E6B035E0539399D30A4B46", - "object": "paymentInstrument", - "state": "ACTIVE", - "card": { - "expirationMonth": 11, - "expirationYear": 2020, - "type": "visa", - "issueNumber": 1, - "startMonth": 12, - "startYear": 2017 - }, - "buyerInformation": { - "companyTaxID": 12345, - "currency": "USD" - }, - "billTo": { - "firstName": "John", - "lastName": "Smith", - "company": "Cybersource", - "address1": "1 My Apartment", - "address2": "20 My Street", - "locality": "San Francisco", - "administrativeArea": "CA", - "postalCode": 90210, - "country": "US", - "email": "ohn.smith@test.com", - "phoneNumber": "+44 289044795" - }, - "processingInformation": { - "billPaymentProgramEnabled": true - }, - "metadata": { - "creator": "user" - }, - "_embedded": { - "instrumentIdentifier": { - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500" - } - }, - "id": "58FEBAEFD2EEFCE1E0539399D30A7500", - "object": "instrumentIdentifier", - "state": "ACTIVE", - "card": { - "number": "424242XXXXXX4242" - }, - "processingInformation": { - "authorizationOptions": { - "initiator": { - "merchantInitiatedTransaction": { - "previousTransactionId": 123456789012345 - } - } - } - }, - "metadata": { - "creator": "user" - } - } - } - } - } - }, - "400": { - "description": "Bad Request: e.g. A required header value could be missing.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsGet400Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "Missing Headers": { - "errors": [{ - "type": "missingHeaders", - "message": "Missing header values" - } - ] - } - } - }, - "403": { - "description": "Forbidden: e.g. The profile might not have permission to perform the token operation.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsGet403Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "forbidden", - "message": "Request not permitted" - } - ] - } - } - }, - "404": { - "description": "Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsGet404Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Token not found" - } - ] - } - } - }, - "410": { - "description": "Token Not Available: e.g. The token has been deleted.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsGet410Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notAvailable", - "message": "Token not available" - } - ] - } - } - }, - "424": { - "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsGet424Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Profile not found" - } - ] - } - } - }, - "500": { - "description": "Unexpected error.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "serverError", - "message": "Internal server error" - } - ] - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsGet500Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete a Payment Instrument", - "operationId": "tmsV1PaymentinstrumentsTokenIdDelete", - "tags": [ - "PaymentInstruments" - ], - "parameters": [{ - "name": "profile-id", - "in": "header", - "description": "The id of a profile containing user specific TMS configuration.", - "required": true, - "type": "string", - "minLength": 36, - "maxLength": 36 - }, { - "name": "tokenId", - "in": "path", - "description": "The TokenId of a Payment Instrument.", - "required": true, - "type": "string", - "minLength": 16, - "maxLength": 32 - } - ], - "responses": { - "204": { - "description": "An existing Payment Instrument associated with the supplied tokenId has been deleted.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - } - }, - "403": { - "description": "Forbidden: e.g. The profile might not have permission to perform the token operation.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsDelete403Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "forbidden", - "message": "Request not permitted" - } - ] - } - } - }, - "404": { - "description": "Token Not Found: e.g. The tokenid may not exist or was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsDelete404Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Token not found" - } - ] - } - } - }, - "410": { - "description": "Token Not Available: e.g. The token has been deleted.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsDelete410Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notAvailable", - "message": "Token not available" - } - ] - } - } - }, - "424": { - "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsDelete424Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "notFound", - "message": "Profile not found" - } - ] - } - } - }, - "500": { - "description": "Unexpected error.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "examples": { - "application/json": { - "errors": [{ - "type": "serverError", - "message": "Internal server error" - } - ] - } - }, - "schema": { - "type": "array", - "title": "tmsV1PaymentinstrumentsDelete500Response", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" - }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." - }, - "details": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the field that threw the error." - }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - } - } - } - } - } - }, - "/tss/v2/transactions/{id}": { - "get": { - "summary": "Retrieve a Transaction", - "description": "Include the Request ID in the GET request to retrieve the transaction details.", - "tags": [ - "TransactionDetails" - ], - "operationId": "getTransaction", - "parameters": [{ - "name": "id", - "in": "path", - "description": "Request ID.\n", - "required": true, - "type": "string" - } - ], - "x-example": { - "example0": { - "summary": "Retrieve a Transaction", - "value": {} - } - }, - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "title": "tssV2TransactionsGet200Response", - "type": "object", - "properties": { - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "rootId": { - "type": "string", - "maxLength": 26, - "description": "Payment Request Id" - }, - "reconciliationId": { - "type": "string", - "maxLength": 60, - "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" - }, - "merchantId": { - "type": "string", - "description": "The description for this field is not available." - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "applicationInformation": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "The status of the submitted transaction." - }, - "reasonCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "rCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "rFlag": { - "type": "string", - "description": "The description for this field is not available." - }, - "applications": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The description for this field is not available." - }, - "status": { - "type": "string", - "description": "The description for this field is not available." - }, - "reasonCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "rCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "rFlag": { - "type": "string", - "description": "The description for this field is not available." - }, - "reconciliationId": { - "type": "string", - "description": "The description for this field is not available." - }, - "rMessage": { - "type": "string", - "description": "The description for this field is not available." - }, - "returnCode": { - "type": "string", - "description": "The description for this field is not available." - } - } - } - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "merchantCustomerId": { - "type": "string", - "maxLength": 100, - "description": "Your identifier for the customer.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "hashedPassword": { - "type": "string", - "maxLength": 100, - "description": "The description for this field is not available.\n" - } - } - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n" - }, - "applicationVersion": { - "type": "string", - "description": "The description for this field is not available." - }, - "applicationName": { - "type": "string", - "description": "The application name of client which is used to submit the request." - }, - "applicationUser": { - "type": "string", - "description": "The description for this field is not available." - }, - "comments": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "consumerAuthenticationInformation": { - "type": "object", - "properties": { - "eciRaw": { - "type": "string", - "maxLength": 2, - "description": "Raw electronic commerce indicator (ECI)." - }, - "cavv": { - "type": "string", - "maxLength": 40, - "description": "Cardholder authentication verification value (CAVV)." - }, - "xid": { - "type": "string", - "maxLength": 40, - "description": "Transaction identifier." - }, - "transactionId": { - "type": "string", - "description": "Payer auth Transaction identifier." - } - } - }, - "deviceInformation": { - "type": "object", - "properties": { - "ipAddress": { - "type": "string", - "maxLength": 15, - "description": "IP address of the customer." - }, - "hostName": { - "type": "string", - "maxLength": 60, - "description": "DNS resolved hostname from above _ipAddress_." - }, - "cookiesAccepted": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "errorInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "description": "The description for this field is not available." - }, - "message": { - "type": "string", - "description": "The description for this field is not available." - }, - "details": { - "type": "array", - "items": { - "type": "object", - "properties": { - "field": { - "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." - }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - }, - "installmentInformation": { - "type": "object", - "properties": { - "numberOfInstallments": { - "type": "string", - "description": "Number of Installments." - } - } - }, - "fraudMarkingInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "merchantDefinedInformation": { - "type": "array", - "description": "The description for this field is not available.", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "maxLength": 50, - "description": "The description for this field is not available." - }, - "value": { - "type": "string", - "maxLength": 255, - "description": "The description for this field is not available." - } - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" - } - } - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "middelName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s middle name.\n" - }, - "nameSuffix": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s name suffix.\n" - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "address2": { - "type": "string", - "maxLength": 60, - "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "locality": { - "type": "string", - "maxLength": 50, - "description": "City of the billing address.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "company": { - "type": "string", - "maxLength": 60, - "description": "Name of the customer\u2019s company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "email": { - "type": "string", - "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "title": { - "type": "string", - "maxLength": 60, - "description": "Title.\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - }, - "shipTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Last name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "First line of the shipping address." - }, - "address2": { - "type": "string", - "maxLength": 60, - "description": "Second line of the shipping address." - }, - "locality": { - "type": "string", - "maxLength": 50, - "description": "City of the shipping address." - }, - "administrativeArea": { - "type": "string", - "maxLength": 2, - "description": "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" - }, - "postalCode": { - "type": "string", - "maxLength": 10, - "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n" - }, - "company": { - "type": "string", - "maxLength": 60, - "description": "Name of the customer\u2019s company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the shipping address. Use the two character ISO Standard Country Codes." - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Phone number for the shipping address." - } - } - }, - "lineItems": { - "type": "array", - "description": "Transaction Line Item data.", - "items": { - "type": "object", - "properties": { - "productCode": { - "type": "string", - "maxLength": 255, - "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\n\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n" - }, - "productName": { - "type": "string", - "maxLength": 255, - "description": "For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the\nvalues related to shipping and handling.\n" - }, - "productSku": { - "type": "string", - "maxLength": 255, - "description": "Identification code for the product. For PAYMENT and CAPTURE API, this field is required when above\n_productCode_ is not **default** or one of the values related to shipping and/or handling.\n" - }, - "taxAmount": { - "type": "string", - "maxLength": 15, - "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n1. You include each line item in your request.\n..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nThis field is frequently used for Level II and Level III transactions.\n" - }, - "quantity": { - "type": "number", - "minimum": 1, - "maximum": 9999999999, - "description": "For a payment or capture, this field is required when _productCode_ is not **default** or one of the values\nrelated to shipping and handling.\n", - "default": 1 - }, - "unitPrice": { - "type": "string", - "maxLength": 15, - "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "fulfillmentType": { - "type": "string", - "description": "The description for this field is not available." - } - } - } - }, - "amountDetails": { - "type": "object", - "properties": { - "totalAmount": { - "type": "string", - "maxLength": 19, - "description": "Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n" - }, - "taxAmount": { - "type": "string", - "maxLength": 12, - "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" - }, - "authorizedAmount": { - "type": "string", - "maxLength": 15, - "description": "Amount that was authorized.\n" - } - } - }, - "shippingDetails": { - "type": "object", - "properties": { - "giftWrap": { - "type": "boolean", - "description": "The description for this field is not available." - }, - "shippingMethod": { - "type": "string", - "maxLength": 10, - "description": "Shipping method for the product. Possible values:\n\n - lowcost: Lowest-cost service\n - sameday: Courier or same-day service\n - oneday: Next-day or overnight service\n - twoday: Two-day service\n - threeday: Three-day service\n - pickup: Store pick-up\n - other: Other shipping method\n - none: No shipping method because product is a service or subscription\n" - } - } - } - } - }, - "paymentInformation": { - "type": "object", - "properties": { - "paymentType": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The description for this field is not available." - }, - "type": { - "type": "string", - "description": "The description for this field is not available." - }, - "subType": { - "type": "string", - "description": "The description for this field is not available." - }, - "method": { - "type": "string", - "description": "The description for this field is not available." - }, - "fundingSource": { - "type": "string", - "description": "The description for this field is not available." - }, - "fundingSourceAffiliation": { - "type": "string", - "description": "The description for this field is not available." - }, - "credential": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "customer": { - "type": "object", - "properties": { - "customerId": { - "type": "string", - "description": "Unique identifier for the customer's card and billing information." - } - } - }, - "card": { - "type": "object", - "properties": { - "suffix": { - "type": "string", - "description": "Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n" - }, - "prefix": { - "type": "string", - "maxLength": 6, - "description": "The description for this field is not available." - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the credit card expires. `Format: YYYY`.\n\n**Encoded Account Numbers**\n\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "startMonth": { - "type": "string", - "maxLength": 2, - "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a\nblank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\nThe start date is not required for Maestro (UK Domestic) transactions.\n" - }, - "startYear": { - "type": "string", - "maxLength": 4, - "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a\nblank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\nThe start date is not required for Maestro (UK Domestic) transactions.\n" - }, - "issueNumber": { - "type": "string", - "maxLength": 5, - "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might\nnot have an issue number. The number can consist of one or two digits, and the first digit might be a zero.\nWhen you include this value in your request, include exactly what is printed on the card. A value of 2 is\ndifferent than a value of 02. Do not include the field, even with a blank value, if the card is not a\nMaestro (UK Domestic) card.\n\nThe issue number is not required for Maestro (UK Domestic) transactions.\n" - }, - "type": { - "type": "string", - "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n" - }, - "accountEncoderId": { - "type": "string", - "maxLength": 3, - "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor\nfor the bank\u2019s ID.\n" - }, - "useAs": { - "type": "string", - "maxLength": 2, - "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\n**Cielo** and **Comercio Latino**\n\nPossible values:\n\n - CREDIT: Credit card\n - DEBIT: Debit card\n\nThis field is required for:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n" - } - } - }, - "invoice": { - "type": "object", - "properties": { - "number": { - "type": "string", - "description": "Invoice Number." - }, - "barcodeNumber": { - "type": "string", - "description": "Barcode Number." - }, - "expirationDate": { - "type": "string", - "description": "Expiration Date." - } - } - }, - "bank": { - "type": "object", - "properties": { - "routingNumber": { - "type": "string", - "description": "The description for this field is not available." - }, - "branchCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "swiftCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "bankCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "iban": { - "type": "string", - "description": "The description for this field is not available." - }, - "account": { - "type": "object", - "properties": { - "suffix": { - "type": "string", - "description": "The description for this field is not available." - }, - "prefix": { - "type": "string", - "description": "The description for this field is not available." - }, - "checkNumber": { - "type": "string", - "description": "The description for this field is not available." - }, - "type": { - "type": "string", - "description": "The description for this field is not available." - }, - "name": { - "type": "string", - "description": "The description for this field is not available." - }, - "checkDigit": { - "type": "string", - "description": "The description for this field is not available." - }, - "encoderId": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "mandate": { - "type": "object", - "properties": { - "referenceNumber": { - "type": "string", - "description": "The description for this field is not available." - }, - "recurringType": { - "type": "string", - "description": "The description for this field is not available." - }, - "id": { - "type": "string", - "description": "The description for this field is not available." - } - } - } - } - }, - "accountFeatures": { - "type": "object", - "properties": { - "balanceAmount": { - "type": "string", - "maxLength": 12, - "description": "Remaining balance on the account.\n" - }, - "previousBalanceAmount": { - "type": "string", - "maxLength": 12, - "description": "Remaining balance on the account.\n" - }, - "currency": { - "type": "string", - "maxLength": 5, - "description": "Currency of the remaining balance on the account. For the possible values, see the ISO Standard Currency Codes.\n" - } - } - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "paymentSolution": { - "type": "string", - "maxLength": 12, - "description": "Type of digital payment solution that is being used for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout.\n - **001**: Apple Pay.\n - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct.\n - **006**: Android Pay.\n - **008**: Samsung Pay.\n" - }, - "commerceIndicator": { - "type": "string", - "maxLength": 20, - "description": "Type of transaction. Some payment card companies use this information when determining discount rates. When you\nomit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file\nfor you instead of the default value listed here.\n" - }, - "businessApplicationId": { - "type": "string", - "description": "The description for this field is not available." - }, - "authorizationOptions": { - "type": "object", - "properties": { - "authType": { - "type": "string", - "maxLength": 15, - "description": "Authorization type. Possible values:\n\n - **AUTOCAPTURE**: automatic capture.\n - **STANDARDCAPTURE**: standard capture.\n - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture\n request for a verbal payment.\n\nFor processor-specific information, see the auth_type field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - }, - "bankTransferOptions": { - "type": "object", - "properties": { - "secCode": { - "type": "string", - "description": "The description for this field is not available." - } - } - } - } - }, - "processorInformation": { - "type": "object", - "properties": { - "processor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 30, - "description": "Name of the Processor.\n" - } - } - }, - "transactionId": { - "type": "string", - "maxLength": 50, - "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n" - }, - "networkTransactionId": { - "type": "string", - "description": "The description for this field is not available." - }, - "responseId": { - "type": "string", - "description": "The description for this field is not available." - }, - "providerTransactionId": { - "type": "string", - "description": "The description for this field is not available." - }, - "approvalCode": { - "type": "string", - "description": "Authorization code. Returned only when the processor returns this value.\n" - }, - "responseCode": { - "type": "string", - "maxLength": 10, - "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n" - }, - "avs": { - "type": "object", - "properties": { - "code": { - "type": "string", - "description": "AVS result code.\n" - }, - "codeRaw": { - "type": "string", - "maxLength": 10, - "description": "AVS result code sent directly from the processor. Returned only when the processor returns this value.\nImportant Do not use this field to evaluate the result of AVS. Use for debugging purposes only.\n" - } - } - }, - "cardVerification": { - "type": "object", - "properties": { - "resultCode": { - "type": "string", - "maxLength": 1, - "description": "CVN result code.\n" - } - } - }, - "achVerification": { - "type": "object", - "properties": { - "resultCode": { - "type": "string", - "maxLength": 1, - "description": "The description for this field is not available..\n" - }, - "resultCodeRaw": { - "type": "string", - "maxLength": 10, - "description": "The description for this field is not available.\n" - } - } - }, - "electronicVerificationResults": { - "type": "object", - "properties": { - "email": { - "type": "string", - "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer\u2019s email address.\n" - }, - "emailRaw": { - "type": "string", - "maxLength": 1, - "description": "Raw Electronic Verification response code from the processor for the customer\u2019s email address." - }, - "name": { - "type": "string", - "maxLength": 30, - "description": "The description for this field is not available.\n" - }, - "nameRaw": { - "type": "string", - "maxLength": 30, - "description": "The description for this field is not available." - }, - "phoneNumber": { - "type": "string", - "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer\u2019s phone number.\n" - }, - "phoneNumberRaw": { - "type": "string", - "maxLength": 1, - "description": "Raw Electronic Verification response code from the processor for the customer\u2019s phone number." - }, - "street": { - "type": "string", - "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer\u2019s street address.\n" - }, - "streetRaw": { - "type": "string", - "maxLength": 1, - "description": "Raw Electronic Verification response code from the processor for the customer\u2019s street address." - }, - "postalCode": { - "type": "string", - "maxLength": 1, - "description": "Mapped Electronic Verification response code for the customer\u2019s postal code.\n" - }, - "postalCodeRaw": { - "type": "string", - "maxLength": 1, - "description": "Raw Electronic Verification response code from the processor for the customer\u2019s postal code." - } - } - } - } - }, - "pointOfSaleInformation": { - "type": "object", - "properties": { - "entryMode": { - "type": "string", - "maxLength": 11, - "description": "Method of entering credit card information into the POS terminal. Possible values:\n\n - contact: Read from direct contact with chip card.\n - contactless: Read from a contactless interface using chip data.\n - keyed: Manually keyed into POS terminal.\n - msd: Read from a contactless interface using magnetic stripe data (MSD).\n - swiped: Read from credit card magnetic stripe.\n\nThe contact, contactless, and msd values are supported only for EMV transactions.\n* Applicable only for CTV for Payouts.\n" - }, - "terminalCapability": { - "type": "integer", - "minimum": 1, - "maximum": 5, - "description": "POS terminal\u2019s capability. Possible values:\n\n - 1: Terminal has a magnetic stripe reader only.\n - 2: Terminal has a magnetic stripe reader and manual entry capability.\n - 3: Terminal has manual entry capability only.\n - 4: Terminal can read chip cards.\n - 5: Terminal can read contactless chip cards.\n\nThe values of 4 and 5 are supported only for EMV transactions.\n* Applicable only for CTV for Payouts. \n" - } - } - }, - "riskInformation": { - "type": "object", - "properties": { - "profile": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The description for this field is not available." - }, - "decision": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "rules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The description for this field is not available." - }, - "decision": { - "type": "string", - "description": "The description for this field is not available." - } - } - } - }, - "passiveProfile": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The description for this field is not available." - }, - "decision": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "passiveRules": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The description for this field is not available." - }, - "decision": { - "type": "string", - "description": "The description for this field is not available." - } - } - } - }, - "score": { - "type": "object", - "properties": { - "factorCodes": { - "type": "array", - "description": "Array of factor codes.", - "items": { - "type": "string", - "description": "Represents a factor code." - } - }, - "result": { - "type": "integer", - "description": "The description for this field is not available.\n" - } - } - }, - "localTime": { - "type": "string", - "description": "Time that the transaction was submitted in local time.." - } - } - }, - "senderInformation": { - "type": "object", - "properties": { - "referenceNumber": { - "type": "string", - "maxLength": 19, - "description": "Reference number generated by you that uniquely identifies the sender." - } - } - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" + "description": "This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer.\n" } } } } } }, - "example": { - "id": "5330579740206278601009", - "rootId": "5330571038726320201013", - "reconciliationId": "53703847LK9LPPXY", - "merchantId": "string", - "status": "PENDING", - "submitTimeUtc": "2018-07-31T17:26:14Z", - "applicationInformation": { - "status": "PENDING", - "reasonCode": "100", - "rCode": "string", - "rFlag": "string", - "applications": [{ - "name": "ics_bill", - "status": "PENDING", - "reasonCode": "100", - "rCode": "string", - "rFlag": "string", - "reconciliationId": "53703847LK9LPPXY", - "rMessage": "Request was processed successfully.", - "returnCode": "1260000" - } - ] - }, - "buyerInformation": { - "merchantCustomerId": "123456", - "hashedPassword": "fhjfhj" - }, - "clientReferenceInformation": { - "code": "ECERT001", - "applicationVersion": "1.0", - "applicationName": "string", - "applicationUser": "ng_paymentech", - "comments": "test comment" - }, - "consumerAuthenticationInformation": { - "eciRaw": "1234", - "cavv": "12345", - "xid": "12345678", - "transactionId": "string" - }, - "deviceInformation": { - "ipAddress": "1.10.10.10", - "hostName": "cybs test", - "cookiesAccepted": "no" - }, - "errorInformation": { - "reason": "string", - "message": "string", - "details": [{ - "field": "string", - "reason": "string" - } - ] - }, - "installmentInformation": { - "numberOfInstallments": 0 - }, - "fraudMarkingInformation": { - "reason": "string" - }, - "merchantDefinedInformation": [{ - "key": "string", - "value": "string" - } - ], - "merchantInformation": { - "merchantDescriptor": { - "name": "ng_paymentech" - } - }, - "orderInformation": { - "billTo": { - "firstName": "JAMES", - "lastName": "DOUGH", - "middleName": "ROY", - "nameSuffix": "Mr", - "address1": "600 Morgan Falls Road", - "address2": "Room 2-2123", - "locality": "Atlanta", - "administrativeArea": "GA", - "postalCode": "30350", - "company": "cybersource", - "email": "jdough@cybersource.com", - "country": "US", - "title": "Manager", - "phoneNumber": "6509656111" - }, - "shipTo": { - "firstName": "Test", - "lastName": "TSS", - "address1": "201S.DivisionSt._1", - "address2": "Suite500", - "locality": "Austin", - "administrativeArea": "TX", - "postalCode": "78750", - "company": "cybs", - "country": "US", - "phoneNumber": "5120000000" - }, - "lineItems": [{ - "productCode": "string", - "productName": "string", - "productSku": "string", - "taxAmount": "string", - "quantity": 123, - "unitPrice": "string", - "fulfillmentType": "string" - } - ], - "amountDetails": { - "totalAmount": "100", - "currency": "USD", - "taxAmount": "5", - "authorizedAmount": "100" - }, - "shippingDetails": { - "giftWrap": "none", - "shippingMethod": "string" - } - }, - "paymentInformation": { - "paymentType": { - "name": "paymentProcessor1234", - "type": "credit card", - "subType": "V1", - "method": "string", - "fundingSource": "string", - "fundingSourceAffiliation": "string", - "credential": "string" - }, - "customer": { - "customerId": "string" - }, - "card": { - "suffix": "1111", - "prefix": "123", - "expirationMonth": "10", - "expirationYear": "2017", - "startMonth": "string", - "startYear": "string", - "issueNumber": "string", - "type": "credit card", - "accountEncoderId": "string", - "useAs": "string" - }, - "invoice": { - "number": "string", - "barcodeNumber": "string", - "expirationDate": "string" - }, - "bank": { - "routingNumber": "string", - "branchCode": "string", - "swiftCode": "string", - "bankCode": "string", - "iban": "string", - "account": { - "suffix": "2222", - "prefix": "123", - "checkNumber": "123456", - "type": "string", - "name": "string", - "checkDigit": "string", - "encoderId": "string" - }, - "mandate": { - "referenceNumber": "string", - "recurringType": "string", - "id": "string" - } - }, - "accountFeatures": { - "balanceAmount": "string", - "previousBalanceAmount": "string", - "currency": "string" - } - }, - "processingInformation": { - "paymentSolution": "Visa", - "commerceIndicator": "7", - "businessApplicationId": "string", - "authorizationOptions": { - "authType": "0" - }, - "bankTransferOptions": { - "secCode": "string" - } - }, - "processorInformation": { - "processor": { - "name": "paymentProcessor1234" - }, - "transactionId": "processortransactionid123", - "networkTransactionId": "networktransactionid67890", - "responseId": "string", - "providerTransactionId": "string", - "approvalCode": "authcode1234567", - "responseCode": "responsecode12345678", - "avs": { - "code": "ARM", - "codeRaw": "avsResults" - }, - "cardVerification": { - "resultCode": "Y" - }, - "achVerification": { - "resultCode": "rspcodmap", - "resultCodeRaw": "responsecode12345678" - }, - "electronicVerificationResults": { - "email": "email@email.com", - "emailRaw": "emailRaw12", - "name": "ename", - "nameRaw": "enameRaw12", - "phoneNumber": "01179", - "phoneNumberRaw": "9925551608", - "street": "123 street", - "streetRaw": "SteertRaw12", - "postalCode": "78717", - "postalCodeRaw": "1166678717" - } - }, - "pointOfSaleInformation": { - "entryMode": "posentrymode1234512", - "terminalCapability": "integer" - }, - "riskInformation": { - "profile": { - "name": "string", - "decision": "string" - }, - "rules": [{ - "name": "string", - "decision": "string" - } - ], - "passiveProfile": { - "name": "string", - "decision": "string" - }, - "passiveRules": [{ - "name": "string", - "decision": "string" - } - ], - "localTime": "string", - "score": { - "factorCodes": [ - "string" - ], - "result": "integer" - } - }, - "senderInformation": { - "referenceNumber": "senderRefNumber1" - }, - "_links": { - "self": { - "href": "https://sl73paysvapq002.visa.com:2031/payment/tss/v2/transactions/5330579740206278601009", - "method": "GET" - } - } - } - } - }, - "404": { - "description": "The specified resource not found in the system." - }, - "500": { - "description": "Unexpected server error." - } - } - } - }, - "/tss/v2/searches": { - "post": { - "summary": "Create a search request", - "description": "Create a search request.\n", - "tags": [ - "SearchTransactions" - ], - "operationId": "createSearch", - "parameters": [{ - "name": "createSearchRequest", - "in": "body", - "required": true, - "schema": { - "title": "tssV2TransactionsPostResponse", - "type": "object", - "properties": { - "save": { - "type": "boolean", - "description": "save or not save." - }, - "name": { - "type": "string", - "description": "The description for this field is not available.\n" - }, - "timezone": { - "type": "string", - "description": "Time Zone." - }, - "query": { - "type": "string", - "description": "transaction search query string." - }, - "offset": { - "type": "integer", - "description": "offset." - }, - "limit": { - "type": "integer", - "description": "limit on number of results." - }, - "sort": { - "type": "string", - "description": "A comma separated list of the following form - fieldName1 asc or desc, fieldName2 asc or desc, etc." - } - } - } - } - ], - "x-example": { - "example0": { - "summary": "Create a search request", - "value": { - "save": "false", - "name": "TSS search", - "timezone": "America/Chicago", - "query": "clientReferenceInformation.code:12345", - "offset": 0, - "limit": 100, - "sort": "id:asc, submitTimeUtc:asc" - } - } - }, - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "title": "tssV2TransactionsPost201Response", + "example": { + "_links": { + "self": { + "href": "/pts/v2/payouts/5287556536256000401540", + "method": "GET" + } + }, + "clientReferenceInformation": { + "code": "1528755653559" + }, + "id": "5287556536256000401540", + "orderInformation": { + "amountDetails": { + "totalAmount": "100.00", + "currency": "USD" + } + }, + "processorInformation": { + "systemTraceAuditNumber": "897596", + "approvalCode": "831000", + "transactionId": "016153570198200", + "responseCode": "00", + "responseCodeSource": "5" + }, + "reconciliationId": "1087488702VIAQNSPQ", + "status": "ACCEPTED", + "submitTimeUtc": "2018-06-11T222054Z" + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "title": "ptsV2PayoutsPost400Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "maxLength": 6, + "minLength": 6, + "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction." + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - INVALID_MERCHANT_CONFIGURATION\n - INVALID_AMOUNT\n - DEBIT_CARD_USEAGE_EXCEEDD_LIMIT\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_CARD", + "INVALID_MERCHANT_CONFIGURATION", + "INVALID_AMOUNT", + "DEBIT_CARD_USEAGE_EXCEEDD_LIMIT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "title": "ptsV2PayoutsPost502Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Payout (Card not Token)", + "value": { + "clientReferenceInformation": { + "code": "33557799" + }, + "senderInformation": { + "referenceNumber": "1234567890", + "address1": "900 Metro Center Blvd.900", + "countryCode": "US", + "locality": "Foster City", + "name": "Company Name", + "administrativeArea": "CA", + "account": { + "fundsSource": "05" + } + }, + "processingInformation": { + "commerceIndicator": "internet", + "businessApplicationId": "FD", + "networkRoutingOrder": "V8" + }, + "orderInformation": { + "amountDetails": { + "totalAmount": "100.00", + "currency": "USD" + } + }, + "merchantInformation": { + "merchantDescriptor": { + "country": "US", + "postalCode": "94440", + "locality": "FC", + "name": "Sending Company Name", + "administrativeArea": "CA" + } + }, + "paymentInformation": { + "card": { + "expirationYear": "2025", + "number": "4111111111111111", + "expirationMonth": "12", + "type": "001" + } + }, + "recipientInformation": { + "firstName": "John", + "lastName": "Doe", + "address1": "Paseo Padre Boulevard", + "locality": "Foster City", + "administrativeArea": "CA", + "postalCode": "94400", + "phoneNumber": "6504320556", + "country": "US" + } + } + }, + "example1": { + "summary": "Payout (Token)", + "value": { + "clientReferenceInformation": { + "code": "111111113" + }, + "senderInformation": { + "referenceNumber": "1234567890", + "address1": "900 Metro Center Blvd.900", + "countryCode": "US", + "locality": "Foster City", + "name": "Company Name", + "administrativeArea": "CA", + "account": { + "number": "1234567890123456789012345678901234", + "fundsSource": "05" + } + }, + "processingInformation": { + "commerceIndicator": "internet", + "businessApplicationId": "FD", + "networkRoutingOrder": "V8" + }, + "orderInformation": { + "amountDetails": { + "totalAmount": "111.00", + "currency": "USD" + } + }, + "merchantInformation": { + "merchantDescriptor": { + "country": "US", + "postalCode": "94440", + "locality": "FC", + "name": "Sending Company Name", + "administrativeArea": "CA" + } + }, + "paymentInformation": { + "customer": { + "customerId": "7500BB199B4270EFE05340588D0AFCAD" + } + }, + "recipientInformation": { + "firstName": "John", + "lastName": "Doe", + "address1": "Paseo Padre Boulevard", + "locality": "Foster City", + "administrativeArea": "CA", + "postalCode": "94400", + "phoneNumber": "6504320556", + "country": "US" + } + } + } + } + } + }, + "/reporting/v3/report-downloads": { + "get": { + "tags": [ + "ReportDownloads" + ], + "summary": "Download a report", + "description": "Download a report using the unique report name and date.\n", + "operationId": "downloadReport", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "x-queryParameterDefaults": { + "organizationId": "testrest", + "reportName": "Demo_Report", + "reportDate": "2018-09-30" + }, + "produces": [ + "application/xml", + "text/csv" + ], + "parameters": [ + { + "name": "organizationId", + "in": "query", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 32 + }, + { + "name": "reportDate", + "in": "query", + "description": "Valid date on which to download the report in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd\n", + "required": true, + "type": "string", + "format": "date" + }, + { + "name": "reportName", + "in": "query", + "description": "Name of the report to download", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Invalid Request", + "schema": { + "title": "reportingv3ReportDownloadsGet400Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "404": { + "description": "No Reports Found" + } + } + } + }, + "/reporting/v3/reports": { + "get": { + "tags": [ + "Reports" + ], + "summary": "Retrieve available reports", + "description": "Retrieve a list of the available reports to which\nyou are subscribed. This will also give you the reportId value,\nwhich you can also use to download a report.\n", + "operationId": "searchReports", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "x-queryParameterDefaults": { + "startTime": "2018-10-01T00:00:00.0Z", + "endTime": "2018-10-30T23:59:59.0Z", + "timeQueryType": "executedTime", + "reportMimeType": "application/xml" + }, + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "organizationId", + "in": "query", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 32 + }, + { + "name": "startTime", + "in": "query", + "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "timeQueryType", + "in": "query", + "description": "Specify time you would like to search", + "required": true, + "type": "string", + "enum": [ + "reportTimeFrame", + "executedTime" + ] + }, + { + "name": "reportMimeType", + "in": "query", + "description": "Valid Report Format", + "required": false, + "type": "string", + "enum": [ + "application/xml", + "text/csv" + ] + }, + { + "name": "reportFrequency", + "in": "query", + "description": "Valid Report Frequency", + "required": false, + "type": "string", + "enum": [ + "DAILY", + "WEEKLY", + "MONTHLY", + "ADHOC" + ] + }, + { + "name": "reportName", + "in": "query", + "description": "Valid Report Name", + "required": false, + "type": "string" + }, + { + "name": "reportDefinitionId", + "in": "query", + "description": "Valid Report Definition Id", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "reportStatus", + "in": "query", + "description": "Valid Report Status", + "required": false, + "type": "string", + "enum": [ + "COMPLETED", + "PENDING", + "QUEUED", + "RUNNING", + "ERROR", + "NO_DATA" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "title": "reportingV3ReportsGet200Response", + "type": "object", + "properties": { + "reports": { + "type": "array", + "items": { + "type": "object", + "properties": { + "reportDefinitionId": { + "type": "string", + "description": "Unique Report Identifier of each report type", + "example": "210" + }, + "reportName": { + "type": "string", + "description": "Name of the report specified by merchant while creating the report", + "example": "My Transaction Request Detail Report" + }, + "reportMimeType": { + "type": "string", + "example": "application/xml", + "description": "Format of the report to get generated", + "enum": [ + "application/xml", + "text/csv" + ] + }, + "reportFrequency": { + "type": "string", + "example": "DAILY", + "description": "Frequency of the report to get generated", + "enum": [ + "DAILY", + "WEEKLY", + "MONTHLY", + "ADHOC" + ] + }, + "status": { + "type": "string", + "description": "Status of the report", + "enum": [ + "COMPLETED", + "PENDING", + "QUEUED", + "RUNNING", + "ERROR", + "NO_DATA" + ] + }, + "reportStartTime": { + "type": "string", + "format": "date-time", + "example": "2017-10-01T10:10:10+05:00", + "description": "Specifies the report start time in ISO 8601 format" + }, + "reportEndTime": { + "type": "string", + "format": "date-time", + "example": "2017-10-02T10:10:10+05:00", + "description": "Specifies the report end time in ISO 8601 format" + }, + "timezone": { + "type": "string", + "example": "America/Chicago", + "description": "Time Zone" + }, + "reportId": { + "type": "string", + "example": "6d9cb5b6-0e97-2d03-e053-7cb8d30af52e", + "description": "Unique identifier generated for every reports" + }, + "organizationId": { + "type": "string", + "example": "Test_MerchantId", + "description": "CyberSource Merchant Id" + }, + "queuedTime": { + "type": "string", + "format": "date-time", + "example": "2017-10-03T10:10:10+05:00", + "description": "Specifies the time of the report in queued in ISO 8601 format" + }, + "reportGeneratingTime": { + "type": "string", + "format": "date-time", + "example": "2017-10-03T10:10:10+05:00", + "description": "Specifies the time of the report started to generate in ISO 8601 format" + }, + "reportCompletedTime": { + "type": "string", + "format": "date-time", + "example": "2017-10-03T10:10:10+05:00", + "description": "Specifies the time of the report completed the generation in ISO 8601 format" + }, + "subscriptionType": { + "type": "string", + "example": "CUSTOM", + "description": "Specifies whether the subscription created is either Custom, Standard or Classic\n" + }, + "groupId": { + "type": "string", + "example": "12345", + "description": "Id for selected group." + } + }, + "description": "Report Search Result Bean" + } + } + } + } + }, + "400": { + "description": "Invalid Request", + "schema": { + "title": "reportingV3ReportsGet400Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "404": { + "description": "No Reports Found" + } + } + }, + "post": { + "tags": [ + "Reports" + ], + "summary": "Create Adhoc Report", + "description": "Create a one-time report. You must specify the\ntype of report in reportDefinitionName. For a list of values for\nreportDefinitionName, see the [Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation)\n", + "operationId": "createReport", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "x-queryParameterDefaults": { + "organizationId": "testrest" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "organizationId", + "in": "query", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 32 + }, + { + "in": "body", + "name": "requestBody", + "description": "Report subscription request payload", + "required": true, + "schema": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Valid CyberSource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "example": "Test_Merchatnt_id" + }, + "reportDefinitionName": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "[a-zA-Z0-9-]+", + "example": "TransactionRequestClass" + }, + "reportFields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of fields which needs to get included in a report", + "example": [ + "Request.RequestID", + "Request.TransactionDate", + "Request.MerchantID" + ] + }, + "reportMimeType": { + "type": "string", + "description": " Format of the report", + "example": "application/xml", + "enum": [ + "application/xml", + "text/csv" + ] + }, + "reportName": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "[a-zA-Z0-9-_ ]+", + "description": "Name of the report", + "example": "My Transaction Request report" + }, + "timezone": { + "type": "string", + "description": "Timezone of the report", + "example": "America/Chicago" + }, + "reportStartTime": { + "type": "string", + "format": "date-time", + "description": "Start time of the report", + "example": "2017-10-01T10:10:10+05:00" + }, + "reportEndTime": { + "type": "string", + "format": "date-time", + "description": "End time of the report", + "example": "2017-10-02T10:10:10+05:00" + }, + "reportFilters": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "List of filters to apply", + "example": { + "Application.Name": [ + "ics_auth", + "ics_bill" + ] + } + }, + "reportPreferences": { + "type": "object", + "properties": { + "signedAmounts": { + "type": "boolean", + "description": "Indicator to determine whether negative sign infront of amount for all refunded transaction" + }, + "fieldNameConvention": { + "type": "string", + "description": "Specify the field naming convention to be followed in reports (applicable to only csv report formats", + "enum": [ + "SOAPI", + "SCMP" + ] + } + }, + "description": "Report Preferences" + }, + "groupName": { + "type": "string", + "pattern": "[0-9]*", + "description": "Specifies the group name", + "example": "myGroup" + } + } + } + } + ], + "responses": { + "201": { + "description": "Created" + }, + "304": { + "description": "Not Modified" + }, + "400": { + "description": "Invalid request", + "schema": { + "title": "reportingV3ReportsPost400Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + } + }, + "x-example": { + "example0": { + "summary": "Create Adhoc Report", + "value": { + "reportDefinitionName": "TransactionRequestClass", + "reportFields": [ + "Request.RequestID", + "Request.TransactionDate", + "Request.MerchantID", + "AFSFields.IPAddress", + "AFSFields.IPCountry", + "AFSFields.IPRoutingMethod", + "AFSFields.IPState", + "Application.Name", + "BankInfo.Address", + "BankInfo.BranchCode", + "BankInfo.City", + "BankInfo.Country", + "BankInfo.Name", + "BankInfo.SwiftCode", + "BillTo.Address1", + "BillTo.Address2", + "BillTo.City", + "BillTo.CompanyName", + "BillTo.CompanyTaxID", + "BillTo.Country", + "BillTo.Email", + "BillTo.FirstName", + "BillTo.LastName", + "BillTo.MiddleName", + "BillTo.NameSuffix", + "BillTo.PersonalID", + "BillTo.Phone", + "BillTo.State", + "BillTo.Title", + "BillTo.Zip", + "ChargebackAndRetrieval.AdjustmentAmount", + "ChargebackAndRetrieval.AdjustmentCurrency", + "ChargebackAndRetrieval.ARN", + "ChargebackAndRetrieval.CaseIdentifier", + "ChargebackAndRetrieval.CaseNumber", + "ChargebackAndRetrieval.CaseTime", + "ChargebackAndRetrieval.CaseType", + "ChargebackAndRetrieval.ChargebackAmount", + "ChargebackAndRetrieval.ChargebackCurrency", + "ChargebackAndRetrieval.ChargebackMessage", + "ChargebackAndRetrieval.ChargebackReasonCode", + "ChargebackAndRetrieval.ChargebackReasonCodeDescription", + "ChargebackAndRetrieval.ChargebackTime", + "ChargebackAndRetrieval.DocumentIndicator", + "ChargebackAndRetrieval.FeeAmount", + "ChargebackAndRetrieval.FeeCurrency", + "ChargebackAndRetrieval.FinancialImpact", + "ChargebackAndRetrieval.FinancialImpactType", + "ChargebackAndRetrieval.MerchantCategoryCode", + "ChargebackAndRetrieval.PartialIndicator", + "ChargebackAndRetrieval.ResolutionTime", + "ChargebackAndRetrieval.ResolvedToIndicator", + "ChargebackAndRetrieval.RespondByDate", + "ChargebackAndRetrieval.TransactionType", + "Check.AccountEncoderID", + "Check.BankTransitNumber", + "Check.SecCode", + "CustomerFields.BillingAddress1", + "CustomerFields.BillingAddress2", + "CustomerFields.BillingCity", + "CustomerFields.BillingCompanyName", + "CustomerFields.BillingCountry", + "CustomerFields.BillingEmail", + "CustomerFields.BillingFirstName", + "CustomerFields.BillingLastName", + "CustomerFields.BillingPhone", + "CustomerFields.BillingPostalCode", + "CustomerFields.BillingState", + "CustomerFields.CustomerID", + "CustomerFields.CustomerUserName", + "CustomerFields.PersonalId(CPF/CNPJ)", + "CustomerFields.ShippingAddress1", + "CustomerFields.ShippingAddress2", + "CustomerFields.ShippingCity", + "CustomerFields.ShippingCompanyName", + "CustomerFields.ShippingCountry", + "CustomerFields.ShippingFirstName", + "CustomerFields.ShippingLastName", + "CustomerFields.ShippingPhone", + "CustomerFields.ShippingPostalCode", + "CustomerFields.ShippingState", + "DecisionManagerEvents.EventPolicy", + "DecisionManagerEvents.TypeofEvent", + "Device.DeviceID", + "DeviceFingerprintFields.abcd", + "DeviceFingerprintFields.BrowserLanguage", + "DeviceFingerprintFields.DeviceLatitude", + "DeviceFingerprintFields.DeviceLongitude", + "DeviceFingerprintFields.displayNameFinalCheck", + "DeviceFingerprintFields.DMESignOffFieldEdit", + "DeviceFingerprintFields.Fingerprint/DeviceFingerprint", + "DeviceFingerprintFields.FlashEnabled", + "DeviceFingerprintFields.FlashOperatingSystem", + "DeviceFingerprintFields.FlashVersion", + "DeviceFingerprintFields.GPSAccuracy", + "DeviceFingerprintFields.ImagesEnabled", + "DeviceFingerprintFields.Jailbreak/RootPrivileges", + "DeviceFingerprintFields.JavaScriptEnabled", + "DeviceFingerprintFields.ProfiledURL", + "DeviceFingerprintFields.ProxyIPAddress", + "DeviceFingerprintFields.ProxyIPAddressActivities", + "DeviceFingerprintFields.ProxyServerType", + "DeviceFingerprintFields.ScreenResolution", + "DeviceFingerprintFields.SignOffFieldDMEEditNewOne", + "DeviceFingerprintFields.SmartID", + "DeviceFingerprintFields.SmartIDConfidenceLevel", + "DeviceFingerprintFields.TimeOnPage", + "DeviceFingerprintFields.TrueIPAddress", + "DeviceFingerprintFields.TrueIPAddressActivities", + "DeviceFingerprintFields.TrueIPAddressAttributes", + "DeviceFingerprintFields.txdea1", + "DeviceFingerprintFields.txdesv", + "EmailageFields.FraudType", + "EmailageFields.IP Postal", + "EmailageFields.IPCity", + "EmailageFields.IPCountry", + "EmailageFields.IPRegion", + "EmailageFields.SourceIndustry", + "Event.Amount", + "Event.CurrencyCode", + "Event.Event", + "Event.EventDate", + "Event.ProcessorMessage", + "Exception.Action", + "Exception.CYBSExceptionID", + "Exception.DccLookupStatus", + "Exception.ExceptionAmount", + "Exception.ExceptionAmountCurrency", + "Exception.ExceptionCategory", + "Exception.ExceptionDate", + "Exception.ExceptionDescription", + "Exception.ExceptionDeviceHardwareRevision", + "Exception.ExceptionDeviceID", + "Exception.ExceptionDeviceOS", + "Exception.ExceptionDeviceOSVersion", + "Exception.ExceptionDeviceTerminalID", + "Exception.ExceptionMessage", + "Exception.ExceptionReasonDescription", + "Exception.ExceptionStatus", + "Exception.ExceptionStatusCode", + "Exception.ExceptionType", + "Exception.FinancialStatus", + "Exception.LastActionDate", + "Exception.NextActionDate", + "Exception.OriginalTransactionSubmissionDate", + "Exception.PaymentNumber", + "Exception.ProcessorCaseID", + "Exception.ProcessorResponseCode", + "Exception.ReasonCode", + "Exception.RetryCount", + "Fee.AssessmentAmount", + "Fee.AssessmentCurrency", + "Fee.BillingCycle", + "Fee.BillingType", + "Fee.ClearedInterchangeLevel", + "Fee.DiscountAmount", + "Fee.DiscountCurrency", + "Fee.DiscountRate", + "Fee.DowngradeReasonCode", + "Fee.InterchangeAmount", + "Fee.InterchangeCurrency", + "Fee.InterchangeRate", + "Fee.PerItemFeeAmount", + "Fee.PerItemFeeCurrency", + "Fee.PricedInterchangeLevel", + "Fee.ServiceFeeAmount", + "Fee.ServiceFeeAmountCcy", + "Fee.ServiceFeeFixedAmount", + "Fee.ServiceFeeFixedAmountCcy", + "Fee.ServiceFeeRate", + "Fee.SettlementAmount", + "Fee.SettlementCurrency", + "Fee.SettlementTime", + "Fee.SettlementTimeZone", + "Fee.SourceDescriptor", + "Fee.TotalFeeAmount", + "Fee.TotalFeeCurrency", + "Funding.AdjustmentAmount", + "Funding.AdjustmentCurrency", + "Funding.AdjustmentDescription", + "Funding.AdjustmentType", + "FundTransfer.BankCheckDigit", + "FundTransfer.IbanIndicator", + "Invoice.BillingGroupDescription", + "Invoice.NotProcessed", + "Invoice.OrganizationID", + "Invoice.PerformedServices", + "Invoice.Processed", + "Invoice.Total", + "JP.Amount", + "JP.AuthForward", + "JP.AuthorizationCode", + "JP.CardSuffix", + "JP.Currency", + "JP.CustomerFirstName", + "JP.CustomerLastName", + "JP.Date", + "JP.Gateway", + "JP.JPOInstallmentMethod", + "JP.JPOPaymentMethod", + "JP.MerchantID", + "JP.MerchantReferenceNumber", + "JP.PaymentMethod", + "JP.RequestID", + "JP.SubscriptionID", + "JP.Time", + "JP.TransactionReferenceNumber", + "JP.TransactionType", + "LineItems.FulfillmentType", + "LineItems.InvoiceNumber", + "LineItems.MerchantProductSku", + "LineItems.ProductCode", + "LineItems.ProductName", + "LineItems.Quantity", + "LineItems.TaxAmount", + "LineItems.UnitPrice", + "MarkAsSuspectFields.MarkingDate", + "MarkAsSuspectFields.MarkingNotes", + "MarkAsSuspectFields.MarkingReason", + "MarkAsSuspectFields.MarkingUserName", + "Merchant-DefinedDataFields.MerchantDefinedData1", + "Merchant-DefinedDataFields.MerchantDefinedData10", + "Merchant-DefinedDataFields.MerchantDefinedData100", + "Merchant-DefinedDataFields.MerchantDefinedData11", + "Merchant-DefinedDataFields.MerchantDefinedData12", + "Merchant-DefinedDataFields.MerchantDefinedData13", + "Merchant-DefinedDataFields.MerchantDefinedData14", + "Merchant-DefinedDataFields.MerchantDefinedData15", + "Merchant-DefinedDataFields.MerchantDefinedData16", + "Merchant-DefinedDataFields.MerchantDefinedData17", + "Merchant-DefinedDataFields.MerchantDefinedData18", + "Merchant-DefinedDataFields.MerchantDefinedData19", + "Merchant-DefinedDataFields.MerchantDefinedData2", + "Merchant-DefinedDataFields.MerchantDefinedData20", + "Merchant-DefinedDataFields.MerchantDefinedData21", + "Merchant-DefinedDataFields.MerchantDefinedData22", + "Merchant-DefinedDataFields.MerchantDefinedData23", + "Merchant-DefinedDataFields.MerchantDefinedData24", + "Merchant-DefinedDataFields.MerchantDefinedData25", + "Merchant-DefinedDataFields.MerchantDefinedData26", + "Merchant-DefinedDataFields.MerchantDefinedData27", + "Merchant-DefinedDataFields.MerchantDefinedData28", + "Merchant-DefinedDataFields.MerchantDefinedData29", + "Merchant-DefinedDataFields.MerchantDefinedData3", + "Merchant-DefinedDataFields.MerchantDefinedData30", + "Merchant-DefinedDataFields.MerchantDefinedData31", + "Merchant-DefinedDataFields.MerchantDefinedData32", + "Merchant-DefinedDataFields.MerchantDefinedData34", + "Merchant-DefinedDataFields.MerchantDefinedData35", + "Merchant-DefinedDataFields.MerchantDefinedData36", + "Merchant-DefinedDataFields.MerchantDefinedData37", + "Merchant-DefinedDataFields.MerchantDefinedData39", + "Merchant-DefinedDataFields.MerchantDefinedData4", + "Merchant-DefinedDataFields.MerchantDefinedData40", + "Merchant-DefinedDataFields.MerchantDefinedData41", + "Merchant-DefinedDataFields.MerchantDefinedData43", + "Merchant-DefinedDataFields.MerchantDefinedData44", + "Merchant-DefinedDataFields.MerchantDefinedData45", + "Merchant-DefinedDataFields.MerchantDefinedData46", + "Merchant-DefinedDataFields.MerchantDefinedData48", + "Merchant-DefinedDataFields.MerchantDefinedData49", + "Merchant-DefinedDataFields.MerchantDefinedData5", + "Merchant-DefinedDataFields.MerchantDefinedData50", + "Merchant-DefinedDataFields.MerchantDefinedData52", + "Merchant-DefinedDataFields.MerchantDefinedData53", + "Merchant-DefinedDataFields.MerchantDefinedData54", + "Merchant-DefinedDataFields.MerchantDefinedData56", + "Merchant-DefinedDataFields.MerchantDefinedData57", + "Merchant-DefinedDataFields.MerchantDefinedData58", + "Merchant-DefinedDataFields.MerchantDefinedData59", + "Merchant-DefinedDataFields.MerchantDefinedData6", + "Merchant-DefinedDataFields.MerchantDefinedData61", + "Merchant-DefinedDataFields.MerchantDefinedData62", + "Merchant-DefinedDataFields.MerchantDefinedData63", + "Merchant-DefinedDataFields.MerchantDefinedData65", + "Merchant-DefinedDataFields.MerchantDefinedData66", + "Merchant-DefinedDataFields.MerchantDefinedData67", + "Merchant-DefinedDataFields.MerchantDefinedData68", + "Merchant-DefinedDataFields.MerchantDefinedData7", + "Merchant-DefinedDataFields.MerchantDefinedData70", + "Merchant-DefinedDataFields.MerchantDefinedData71", + "Merchant-DefinedDataFields.MerchantDefinedData72", + "Merchant-DefinedDataFields.MerchantDefinedData73", + "Merchant-DefinedDataFields.MerchantDefinedData74", + "Merchant-DefinedDataFields.MerchantDefinedData75", + "Merchant-DefinedDataFields.MerchantDefinedData76", + "Merchant-DefinedDataFields.MerchantDefinedData77", + "Merchant-DefinedDataFields.MerchantDefinedData78", + "Merchant-DefinedDataFields.MerchantDefinedData79", + "Merchant-DefinedDataFields.MerchantDefinedData8", + "Merchant-DefinedDataFields.MerchantDefinedData80", + "Merchant-DefinedDataFields.MerchantDefinedData81", + "Merchant-DefinedDataFields.MerchantDefinedData82", + "Merchant-DefinedDataFields.MerchantDefinedData83", + "Merchant-DefinedDataFields.MerchantDefinedData84", + "Merchant-DefinedDataFields.MerchantDefinedData85", + "Merchant-DefinedDataFields.MerchantDefinedData86", + "Merchant-DefinedDataFields.MerchantDefinedData87", + "Merchant-DefinedDataFields.MerchantDefinedData88", + "Merchant-DefinedDataFields.MerchantDefinedData89", + "Merchant-DefinedDataFields.MerchantDefinedData9", + "Merchant-DefinedDataFields.MerchantDefinedData90", + "Merchant-DefinedDataFields.MerchantDefinedData91", + "Merchant-DefinedDataFields.MerchantDefinedData92", + "Merchant-DefinedDataFields.MerchantDefinedData93", + "Merchant-DefinedDataFields.MerchantDefinedData94", + "Merchant-DefinedDataFields.MerchantDefinedData95", + "Merchant-DefinedDataFields.MerchantDefinedData96", + "Merchant-DefinedDataFields.MerchantDefinedData97", + "Merchant-DefinedDataFields.MerchantDefinedData98", + "Merchant-DefinedDataFields.MerchantDefinedData99", + "OctSummary.AccountId", + "OctSummary.ResellerId", + "OctSummary.SettlementAmountCurrency", + "OctSummary.SettlementDate", + "OctSummary.TransactionAmountCurrency", + "OrderFields.ConnectionMethod", + "OrderFields.MerchantID", + "OrderFields.MerchantReferenceNumber", + "OrderFields.ReasonCode", + "OrderFields.ReplyCode", + "OrderFields.ReplyFlag", + "OrderFields.ReplyMessage", + "OrderFields.RequestID", + "OrderFields.ShippingMethod", + "OrderFields.TransactionDate", + "PayerAuth.RequestID", + "PayerAuth.TransactionType", + "PaymentData.ACHVerificationResult", + "PaymentData.ACHVerificationResultMapped", + "PaymentData.AcquirerMerchantID", + "PaymentData.AuthIndicator", + "PaymentData.AuthorizationCode", + "PaymentData.AuthorizationType", + "PaymentData.AuthReversalAmount", + "PaymentData.AuthReversalResult", + "PaymentData.AVSResult", + "PaymentData.AVSResultMapped", + "PaymentData.BalanceAmount", + "PaymentData.BalanceCurrencyCode", + "PaymentData.BinNumber", + "PaymentData.CardCategory", + "PaymentData.CardCategoryCode", + "PaymentData.CardPresent", + "PaymentData.CurrencyCode", + "PaymentData.CVResult", + "PaymentData.DCCIndicator", + "PaymentData.EMVRequestFallBack", + "PaymentData.EVEmail", + "PaymentData.EVEmailRaw", + "PaymentData.EVName", + "PaymentData.EVNameRaw", + "PaymentData.EVPhoneNumber", + "PaymentData.EVPhoneNumberRaw", + "PaymentData.EVPostalCode", + "PaymentData.EVPostalCodeRaw", + "PaymentData.EVStreet", + "PaymentData.EVStreetRaw", + "PaymentData.ExchangeRate", + "PaymentData.ExchangeRateDate", + "PaymentData.MandateReferenceNumber", + "PaymentData.NetworkCode", + "PaymentData.NetworkTransactionID", + "PaymentData.NumberOfInstallments", + "PaymentData.OriginalAmount", + "PaymentData.OriginalCurrency", + "PaymentData.PaymentProductCode", + "PaymentData.POSEntryMode", + "PaymentData.ProcessorMID", + "PaymentData.ProcessorResponseCode", + "PaymentData.ProcessorResponseID", + "PaymentData.ProcessorTID", + "PaymentData.ProcessorTransactionID", + "PaymentData.RequestedAmount", + "PaymentData.RequestedAmountCurrencyCode", + "PaymentData.SubMerchantCity", + "PaymentData.SubMerchantCountry", + "PaymentData.SubMerchantEmail", + "PaymentData.SubMerchantID", + "PaymentData.SubMerchantName", + "PaymentData.SubMerchantPhone", + "PaymentData.SubMerchantPostalCode", + "PaymentData.SubMerchantState", + "PaymentData.SubMerchantStreet", + "PaymentData.TargetAmount", + "PaymentData.TargetCurrency", + "PaymentFields.AccountSuffix", + "PaymentFields.CardBIN", + "PaymentFields.CardBINCountry", + "PaymentFields.CardIssuer", + "PaymentFields.CardScheme", + "PaymentFields.CardType", + "PaymentFields.CardVerificationResult", + "PaymentMethod.AccountSuffix", + "PaymentMethod.AdditionalCardType", + "PaymentMethod.BankAccountName", + "PaymentMethod.BankCode", + "PaymentMethod.BoletoBarCodeNumber", + "PaymentMethod.BoletoNumber", + "PaymentMethod.CardType", + "PaymentMethod.CheckNumber", + "PaymentMethod.ExpirationMonth", + "PaymentMethod.ExpirationYear", + "PaymentMethod.IssueNumber", + "PaymentMethod.MandateId", + "PaymentMethod.StartMonth", + "PaymentMethod.StartYear", + "PaymentMethod.WalletType", + "POSTerminalExceptions.AccountSuffix", + "POSTerminalExceptions.CurrencyCode", + "POSTerminalExceptions.ExpirationMO", + "POSTerminalExceptions.ExpirationYR", + "POSTerminalExceptions.LastName", + "POSTerminalExceptions.MerchantID", + "Recipient.RecipientBillingAmount", + "Recipient.RecipientBillingCurrency", + "Recipient.ReferenceNumber", + "Request.PartnerOriginalTransactionID", + "Sender.Address", + "Sender.City", + "Sender.Country", + "Sender.DOB", + "Sender.FirstName", + "Sender.LastName", + "Sender.MiddleInitial", + "Sender.PhoneNumber", + "Sender.PostalCode", + "Sender.SenderReferenceNumber", + "Sender.SourceOfFunds", + "Sender.State", + "ShipTo.CompanyName", + "Subscriptions.Applications", + "Subscriptions.AuthAVSResults", + "Subscriptions.AuthCardVerificationResult", + "Subscriptions.AuthCode", + "Subscriptions.AuthRCode", + "Subscriptions.AuthResponseCode", + "Subscriptions.AuthType", + "Subscriptions.BillToAddress1", + "Subscriptions.BillToAddress2", + "Subscriptions.BillToCity", + "Subscriptions.BillToCompanyName", + "Subscriptions.BillToCountry", + "Subscriptions.BillToEmail", + "Subscriptions.BillToFirstName", + "Subscriptions.BillToLastName", + "Subscriptions.BillToState", + "Subscriptions.BillToZip", + "Subscriptions.CardType", + "Subscriptions.Comments", + "Subscriptions.ConsumerPhone", + "Subscriptions.CurrencyCode", + "Subscriptions.CustomerCCAccountSuffix", + "Subscriptions.CustomerCCExpiryMonth", + "Subscriptions.CustomerCCExpiryYear", + "Subscriptions.CustomerCCIssueNo", + "Subscriptions.CustomerCCRoutingNumber", + "Subscriptions.CustomerCCStartMonth", + "Subscriptions.CustomerCCStartYear", + "Subscriptions.CustomerCCSubTypeDescription", + "Subscriptions.EcommerceIndicator", + "Subscriptions.IPAddress", + "Subscriptions.MerchantDefinedData1", + "Subscriptions.MerchantDefinedData2", + "Subscriptions.MerchantDefinedData3", + "Subscriptions.MerchantDefinedData4", + "Subscriptions.MerchantRefNo", + "Subscriptions.MerchantSecureData1", + "Subscriptions.MerchantSecureData2", + "Subscriptions.MerchantSecureData3", + "Subscriptions.MerchantSecureData4", + "Subscriptions.PaymentProcessor", + "Subscriptions.PaymentsSuccess", + "Subscriptions.RCode", + "Subscriptions.ReasonCode", + "Subscriptions.RequestID", + "Subscriptions.RequestToken", + "Subscriptions.RFlag", + "Subscriptions.RMsg", + "Subscriptions.ShipToAddress1", + "Subscriptions.ShipToAddress2", + "Subscriptions.ShipToCity", + "Subscriptions.ShipToCompanyName", + "Subscriptions.ShipToCountry", + "Subscriptions.ShipToFirstName", + "Subscriptions.ShipToLastName", + "Subscriptions.ShipToState", + "Subscriptions.ShipToZip", + "Subscriptions.SubscriptionID", + "Subscriptions.TaxAmount", + "Subscriptions.TransactionDate", + "Subscriptions.TransRefNo", + "TaxCalculation.Status", + "Token.NetworkTokenTransType", + "Token.TokenCode", + "TransactionDetails.MerchantId", + "TransactionDetails.PaymentMethodDesc", + "TransactionDetails.PaymentMethodType", + "TransactionDetails.RequestId", + "TravelFields.DepartureTime", + "VelocityMorphing.FieldName", + "VelocityMorphing.InfoCode", + "WhitepagesProFields.EmailDomainCreationDate" + ], + "reportMimeType": "application/xml", + "reportName": "testrest_v2", + "timezone": "GMT", + "reportStartTime": "2018-09-01T12:00:00+05:00", + "reportEndTime": "2018-09-02T12:00:00+05:00", + "reportPreferences": { + "signedAmounts": "true", + "fieldNameConvention": "SOAPI" + } + } + } + } + } + }, + "/reporting/v3/reports/{reportId}": { + "get": { + "tags": [ + "Reports" + ], + "summary": "Get Report based on reportId", + "description": "Download a report using the reportId value. If\nyou don\u2019t already know this value, you can obtain it using the\nRetrieve available reports call.\n", + "operationId": "getReportByReportId", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "x-queryParameterDefaults": { + "organizationId": "testrest" + }, + "produces": [ + "application/hal+json", + "application/xml" + ], + "parameters": [ + { + "name": "reportId", + "in": "path", + "description": "Valid Report Id", + "required": true, + "type": "string" + }, + { + "name": "organizationId", + "in": "query", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 32 + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "title": "reportingV3ReportsIdGet200Response", + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "CyberSource merchant id", + "example": "myMerchantId" + }, + "reportId": { + "type": "string", + "description": "Report ID Value", + "example": "6da01922-bb8e-a1fb-e053-7cb8d30ade29" + }, + "reportDefinitionId": { + "type": "string", + "description": "Report definition Id", + "example": "210" + }, + "reportName": { + "type": "string", + "description": "Report Name", + "example": "My Transaction Request report" + }, + "reportMimeType": { + "type": "string", + "example": "application/xml", + "description": "Report Format", + "enum": [ + "application/xml", + "text/csv" + ] + }, + "reportFrequency": { + "type": "string", + "example": "DAILY", + "description": "Report Frequency Value", + "enum": [ + "DAILY", + "WEEKLY", + "MONTHLY", + "ADHOC" + ] + }, + "reportFields": { + "type": "array", + "description": "List of Integer Values", + "items": { + "type": "string" + }, + "example": [ + "Request.RequestID", + "Request.TransactionDate", + "Request.MerchantID" + ] + }, + "reportStatus": { + "type": "string", + "description": "Report Status Value", + "enum": [ + "COMPLETED", + "PENDING", + "QUEUED", + "RUNNING", + "ERROR", + "NO_DATA", + "RERUN" + ] + }, + "reportStartTime": { + "type": "string", + "format": "date-time", + "example": "2017-10-01T10:10:10+05:00", + "description": "Report Start Time Value" + }, + "reportEndTime": { + "type": "string", + "format": "date-time", + "example": "2017-10-02T10:10:10+05:00", + "description": "Report End Time Value" + }, + "timezone": { + "type": "string", + "description": "Time Zone Value", + "example": "America/Chicago" + }, + "reportFilters": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "List of filters to apply", + "example": { + "Application.Name": [ + "ics_auth", + "ics_bill" + ] + } + }, + "reportPreferences": { + "description": "Report Preferences", + "type": "object", + "properties": { + "signedAmounts": { + "type": "boolean", + "description": "Indicator to determine whether negative sign infront of amount for all refunded transaction" + }, + "fieldNameConvention": { + "type": "string", + "description": "Specify the field naming convention to be followed in reports (applicable to only csv report formats", + "enum": [ + "SOAPI", + "SCMP" + ] + } + } + }, + "groupId": { + "type": "string", + "description": "Id for selected group.", + "example": "12345" + } + }, + "description": "Report Log" + } + }, + "400": { + "description": "Invalid Request", + "schema": { + "title": "reportingV3ReportsIdPost400Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "404": { + "description": "No Reports Found" + } + } + } + }, + "/reporting/v3/report-definitions/{reportDefinitionName}": { + "get": { + "tags": [ + "ReportDefinitions" + ], + "summary": "Get report definition", + "description": "View the attributes of an individual report type.\nFor a list of values for reportDefinitionName, see the\n[Reporting Developer Guide](https://www.cybersource.com/developers/documentation/reporting_and_reconciliation/)\n", + "operationId": "getResourceInfoByReportDefinition", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "x-queryParameterDefaults": { + "organizationId": "testrest" + }, + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "reportDefinitionName", + "in": "path", + "description": "Name of the Report definition to retrieve", + "required": true, + "type": "string" + }, + { + "name": "organizationId", + "in": "query", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 32 + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "title": "reportingV3ReportDefinitionsNameGet200Response", + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "reportDefinitionId": { + "type": "integer", + "format": "int32" + }, + "reportDefintionName": { + "type": "string" + }, + "attributes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "filterType": { + "type": "string", + "description": "Attribute Filter Type.", + "example": "MULTI" + }, + "default": { + "type": "boolean" + }, + "required": { + "type": "boolean" + }, + "supportedType": { + "type": "string", + "description": "Valid values for the filter.", + "example": [ + "ics_score", + "ics_ap_auth", + "ics_ap_auth_reversal", + "ics_ap_billing_agreement", + "ics_ap_cancel", + "ics_ap_capture", + "ics_ap_initiate", + "ics_ap_options", + "ics_ap_order", + "ics_ap_refund", + "ics_ap_sale", + "ics_ap_sessions", + "ics_ap_check_status", + "ics_auto_auth_reversal", + "ics_bank_transfer", + "ics_bank_transfer_real_time", + "ics_bank_transfer_refund", + "ics_bin_lookup", + "ics_boleto_payment", + "ics_cm_action", + "ics_china_payment", + "ics_china_refund", + "ics_auth", + "ics_auto_full_auth_reversal", + "ics_auth_refresh", + "ics_auth_reversal", + "ics_credit", + "ics_bill", + "ics_risk_update", + "ics_dcc", + "ics_dcc_update", + "ics_decision", + "ics_dm_event", + "ics_direct_debit", + "ics_direct_debit_mandate", + "ics_direct_debit_refund", + "ics_direct_debit_validate", + "ics_ecp_authenticate", + "ics_ecp_credit", + "ics_ecp_debit", + "ics_get_masterpass_data", + "ics_get_visa_checkout_data", + "ics_create_isv", + "ics_get_isv_history", + "ics_add_value_to_isv", + "ics_get_isv_info", + "ics_modify_isv", + "ics_get_isv_profiles", + "ics_redeem_isv", + "ics_ifs_setup", + "ics_ifs_update", + "ics_ipgeo", + "ics_oct", + "ics_pa_enroll", + "ics_pa_validate", + "paypal_mip_agreement_ipn", + "ics_paypal_button_create", + "ics_paypal_credit", + "ics_paypal_authorization", + "ics_paypal_create_agreement", + "ics_paypal_update_agreement", + "ics_paypal_ec_order_setup", + "ics_paypal_auth_reversal", + "ics_paypal_ec_do_payment", + "ics_paypal_do_ref_transaction", + "ics_paypal_refund", + "ics_paypal_do_capture", + "paypal_ipn", + "ics_paypal_preapproved_payment", + "ics_pinless_debit", + "ics_pinless_debit_validate", + "ics_pinless_debit_reversal", + "ics_export", + "ics_service_fee_auth", + "ics_service_fee_auth_reversal", + "ics_service_fee_bill", + "ics_service_fee_credit", + "ics_service_fee_ecp_credit", + "ics_service_fee_ecp_debit", + "ics_pay_subscription_create", + "ics_pay_subscription_create_dup", + "ics_pay_subscription_delete", + "ics_pay_subscription_update", + "ics_dav", + "ics_download", + "ics_tax", + "ics_timeout_auth_reversal", + "ics_timeout_oct_reversal", + "ics_void", + "ics_pin_debit_purchase", + "ics_pin_debit_credit", + "ics_pin_debit_reversal", + "ics_timeout_pin_debit_reversal", + "ics_gift_card_activation", + "ics_gift_card_balance_inquiry", + "ics_gift_card_redemption", + "ics_gift_card_refund", + "ics_gift_card_reload", + "ics_gift_card_void", + "ics_gift_card_reversal" + ] + } + } + } + }, + "supportedFormats": { + "type": "array", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "application/xml", + "text/csv" + ] + } + }, + "description": { + "type": "string" + } + } + } + }, + "400": { + "description": "Invalid request", + "schema": { + "title": "reportingV3ReportDefinitionsNameGet400Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "404": { + "description": "Report not found" + } + } + } + }, + "/reporting/v3/report-definitions": { + "get": { + "tags": [ + "ReportDefinitions" + ], + "summary": "Get reporting resource information", + "description": "View a list of supported reports and their attributes before subscribing to them.\n", + "operationId": "getResourceV2Info", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "x-queryParameterDefaults": { + "organizationId": "testrest" + }, + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "organizationId", + "in": "query", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 32 + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "title": "reportingV3ReportDefinitionsGet200Response", + "type": "object", + "properties": { + "reportDefinitions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "reportDefinitionId": { + "type": "integer", + "format": "int32", + "description": "| Id | Definition Class |\n| --- | --------------------------------- |\n| 210 | TransactionRequestClass |\n| 211 | PaymentBatchDetailClass |\n| 212 | ExceptionDetailClass |\n| 213 | ProcessorSettlementDetailClass |\n| 214 | ProcessorEventsDetailClass |\n| 215 | FundingDetailClass |\n| 216 | AgingDetailClass |\n| 217 | ChargebackAndRetrievalDetailClass |\n| 218 | DepositDetailClass |\n| 219 | FeeDetailClass |\n| 220 | InvoiceSummaryClass |\n| 221 | PayerAuthDetailClass |\n| 222 | ConversionDetailClass |\n| 270 | JPTransactionDetailClass |\n| 271 | ServiceFeeDetailClass |\n| 310 | GatewayTransactionRequestClass |\n| 400 | DecisionManagerEventDetailClass |\n| 401 | DecisionManagerDetailClass |\n| 410 | FeeSummaryClass |\n| 420 | TaxCalculationClass |\n| 520 | POSTerminalExceptionClass |\n| 620 | SubscriptionDetailClass |\n" + }, + "reportDefintionName": { + "type": "string" + }, + "supportedFormats": { + "type": "array", + "uniqueItems": true, + "items": { + "type": "string", + "enum": [ + "application/xml", + "text/csv" + ] + } + }, + "description": { + "type": "string" + } + } + } + } + } + } + }, + "400": { + "description": "Invalid request", + "schema": { + "title": "reportingV3ReportDefinitionsGet400Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "404": { + "description": "Report not found" + } + } + } + }, + "/reporting/v3/report-subscriptions": { + "get": { + "tags": [ + "ReportSubscriptions" + ], + "summary": "Get all subscriptions", + "description": "View a summary of all report subscriptions.\n", + "operationId": "getAllSubscriptions", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "produces": [ + "application/hal+json" + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "title": "reportingV3ReportSubscriptionsGet200Response", + "type": "object", + "properties": { + "subscriptions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Selected Organization Id", + "example": "Merchant 1" + }, + "reportDefinitionId": { + "type": "string", + "description": "Report Definition Id", + "example": "210" + }, + "reportDefinitionName": { + "type": "string", + "description": "Report Definition Class", + "example": "TransactionRequestDetailClass" + }, + "reportMimeType": { + "type": "string", + "example": "application/xml", + "description": "Report Format", + "enum": [ + "application/xml", + "text/csv" + ] + }, + "reportFrequency": { + "type": "string", + "example": "DAILY", + "description": "Report Frequency", + "enum": [ + "DAILY", + "WEEKLY", + "MONTHLY", + "ADHOC" + ] + }, + "reportName": { + "type": "string", + "description": "Report Name", + "example": "My Transaction Request Detail Report" + }, + "timezone": { + "type": "string", + "description": "Time Zone", + "example": "America/Chicago" + }, + "startTime": { + "type": "string", + "description": "Start Time", + "format": "date-time", + "example": "2017-10-01T10:10:10+05:00" + }, + "startDay": { + "type": "integer", + "format": "int32", + "description": "Start Day", + "example": 1 + }, + "reportFields": { + "type": "array", + "example": [ + "Request.RequestID", + "Request.TransactionDate", + "Request.MerchantID" + ], + "description": "List of all fields String values", + "items": { + "type": "string" + } + }, + "reportFilters": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "List of filters to apply", + "example": { + "Application.Name": [ + "ics_auth", + "ics_bill" + ] + } + }, + "reportPreferences": { + "type": "object", + "properties": { + "signedAmounts": { + "type": "boolean", + "description": "Indicator to determine whether negative sign infront of amount for all refunded transaction" + }, + "fieldNameConvention": { + "type": "string", + "description": "Specify the field naming convention to be followed in reports (applicable to only csv report formats", + "enum": [ + "SOAPI", + "SCMP" + ] + } + }, + "description": "Report Preferences" + }, + "groupId": { + "type": "string", + "example": "12345", + "description": "Id for the selected group." + } + }, + "description": "Subscription Details" + } + } + } + } + }, + "400": { + "description": "Invalid request", + "schema": { + "title": "reportingV3ReportSubscriptionsGet400Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "404": { + "description": "Subscriptions not found" + } + } + }, + "put": { + "tags": [ + "ReportSubscriptions" + ], + "summary": "Create Report Subscription for a report name by organization", + "description": "Create a report subscription for your organization. The report name must be unique.\n", + "operationId": "createSubscription", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "organizationId", + "in": "query", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 32 + }, + { + "in": "body", + "name": "requestBody", + "description": "Report subscription request payload", + "required": true, + "schema": { + "type": "object", + "required": [ + "reportDefinitionName", + "reportFields", + "reportName", + "startTime", + "timezone", + "reportFrequency", + "reportMimeType" + ], + "properties": { + "organizationId": { + "type": "string", + "pattern": "[a-zA-Z0-9-_]+", + "description": "Valid CyberSource organizationId", + "example": "Merchant 1" + }, + "reportDefinitionName": { + "type": "string", + "minLength": 1, + "maxLength": 80, + "pattern": "[a-zA-Z0-9-]+", + "description": "Valid Report Definition Name", + "example": "TransactionDetailReportClass" + }, + "reportFields": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "Request.RequestID", + "Request.TransactionDate", + "Request.MerchantID" + ] + }, + "reportMimeType": { + "type": "string", + "example": "application/xml", + "enum": [ + "application/xml", + "text/csv" + ] + }, + "reportFrequency": { + "type": "string", + "description": "The frequency for which subscription is created.", + "example": "DAILY", + "enum": [ + "DAILY", + "WEEKLY", + "MONTHLY", + "ADHOC" + ] + }, + "reportName": { + "type": "string", + "minLength": 1, + "maxLength": 128, + "pattern": "[a-zA-Z0-9-_ ]+", + "example": "My Daily Subdcription" + }, + "timezone": { + "type": "string", + "example": "America/Chicago" + }, + "startTime": { + "type": "string", + "description": "The hour at which the report generation should start. It should be in hhmm format.", + "example": "0900" + }, + "startDay": { + "type": "integer", + "minimum": 1, + "maximum": 31, + "description": "This is the start day if the frequency is WEEKLY or MONTHLY. The value varies from 1-7 for WEEKLY and 1-31 for MONTHLY. For WEEKLY 1 means Sunday and 7 means Saturday. By default the value is 1." + }, + "reportFilters": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "List of filters to apply", + "example": { + "Application.Name": [ + "ics_auth", + "ics_bill" + ] + } + }, + "reportPreferences": { + "type": "object", + "properties": { + "signedAmounts": { + "type": "boolean", + "description": "Indicator to determine whether negative sign infront of amount for all refunded transaction" + }, + "fieldNameConvention": { + "type": "string", + "description": "Specify the field naming convention to be followed in reports (applicable to only csv report formats", + "enum": [ + "SOAPI", + "SCMP" + ] + } + }, + "description": "Report Preferences" + }, + "groupName": { + "type": "string", + "pattern": "[a-zA-Z0-9-_ ]+", + "description": "Valid GroupName", + "example": "CEMEA Group" + } + } + } + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "304": { + "description": "NOT MODIFIED" + }, + "400": { + "description": "Invalid request", + "schema": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "description": "Error code" + }, + "message": { + "type": "string", + "description": "Error message" + }, + "localizationKey": { + "type": "string", + "description": "Localization Key Name" + }, + "correlationId": { + "type": "string", + "description": "Correlation Id" + }, + "detail": { + "type": "string", + "description": "Error Detail" + }, + "fields": { + "type": "array", + "description": "Error fields List", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "Path of the failed property" + }, + "message": { + "type": "string", + "description": "Error description about validation failed field" + }, + "localizationKey": { + "type": "string", + "description": "Localized Key Name" + } + }, + "description": "Provide validation failed input field details" + } + } + }, + "description": "Error Bean" + } + } + }, + "x-example": { + "example0": { + "summary": "Create Report Subscription", + "value": { + "reportDefinitionName": "TransactionRequestClass", + "reportFields": [ + "Request.RequestID", + "Request.TransactionDate", + "Request.MerchantID", + "AFSFields.IPAddress", + "AFSFields.IPCountry", + "AFSFields.IPRoutingMethod", + "AFSFields.IPState", + "Application.Name", + "BankInfo.Address", + "BankInfo.BranchCode", + "BankInfo.City", + "BankInfo.Country", + "BankInfo.Name", + "BankInfo.SwiftCode", + "BillTo.Address1", + "BillTo.Address2", + "BillTo.City", + "BillTo.CompanyName", + "BillTo.CompanyTaxID", + "BillTo.Country", + "BillTo.Email", + "BillTo.FirstName", + "BillTo.LastName", + "BillTo.MiddleName", + "BillTo.NameSuffix", + "BillTo.PersonalID", + "BillTo.Phone", + "BillTo.State", + "BillTo.Title", + "BillTo.Zip", + "ChargebackAndRetrieval.AdjustmentAmount", + "ChargebackAndRetrieval.AdjustmentCurrency", + "ChargebackAndRetrieval.ARN", + "ChargebackAndRetrieval.CaseIdentifier", + "ChargebackAndRetrieval.CaseNumber", + "ChargebackAndRetrieval.CaseTime", + "ChargebackAndRetrieval.CaseType", + "ChargebackAndRetrieval.ChargebackAmount", + "ChargebackAndRetrieval.ChargebackCurrency", + "ChargebackAndRetrieval.ChargebackMessage", + "ChargebackAndRetrieval.ChargebackReasonCode", + "ChargebackAndRetrieval.ChargebackReasonCodeDescription", + "ChargebackAndRetrieval.ChargebackTime", + "ChargebackAndRetrieval.DocumentIndicator", + "ChargebackAndRetrieval.FeeAmount", + "ChargebackAndRetrieval.FeeCurrency", + "ChargebackAndRetrieval.FinancialImpact", + "ChargebackAndRetrieval.FinancialImpactType", + "ChargebackAndRetrieval.MerchantCategoryCode", + "ChargebackAndRetrieval.PartialIndicator", + "ChargebackAndRetrieval.ResolutionTime", + "ChargebackAndRetrieval.ResolvedToIndicator", + "ChargebackAndRetrieval.RespondByDate", + "ChargebackAndRetrieval.TransactionType", + "Check.AccountEncoderID", + "Check.BankTransitNumber", + "Check.SecCode", + "CustomerFields.BillingAddress1", + "CustomerFields.BillingAddress2", + "CustomerFields.BillingCity", + "CustomerFields.BillingCompanyName", + "CustomerFields.BillingCountry", + "CustomerFields.BillingEmail", + "CustomerFields.BillingFirstName", + "CustomerFields.BillingLastName", + "CustomerFields.BillingPhone", + "CustomerFields.BillingPostalCode", + "CustomerFields.BillingState", + "CustomerFields.CustomerID", + "CustomerFields.CustomerUserName", + "CustomerFields.PersonalId(CPF/CNPJ)", + "CustomerFields.ShippingAddress1", + "CustomerFields.ShippingAddress2", + "CustomerFields.ShippingCity", + "CustomerFields.ShippingCompanyName", + "CustomerFields.ShippingCountry", + "CustomerFields.ShippingFirstName", + "CustomerFields.ShippingLastName", + "CustomerFields.ShippingPhone", + "CustomerFields.ShippingPostalCode", + "CustomerFields.ShippingState", + "DecisionManagerEvents.EventPolicy", + "DecisionManagerEvents.TypeofEvent", + "Device.DeviceID", + "DeviceFingerprintFields.abcd", + "DeviceFingerprintFields.BrowserLanguage", + "DeviceFingerprintFields.DeviceLatitude", + "DeviceFingerprintFields.DeviceLongitude", + "DeviceFingerprintFields.displayNameFinalCheck", + "DeviceFingerprintFields.DMESignOffFieldEdit", + "DeviceFingerprintFields.Fingerprint/DeviceFingerprint", + "DeviceFingerprintFields.FlashEnabled", + "DeviceFingerprintFields.FlashOperatingSystem", + "DeviceFingerprintFields.FlashVersion", + "DeviceFingerprintFields.GPSAccuracy", + "DeviceFingerprintFields.ImagesEnabled", + "DeviceFingerprintFields.Jailbreak/RootPrivileges", + "DeviceFingerprintFields.JavaScriptEnabled", + "DeviceFingerprintFields.ProfiledURL", + "DeviceFingerprintFields.ProxyIPAddress", + "DeviceFingerprintFields.ProxyIPAddressActivities", + "DeviceFingerprintFields.ProxyServerType", + "DeviceFingerprintFields.ScreenResolution", + "DeviceFingerprintFields.SignOffFieldDMEEditNewOne", + "DeviceFingerprintFields.SmartID", + "DeviceFingerprintFields.SmartIDConfidenceLevel", + "DeviceFingerprintFields.TimeOnPage", + "DeviceFingerprintFields.TrueIPAddress", + "DeviceFingerprintFields.TrueIPAddressActivities", + "DeviceFingerprintFields.TrueIPAddressAttributes", + "DeviceFingerprintFields.txdea1", + "DeviceFingerprintFields.txdesv", + "EmailageFields.FraudType", + "EmailageFields.IP Postal", + "EmailageFields.IPCity", + "EmailageFields.IPCountry", + "EmailageFields.IPRegion", + "EmailageFields.SourceIndustry", + "Event.Amount", + "Event.CurrencyCode", + "Event.Event", + "Event.EventDate", + "Event.ProcessorMessage", + "Exception.Action", + "Exception.CYBSExceptionID", + "Exception.DccLookupStatus", + "Exception.ExceptionAmount", + "Exception.ExceptionAmountCurrency", + "Exception.ExceptionCategory", + "Exception.ExceptionDate", + "Exception.ExceptionDescription", + "Exception.ExceptionDeviceHardwareRevision", + "Exception.ExceptionDeviceID", + "Exception.ExceptionDeviceOS", + "Exception.ExceptionDeviceOSVersion", + "Exception.ExceptionDeviceTerminalID", + "Exception.ExceptionMessage", + "Exception.ExceptionReasonDescription", + "Exception.ExceptionStatus", + "Exception.ExceptionStatusCode", + "Exception.ExceptionType", + "Exception.FinancialStatus", + "Exception.LastActionDate", + "Exception.NextActionDate", + "Exception.OriginalTransactionSubmissionDate", + "Exception.PaymentNumber", + "Exception.ProcessorCaseID", + "Exception.ProcessorResponseCode", + "Exception.ReasonCode", + "Exception.RetryCount", + "Fee.AssessmentAmount", + "Fee.AssessmentCurrency", + "Fee.BillingCycle", + "Fee.BillingType", + "Fee.ClearedInterchangeLevel", + "Fee.DiscountAmount", + "Fee.DiscountCurrency", + "Fee.DiscountRate", + "Fee.DowngradeReasonCode", + "Fee.InterchangeAmount", + "Fee.InterchangeCurrency", + "Fee.InterchangeRate", + "Fee.PerItemFeeAmount", + "Fee.PerItemFeeCurrency", + "Fee.PricedInterchangeLevel", + "Fee.ServiceFeeAmount", + "Fee.ServiceFeeAmountCcy", + "Fee.ServiceFeeFixedAmount", + "Fee.ServiceFeeFixedAmountCcy", + "Fee.ServiceFeeRate", + "Fee.SettlementAmount", + "Fee.SettlementCurrency", + "Fee.SettlementTime", + "Fee.SettlementTimeZone", + "Fee.SourceDescriptor", + "Fee.TotalFeeAmount", + "Fee.TotalFeeCurrency", + "Funding.AdjustmentAmount", + "Funding.AdjustmentCurrency", + "Funding.AdjustmentDescription", + "Funding.AdjustmentType", + "FundTransfer.BankCheckDigit", + "FundTransfer.IbanIndicator", + "Invoice.BillingGroupDescription", + "Invoice.NotProcessed", + "Invoice.OrganizationID", + "Invoice.PerformedServices", + "Invoice.Processed", + "Invoice.Total", + "JP.Amount", + "JP.AuthForward", + "JP.AuthorizationCode", + "JP.CardSuffix", + "JP.Currency", + "JP.CustomerFirstName", + "JP.CustomerLastName", + "JP.Date", + "JP.Gateway", + "JP.JPOInstallmentMethod", + "JP.JPOPaymentMethod", + "JP.MerchantID", + "JP.MerchantReferenceNumber", + "JP.PaymentMethod", + "JP.RequestID", + "JP.SubscriptionID", + "JP.Time", + "JP.TransactionReferenceNumber", + "JP.TransactionType", + "LineItems.FulfillmentType", + "LineItems.InvoiceNumber", + "LineItems.MerchantProductSku", + "LineItems.ProductCode", + "LineItems.ProductName", + "LineItems.Quantity", + "LineItems.TaxAmount", + "LineItems.UnitPrice", + "MarkAsSuspectFields.MarkingDate", + "MarkAsSuspectFields.MarkingNotes", + "MarkAsSuspectFields.MarkingReason", + "MarkAsSuspectFields.MarkingUserName", + "Merchant-DefinedDataFields.MerchantDefinedData1", + "Merchant-DefinedDataFields.MerchantDefinedData10", + "Merchant-DefinedDataFields.MerchantDefinedData100", + "Merchant-DefinedDataFields.MerchantDefinedData11", + "Merchant-DefinedDataFields.MerchantDefinedData12", + "Merchant-DefinedDataFields.MerchantDefinedData13", + "Merchant-DefinedDataFields.MerchantDefinedData14", + "Merchant-DefinedDataFields.MerchantDefinedData15", + "Merchant-DefinedDataFields.MerchantDefinedData16", + "Merchant-DefinedDataFields.MerchantDefinedData17", + "Merchant-DefinedDataFields.MerchantDefinedData18", + "Merchant-DefinedDataFields.MerchantDefinedData19", + "Merchant-DefinedDataFields.MerchantDefinedData2", + "Merchant-DefinedDataFields.MerchantDefinedData20", + "Merchant-DefinedDataFields.MerchantDefinedData21", + "Merchant-DefinedDataFields.MerchantDefinedData22", + "Merchant-DefinedDataFields.MerchantDefinedData23", + "Merchant-DefinedDataFields.MerchantDefinedData24", + "Merchant-DefinedDataFields.MerchantDefinedData25", + "Merchant-DefinedDataFields.MerchantDefinedData26", + "Merchant-DefinedDataFields.MerchantDefinedData27", + "Merchant-DefinedDataFields.MerchantDefinedData28", + "Merchant-DefinedDataFields.MerchantDefinedData29", + "Merchant-DefinedDataFields.MerchantDefinedData3", + "Merchant-DefinedDataFields.MerchantDefinedData30", + "Merchant-DefinedDataFields.MerchantDefinedData31", + "Merchant-DefinedDataFields.MerchantDefinedData32", + "Merchant-DefinedDataFields.MerchantDefinedData34", + "Merchant-DefinedDataFields.MerchantDefinedData35", + "Merchant-DefinedDataFields.MerchantDefinedData36", + "Merchant-DefinedDataFields.MerchantDefinedData37", + "Merchant-DefinedDataFields.MerchantDefinedData39", + "Merchant-DefinedDataFields.MerchantDefinedData4", + "Merchant-DefinedDataFields.MerchantDefinedData40", + "Merchant-DefinedDataFields.MerchantDefinedData41", + "Merchant-DefinedDataFields.MerchantDefinedData43", + "Merchant-DefinedDataFields.MerchantDefinedData44", + "Merchant-DefinedDataFields.MerchantDefinedData45", + "Merchant-DefinedDataFields.MerchantDefinedData46", + "Merchant-DefinedDataFields.MerchantDefinedData48", + "Merchant-DefinedDataFields.MerchantDefinedData49", + "Merchant-DefinedDataFields.MerchantDefinedData5", + "Merchant-DefinedDataFields.MerchantDefinedData50", + "Merchant-DefinedDataFields.MerchantDefinedData52", + "Merchant-DefinedDataFields.MerchantDefinedData53", + "Merchant-DefinedDataFields.MerchantDefinedData54", + "Merchant-DefinedDataFields.MerchantDefinedData56", + "Merchant-DefinedDataFields.MerchantDefinedData57", + "Merchant-DefinedDataFields.MerchantDefinedData58", + "Merchant-DefinedDataFields.MerchantDefinedData59", + "Merchant-DefinedDataFields.MerchantDefinedData6", + "Merchant-DefinedDataFields.MerchantDefinedData61", + "Merchant-DefinedDataFields.MerchantDefinedData62", + "Merchant-DefinedDataFields.MerchantDefinedData63", + "Merchant-DefinedDataFields.MerchantDefinedData65", + "Merchant-DefinedDataFields.MerchantDefinedData66", + "Merchant-DefinedDataFields.MerchantDefinedData67", + "Merchant-DefinedDataFields.MerchantDefinedData68", + "Merchant-DefinedDataFields.MerchantDefinedData7", + "Merchant-DefinedDataFields.MerchantDefinedData70", + "Merchant-DefinedDataFields.MerchantDefinedData71", + "Merchant-DefinedDataFields.MerchantDefinedData72", + "Merchant-DefinedDataFields.MerchantDefinedData73", + "Merchant-DefinedDataFields.MerchantDefinedData74", + "Merchant-DefinedDataFields.MerchantDefinedData75", + "Merchant-DefinedDataFields.MerchantDefinedData76", + "Merchant-DefinedDataFields.MerchantDefinedData77", + "Merchant-DefinedDataFields.MerchantDefinedData78", + "Merchant-DefinedDataFields.MerchantDefinedData79", + "Merchant-DefinedDataFields.MerchantDefinedData8", + "Merchant-DefinedDataFields.MerchantDefinedData80", + "Merchant-DefinedDataFields.MerchantDefinedData81", + "Merchant-DefinedDataFields.MerchantDefinedData82", + "Merchant-DefinedDataFields.MerchantDefinedData83", + "Merchant-DefinedDataFields.MerchantDefinedData84", + "Merchant-DefinedDataFields.MerchantDefinedData85", + "Merchant-DefinedDataFields.MerchantDefinedData86", + "Merchant-DefinedDataFields.MerchantDefinedData87", + "Merchant-DefinedDataFields.MerchantDefinedData88", + "Merchant-DefinedDataFields.MerchantDefinedData89", + "Merchant-DefinedDataFields.MerchantDefinedData9", + "Merchant-DefinedDataFields.MerchantDefinedData90", + "Merchant-DefinedDataFields.MerchantDefinedData91", + "Merchant-DefinedDataFields.MerchantDefinedData92", + "Merchant-DefinedDataFields.MerchantDefinedData93", + "Merchant-DefinedDataFields.MerchantDefinedData94", + "Merchant-DefinedDataFields.MerchantDefinedData95", + "Merchant-DefinedDataFields.MerchantDefinedData96", + "Merchant-DefinedDataFields.MerchantDefinedData97", + "Merchant-DefinedDataFields.MerchantDefinedData98", + "Merchant-DefinedDataFields.MerchantDefinedData99", + "OctSummary.AccountId", + "OctSummary.ResellerId", + "OctSummary.SettlementAmountCurrency", + "OctSummary.SettlementDate", + "OctSummary.TransactionAmountCurrency", + "OrderFields.ConnectionMethod", + "OrderFields.MerchantID", + "OrderFields.MerchantReferenceNumber", + "OrderFields.ReasonCode", + "OrderFields.ReplyCode", + "OrderFields.ReplyFlag", + "OrderFields.ReplyMessage", + "OrderFields.RequestID", + "OrderFields.ShippingMethod", + "OrderFields.TransactionDate", + "PayerAuth.RequestID", + "PayerAuth.TransactionType", + "PaymentData.ACHVerificationResult", + "PaymentData.ACHVerificationResultMapped", + "PaymentData.AcquirerMerchantID", + "PaymentData.AuthIndicator", + "PaymentData.AuthorizationCode", + "PaymentData.AuthorizationType", + "PaymentData.AuthReversalAmount", + "PaymentData.AuthReversalResult", + "PaymentData.AVSResult", + "PaymentData.AVSResultMapped", + "PaymentData.BalanceAmount", + "PaymentData.BalanceCurrencyCode", + "PaymentData.BinNumber", + "PaymentData.CardCategory", + "PaymentData.CardCategoryCode", + "PaymentData.CardPresent", + "PaymentData.CurrencyCode", + "PaymentData.CVResult", + "PaymentData.DCCIndicator", + "PaymentData.EMVRequestFallBack", + "PaymentData.EVEmail", + "PaymentData.EVEmailRaw", + "PaymentData.EVName", + "PaymentData.EVNameRaw", + "PaymentData.EVPhoneNumber", + "PaymentData.EVPhoneNumberRaw", + "PaymentData.EVPostalCode", + "PaymentData.EVPostalCodeRaw", + "PaymentData.EVStreet", + "PaymentData.EVStreetRaw", + "PaymentData.ExchangeRate", + "PaymentData.ExchangeRateDate", + "PaymentData.MandateReferenceNumber", + "PaymentData.NetworkCode", + "PaymentData.NetworkTransactionID", + "PaymentData.NumberOfInstallments", + "PaymentData.OriginalAmount", + "PaymentData.OriginalCurrency", + "PaymentData.PaymentProductCode", + "PaymentData.POSEntryMode", + "PaymentData.ProcessorMID", + "PaymentData.ProcessorResponseCode", + "PaymentData.ProcessorResponseID", + "PaymentData.ProcessorTID", + "PaymentData.ProcessorTransactionID", + "PaymentData.RequestedAmount", + "PaymentData.RequestedAmountCurrencyCode", + "PaymentData.SubMerchantCity", + "PaymentData.SubMerchantCountry", + "PaymentData.SubMerchantEmail", + "PaymentData.SubMerchantID", + "PaymentData.SubMerchantName", + "PaymentData.SubMerchantPhone", + "PaymentData.SubMerchantPostalCode", + "PaymentData.SubMerchantState", + "PaymentData.SubMerchantStreet", + "PaymentData.TargetAmount", + "PaymentData.TargetCurrency", + "PaymentFields.AccountSuffix", + "PaymentFields.CardBIN", + "PaymentFields.CardBINCountry", + "PaymentFields.CardIssuer", + "PaymentFields.CardScheme", + "PaymentFields.CardType", + "PaymentFields.CardVerificationResult", + "PaymentMethod.AccountSuffix", + "PaymentMethod.AdditionalCardType", + "PaymentMethod.BankAccountName", + "PaymentMethod.BankCode", + "PaymentMethod.BoletoBarCodeNumber", + "PaymentMethod.BoletoNumber", + "PaymentMethod.CardType", + "PaymentMethod.CheckNumber", + "PaymentMethod.ExpirationMonth", + "PaymentMethod.ExpirationYear", + "PaymentMethod.IssueNumber", + "PaymentMethod.MandateId", + "PaymentMethod.StartMonth", + "PaymentMethod.StartYear", + "PaymentMethod.WalletType", + "POSTerminalExceptions.AccountSuffix", + "POSTerminalExceptions.CurrencyCode", + "POSTerminalExceptions.ExpirationMO", + "POSTerminalExceptions.ExpirationYR", + "POSTerminalExceptions.LastName", + "POSTerminalExceptions.MerchantID", + "Recipient.RecipientBillingAmount", + "Recipient.RecipientBillingCurrency", + "Recipient.ReferenceNumber", + "Request.PartnerOriginalTransactionID", + "Sender.Address", + "Sender.City", + "Sender.Country", + "Sender.DOB", + "Sender.FirstName", + "Sender.LastName", + "Sender.MiddleInitial", + "Sender.PhoneNumber", + "Sender.PostalCode", + "Sender.SenderReferenceNumber", + "Sender.SourceOfFunds", + "Sender.State", + "ShipTo.CompanyName", + "Subscriptions.Applications", + "Subscriptions.AuthAVSResults", + "Subscriptions.AuthCardVerificationResult", + "Subscriptions.AuthCode", + "Subscriptions.AuthRCode", + "Subscriptions.AuthResponseCode", + "Subscriptions.AuthType", + "Subscriptions.BillToAddress1", + "Subscriptions.BillToAddress2", + "Subscriptions.BillToCity", + "Subscriptions.BillToCompanyName", + "Subscriptions.BillToCountry", + "Subscriptions.BillToEmail", + "Subscriptions.BillToFirstName", + "Subscriptions.BillToLastName", + "Subscriptions.BillToState", + "Subscriptions.BillToZip", + "Subscriptions.CardType", + "Subscriptions.Comments", + "Subscriptions.ConsumerPhone", + "Subscriptions.CurrencyCode", + "Subscriptions.CustomerCCAccountSuffix", + "Subscriptions.CustomerCCExpiryMonth", + "Subscriptions.CustomerCCExpiryYear", + "Subscriptions.CustomerCCIssueNo", + "Subscriptions.CustomerCCRoutingNumber", + "Subscriptions.CustomerCCStartMonth", + "Subscriptions.CustomerCCStartYear", + "Subscriptions.CustomerCCSubTypeDescription", + "Subscriptions.EcommerceIndicator", + "Subscriptions.IPAddress", + "Subscriptions.MerchantDefinedData1", + "Subscriptions.MerchantDefinedData2", + "Subscriptions.MerchantDefinedData3", + "Subscriptions.MerchantDefinedData4", + "Subscriptions.MerchantRefNo", + "Subscriptions.MerchantSecureData1", + "Subscriptions.MerchantSecureData2", + "Subscriptions.MerchantSecureData3", + "Subscriptions.MerchantSecureData4", + "Subscriptions.PaymentProcessor", + "Subscriptions.PaymentsSuccess", + "Subscriptions.RCode", + "Subscriptions.ReasonCode", + "Subscriptions.RequestID", + "Subscriptions.RequestToken", + "Subscriptions.RFlag", + "Subscriptions.RMsg", + "Subscriptions.ShipToAddress1", + "Subscriptions.ShipToAddress2", + "Subscriptions.ShipToCity", + "Subscriptions.ShipToCompanyName", + "Subscriptions.ShipToCountry", + "Subscriptions.ShipToFirstName", + "Subscriptions.ShipToLastName", + "Subscriptions.ShipToState", + "Subscriptions.ShipToZip", + "Subscriptions.SubscriptionID", + "Subscriptions.TaxAmount", + "Subscriptions.TransactionDate", + "Subscriptions.TransRefNo", + "TaxCalculation.Status", + "Token.NetworkTokenTransType", + "Token.TokenCode", + "TransactionDetails.MerchantId", + "TransactionDetails.PaymentMethodDesc", + "TransactionDetails.PaymentMethodType", + "TransactionDetails.RequestId", + "TravelFields.DepartureTime", + "VelocityMorphing.FieldName", + "VelocityMorphing.InfoCode", + "WhitepagesProFields.EmailDomainCreationDate" + ], + "reportMimeType": "application/xml", + "reportFrequency": "WEEKLY", + "reportName": "testrest_subcription_v1", + "timezone": "GMT", + "startTime": "0900", + "startDay": "1" + } + } + } + } + }, + "/reporting/v3/report-subscriptions/{reportName}": { + "get": { + "tags": [ + "ReportSubscriptions" + ], + "summary": "Get subscription for report name", + "description": "View the details of a report subscription, such as\nthe report format or report frequency, using the report\u2019s\nunique name.\n", + "operationId": "getSubscription", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "reportName", + "in": "path", + "description": "Name of the Report to Retrieve", + "required": true, + "type": "string", + "maxLength": 80, + "minLength": 1, + "pattern": "[a-zA-Z0-9-_+]+" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "title": "reportingV3ReportsSbscriptionsNameGet200Response", + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Selected Organization Id", + "example": "Merchant 1" + }, + "reportDefinitionId": { + "type": "string", + "description": "Report Definition Id", + "example": "210" + }, + "reportDefinitionName": { + "type": "string", + "description": "Report Definition Class", + "example": "TransactionRequestDetailClass" + }, + "reportMimeType": { + "type": "string", + "example": "application/xml", + "description": "Report Format", + "enum": [ + "application/xml", + "text/csv" + ] + }, + "reportFrequency": { + "type": "string", + "example": "DAILY", + "description": "Report Frequency", + "enum": [ + "DAILY", + "WEEKLY", + "MONTHLY", + "ADHOC" + ] + }, + "reportName": { + "type": "string", + "description": "Report Name", + "example": "My Transaction Request Detail Report" + }, + "timezone": { + "type": "string", + "description": "Time Zone", + "example": "America/Chicago" + }, + "startTime": { + "type": "string", + "description": "Start Time", + "format": "date-time", + "example": "2017-10-01T10:10:10+05:00" + }, + "startDay": { + "type": "integer", + "format": "int32", + "description": "Start Day", + "example": 1 + }, + "reportFields": { + "type": "array", + "example": [ + "Request.RequestID", + "Request.TransactionDate", + "Request.MerchantID" + ], + "description": "List of all fields String values", + "items": { + "type": "string" + } + }, + "reportFilters": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "description": "List of filters to apply", + "example": { + "Application.Name": [ + "ics_auth", + "ics_bill" + ] + } + }, + "reportPreferences": { + "type": "object", + "properties": { + "signedAmounts": { + "type": "boolean", + "description": "Indicator to determine whether negative sign infront of amount for all refunded transaction" + }, + "fieldNameConvention": { + "type": "string", + "description": "Specify the field naming convention to be followed in reports (applicable to only csv report formats", + "enum": [ + "SOAPI", + "SCMP" + ] + } + }, + "description": "Report Preferences" + }, + "groupId": { + "type": "string", + "example": "12345", + "description": "Id for the selected group." + } + }, + "description": "Subscription Details" + } + }, + "400": { + "description": "Invalid request", + "schema": { + "title": "reportingV3ReportSubscriptionsNameGet400Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "404": { + "description": "Subscription not found" + } + } + }, + "delete": { + "tags": [ + "ReportSubscriptions" + ], + "summary": "Delete subscription of a report name by organization", + "description": "Delete a report subscription for your\norganization. You must know the unique name of the report\nyou want to delete.\n", + "operationId": "deleteSubscription", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "reportName", + "in": "path", + "description": "Name of the Report to Delete", + "required": true, + "type": "string", + "maxLength": 80, + "minLength": 1, + "pattern": "[a-zA-Z0-9-_+]+" + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "400": { + "description": "Invalid request", + "schema": { + "title": "reportingV3ReportSubscriptionsNameDelete400Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "404": { + "description": "Subscription not found", + "schema": { + "title": "reportingV3ReportSubscriptionsnameDelete404Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + } + } + } + }, + "/reporting/v3/notification-of-changes": { + "get": { + "tags": [ + "NotificationOfChanges" + ], + "summary": "Get Notification Of Changes", + "description": "Download the Notification of Change report. This\nreport shows eCheck-related fields updated as a result of a\nresponse to an eCheck settlement transaction.\n", + "operationId": "getNotificationOfChangeReport", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "x-queryParameterDefaults": { + "startTime": "2018-05-01T12:00:00-05:00", + "endTime": "2018-05-30T12:00:00-05:00" + }, + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "startTime", + "in": "query", + "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n", + "required": true, + "type": "string", + "format": "date-time" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "title": "reportingV3NotificationofChangesGet200Response", + "type": "object", + "properties": { + "notificationOfChanges": { + "type": "array", + "description": "List of Notification Of Change Info values", + "items": { + "type": "object", + "properties": { + "merchantReferenceNumber": { + "type": "string", + "example": "TC30877-10", + "description": "Merchant Reference Number" + }, + "transactionReferenceNumber": { + "type": "string", + "example": "55563", + "description": "Transaction Reference Number" + }, + "time": { + "type": "string", + "example": "2017-10-01T10:10:10+05:00", + "format": "date-time", + "description": "Notification Of Change Date(ISO 8601 Extended)" + }, + "code": { + "type": "string", + "example": "TC30877-10", + "description": "Merchant Reference Number" + }, + "accountType": { + "type": "string", + "example": "Checking Account", + "description": "Account Type" + }, + "routingNumber": { + "type": "string", + "example": "123456789", + "description": "Routing Number" + }, + "accountNumber": { + "type": "string", + "example": "############1234", + "description": "Account Number" + }, + "consumerName": { + "type": "string", + "example": "Consumer Name", + "description": "Consumer Name" + } + }, + "description": "Notification Of Change" + } + } + } + } + }, + "400": { + "description": "Invalid request", + "schema": { + "title": "reportingV3NotificationofChangesGet400Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "401": { + "description": "Unauthorized. Token provided is no more valid." + }, + "404": { + "description": "Report not found", + "schema": { + "title": "reportingV3NotificationofChangesGet404Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "title": "reportingV3NotificationofChangesGet500Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + } + } + } + }, + "/reporting/v3/purchase-refund-details": { + "get": { + "tags": [ + "PurchaseAndRefundDetails" + ], + "summary": "Get Purchase and Refund details", + "description": "Download the Purchase and Refund Details\nreport. This report report includes all purchases and refund\ntransactions, as well as all activities related to transactions\nresulting in an adjustment to the net proceeds.\n", + "operationId": "getPurchaseAndRefundDetails", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "x-queryParameterDefaults": { + "organizationId": "testrest", + "startTime": "2018-05-01T12:00:00-05:00", + "endTime": "2018-05-30T12:00:00-05:00", + "groupName": "groupName", + "paymentSubtype": "VI", + "viewBy": "requestDate", + "offset": "20", + "limit": "2000" + }, + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "startTime", + "in": "query", + "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "organizationId", + "in": "query", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 32 + }, + { + "name": "paymentSubtype", + "in": "query", + "description": "Payment Subtypes.\n - **ALL**: All Payment Subtypes\n - **VI** : Visa\n - **MC** : Master Card\n - **AX** : American Express\n - **DI** : Discover\n - **DP** : Pinless Debit\n", + "required": false, + "type": "string", + "default": "ALL", + "enum": [ + "ALL", + "VI", + "MC", + "AX", + "DI", + "DP" + ] + }, + { + "name": "viewBy", + "in": "query", + "description": "View results by Request Date or Submission Date.\n - **requestDate** : Request Date\n - **submissionDate**: Submission Date\n", + "required": false, + "type": "string", + "default": "requestDate", + "enum": [ + "requestDate", + "submissionDate" + ] + }, + { + "name": "groupName", + "in": "query", + "description": "Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds", + "required": false, + "type": "string" + }, + { + "name": "offset", + "in": "query", + "description": "Offset of the Purchase and Refund Results.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "limit", + "in": "query", + "description": "Results count per page. Range(1-2000)", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 2000, + "default": 2000, + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "title": "reportingV3PurchaseRefundDetailsGet200Response", "type": "object", "properties": { - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "save": { - "type": "boolean", - "description": "save or not save." - }, - "name": { - "type": "string", - "description": "The description for this field is not available.\n" - }, - "timezone": { - "type": "string", - "description": "Time Zone." - }, - "query": { - "type": "string", - "description": "transaction search query string." - }, "offset": { - "type": "integer", - "description": "offset." + "type": "integer" }, "limit": { - "type": "integer", - "description": "limit on number of results." - }, - "sort": { - "type": "string", - "description": "A comma separated list of the following form - fieldName1 asc or desc, fieldName2 asc or desc, etc." - }, - "count": { - "type": "integer", - "description": "Results for this page, this could be below the limit." - }, - "totalCount": { - "type": "integer", - "description": "total number of results." + "type": "integer" }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" + "pageResults": { + "type": "integer" }, - "_embedded": { - "type": "object", - "properties": { - "transactionSummaries": { - "type": "array", - "description": "transaction search summary", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "merchantId": { - "type": "string", - "description": "The description for this field is not available." - }, - "applicationInformation": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "The status of the submitted transaction." - }, - "reasonCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "rCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "rFlag": { - "type": "string", - "description": "The description for this field is not available." - }, - "applications": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The description for this field is not available." - }, - "status": { - "type": "string", - "description": "The description for this field is not available." - }, - "reasonCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "rCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "rFlag": { - "type": "string", - "description": "The description for this field is not available." - }, - "reconciliationId": { - "type": "string", - "description": "The description for this field is not available." - }, - "rMessage": { - "type": "string", - "description": "The description for this field is not available." - }, - "returnCode": { - "type": "string", - "description": "The description for this field is not available." - } - } - } - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "merchantCustomerId": { - "type": "string", - "maxLength": 100, - "description": "Your identifier for the customer.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n" - }, - "applicationName": { - "type": "string", - "description": "The application name of client which is used to submit the request." - }, - "applicationUser": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "consumerAuthenticationInformation": { - "type": "object", - "properties": { - "xid": { - "type": "string", - "maxLength": 40, - "description": "Transaction identifier." - }, - "transactionId": { - "type": "string", - "description": "Payer auth Transaction identifier." - } - } - }, - "deviceInformation": { - "type": "object", - "properties": { - "ipAddress": { - "type": "string", - "maxLength": 15, - "description": "IP address of the customer." - } - } - }, - "fraudMarkingInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "merchantDefinedInformation": { - "type": "array", - "description": "The description for this field is not available.", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "maxLength": 50, - "description": "The description for this field is not available." - }, - "value": { - "type": "string", - "maxLength": 255, - "description": "The description for this field is not available." - } - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "resellerId": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "email": { - "type": "string", - "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - }, - "shipTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Last name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "First line of the shipping address." - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the shipping address. Use the two character ISO Standard Country Codes." - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Phone number for the shipping address." - } - } - }, - "amountDetails": { - "type": "object", - "properties": { - "totalAmount": { - "type": "string", - "maxLength": 19, - "description": "Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n" - } - } - } - } - }, - "paymentInformation": { - "type": "object", - "properties": { - "paymentMethod": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "customer": { - "type": "object", - "properties": { - "customerId": { - "type": "string", - "description": "Unique identifier for the customer's card and billing information." - } - } - }, - "card": { - "type": "object", - "properties": { - "suffix": { - "type": "string", - "maxLength": 4, - "description": "Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n" - }, - "prefix": { - "type": "string", - "maxLength": 6, - "description": "The description for this field is not available." - }, - "type": { - "type": "string", - "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n" - } - } - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "paymentSolution": { - "type": "string", - "maxLength": 12, - "description": "Type of digital payment solution that is being used for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout.\n - **001**: Apple Pay.\n - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct.\n - **006**: Android Pay.\n - **008**: Samsung Pay.\n" - }, - "businessApplicationId": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "processorInformation": { - "type": "object", - "properties": { - "processor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 30, - "description": "Name of the Processor.\n" - } - } - } - } - }, - "pointOfSaleInformation": { - "type": "object", - "properties": { - "terminalId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the terminal at your retail location. You can define this value yourself, but consult the\nprocessor for requirements.\n\nFor Payouts: This field is applicable for CtV.\n" - }, - "terminalSerialNumber": { - "type": "string", - "description": "The description for this field is not available." - }, - "deviceId": { - "type": "string", - "description": "The description for this field is not available." - }, - "partner": { - "type": "object", - "properties": { - "originalTransactionId": { - "type": "string", - "maxLength": 50, - "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n" - } - } - } - } - }, - "riskInformation": { - "type": "object", - "properties": { - "providers": { - "type": "object", - "properties": { - "fingerprint": { - "type": "object", - "properties": { - "true_ipaddress": { - "type": "string", - "maxLength": 255, - "description": "The description for this field is not available." - }, - "hash": { - "type": "string", - "maxLength": 255, - "description": "The description for this field is not available." - }, - "smartId": { - "type": "string", - "maxLength": 255, - "description": "The description for this field is not available." - } - } - } - } - } - } - }, - "_links": { - "type": "object", - "properties": { - "transactionDetail": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - } - } + "requestDetails": { + "type": "array", + "description": "List of Request Info values", + "items": { + "type": "object", + "properties": { + "requestId": { + "type": "string", + "example": "12345678901234567890123456", + "description": "An unique identification number assigned by CyberSource to identify the submitted request." + }, + "cybersourceMerchantId": { + "type": "string", + "example": "Cybersource Merchant Id", + "description": "Cybersource Merchant Id" + }, + "processorMerchantId": { + "type": "string", + "example": "Processor Merchant Id", + "description": "Cybersource Processor Merchant Id" + }, + "groupName": { + "type": "string", + "example": "996411990498708810001", + "description": "Group Name" + }, + "transactionReferenceNumber": { + "type": "string", + "example": "RZ3J9WCS9J33", + "description": "Transaction Reference Number" + }, + "merchantReferenceNumber": { + "type": "string", + "example": "47882339", + "description": "Merchant Reference Number" } - } + }, + "description": "Request Info Section" } }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - } - }, - "example": { - "id": "87e1e4bd-cac2-49b1-919a-4d5e29a2e55d", - "save": "false", - "name": "Search By Code", - "timezone": "America/Chicago", - "query": "clientReferenceInformation.code:12345", - "offset": 0, - "limit": 2000, - "sort": "id:asc, submitTimeUtc:asc", - "count": 22, - "totalCount": 22, - "submitTimeUtc": "2018-09-18T16:59:28Z", - "_embedded": { - "transactionSummaries": [{ - "id": "5217848115816817001541", - "submitTimeUtc": "2018-03-23T06:00:11Z", - "merchantId": "sandeep_wf", - "applicationInformation": { - "status": "string", - "reasonCode": "string", - "rCode": "string", - "rFlag": "string", - "applications": [{ - "name": "ics_service_fee_calculate", - "status": "string", - "reasonCode": "string", - "rCode": "string", - "rFlag": "string", - "reconciliationId": "string", - "rMessage": "string", - "returnCode": "string" - } - ] - }, - "buyerInformation": { - "merchantCustomerId": "123456" + "settlements": { + "type": "array", + "description": "List of Settlement Info values", + "items": { + "type": "object", + "properties": { + "requestId": { + "type": "string", + "example": "12345678901234567890123456", + "description": "An unique identification number assigned by CyberSource to identify the submitted request." }, - "clientReferenceInformation": { - "code": "12345", - "applicationName": "Service Fee Request", - "applicationUser": "sandeep_wf" + "transactionType": { + "type": "string", + "example": "Purchases", + "description": "Transaction Type" }, - "consumerAuthenticationInformation": { - "xid": "12345678", - "transactionId": "string" + "submissionTime": { + "type": "string", + "example": "2017-10-01T10:10:10+05:00", + "description": "Submission Date", + "format": "date-time" }, - "deviceInformation": { - "ipAddress": "1.10.10.10" + "amount": { + "type": "string", + "example": "23.00", + "description": "Amount" }, - "fraudMarkingInformation": { - "reason": "fraud txn" + "currencyCode": { + "type": "string", + "example": "USD", + "description": "Valid ISO 4217 ALPHA-3 currency code" }, - "merchantDefinedInformation": [{ - "key": "string", - "value": "string" - } - ], - "merchantInformation": { - "resellerId": "wfbmcp" + "paymentMethod": { + "type": "string", + "example": "VISA", + "description": "payment method" }, - "orderInformation": { - "billTo": { - "firstName": "Test", - "lastName": "TSS", - "email": "null@cybersource.com", - "country": "US", - "phoneNumber": "5120000000" - }, - "shipTo": { - "firstName": "Test", - "lastName": "TSS", - "address1": "201S.DivisionSt._1", - "country": "US", - "phoneNumber": "5120000000" - }, - "amountDetails": { - "totalAmount": "100.00", - "currency": "USD" - } + "walletType": { + "type": "string", + "example": "V.me", + "description": "Solution Type (Wallet)" }, - "paymentInformation": { - "paymentmethod": { - "type": "credit card" - }, - "customer": { - "customerId": "12345" - }, - "card": { - "suffix": "1111", - "prefix": "123456", - "type": "credit card" - } + "paymentType": { + "type": "string", + "example": "credit card", + "description": "Payment Type" }, - "processingInformation": { - "paymentSolution": "xyz", - "businessApplicationId": "string" + "accountSuffix": { + "type": "string", + "example": "0004", + "description": "Account Suffix" }, - "processorInformation": { - "processor": { - "name": "FirstData" - } + "cybersourceBatchTime": { + "type": "string", + "example": "2017-10-01T10:10:10+05:00", + "description": "Cybersource Batch Time", + "format": "date-time" }, - "pointOfSaleInformation": { - "terminalId": "1", - "terminalSerialNumber": "123111123", - "deviceId": "asfaf12312313", - "partner": { - "originalTransactionId": "131231414414" - } + "cybersourceBatchId": { + "type": "string", + "example": "123123123123123", + "description": "Cybersource Batch Id" }, - "riskInformation": { - "providers": { - "fingerprint": { - "true_ipaddress": "1.101.102.112", - "hash": "tuWmt8Ubw0EAybBF3wrZcEqIcZsLr8YPldTQDUxAg2k=", - "smart_id": "23442fdadfa" - } - } + "cardType": { + "type": "string", + "example": "null", + "description": "Card Type" }, - "_links": { - "transactionDetail": { - "href": "https://sl73paysvapq002.visa.com:2031/payment/tss/v2/transactions/5217848115816817001541", - "method": "GET" - } + "debitNetwork": { + "type": "string", + "example": "", + "description": "Debit Network" } } - ] - }, - "_links": { - "self": { - "href": "https://sl73paysvapq002.visa.com:2031/payment/tss/v2/searches/87e1e4bd-cac2-49b1-919a-4d5e29a2e55d", - "method": "GET" } - } - } - } - }, - "400": { - "description": "Invalid request.", - "schema": { - "title": "tssV2TransactionsPost400Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.", - "enum": [ - "INVALID_REQUEST" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." }, - "details": { + "authorizations": { "type": "array", + "description": "List of Authorization Info values", "items": { "type": "object", "properties": { - "field": { + "requestId": { "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." + "example": "12345678901234567890123456", + "description": "An unique identification number assigned by CyberSource to identify the submitted request." }, - "reason": { + "transactionReferenceNumber": { "type": "string", - "description": "Possible reasons for the error.\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] - } - } - } - } - } - } - }, - "502": { - "description": "Unexpected system error or system timeout.", - "schema": { - "title": "tssV2TransactionsPost502Response", - "type": "object", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.", - "enum": [ - "SERVER_ERROR" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n", - "enum": [ - "SYSTEM_ERROR", - "SERVER_TIMEOUT", - "SERVICE_TIMEOUT", - "PROCESSOR_TIMEOUT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - } - } - } - } - } - } - }, - "/tss/v2/searches/{id}": { - "get": { - "summary": "Get Search results", - "description": "Include the Search ID in the GET request to retrieve the search results.", - "tags": [ - "SearchTransactions" - ], - "operationId": "getSearch", - "parameters": [{ - "name": "id", - "in": "path", - "description": "Search ID.", - "required": true, - "type": "string" - } - ], - "x-example": { - "example0": { - "summary": "Get Search results", - "value": {} - } - }, - "responses": { - "200": { - "description": "Successful response.", - "schema": { - "title": "tssV2SearchesGet200Response", - "type": "object", - "properties": { - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "save": { - "type": "boolean", - "description": "save or not save." - }, - "name": { - "type": "string", - "description": "The description for this field is not available.\n" - }, - "timezone": { - "type": "string", - "description": "Time Zone." - }, - "query": { - "type": "string", - "description": "transaction search query string." - }, - "offset": { - "type": "integer", - "description": "offset." - }, - "limit": { - "type": "integer", - "description": "limit on number of results." - }, - "sort": { - "type": "string", - "description": "A comma separated list of the following form - fieldName1 asc or desc, fieldName2 asc or desc, etc." - }, - "count": { - "type": "integer", - "description": "Results for this page, this could be below the limit." - }, - "totalCount": { - "type": "integer", - "description": "total number of results." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "_embedded": { - "type": "object", - "properties": { - "transactionSummaries": { - "type": "array", - "description": "transaction search summary", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - }, - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "merchantId": { - "type": "string", - "description": "The description for this field is not available." - }, - "applicationInformation": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "The status of the submitted transaction." - }, - "reasonCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "rCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "rFlag": { - "type": "string", - "description": "The description for this field is not available." - }, - "applications": { - "type": "array", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The description for this field is not available." - }, - "status": { - "type": "string", - "description": "The description for this field is not available." - }, - "reasonCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "rCode": { - "type": "string", - "description": "The description for this field is not available." - }, - "rFlag": { - "type": "string", - "description": "The description for this field is not available." - }, - "reconciliationId": { - "type": "string", - "description": "The description for this field is not available." - }, - "rMessage": { - "type": "string", - "description": "The description for this field is not available." - }, - "returnCode": { - "type": "string", - "description": "The description for this field is not available." - } - } - } - } - } - }, - "buyerInformation": { - "type": "object", - "properties": { - "merchantCustomerId": { - "type": "string", - "maxLength": 100, - "description": "Your identifier for the customer.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - }, - "clientReferenceInformation": { - "type": "object", - "properties": { - "code": { - "type": "string", - "maxLength": 50, - "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n" - }, - "applicationName": { - "type": "string", - "description": "The application name of client which is used to submit the request." - }, - "applicationUser": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "consumerAuthenticationInformation": { - "type": "object", - "properties": { - "xid": { - "type": "string", - "maxLength": 40, - "description": "Transaction identifier." - }, - "transactionId": { - "type": "string", - "description": "Payer auth Transaction identifier." - } - } - }, - "deviceInformation": { - "type": "object", - "properties": { - "ipAddress": { - "type": "string", - "maxLength": 15, - "description": "IP address of the customer." - } - } - }, - "fraudMarkingInformation": { - "type": "object", - "properties": { - "reason": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "merchantDefinedInformation": { - "type": "array", - "description": "The description for this field is not available.", - "items": { - "type": "object", - "properties": { - "key": { - "type": "string", - "maxLength": 50, - "description": "The description for this field is not available." - }, - "value": { - "type": "string", - "maxLength": 255, - "description": "The description for this field is not available." - } - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "resellerId": { - "type": "string", - "maxLength": 26, - "description": "An unique identification number assigned by CyberSource to identify the submitted request." - } - } - }, - "orderInformation": { - "type": "object", - "properties": { - "billTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "email": { - "type": "string", - "maxLength": 255, - "description": "Customer's email address, including the full domain name.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } - }, - "shipTo": { - "type": "object", - "properties": { - "firstName": { - "type": "string", - "maxLength": 60, - "description": "First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" - }, - "lastName": { - "type": "string", - "maxLength": 60, - "description": "Last name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" - }, - "address1": { - "type": "string", - "maxLength": 60, - "description": "First line of the shipping address." - }, - "country": { - "type": "string", - "maxLength": 2, - "description": "Country of the shipping address. Use the two character ISO Standard Country Codes." - }, - "phoneNumber": { - "type": "string", - "maxLength": 15, - "description": "Phone number for the shipping address." - } - } - }, - "amountDetails": { - "type": "object", - "properties": { - "totalAmount": { - "type": "string", - "maxLength": 19, - "description": "Grand total for the order. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n* CTV, FDCCompass, Paymentech (<= 12)\n\nFor processor-specific information, see the grand_total_amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API.\n" - } - } - } - } - }, - "paymentInformation": { - "type": "object", - "properties": { - "paymentMethod": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "customer": { - "type": "object", - "properties": { - "customerId": { - "type": "string", - "description": "Unique identifier for the customer's card and billing information." - } - } - }, - "card": { - "type": "object", - "properties": { - "suffix": { - "type": "string", - "maxLength": 4, - "description": "Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n" - }, - "prefix": { - "type": "string", - "maxLength": 6, - "description": "The description for this field is not available." - }, - "type": { - "type": "string", - "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n" - } - } - } - } - }, - "processingInformation": { - "type": "object", - "properties": { - "paymentSolution": { - "type": "string", - "maxLength": 12, - "description": "Type of digital payment solution that is being used for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout.\n - **001**: Apple Pay.\n - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct.\n - **006**: Android Pay.\n - **008**: Samsung Pay.\n" - }, - "businessApplicationId": { - "type": "string", - "description": "The description for this field is not available." - } - } - }, - "processorInformation": { - "type": "object", - "properties": { - "processor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 30, - "description": "Name of the Processor.\n" - } - } - } - } - }, - "pointOfSaleInformation": { - "type": "object", - "properties": { - "terminalId": { - "type": "string", - "maxLength": 8, - "description": "Identifier for the terminal at your retail location. You can define this value yourself, but consult the\nprocessor for requirements.\n\nFor Payouts: This field is applicable for CtV.\n" - }, - "terminalSerialNumber": { - "type": "string", - "description": "The description for this field is not available." - }, - "deviceId": { - "type": "string", - "description": "The description for this field is not available." - }, - "partner": { - "type": "object", - "properties": { - "originalTransactionId": { - "type": "string", - "maxLength": 50, - "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n" - } - } - } - } - }, - "riskInformation": { - "type": "object", - "properties": { - "providers": { - "type": "object", - "properties": { - "fingerprint": { - "type": "object", - "properties": { - "true_ipaddress": { - "type": "string", - "maxLength": 255, - "description": "The description for this field is not available." - }, - "hash": { - "type": "string", - "maxLength": 255, - "description": "The description for this field is not available." - }, - "smartId": { - "type": "string", - "maxLength": 255, - "description": "The description for this field is not available." - } - } - } - } - } - } - }, - "_links": { - "type": "object", - "properties": { - "transactionDetail": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - } - } - } - } - } - }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "URL" - }, - "method": { - "type": "string", - "description": "HTTP method applied to above URL" - } - } - } - } - } - }, - "example": { - "id": "87e1e4bd-cac2-49b1-919a-4d5e29a2e55d", - "save": "false", - "name": "Search By Code", - "timezone": "America/Chicago", - "query": "clientReferenceInformation.code:12345", - "offset": 0, - "limit": 2000, - "sort": "id:asc, submitTimeUtc:asc", - "count": 22, - "totalCount": 22, - "submitTimeUtc": "2018-09-18T16:59:28Z", - "_embedded": { - "transactionSummaries": [{ - "id": "5217848115816817001541", - "submitTimeUtc": "2018-03-23T06:00:11Z", - "merchantId": "sandeep_wf", - "applicationInformation": { - "status": "string", - "reasonCode": "string", - "rCode": "string", - "rFlag": "string", - "applications": [{ - "name": "ics_service_fee_calculate", - "status": "string", - "reasonCode": "string", - "rCode": "string", - "rFlag": "string", - "reconciliationId": "string", - "rMessage": "string", - "returnCode": "string" - } - ] + "example": "RZ3J9WCS9J27", + "description": "Authorization Transaction Reference Number" + }, + "time": { + "type": "string", + "example": "2017-10-01T10:10:10+05:00", + "description": "Authorization Date", + "format": "date-time" + }, + "authorizationRequestId": { + "type": "string", + "example": "12345678901234567890123459", + "description": "Authorization Request Id" }, - "buyerInformation": { - "merchantCustomerId": "123456" + "amount": { + "type": "string", + "example": "2.50", + "description": "Authorization Amount" }, - "clientReferenceInformation": { - "code": "12345", - "applicationName": "Service Fee Request", - "applicationUser": "sandeep_wf" + "currencyCode": { + "type": "string", + "example": "USD", + "description": "Valid ISO 4217 ALPHA-3 currency code" }, - "consumerAuthenticationInformation": { - "xid": "12345678", - "transactionId": "string" + "code": { + "type": "string", + "example": "160780", + "description": "Authorization Code" }, - "deviceInformation": { - "ipAddress": "1.10.10.10" + "rcode": { + "type": "string", + "example": "1", + "description": "Authorization RCode" + } + }, + "description": "Authorization Info Values" + } + }, + "feeAndFundingDetails": { + "type": "array", + "description": "List of Fee Funding Info values", + "items": { + "type": "object", + "properties": { + "requestId": { + "type": "string", + "maxLength": 26, + "example": "12345678901234567890123456", + "description": "An unique identification number assigned by CyberSource to identify the submitted request." }, - "fraudMarkingInformation": { - "reason": "fraud txn" + "interchangePerItemFee": { + "type": "string", + "example": "2.7", + "description": "interchange Per Item Fee" }, - "merchantDefinedInformation": [{ - "key": "string", - "value": "string" - } - ], - "merchantInformation": { - "resellerId": "wfbmcp" + "discountPercentage": { + "type": "string", + "example": "2.39", + "description": "Discount Percentage" }, - "orderInformation": { - "billTo": { - "firstName": "Test", - "lastName": "TSS", - "email": "null@cybersource.com", - "country": "US", - "phoneNumber": "5120000000" - }, - "shipTo": { - "firstName": "Test", - "lastName": "TSS", - "address1": "201S.DivisionSt._1", - "country": "US", - "phoneNumber": "5120000000" - }, - "amountDetails": { - "totalAmount": "100.00", - "currency": "USD" - } + "discountAmount": { + "type": "string", + "example": "0.429", + "description": "Discount Amount" }, - "paymentInformation": { - "paymentmethod": { - "type": "credit card" - }, - "customer": { - "customerId": "12345" - }, - "card": { - "suffix": "1111", - "prefix": "123456", - "type": "credit card" - } + "discountPerItemFee": { + "type": "string", + "example": "0.002", + "description": "Discount Per Item Fee" }, - "processingInformation": { - "paymentSolution": "xyz", - "businessApplicationId": "string" + "totalFee": { + "type": "string", + "example": "0.429", + "description": "Total Fee" }, - "processorInformation": { - "processor": { - "name": "FirstData" - } + "feeCurrency": { + "type": "string", + "example": "1", + "description": "Fee Currency" }, - "pointOfSaleInformation": { - "terminalId": "1", - "terminalSerialNumber": "123111123", - "deviceId": "asfaf12312313", - "partner": { - "originalTransactionId": "131231414414" - } + "duesAssessments": { + "type": "string", + "example": "0", + "description": "Dues Assessments" }, - "riskInformation": { - "providers": { - "fingerprint": { - "true_ipaddress": "1.101.102.112", - "hash": "tuWmt8Ubw0EAybBF3wrZcEqIcZsLr8YPldTQDUxAg2k=", - "smart_id": "23442fdadfa" - } - } + "fundingAmount": { + "type": "string", + "example": "2.50", + "description": "Funding Amount" }, - "_links": { - "transactionDetail": { - "href": "https://sl73paysvapq002.visa.com:2031/payment/tss/v2/transactions/5217848115816817001541", - "method": "GET" - } + "fundingCurrency": { + "type": "string", + "example": "USD", + "description": "Funding Currency (ISO 4217)" } - } - ] - }, - "_links": { - "self": { - "href": "https://sl73paysvapq002.visa.com:2031/payment/tss/v2/searches/87e1e4bd-cac2-49b1-919a-4d5e29a2e55d", - "method": "GET" + }, + "description": "Fee Funding Section" } - } - } - } - }, - "404": { - "description": "The specified resource not found in the system." - }, - "500": { - "description": "Unexpected server error." - } - } - } - }, - "/ums/v1/users": { - "get": { - "summary": "Get user based on organization Id, username, permission and role", - "description": "This endpoint is to get all the user information depending on the filter criteria passed in the query.", - "tags": [ - "UserManagement" - ], - "operationId": "getUsers", - "parameters": [{ - "in": "query", - "name": "organizationId", - "type": "string", - "description": "This is the orgId of the organization which the user belongs to." - }, { - "in": "query", - "name": "userName", - "type": "string", - "description": "User ID of the user you want to get details on." - }, { - "in": "query", - "name": "permissionId", - "type": "string", - "description": "permission that you are trying to search user on." - }, { - "in": "query", - "name": "roleId", - "type": "string", - "description": "role of the user you are trying to search on." - } - ], - "x-example": { - "example0": { - "summary": "User Management", - "value": {} - } - }, - "responses": { - "200": { - "description": "OK", - "schema": { - "type": "object", - "title": "umsV1UsersGet200Response", - "properties": { - "users": { + }, + "others": { "type": "array", + "description": "List of Other Info values", "items": { "type": "object", "properties": { - "accountInformation": { - "type": "object", - "properties": { - "userName": { - "type": "string" - }, - "roleId": { - "type": "string" - }, - "permissions": { - "type": "array", - "items": { - "type": "string", - "description": "array of permissions" - } - }, - "status": { - "type": "string", - "enum": [ - "active", - "inactive", - "locked", - "disabled", - "forgotpassword", - "deleted" - ] - }, - "createdTime": { - "type": "string", - "format": "date-time" - }, - "lastAccessTime": { - "type": "string", - "format": "date-time" - }, - "languagePreference": { - "type": "string" - }, - "timezone": { - "type": "string" - } - } + "requestId": { + "type": "string", + "maxLength": 26, + "example": "12345678901234567890123456", + "description": "An unique identification number assigned by CyberSource to identify the submitted request." }, - "organizationInformation": { - "type": "object", - "properties": { - "organizationId": { - "type": "string" - } - } + "merchantData1": { + "type": "string", + "example": "Merchant Defined Data", + "description": "Merchant Defined Data" }, - "contactInformation": { - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "phoneNumber": { - "type": "string" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - } - } + "merchantData2": { + "type": "string", + "example": "Merchant Defined Data", + "description": "Merchant Defined Data" + }, + "merchantData3": { + "type": "string", + "example": "Merchant Defined Data", + "description": "Merchant Defined Data" + }, + "merchantData4": { + "type": "string", + "example": "Merchant Defined Data", + "description": "Merchant Defined Data" + }, + "firstName": { + "type": "string", + "example": "First Name", + "description": "First Name" + }, + "lastName": { + "type": "string", + "example": "Last Name", + "description": "Last Name" } - } - } - } - }, - "example": { - "users": [{ - "accountInformation": { - "userName": "auto_nonmember", - "roleId": "admin", - "permissions": [ - "ReportViewPermission", - "ReportGeneratePermission" - ], - "status": "active", - "createdTime": "2018-06-14T19:45:52.093Z", - "lastAccessTime": "2018-06-14T19:45:52.093Z", - "languagePreference": "en-US", - "timezone": "America/Los_Angeles" - }, - "organizationInformation": { - "organizationId": "auto_nonmember" }, - "contactInformation": { - "email": "auto_nonmember@exchange.com", - "phoneNumber": "4445551234", - "firstName": "Zeta", - "lastName": "DMH" - } + "description": "Other Merchant Details Values." } - ] - } - } - }, - "400": { - "description": "Invalid request.", - "schema": { - "type": "object", - "title": "umsV1UsersGet400Response", - "properties": { - "submitTimeUtc": { - "type": "string", - "description": "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ`\n\nExample 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the\ntime. The Z indicates UTC.\n" - }, - "status": { - "type": "string", - "description": "The status of the submitted transaction.", - "enum": [ - "INVALID_REQUEST" - ] - }, - "reason": { - "type": "string", - "description": "The reason of the status.\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA", - "DUPLICATE_REQUEST", - "INVALID_CARD", - "INVALID_MERCHANT_CONFIGURATION", - "CAPTURE_ALREADY_VOIDED", - "ACCOUNT_NOT_ALLOWED_CREDIT" - ] - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." }, - "details": { + "settlementStatuses": { "type": "array", + "description": "List of Settlement Status Info values", "items": { "type": "object", "properties": { - "field": { + "requestId": { + "type": "string", + "maxLength": 26, + "example": "12345678901234567890123456", + "description": "An unique identification number assigned by CyberSource to identify the submitted request." + }, + "status": { + "type": "string", + "example": "Settlement Status", + "description": "Settlement Status" + }, + "settlementTime": { + "type": "string", + "example": "2017-10-01T10:10:10+05:00", + "format": "date-time", + "description": "Settlement Date" + }, + "reasonCode": { + "example": "reasonCode", "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." + "description": "ReasonCode" }, - "reason": { + "errorText": { + "example": "errorText", "type": "string", - "description": "Possible reasons for the error.\n", - "enum": [ - "MISSING_FIELD", - "INVALID_DATA" - ] + "description": "errorText" } - } - } - } - } - } - }, - "500": { - "description": "Unexpected server error." - } - } - } - } - }, - "definitions": { - "TokenizeResult": { - "properties": { - "keyId": { - "type": "string", - "description": "The Key ID." - }, - "token": { - "type": "string", - "description": "The generated token. The token replaces card data and is used as the Subscription ID in the CyberSource Simple Order API or SCMP API." - }, - "maskedPan": { - "type": "string", - "description": "The masked card number displaying the first 6 digits and the last 4 digits." - }, - "cardType": { - "type": "string", - "description": "The card type." - }, - "timestamp": { - "type": "integer", - "format": "int64", - "description": "The UTC date and time in milliseconds at which the signature was generated." - }, - "signedFields": { - "type": "string", - "description": "Indicates which fields from the response make up the data that is used when verifying the response signature. See the [sample code] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/java/com/cybersource/flex/application/CheckoutController.java) on how to verify the signature." - }, - "signature": { - "type": "string", - "description": "Flex-generated digital signature. To ensure the values have not been tampered with while passing through the client, verify this server-side using the public key generated from the /keys resource." - }, - "discoverableServices": { - "type": "object", - "additionalProperties": { - "type": "object" - } - } - } - }, - "TokenizeParameters": { - "type": "object", - "properties": { - "keyId": { - "type": "string", - "description": "Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key." - }, - "cardInfo": { - "type": "object", - "properties": { - "cardNumber": { - "type": "string", - "description": "Encrypted or plain text card number. If the encryption type of \u201cNone\u201d was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders\u2019 device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request." - }, - "cardExpirationMonth": { - "type": "string", - "description": "Two digit expiration month" - }, - "cardExpirationYear": { - "type": "string", - "description": "Four digit expiration year" - }, - "cardType": { - "type": "string", - "description": "Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types." - } - } - } - } - }, - "KeyParameters": { - "type": "object", - "properties": { - "encryptionType": { - "type": "string", - "description": "How the card number should be encrypted in the subsequent Tokenize Card request. Possible values are RsaOaep256 or None (if using this value the card number must be in plain text when included in the Tokenize Card request). The Tokenize Card request uses a secure connection (TLS 1.2+) regardless of what encryption type is specified." - } - } - }, - "JsonWebKey": { - "type": "object", - "description": "The public key in JSON Web Key (JWK) format. This format is useful for client side encryption in JavaScript based implementations.", - "properties": { - "kty": { - "type": "string", - "description": "Algorithm used to encrypt the public key." - }, - "use": { - "type": "string", - "description": "Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc." - }, - "kid": { - "type": "string", - "description": "The key ID in JWK format." - }, - "n": { - "type": "string", - "description": "JWK RSA Modulus" - }, - "e": { - "type": "string", - "description": "JWK RSA Exponent" - } - } - }, - "DerPublicKey": { - "type": "object", - "description": "The public key in DER format. Used to validate the response from the Tokenize Card request. Additionally this format is useful for client side encryption in Android and iOS implementations.", - "properties": { - "format": { - "type": "string", - "description": "Specifies the format of the public key; currently X.509." - }, - "algorithm": { - "type": "string", - "description": "Algorithm used to encrypt the public key." - }, - "publicKey": { - "type": "string", - "description": "Base64 encoded public key value." - } - } - }, - "KeyResult": { - "properties": { - "keyId": { - "type": "string", - "description": "Unique identifier for the generated token. Used in the subsequent Tokenize Card request from your customer\u2019s device or browser." - }, - "der": { - "type": "object", - "description": "The public key in DER format. Used to validate the response from the Tokenize Card request. Additionally this format is useful for client side encryption in Android and iOS implementations.", - "properties": { - "format": { - "type": "string", - "description": "Specifies the format of the public key; currently X.509." - }, - "algorithm": { - "type": "string", - "description": "Algorithm used to encrypt the public key." - }, - "publicKey": { - "type": "string", - "description": "Base64 encoded public key value." - } - } - }, - "jwk": { - "type": "object", - "description": "The public key in JSON Web Key (JWK) format. This format is useful for client side encryption in JavaScript based implementations.", - "properties": { - "kty": { - "type": "string", - "description": "Algorithm used to encrypt the public key." - }, - "use": { - "type": "string", - "description": "Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc." - }, - "kid": { - "type": "string", - "description": "The key ID in JWK format." - }, - "n": { - "type": "string", - "description": "JWK RSA Modulus" - }, - "e": { - "type": "string", - "description": "JWK RSA Exponent" - } - } - } - } - }, - "CardInfo": { - "type": "object", - "properties": { - "cardNumber": { - "type": "string", - "description": "Encrypted or plain text card number. If the encryption type of \u201cNone\u201d was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders\u2019 device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request." - }, - "cardExpirationMonth": { - "type": "string", - "description": "Two digit expiration month" - }, - "cardExpirationYear": { - "type": "string", - "description": "Four digit expiration year" - }, - "cardType": { - "type": "string", - "description": "Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types." - } - } - }, - "Error": { - "properties": { - "responseStatus": { - "properties": { - "status": { - "type": "number", - "description": "HTTP Status code." - }, - "reason": { - "type": "string", - "description": "Error Reason Code." - }, - "message": { - "type": "string", - "description": "Error Message." - }, - "correlationId": { - "type": "string", - "description": "API correlation ID." - }, - "details": { - "type": "array", - "items": { - "properties": { - "location": { - "type": "string", - "description": "Field name referred to for validation issues." - }, - "message": { - "type": "string", - "description": "Description or code of any error response." - } - } - } - } - } - }, - "_links": { - "properties": { - "self": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - }, - "documentation": { - "type": "array", - "items": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - }, - "next": { - "type": "array", - "items": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - } - } - } - } - }, - "Link": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - }, - "Links": { - "properties": { - "self": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - }, - "documentation": { - "type": "array", - "items": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - }, - "next": { - "type": "array", - "items": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - } - } - }, - "ResponseStatus": { - "properties": { - "status": { - "type": "number", - "description": "HTTP Status code." - }, - "reason": { - "type": "string", - "description": "Error Reason Code." - }, - "message": { - "type": "string", - "description": "Error Message." - }, - "correlationId": { - "type": "string", - "description": "API correlation ID." - }, - "details": { - "type": "array", - "items": { - "properties": { - "location": { - "type": "string", - "description": "Field name referred to for validation issues." - }, - "message": { - "type": "string", - "description": "Description or code of any error response." - } - } - } - } - } - }, - "ResponseStatusDetails": { - "properties": { - "location": { - "type": "string", - "description": "Field name referred to for validation issues." - }, - "message": { - "type": "string", - "description": "Description or code of any error response." - } - } - }, - "ErrorResponse": { - "type": "object", - "properties": { - "responseStatus": { - "properties": { - "status": { - "type": "number", - "description": "HTTP Status code." - }, - "reason": { - "type": "string", - "description": "Error Reason Code." - }, - "message": { - "type": "string", - "description": "Error Message." - }, - "correlationId": { - "type": "string", - "description": "API correlation ID." - }, - "details": { - "type": "array", - "items": { - "properties": { - "location": { - "type": "string", - "description": "Field name referred to for validation issues." - }, - "message": { - "type": "string", - "description": "Description or code of any error response." - } - } - } - } - } - }, - "_links": { - "type": "object", - "properties": { - "next": { - "type": "array", - "items": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - }, - "documentation": { - "type": "array", - "items": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." + }, + "description": "Settlement Status Section Values." } } } - }, - "self": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - } - } - } - }, - "ErrorLinks": { - "type": "object", - "properties": { - "next": { - "type": "array", - "items": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - }, - "documentation": { - "type": "array", - "items": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - }, - "self": { - "properties": { - "href": { - "type": "string", - "description": "URI of the linked resource." - }, - "title": { - "type": "string", - "description": "Label of the linked resource." - }, - "method": { - "type": "string", - "description": "HTTP method of the linked resource." - } - } - } - } - } - } -} + } + }, + "400": { + "description": "Invalid request", + "schema": { + "title": "reportingV3PurchaseRefundDetailsGet400Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "title": "reportingV3PurchaseRefundDetailsGet401Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "404": { + "description": "Report not found", + "schema": { + "title": "reportingV3PurchaseRefundDetailsGet404Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "title": "reportingV3PurchaseRefundDetailsGet500Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + }, + "examples": { + "application/json": { + "code": "SERVER_ERROR", + "correlationId": null, + "detail": "Internal Server Error. Please contact the customer support.", + "localizationKey": "cybsapi.server.error", + "message": "Error encountered while processing request" + } + } + } + } + } + }, + "/reporting/v3/payment-batch-summaries": { + "get": { + "tags": [ + "PaymentBatchSummaries" + ], + "summary": "Get payment batch summary data", + "description": "Scope can be either account/merchant or reseller.", + "operationId": "getPaymentBatchSummary", + "x-devcenter-metaData": { + "categoryTag": "Reporting", + "isClientSideApi": true + }, + "x-queryParameterDefaults": { + "organizationId": "testrest", + "startTime": "2018-05-01T12:00:00-05:00", + "endTime": "2018-05-30T12:00:00-05:00" + }, + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "startTime", + "in": "query", + "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "organizationId", + "in": "query", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 32 + }, + { + "name": "rollUp", + "in": "query", + "description": "Conditional - RollUp for data for DAY/WEEK/MONTH. Required while getting breakdown data for a Merchant", + "required": false, + "type": "string", + "enum": [ + "day", + "week", + "month" + ] + }, + { + "name": "breakdown", + "in": "query", + "description": "Conditional - Breakdown on account_rollup/allMerchants/selectedMerchant. Required while getting breakdown data for a Merchant.", + "required": false, + "type": "string", + "enum": [ + "account_rollup", + "all_merchant", + "selected_merchant" + ] + }, + { + "name": "startDayOfWeek", + "in": "query", + "description": "Optional - Start day of week to breakdown data for weeks in a month", + "required": false, + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 7 + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "type": "object", + "properties": { + "startTime": { + "type": "string", + "format": "date-time" + }, + "endTime": { + "type": "string", + "format": "date-time" + }, + "paymentBatchSummaries": { + "type": "array", + "items": { + "type": "object", + "properties": { + "currencyCode": { + "type": "string", + "example": "USD" + }, + "paymentSubTypeDescription": { + "type": "string", + "example": "Diners Club" + }, + "startTime": { + "type": "string", + "format": "date-time" + }, + "endTime": { + "type": "string", + "format": "date-time" + }, + "salesCount": { + "type": "integer", + "example": 10, + "format": "int32" + }, + "salesAmount": { + "type": "string", + "example": "5000.01" + }, + "creditCount": { + "type": "integer", + "example": 10, + "format": "int32" + }, + "creditAmount": { + "type": "string", + "example": "5000.01" + }, + "accountName": { + "type": "string", + "example": "ubmerchant296" + }, + "accountId": { + "type": "string", + "example": "ubmerchant296_acct" + }, + "merchantId": { + "type": "string", + "example": "ubmerchant296_3" + }, + "merchantName": { + "type": "string", + "example": "ubmerchant296_3" + } + } + } + } + } + } + }, + "400": { + "description": "Invalid request", + "schema": { + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "404": { + "description": "Payment Batch Summary not found" + } + } + } + }, + "/reporting/v3/conversion-details": { + "get": { + "tags": [ + "ConversionDetails" + ], + "summary": "Get conversion detail transactions", + "description": "Get conversion detail of transactions for a merchant.", + "operationId": "getConversionDetail", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "x-queryParameterDefaults": { + "startTime": "2019-03-21T00:00:00.0Z", + "endTime": "2019-03-21T23:00:00.0Z", + "organizationId": "testrest" + }, + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "startTime", + "in": "query", + "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "organizationId", + "in": "query", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 32 + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "title": "reportingV3ConversionDetailsGet200Response", + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Merchant Id", + "example": "testMerchantId" + }, + "startTime": { + "type": "string", + "format": "date-time", + "example": "2017-10-01T10:10:10+05:00" + }, + "endTime": { + "type": "string", + "format": "date-time", + "example": "2017-10-01T10:10:10+05:00" + }, + "conversionDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "merchantReferenceNumber": { + "type": "string", + "description": "Merchant reference number of a merchant", + "example": "1234567890" + }, + "conversionTime": { + "type": "string", + "format": "date-time", + "description": "Date of conversion", + "example": "2017-10-01T10:10:10+05:00" + }, + "requestId": { + "type": "string", + "description": "Cybersource Transation request id", + "example": "1234567890123456789012" + }, + "originalDecision": { + "type": "string", + "description": "Original decision", + "example": "REVIEW" + }, + "newDecision": { + "type": "string", + "description": "New decision", + "example": "ACCEPT" + }, + "reviewer": { + "type": "string", + "description": "User name of the reviewer", + "example": "testuserId" + }, + "reviewerComments": { + "type": "string", + "description": "Comments of the reviewer", + "example": "Verified order." + }, + "queue": { + "type": "string", + "description": "Name of the queue", + "example": "Review Queue" + }, + "profile": { + "type": "string", + "description": "Name of the profile", + "example": "Test Profile" + }, + "notes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "time": { + "type": "string", + "format": "date-time", + "description": "Time of the note added by reviewer", + "example": "2017-10-01T10:10:10+05:00" + }, + "addedBy": { + "type": "string", + "description": "Note added by reviewer", + "example": "testuserId" + }, + "comments": { + "type": "string", + "description": "Comments given by the reviewer", + "example": "Verified the order and accepted." + } + }, + "xml": { + "name": "note" + } + } + } + }, + "xml": { + "name": "conversionDataPoint" + } + } + } + }, + "xml": { + "name": "conversionDetailResponse" + } + } + }, + "400": { + "description": "Invalid request", + "schema": { + "title": "reportingV3ConversionDetailsGet400Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "404": { + "description": "Conversion detail not found", + "schema": { + "title": "reportingV3ConversionDetailsGet404Response" + } + } + } + } + }, + "/reporting/v3/net-fundings": { + "get": { + "tags": [ + "NetFundings" + ], + "summary": "Get Netfunding information for an account or a merchant", + "description": "Get Netfunding information for an account or a merchant.", + "operationId": "getNetFundingDetails", + "x-devcenter-metaData": { + "categoryTag": "Reporting" + }, + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "startTime", + "in": "query", + "description": "Valid report Start Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "endTime", + "in": "query", + "description": "Valid report End Time in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)\n", + "required": true, + "type": "string", + "format": "date-time" + }, + { + "name": "organizationId", + "in": "query", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 32 + }, + { + "name": "groupName", + "in": "query", + "description": "Valid CyberSource Group Name.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "title": "reportingV3NetFundingsGet200Response", + "type": "object", + "properties": { + "startTime": { + "type": "string", + "description": "Valid report Start Date in **ISO 8601 format**.\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n**Example:**\n- yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n", + "example": "2017-10-01T10:10:10+05:00", + "format": "date-time", + "xml": { + "attribute": true + } + }, + "endTime": { + "type": "string", + "description": "Valid report End Date in **ISO 8601 format**\n**Example date format:**\n- yyyy-MM-dd'T'HH:mm:ss.SSSZZ\n", + "example": "2018-04-12T23:20:50.52Z", + "format": "date-time", + "xml": { + "attribute": true + } + }, + "netFundingSummaries": { + "type": "array", + "description": "List of Netfunding summary objects", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "PURCHASES", + "REFUNDS", + "FEES", + "CHARGEBACKS" + ], + "example": "PURCHASES" + }, + "paymentSubType": { + "type": "string", + "example": "VI" + }, + "conveyedCount": { + "type": "integer", + "example": 10 + }, + "conveyedAmount": { + "type": "string", + "example": "100.50" + }, + "settledCount": { + "type": "integer", + "example": 10 + }, + "fundedCount": { + "type": "integer", + "example": 10 + }, + "fundedAmount": { + "type": "string", + "example": "150.50" + }, + "currencyCode": { + "type": "string", + "description": "Valid ISO 4217 ALPHA-3 currency code", + "example": "USD" + } + }, + "xml": { + "name": "NetFundingSummary" + } + }, + "xml": { + "name": "NetFundingSummaries", + "wrapped": true + } + }, + "totalPurchases": { + "type": "array", + "description": "List of total purchases currency wise", + "items": { + "type": "object", + "required": [ + "currency", + "value" + ], + "properties": { + "currency": { + "type": "string", + "description": "Valid ISO 4217 ALPHA-3 currency code", + "example": "USD" + }, + "value": { + "type": "string", + "example": "10.01" + } + }, + "xml": { + "name": "Amount" + } + }, + "xml": { + "name": "totalPurchases", + "wrapped": true + } + }, + "totalRefunds": { + "type": "array", + "description": "List of total refunds currency wise", + "items": { + "type": "object", + "required": [ + "currency", + "value" + ], + "properties": { + "currency": { + "type": "string", + "description": "Valid ISO 4217 ALPHA-3 currency code", + "example": "USD" + }, + "value": { + "type": "string", + "example": "10.01" + } + }, + "xml": { + "name": "Amount" + } + }, + "xml": { + "name": "totalRefunds", + "wrapped": true + } + }, + "totalFees": { + "type": "array", + "description": "List of total fees currency wise", + "items": { + "type": "object", + "required": [ + "currency", + "value" + ], + "properties": { + "currency": { + "type": "string", + "description": "Valid ISO 4217 ALPHA-3 currency code", + "example": "USD" + }, + "value": { + "type": "string", + "example": "10.01" + } + }, + "xml": { + "name": "Amount" + } + }, + "xml": { + "name": "totalFees", + "wrapped": true + } + }, + "totalChargebacks": { + "type": "array", + "description": "List of total chargebacks currency wise", + "items": { + "type": "object", + "required": [ + "currency", + "value" + ], + "properties": { + "currency": { + "type": "string", + "description": "Valid ISO 4217 ALPHA-3 currency code", + "example": "USD" + }, + "value": { + "type": "string", + "example": "10.01" + } + }, + "xml": { + "name": "Amount" + } + }, + "xml": { + "name": "totalChargebacks", + "wrapped": true + } + }, + "netTotal": { + "type": "array", + "description": "List of new total currency wise", + "items": { + "type": "object", + "required": [ + "currency", + "value" + ], + "properties": { + "currency": { + "type": "string", + "description": "Valid ISO 4217 ALPHA-3 currency code", + "example": "USD" + }, + "value": { + "type": "string", + "example": "10.01" + } + }, + "xml": { + "name": "Amount" + } + }, + "xml": { + "name": "netTotal", + "wrapped": true + } + } + } + } + }, + "400": { + "description": "Invalid request", + "schema": { + "title": "reportingV3NetFundingsGet400Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "title": "reportingV3NetFundingsGet401Response" + } + }, + "403": { + "description": "Forbidden", + "schema": { + "title": "reportingV3NetFundingsGet403Response" + } + }, + "404": { + "description": "Report not found", + "schema": { + "title": "reportingV3NetFundingsGet404Response" + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "title": "reportingV3NetFundingsGet500Response", + "type": "object", + "required": [ + "submitTimeUtc", + "reason", + "message", + "details" + ], + "properties": { + "submitTimeUtc": { + "type": "string", + "format": "date-time", + "description": "Time of request in UTC. \n", + "example": "2016-08-11T22:47:57Z" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n", + "example": "INVALID_DATA" + }, + "message": { + "type": "string", + "description": "Short descriptive message to the user.\n", + "example": "One or more fields contains invalid data" + }, + "details": { + "type": "array", + "description": "Error field list\n", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "Field in request that caused an error\n" + }, + "reason": { + "type": "string", + "description": "Documented reason code\n" + } + }, + "description": "Provides failed validation input field detail\n" + } + } + }, + "description": "HTTP status code for client application" + }, + "examples": { + "application/json": { + "code": "SERVER_ERROR", + "correlationId": null, + "detail": null, + "fields": [], + "localizationKey": "cybsapi.server.error", + "message": "Error encountered while processing request" + } + } + } + } + } + }, + "/reporting/v3/dtds/{reportDefinitionNameVersion}": { + "get": { + "tags": [ + "DownloadDTD" + ], + "summary": "Used to download DTDs for reports.", + "description": "Downloads DTDs for reports on no-auth.", + "operationId": "getDTDV2", + "x-devcenter-metaData": { + "categoryTag": "Reporting", + "isClientSideApi": true + }, + "produces": [ + "application/xml-dtd" + ], + "parameters": [ + { + "name": "reportDefinitionNameVersion", + "in": "path", + "description": "Name and version of DTD file to download. Some DTDs only have one version. In that case version name is not needed. Some example values are ctdr-1.0, tdr, pbdr-1.1", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "400": { + "description": "Bad request. DTD file name may be invalid" + }, + "404": { + "description": "DTD file not found" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/reporting/v3/xsds/{reportDefinitionNameVersion}": { + "get": { + "tags": [ + "DownloadXSD" + ], + "summary": "Used to download XSDs for reports.", + "description": "Downloads XSDs for reports on no-auth.", + "operationId": "getXSDV2", + "x-devcenter-metaData": { + "categoryTag": "Reporting", + "isClientSideApi": true + }, + "produces": [ + "text/xml" + ], + "parameters": [ + { + "name": "reportDefinitionNameVersion", + "in": "path", + "description": "Name and version of XSD file to download. Some XSDs only have one version. In that case version name is not needed. Some example values are DecisionManagerDetailReport, DecisionManagerTypes", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "400": { + "description": "Bad request. XSD file name may be invalid" + }, + "404": { + "description": "XSD file not found" + }, + "500": { + "description": "Internal Server Error" + } + } + } + }, + "/risk/v1/decisions": { + "post": { + "summary": "Create Decision Manager case", + "description": "This is the combined request to the Decision Manager Service for a transaction sent to Cybersource.\nDecision Manager will return a decision based on the request values.\n", + "operationId": "createDecisionManagerCase", + "tags": [ + "decision manager" + ], + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/hal+json;charset=utf-8" + ], + "x-devcenter-metaData": { + "categoryTag": "Decision_Manager" + }, + "parameters": [ + { + "name": "createDecisionManagerCaseRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "required": [ + "orderInformation", + "clientReferenceInformation" + ], + "properties": { + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "comments": { + "type": "string", + "maxLength": 255, + "description": "Brief description of the order or any comment you wish to add to the order." + } + } + }, + "processorInformation": { + "type": "object", + "description": "Contains information related to the payment processor.", + "properties": { + "avs": { + "type": "object", + "description": "Address Verification Service", + "properties": { + "code": { + "type": "string", + "maxLength": 3, + "description": "Value returned for address verification from the Payments Authorization response." + } + } + } + } + }, + "paymentInformation": { + "type": "object", + "description": "Contains the payment data for this transaction.", + "properties": { + "card": { + "type": "object", + "description": "Use this for a non-tokenized payment card.", + "properties": { + "number": { + "type": "string", + "maxLength": 20, + "description": "The customer\u2019s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field\nfor encoded account numbers.\n\nFor processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "type": { + "type": "string", + "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n" + }, + "bin": { + "type": "string", + "maxLength": 6, + "description": "description: The BIN is the first six digits of the card's Primary Account Number (PAN).\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\nFor processor-specific information, see the `customer_cc_expmo` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`.\n\nFor processor-specific information, see the `customer_cc_expyr` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + }, + "tokenizedCard": { + "type": "object", + "description": "Use this object to submit a payment network token instead of card-based values.", + "properties": { + "type": { + "type": "string", + "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n" + }, + "number": { + "type": "string", + "maxLength": 20, + "description": "Customer\u2019s payment network token value.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use 12.\n\nFor processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the payment network token expires. `Format: YYYY`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021.\n\nFor processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + } + } + }, + "orderInformation": { + "type": "object", + "description": "Contains detailed order-level information.", + "properties": { + "amountDetails": { + "type": "object", + "description": "Contains `currency` and `totalAmount` for this order.", + "required": [ + "currency" + ], + "properties": { + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + }, + "totalAmount": { + "type": "string", + "maxLength": 19, + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" + } + } + }, + "shippingDetails": { + "type": "object", + "description": "Contains shipping information not related to address.", + "properties": { + "giftWrap": { + "type": "string", + "maxLength": 3, + "description": "Boolean that indicates whether the customer requested gift wrapping for this\npurchase. This field can contain one of the following\nvalues:\n\n- `yes`: The customer requested gift wrapping.\n- `no`: The customer did not request gift wrapping.\n" + }, + "shippingMethod": { + "type": "string", + "maxLength": 10, + "description": "Shipping method for the product. Possible values:\n\n - `lowcost`: Lowest-cost service\n - `sameday`: Courier or same-day service\n - `oneday`: Next-day or overnight service\n - `twoday`: Two-day service\n - `threeday`: Three-day service\n - `pickup`: Store pick-up\n - `other`: Other shipping method\n - `none`: No shipping method because product is a service or subscription\n" + } + } + }, + "shipTo": { + "type": "object", + "description": "Contains recipient shipping information.", + "properties": { + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the shipping address." + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Second line of the shipping address." + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n" + }, + "country": { + "type": "string", + "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.", + "maxLength": 2 + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the shipping address." + }, + "firstName": { + "type": "string", + "maxLength": 60, + "description": "First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Last name of the recipient.\n\n**Processor-specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Phone number associated with the shipping address." + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" + } + } + }, + "returnsAccepted": { + "type": "string", + "maxLength": 3, + "description": "Boolean that indicates whether returns are accepted for this order.\nThis field can contain one of the following values:\n- `yes`: Returns are accepted for this order.\n- `no`: Returns are not accepted for this order.\n" + }, + "lineItems": { + "type": "array", + "description": "This array contains detailed information about individual products in the order.", + "items": { + "type": "object", + "properties": { + "unitPrice": { + "type": "string", + "maxLength": 15, + "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n- Table 12, \"Authorization Information for Specific Processors,\" on page 36\n- Table 16, \"Capture Information for Specific Processors,\" on page 51\n- Table 20, \"Credit Information for Specific Processors,\" on page 65\n\n**DCC for First Data**\\\nThis value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36.\n\n**Zero Amount Authorizations**\\\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220.\n" + }, + "quantity": { + "type": "number", + "minimum": 1, + "maximum": 9999999999, + "description": "Number of units for this order.\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling.\nWhen `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased.\n", + "default": 1 + }, + "productSKU": { + "type": "string", + "maxLength": 255, + "description": "Stock Keeping Unit (SKU) code for the product.\n\nFor an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling.\n" + }, + "productRisk": { + "type": "string", + "maxLength": 6, + "description": "Indicates the level of risk for the product. This field can contain one of the following values:\n- `low`: The product is associated with few chargebacks.\n- `normal`: The product is associated with a normal number of chargebacks.\n- `high`: The product is associated with many chargebacks.\n" + }, + "productName": { + "type": "string", + "maxLength": 255, + "description": "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`),\nthis field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of\nthe other values that are related to shipping and/or handling.\n" + }, + "productCode": { + "type": "string", + "maxLength": 255, + "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\nIf you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to\nshipping and handling, then the fields `quantity`, `productName`, and `productSku` are required.\nIt can also have a value of \"gift_card\".\n\nSee Appendix O, \"Product Codes,\" on page 373 for a list of valid values.\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n" + }, + "gift": { + "type": "string", + "maxLength": 3, + "description": "Determines whether to assign risk to the order if the billing and shipping addresses specify different cities,\nstates, or countries. This field can contain one of the following values:\n- `yes`: Orders are assigned only slight additional risk if billing and shipping addresses are different.\n- `no` (default): Orders are assigned higher additional risk if billing and shipping addresses are different.\n- `off`: Differences between billing and shipping addresses do not affect the score.\n", + "default": "no" + }, + "distributorProductSku": { + "type": "string", + "maxLength": 15, + "description": "Product\u2019s identifier code. This field is inserted into the outgoing message without being parsed or formatted.\nThis field is included as Distributor product SKU (Offer) in the list of API fields with which you can create\ncustom rules.\n" + }, + "passenger": { + "type": "object", + "description": "Contains travel-related passenger details.", + "properties": { + "type": { + "type": "string", + "maxLength": 32, + "description": "Passenger classification associated with the price of the ticket. You can use one of the following values:\n- `ADT`: Adult\n- `CNN`: Child\n- `INF`: Infant\n- `YTH`: Youth\n- `STU`: Student\n- `SCR`: Senior Citizen\n- `MIL`: Military\n" + }, + "status": { + "type": "string", + "maxLength": 32, + "description": "Your company's passenger classification, such as with a frequent flyer program. In this case, you might use\nvalues such as `standard`, `gold`, or `platinum`.\n" + }, + "phone": { + "type": "string", + "maxLength": 15, + "description": "Passenger's phone number. If the order is from outside the U.S., CyberSource recommends that you include\nthe country code.\n" + }, + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Passenger's first name." + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Passenger's last name." + }, + "id": { + "type": "string", + "maxLength": 40, + "description": "ID of the passenger to whom the ticket was issued. For example, you can use this field for the frequent flyer\nnumber.\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Passenger's email address, including the full domain name, such as jdoe@example.com." + } + } + } + } + } + }, + "billTo": { + "type": "object", + "properties": { + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "description": "Contains information about the buyer.", + "properties": { + "hashedPassword": { + "type": "string", + "maxLength": 100, + "description": "The description for this field is not available.\n" + }, + "dateOfBirth": { + "type": "string", + "maxLength": 8, + "description": "Recipient\u2019s date of birth. **Format**: `YYYYMMDD`.\n\nThis field is a pass-through, which means that CyberSource ensures that the value is eight numeric characters\nbut otherwise does not verify the value or modify it in any way before sending it to the processor. If the field\nis not required for the transaction, CyberSource does not forward it to the processor.\n\nFor more details, see \"Recipients,\" page 224.\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of the identification.\n\nPossible values:\n - `NATIONAL`\n - `CPF`\n - `CPNJ`\n - `CURP`\n - `SSN`\n - `DRIVER_LICENSE`\n\nThis field is supported only on the following processors.\n\n**ComercioLatino**\\\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n**CyberSource Latin American Processing**\\\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n", + "enum": [ + "NATIONAL", + "CPF", + "CPNJ", + "CURP", + "SSN", + "DRIVER_LICENSE" + ] + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "The value of the identification type. This field is supported only on the following processors.\n\n**ComercioLatino**\nSet this field to the Cadastro de Pessoas Fisicas (CPF).\n\n**CyberSource Latin American Processing**\nSupported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil.\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\nFor processor-specific information, see the personal_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n \nIf type = PASSPORT, this is the cardholder's passport number.\nRecommended for Discover ProtectBuy.\n" + }, + "issuedBy": { + "type": "string", + "description": "If type = DRIVER_LICENSE, this is the State or province where the customer\u2019s driver\u2019s license was issued.\nUse the two-character State, Province, and Territory Codes for the United States and Canada.\n\n** TeleCheck **\nContact your TeleCheck representative to find out whether this field is required or optional.\n\n** All Other Processors **\nNot used.\n\nIf type = PASSPORT, this is the Issuing country for the cardholder\u2019s passport.\nRecommended for Discover ProtectBuy.\n" + } + } + } + } + } + }, + "deviceInformation": { + "type": "object", + "properties": { + "cookiesAccepted": { + "type": "string", + "description": "Boolean that indicates whether the customer\u2019s browser accepts cookies. This field can contain one of the following values:\n - `yes`: The customer\u2019s browser accepts cookies.\n - `no`: The customer\u2019s browser does not accept cookies.\n" + }, + "ipAddress": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n" + }, + "hostName": { + "type": "string", + "maxLength": 60, + "description": "Host name reported by the customer\u2019s browser to your Web server identified via the HTTP header." + }, + "fingerprintSessionId": { + "type": "string", + "description": "Contains the session ID that you send to Decision Manager to obtain the device fingerprint\ninformation. The string can contain uppercase and lowercase letters, digits, hyphen (-), and\nunderscore (_). However, do not use the same uppercase and lowercase letters to indicate different session IDs.\nThe session ID must be unique for each merchant ID. You can use any string that you are already generating,\nsuch as an order number or web session ID.The session ID must be unique for each page load, regardless of an\nindividual\u2019s web session ID.\nIf the same user navigates to a profiled page and is assigned a web session, navigates away from the profiled\npage, then navigates back to the profiled page, the generated session ID should be different and unique.\nAn example of an ideal session ID would be a web session ID plus the timestamp. This measure ensures that a\nunique ID is generated every time the page is loaded, even if it is the same user reloading the page.\n" + }, + "httpBrowserEmail": { + "type": "string", + "description": "Email address set in the customer\u2019s browser, which may differ from customer email.\n" + }, + "userAgent": { + "type": "string", + "maxLength": 40, + "description": "Customer\u2019s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies\nthe Netscape browser.\n" + } + } + }, + "cardVerification": { + "type": "object", + "properties": { + "resultCode": { + "type": "string", + "maxLength": 1, + "description": "Result of card verification. Returned by the authorization service in the `processorInformation.cardVerification.resultCode`\nreply field. If ics_auth and ics_score are requested at the same time, the value is automatically\npassed from ics_auth to ics_score. For more information on using this field, see\n\"\"Sending the Results of Address and Card Verification Tests,\"\" page 16.\nThe field contains one of the following values:\n - `I`: Card verification number failed processor's data\n validation check.\n - `M`: Card verification number matched.\n - `N`: Card verification number not matched.\n - `P`: Card verification number not processed.\n - `S`: Card verification number is on the card but was not included in the request.\n - `U`: Card verification is not supported by the issuing bank.\n - `X`: Card verification is not supported by the payment card company.\n - Space Character: Deprecated. Ignore this value.\n - `1`: CyberSource does not support card verification for this processor or card type.\n - `2`: Processor returned value unrecognized for card verification response.\n - `3`: Processor did not return card verification result code.\n" + } + } + }, + "riskInformation": { + "type": "object", + "properties": { + "profile": { + "type": "object", + "description": "Identifies a risk profile.", + "properties": { + "name": { + "type": "string", + "maxLength": 30, + "description": "Name of the active profile chosen by the profile selector. If no profile selector exists,\nthe default active profile is chosen.\n" + } + } + } + } + }, + "travelInformation": { + "type": "object", + "properties": { + "completeRoute": { + "type": "string", + "maxLength": 255, + "description": "Concatenation of individual travel legs in the format ORIG1-DEST1[:ORIG2-DEST2...:ORIGn-DESTn], for\nexample, SFO-JFK:JFK-LHR:LHR-CDG. For airport codes, see the IATA Airline and Airport Code Search.\nNote In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you\nsend all the fields, the value of _complete_route takes precedence over that of the _leg# fields.\n" + }, + "departureTime": { + "type": "string", + "maxLength": 25, + "description": "Departure date and time of the first leg of the trip. Use one of the following formats:\n - yyyy-MM-dd HH:mm z\n - yyyy-MM-dd hh:mm a z\n - yyyy-MM-dd hh:mma z\n HH = hour in 24-hour format\n hh = hour in 12-hour format\n a = am or pm (case insensitive)\n z = time zone of the departing flight, for example: If the\n airline is based in city A, but the flight departs from city\n B, z is the time zone of city B at the time of departure.\nImportant For travel information, use GMT instead of UTC, or use the local time zone.\nExamples\n2011-03-20 11:30 PM PDT\n2011-03-20 11:30pm GMT\n2011-03-20 11:30pm GMT-05:00\nEastern Standard Time: GMT-05:00 or EST\nNote When specifying an offset from GMT, the format must be exactly as specified in the example. Insert no\nspaces between the time zone and the offset.\n" + }, + "journeyType": { + "type": "string", + "maxLength": 32, + "description": "Type of travel, for example one way or round trip." + }, + "legs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "origination": { + "type": "string", + "maxLength": 3, + "description": "Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#)\nsymbol in the field name. This code is usually three digits long, for example: SFO = San Francisco.\nDo not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search.\nThe leg number can be a positive integer from 0 to N.\nFor example:\ndecision_manager_travel_leg0_orig=SFO\ndecision_manager_travel_leg1_orig=SFO\nNote In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you\nsend all the fields, the complete route takes precedence over the individual legs.\n" + }, + "destination": { + "type": "string", + "maxLength": 3, + "description": "Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#)\nsymbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the\ncolon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a\npositive integer from 0 to N.\nFor example:\ndecision_manager_travel_leg0_dest=SFO\ndecision_manager_travel_leg1_dest=SFO\nNote In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you\nsend all the fields, the complete route takes precedence over the individual legs.\n" + } + } + } + } + } + }, + "merchantDefinedInformation": { + "type": "array", + "items": { + "type": "object", + "description": "Contains merchant-defined key-value pairs.", + "properties": { + "key": { + "type": "string", + "maxLength": 255, + "description": "Fields that you can use to store information. The value\nappears in the Case Management Details window in the\nBusiness Center. The first four fields are the same fields\nthat are used by the Secure Data services. See request\ncode examples.\nWarning Merchant-defined data fields are not intended\nto and must not be used to capture personally identifying\ninformation. Accordingly, merchants are prohibited from\ncapturing, obtaining, and/or transmitting any personally\nidentifying information in or via the merchant-defined data\nfields. Personally identifying information includes, but is\nnot limited to, address, credit card number, social security\nnumber, driver's license number, state-issued\nidentification number, passport number, and card\nverification numbers (CVV, CVC2, CVV2, CID, CVN). In\nthe event CyberSource discovers that a merchant is\ncapturing and/or transmitting personally identifying\ninformation via the merchant-defined data fields, whether\nor not intentionally, CyberSource will immediately\nsuspend the merchant's account, which will result in a\nrejection of any and all transaction requests submitted by\nthe merchant after the point of suspension.\n" + }, + "value": { + "type": "string", + "maxLength": 255, + "description": "String value for the key" + } + } + } + } + } + } + } + ], + "responses": { + "201": { + "description": "Successful response", + "schema": { + "title": "riskV1DecisionsPost201Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + }, + "reversal": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + }, + "capture": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + }, + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "submitTimeLocal": { + "type": "string", + "description": "Time that the transaction was submitted in local time." + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - `ACCEPTED`\n - `REJECTED`\n - `PENDING_REVIEW`\n" + }, + "riskInformation": { + "type": "object", + "description": "Contains the result of risk assessment.", + "properties": { + "profile": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 30, + "description": "Name of the active profile chosen by the profile selector. If no profile selector exists,\nthe default active profile is chosen.\n" + }, + "desinationQueue": { + "type": "string", + "maxLength": 255, + "description": "Name of the queue where orders that are not automatically accepted are sent.\n" + }, + "selectorRule": { + "type": "string", + "maxLength": 255, + "description": "Name of the profile selector rule that chooses the profile to use for the\ntransaction. If no profile selector exists, the value is Default Active Profile.\n" + } + } + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 255, + "description": "Description of the rule as it appears in the Profile Editor." + }, + "decision": { + "type": "string", + "maxLength": 255, + "description": "Summarizes the result for the rule according to the setting that you chose in the Profile Editor.\nThis field can contain one of the following values:\n- `IGNORE`\n- `REVIEW`\n- `REJECT`\n- `ACCEPT`\n" + } + } + } + }, + "infoCodes": { + "type": "object", + "properties": { + "velocity": { + "type": "array", + "description": "List of information codes triggered by the order. These information codes were generated when you created\nthe order and product velocity rules and are returned so that you can associate them with the rules.\n", + "items": { + "type": "string", + "description": "Indicates excessive volume of transactions." + } + }, + "address": { + "type": "array", + "description": "Indicates a mismatch between the customer\u2019s billing and shipping addresses.", + "items": { + "type": "string" + } + }, + "customerList": { + "type": "array", + "description": "Indicates that customer information is associated with transactions that are either on the negative or\nthe positive list.\n", + "items": { + "type": "string" + } + }, + "identityChange": { + "type": "array", + "description": "Indicates excessive identity changes. The threshold is variable depending on the identity elements being\ncompared. This field can contain one or more information codes, separated by carets (^).\n", + "items": { + "type": "string" + } + }, + "internet": { + "type": "array", + "description": "Indicates a problem with the customer\u2019s email address, IP address, or billing address.", + "items": { + "type": "string" + } + }, + "phone": { + "type": "array", + "description": "Indicates a problem with the customer\u2019s phone number.", + "items": { + "type": "string" + } + }, + "suspicious": { + "type": "array", + "description": "Indicates that the customer provided potentially suspicious information.", + "items": { + "type": "string" + } + }, + "globalVelocity": { + "type": "array", + "description": "Indicates that the customer has a high purchase frequency.", + "items": { + "type": "string" + } + } + } + }, + "velocity": { + "type": "object", + "properties": { + "morphing": { + "type": "array", + "items": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "maxLength": 5, + "description": "Morphing count. Note The count is not returned for the initial transaction." + }, + "fieldName": { + "type": "string", + "maxLength": 255, + "description": "Field name of the morphing element. specified by the setting that you chose in the\nVelocity Editor. For all possible values, Please refer to Simple Order API Developer Guide\n on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/) - Look for 'Reply Fields': \"decisionReply_morphingElement_#_fieldName\".\n" + }, + "informationCode": { + "type": "string", + "maxLength": 255, + "description": "Identifier that CYBS assigned to the velocity rule specified by the number." + } + } + } + }, + "address": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "description": "Indicates a mismatch between the customer\u2019s billing and shipping addresses." + } + } + } + }, + "casePriority": { + "type": "integer", + "maxLength": 1, + "description": "You receive this field only if you subscribe to the Enhanced Case Management service.\nFor all possible values, Please refer to Simple Order API Developer Guide\non [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/) - Look for 'Reply Fields': \"decisionReply_casePriority\".\n" + }, + "localTime": { + "type": "string", + "maxLength": 255, + "description": "The customer's local time (hh:mm:ss), which is calculated from the transaction request time and the\ncustomer's billing address.\n" + }, + "paymentInformation": { + "type": "object", + "description": "Contains response information about the payment.", + "properties": { + "binCountry": { + "type": "string", + "maxLength": 255, + "description": "Country (two-digit country code) associated with the BIN of the customer\u2019s card used for the payment.\nReturned if the information is available. Use this field for additional information when reviewing orders.\nThis information is also displayed in the details page of the Business Center.\n" + }, + "accountType": { + "type": "string", + "maxLength": 255, + "description": "Type of payment card account. This field can refer to a credit card, debit card, or prepaid card\naccount type.\n" + }, + "issuer": { + "type": "string", + "maxLength": 255, + "description": "Name of the bank or entity that issued the card account." + }, + "scheme": { + "type": "string", + "maxLength": 255, + "description": "Subtype of card account. This field can contain one of the following values:\n- Maestro International\n- Maestro UK Domestic\n- MasterCard Credit\n- MasterCard Debit\n- Visa Credit\n- Visa Debit\n- Visa Electron\n*Note:* Additional values may be present.\n" + }, + "bin": { + "type": "string", + "maxLength": 255, + "description": "Credit card BIN (the first six digits of the credit card).Derived either from the `bin` request field\nor from the first six characters of the `number` field.\n" + } + } + }, + "score": { + "type": "object", + "properties": { + "factorCodes": { + "type": "array", + "items": { + "type": "string", + "description": "This field contains information that affected the score of the order.\nThis field will contain one or more codes, separated by carets (^).\n" + } + }, + "modelUsed": { + "type": "string", + "maxLength": 255, + "description": "Name of the score model used for the transaction. If you did not include a custom model in your request,\nthis field contains the name of CyberSource\u2019s default model.\n" + }, + "result": { + "type": "string", + "maxLength": 255, + "description": "Total score calculated for this order. The value cannot be negative.\n" + } + } + }, + "ipAddress": { + "type": "object", + "description": "Contains detailed response information about the customer's IP address.", + "properties": { + "anonymizerStatus": { + "type": "string", + "maxLength": 255, + "description": "Indicates whether the transaction IP address is associated with a known anonymous proxy.\nFor all possible values, Please refer to Simple Order API Developer Guide\non [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/)- Look for 'Reply Fields': \"afsReply_ipAnonymizerStatus\".\n" + }, + "city": { + "type": "string", + "maxLength": 255, + "description": "Name of the city decoded from the IP address used directly or indirectly by the customer to send the order.\n" + }, + "country": { + "type": "string", + "maxLength": 255, + "description": "Name of the country decoded from the IP address used directly or indirectly by the customer to send the order.\n" + }, + "state": { + "type": "string", + "maxLength": 255, + "description": "Name of the state decoded from the IP address used directly or indirectly by the customer to send the order.\n" + }, + "routingMethod": { + "type": "string", + "maxLength": 255, + "description": "Routing method decoded from the IP address used directly or indirectly by the customer to send the order.\nFor all possible values, Please refer to Simple Order API Developer Guide\non [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/)- Look for 'Reply Fields': \"afsService_ipRoutingMethod \".\n" + } + } + }, + "providers": { + "type": "object", + "properties": { + "providerName": { + "type": "array", + "items": { + "type": "object", + "description": "Name of the 3rd party provider, for example, Emailage.", + "properties": { + "fieldName": { + "type": "array", + "items": { + "type": "string", + "description": "Field name, for example, email address domain name (domain_name)." + } + }, + "fieldValue": { + "type": "array", + "items": { + "type": "string", + "description": "Value for the field, for example, yahoo.com." + } + } + } + } + } + } + } + } + }, + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - AVS_FAILED\n - CONTACT_PROCESSOR\n - EXPIRED_CARD\n - PROCESSOR_DECLINED\n - INSUFFICIENT_FUND\n - STOLEN_LOST_CARD\n - ISSUER_UNAVAILABLE\n - UNAUTHORIZED_CARD\n - CVN_NOT_MATCH\n - EXCEEDS_CREDIT_LIMIT\n - INVALID_CVN\n - DECLINED_CHECK\n - BLACKLISTED_CUSTOMER\n - SUSPENDED_ACCOUNT\n - PAYMENT_REFUSED\n - CV_FAILED\n - INVALID_ACCOUNT\n - GENERAL_DECLINE\n - INVALID_MERCHANT_CONFIGURATION\n - DECISION_PROFILE_REJECT\n - SCORE_EXCEEDS_THRESHOLD\n", + "enum": [ + "AVS_FAILED", + "CONTACT_PROCESSOR", + "CV_FAILED", + "EXPIRED_CARD", + "PROCESSOR_DECLINED", + "INSUFFICIENT_FUND", + "STOLEN_LOST_CARD", + "ISSUER_UNAVAILABLE", + "UNAUTHORIZED_CARD", + "CVN_NOT_MATCH", + "EXCEEDS_CREDIT_LIMIT", + "INVALID_CVN", + "PAYMENT_REFUSED", + "INVALID_ACCOUNT", + "GENERAL_DECLINE", + "DECISION_PROFILE_REJECT", + "SCORE_EXCEEDS_THRESHOLD" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + } + } + }, + "400": { + "description": "Invalid request", + "schema": { + "title": "riskV1DecisionsPost400Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_MERCHANT_CONFIGURATION\n - PROCESSOR_UNAVAILABLE\n" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "title": "riskV1DecisionsPost502Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Basic DM Transaction", + "value": { + "clientReferenceInformation": { + "code": "54323007" + }, + "paymentInformation": { + "card": { + "expirationMonth": "12", + "expirationYear": "2020", + "number": "4444444444444448" + } + }, + "orderInformation": { + "billTo": { + "firstName": "James", + "lastName": "Smith", + "locality": "Clearwater milford", + "address1": "96, powers street", + "email": "test@visa.com", + "country": "US", + "administrativeArea": "NH", + "postalCode": "03055", + "phoneNumber": "7606160717" + }, + "amountDetails": { + "currency": "USD", + "totalAmount": "144.14" + } + } + }, + "responseValue": { + "clientReferenceInformation": { + "code": "54323007" + }, + "id": "5526663169230178269497", + "riskInformation": { + "score": "H", + "localTime": "12:11:56", + "infoCodes": { + "address": [ + "COR-BA", + "MM-BIN" + ] + }, + "profile": { + "name": "Example", + "selectorRule": "Default Active Profile" + }, + "rules": [ + { + "decision": "IGNORE", + "name": "Correctable errors in addresses" + }, + { + "decision": "REVIEW", + "name": "Order is above your AFS threshold for review." + }, + { + "decision": "IGNORE", + "name": "CVN not submitted" + } + ], + "paymentInformation": { + "scheme": "VISA CREDIT", + "bin": "444444", + "accountType": "GOLD", + "issuer": "CREDIT AGRICOLE BANK POLSKA, S.A.", + "binCountry": "PL" + }, + "providers": {}, + "casePriority": "3" + }, + "status": "ACCEPTED", + "submitTimeUtc": "2019-03-13T16:12:00Z" + } + }, + "example1": { + "summary": "DM with Device Information", + "value": { + "clientReferenceInformation": { + "code": "54323007" + }, + "paymentInformation": { + "card": { + "expirationMonth": "12", + "expirationYear": "2020", + "number": "4444444444444448" + } + }, + "orderInformation": { + "billTo": { + "firstName": "James", + "lastName": "Smith", + "locality": "Clearwater milford", + "address1": "96, powers street", + "email": "test@visa.com", + "country": "US", + "administrativeArea": "NH", + "postalCode": "03055", + "phoneNumber": "7606160717" + }, + "amountDetails": { + "currency": "USD", + "totalAmount": "144.14" + } + }, + "deviceInformation": { + "cookiesAccepted": "yes", + "hostName": "host.com", + "httpBrowserEmail": "xyz@gmail.com", + "userAgent": "Chrome", + "ipAddress": "64.124.61.215" + } + }, + "responseValue": { + "riskInformation": { + "score": { + "result": "99", + "modelUsed": "default" + }, + "localTime": "10:02:05", + "profile": { + "name": "Profile 1_test", + "selectorRule": "Default Active Profile" + }, + "rules": [ + { + "decision": "IGNORE", + "name": "Correctable errors in addresses" + }, + { + "decision": "REVIEW", + "name": "Order is above your AFS threshold for review." + }, + { + "decision": "IGNORE", + "name": "CVN not submitted" + } + ], + "paymentInformation": { + "scheme": "VISA CREDIT", + "bin": "444444", + "accountType": "GOLD", + "issuer": "CREDIT AGRICOLE BANK POLSKA, S.A." + }, + "casePriority": "3" + }, + "ipAddress": { + "country": "us", + "city": "seattle", + "state": "wa", + "routingMethod": "fixed" + } + } + }, + "example2": { + "summary": "DM with Merchant Defined Information", + "value": { + "clientReferenceInformation": { + "code": "54323007" + }, + "paymentInformation": { + "card": { + "expirationMonth": "12", + "expirationYear": "2020", + "number": "4444444444444448" + } + }, + "orderInformation": { + "billTo": { + "firstName": "James", + "lastName": "Smith", + "locality": "Clearwater milford", + "address1": "96, powers street", + "email": "test@visa.com", + "country": "US", + "administrativeArea": "NH", + "postalCode": "03055", + "phoneNumber": "7606160717" + }, + "amountDetails": { + "currency": "USD", + "totalAmount": "144.14" + } + }, + "merchantDefinedInformation": [ + { + "key": "1", + "value": "Test" + }, + { + "key": "2", + "value": "Test2" + } + ] + }, + "responseValue": { + "riskInformation": { + "score": { + "result": "99", + "modelUsed": "default" + }, + "localTime": "10:02:05", + "profile": { + "name": "Profile 1_test", + "selectorRule": "Default Active Profile" + }, + "paymentInformation": { + "scheme": "VISA CREDIT", + "bin": "444444", + "accountType": "GOLD", + "issuer": "CREDIT AGRICOLE BANK POLSKA, S.A." + }, + "casePriority": "3" + }, + "rules": [ + { + "decision": "REJECT", + "name": "Incorrect merchant defined data " + } + ] + } + }, + "example3": { + "summary": "DM with Travel Information", + "value": { + "clientReferenceInformation": { + "code": "54323007" + }, + "paymentInformation": { + "card": { + "expirationMonth": "12", + "expirationYear": "2020", + "number": "4444444444444448" + } + }, + "orderInformation": { + "billTo": { + "firstName": "James", + "lastName": "Smith", + "locality": "Clearwater milford", + "address1": "96, powers street", + "email": "test@visa.com", + "country": "US", + "administrativeArea": "NH", + "postalCode": "03055", + "phoneNumber": "7606160717" + }, + "amountDetails": { + "currency": "USD", + "totalAmount": "144.14" + } + }, + "travelInformation": { + "completeRoute": "SFO-JFK:JFK-BLR", + "departureTime": "2011-03-20 11:30pm GMT", + "journeyType": "One way", + "legs": [ + { + "destination": "JFK", + "origination": "SFO" + }, + { + "destination": "BLR", + "origination": "JFK" + } + ] + } + }, + "responseValue": { + "riskInformation": { + "score": { + "result": "99", + "modelUsed": "default" + }, + "localTime": "10:02:05", + "profile": { + "name": "Profile 1_test", + "selectorRule": "Default Active Profile" + }, + "paymentInformation": { + "scheme": "VISA CREDIT", + "bin": "444444", + "accountType": "GOLD", + "issuer": "CREDIT AGRICOLE BANK POLSKA, S.A." + }, + "casePriority": "3" + }, + "rules": [ + { + "decision": "IGNORE", + "name": "Correctable errors in addresses" + } + ] + } + }, + "example4": { + "summary": "DM with Buyer Information", + "value": { + "clientReferenceInformation": { + "code": "54323007" + }, + "paymentInformation": { + "card": { + "expirationMonth": "12", + "expirationYear": "2020", + "number": "4444444444444448" + } + }, + "orderInformation": { + "billTo": { + "firstName": "James", + "lastName": "Smith", + "locality": "Clearwater milford", + "address1": "96, powers street", + "email": "test@visa.com", + "country": "US", + "administrativeArea": "NH", + "postalCode": "03055", + "phoneNumber": "7606160717" + }, + "amountDetails": { + "currency": "USD", + "totalAmount": "144.14" + } + }, + "buyerInformation": { + "hashedPassword": "", + "dateOfBirth": "1998-05-05", + "personalIdentification": [ + { + "id": "1a23apwe98", + "type": "CPF" + } + ] + } + }, + "responseValue": { + "riskInformation": { + "score": { + "result": "99", + "modelUsed": "default" + }, + "localTime": "10:02:05", + "profile": { + "name": "Profile 1_test", + "selectorRule": "Default Active Profile" + }, + "paymentInformation": { + "scheme": "VISA CREDIT", + "bin": "444444", + "accountType": "GOLD", + "issuer": "CREDIT AGRICOLE BANK POLSKA, S.A." + }, + "casePriority": "3" + }, + "rules": [ + { + "decision": "REJECT", + "name": "Incorrect BUYER data " + } + ] + } + }, + "example5": { + "summary": "DM with Shipping Information", + "value": { + "clientReferenceInformation": { + "code": "54323007" + }, + "paymentInformation": { + "card": { + "expirationMonth": "12", + "expirationYear": "2020", + "number": "4444444444444448" + } + }, + "orderInformation": { + "billTo": { + "firstName": "James", + "lastName": "Smith", + "locality": "Clearwater milford", + "address1": "96, powers street", + "email": "test@visa.com", + "country": "US", + "administrativeArea": "NH", + "postalCode": "03055", + "phoneNumber": "7606160717" + }, + "amountDetails": { + "currency": "USD", + "totalAmount": "144.14" + }, + "shipTo": { + "address1": "96, powers street", + "address2": "", + "locality": "Clearwater milford", + "country": "INDIA", + "firstName": "James", + "lastName": "Smith", + "phoneNumber": "7606160717", + "administrativeArea": "KA", + "postalCode": "560056" + } + } + }, + "responseValue": { + "clientReferenceInformation": { + "code": "54323007" + }, + "id": "5526665686910178269497", + "riskInformation": { + "score": { + "result": "99", + "modelUsed": "default" + }, + "localTime": "10:02:05", + "profile": { + "name": "Profile 1_test", + "selectorRule": "Default Active Profile" + }, + "infoCodes": { + "address": [ + "MM-A" + ] + }, + "rules": [ + { + "decision": "IGNORE", + "name": "Correctable errors in addresses" + }, + { + "decision": "REVIEW", + "name": "Order is above your AFS threshold for review." + }, + { + "decision": "IGNORE", + "name": "CVN not submitted" + } + ], + "paymentInformation": { + "scheme": "VISA CREDIT", + "bin": "444444", + "accountType": "GOLD", + "issuer": "CREDIT AGRICOLE BANK POLSKA, S.A." + }, + "casePriority": "3" + } + } + }, + "example6": { + "summary": "SCORE_EXCEEDS_THRESHOLD response", + "value": { + "clientReferenceInformation": { + "code": "54323007" + }, + "paymentInformation": { + "card": { + "expirationMonth": "12", + "expirationYear": "2020", + "number": "4444444444444448" + } + }, + "orderInformation": { + "billTo": { + "firstName": "James", + "lastName": "Smith", + "locality": "Clearwater milford", + "address1": "96, powers street", + "email": "test@visa.com", + "country": "US", + "administrativeArea": "NH", + "postalCode": "03055", + "phoneNumber": "7606160717" + }, + "amountDetails": { + "currency": "USD", + "totalAmount": "144.14" + }, + "shipTo": { + "address1": "96, powers street", + "address2": "", + "locality": "Clearwater milford", + "country": "INDIA", + "firstName": "James", + "lastName": "Smith", + "phoneNumber": "7606160717", + "administrativeArea": "KA", + "postalCode": "560056" + } + } + }, + "responseValue": { + "clientReferenceInformation": { + "code": "54323007" + }, + "errorInformation": { + "reason": "SCORE_EXCEEDS_THRESHOLD", + "message": "Soft Decline - Fraud score exceeds threshold." + }, + "id": "5525558950470178269497", + "riskInformation": { + "score": { + "result": "90", + "factorCodes": [ + "D", + "Y" + ], + "modelUsed": "default" + }, + "localTime": "05:31:35", + "infoCodes": { + "address": [ + "COR-BA", + "MM-BIN" + ] + }, + "ipAddress": { + "country": "us", + "city": "seattle", + "state": "wa", + "routingMethod": "fixed" + } + }, + "status": "REJECTED", + "submitTimeUtc": "2019-03-14T09:31:35Z" + } + }, + "example7": { + "summary": "DECISION_PROFILE_REJECT response", + "value": { + "clientReferenceInformation": { + "code": "54323007" + }, + "paymentInformation": { + "card": { + "expirationMonth": "12", + "expirationYear": "2020", + "number": "4444444444444448" + } + }, + "orderInformation": { + "billTo": { + "firstName": "James", + "lastName": "Smith", + "locality": "Clearwater milford", + "address1": "96, powers street", + "email": "test@visa.com", + "country": "US", + "administrativeArea": "NH", + "postalCode": "03055", + "phoneNumber": "7606160717" + }, + "amountDetails": { + "currency": "USD", + "totalAmount": "144.14" + } + }, + "riskInformation": { + "profile": { + "name": "profile2" + }, + "score": { + "ignoreAvsResults": "false" + } + } + }, + "responseValue": { + "clientReferenceInformation": { + "code": "54323007" + }, + "errorInformation": { + "reason": "DECISION_PROFILE_REJECT", + "message": "The order has been rejected by Decision Manager" + }, + "id": "5525558833540178269497", + "riskInformation": { + "score": { + "result": "96", + "factorCodes": [ + "H", + "V", + "Y" + ], + "modelUsed": "default" + }, + "localTime": "05:31:23", + "infoCodes": { + "address": [ + "COR-BA", + "MM-BIN" + ] + }, + "profile": { + "destinationQueue": "Example", + "name": "profile2", + "selectorRule": "Default Active Profile" + }, + "rules": [ + { + "decision": "IGNORE", + "name": "Correctable errors in addresses" + }, + { + "decision": "REVIEW", + "name": "Order is above your AFS threshold for review." + }, + { + "decision": "IGNORE", + "name": "CVN not submitted" + } + ], + "paymentInformation": { + "scheme": "VISA CREDIT", + "bin": "444444", + "accountType": "GOLD", + "issuer": "CREDIT AGRICOLE BANK POLSKA, S.A.", + "binCountry": "PL" + }, + "casePriority": "3" + }, + "status": "REJECTED", + "submitTimeUtc": "2019-03-14T09:31:29Z" + } + } + } + } + }, + "/sfs/v1/file-details": { + "get": { + "tags": [ + "SecureFileShare" + ], + "summary": "Get list of files", + "description": "Get list of files and it's information of them available inside the report directory", + "operationId": "getFileDetail", + "x-devcenter-metaData": { + "categoryTag": "Secure_File_Share" + }, + "x-queryParameterDefaults": { + "organizationId": "testrest", + "startDate": "2018-10-20T00:00:00.000Z", + "endDate": "2018-10-30T00:00:00.000Z" + }, + "produces": [ + "application/hal+json" + ], + "parameters": [ + { + "name": "startDate", + "in": "query", + "description": "Valid start date in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd\n", + "required": true, + "type": "string", + "format": "date" + }, + { + "name": "endDate", + "in": "query", + "description": "Valid end date in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.\n- https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14\n\n **Example date format:**\n - yyyy-MM-dd\n", + "required": true, + "type": "string", + "format": "date" + }, + { + "name": "organizationId", + "in": "query", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 32 + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "title": "V1FileDetailsGet200Response", + "type": "object", + "properties": { + "fileDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fileId": { + "type": "string", + "description": "Unique identifier of a file", + "example": "AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B" + }, + "name": { + "type": "string", + "description": "Name of the file", + "example": "MyTransactionDetailreport.xml" + }, + "createdTime": { + "type": "string", + "format": "date-time", + "description": "Date and time for the file in PST", + "example": "2017-10-01T00:00:00+05:00" + }, + "lastModifiedTime": { + "type": "string", + "format": "date-time", + "description": "Date and time for the file in PST", + "example": "2017-10-01T00:00:00+05:00" + }, + "date": { + "type": "string", + "format": "date", + "description": "Date and time for the file in PST", + "example": "2017-10-05" + }, + "mimeType": { + "type": "string", + "description": "File extension", + "enum": [ + "application/xml", + "text/csv", + "application/pdf", + "application/octet-stream" + ], + "example": "application/xml" + }, + "size": { + "type": "integer", + "description": "Size of the file in bytes", + "example": 2245397 + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "/sfs/v1/file-details?startDate=2018-01-01&endDate=2018-01-02" + }, + "method": { + "type": "string", + "example": "GET" + } + } + }, + "files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fileId": { + "type": "string", + "description": "Unique identifier for each file", + "example": "AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B" + }, + "href": { + "type": "string", + "example": "/sfs/v1/files/AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B" + }, + "method": { + "type": "string", + "example": "GET" + } + } + } + } + } + } + } + } + }, + "400": { + "description": "Invalid request", + "schema": { + "title": "V1FilesGet400Response", + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "description": "Error code" + }, + "message": { + "type": "string", + "description": "Error message" + }, + "localizationKey": { + "type": "string", + "description": "Localization Key Name" + }, + "correlationId": { + "type": "string", + "description": "Correlation Id" + }, + "detail": { + "type": "string", + "description": "Error Detail" + }, + "fields": { + "type": "array", + "description": "Error fields List", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "Path of the failed property" + }, + "message": { + "type": "string", + "description": "Error description about validation failed field" + }, + "localizationKey": { + "type": "string", + "description": "Localized Key Name" + } + }, + "description": "Provide validation failed input field details" + } + } + }, + "description": "Error Bean" + }, + "examples": { + "application/json": { + "code": "VALIDATION_ERROR", + "correlationId": null, + "detail": null, + "fields": [ + { + "path": "startTime", + "message": "Start date should not precede 18 months from current time in GMT", + "localizationKey": null + } + ], + "localizationKey": "cybsapi.validation.errors", + "message": "Field validation errors" + } + } + }, + "401": { + "description": "Ok", + "schema": { + "title": "V1FileDetailsGet401Response", + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "description": "Error code" + }, + "message": { + "type": "string", + "description": "Error message" + }, + "localizationKey": { + "type": "string", + "description": "Localization Key Name" + }, + "correlationId": { + "type": "string", + "description": "Correlation Id" + }, + "detail": { + "type": "string", + "description": "Error Detail" + }, + "fields": { + "type": "array", + "description": "Error fields List", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "Path of the failed property" + }, + "message": { + "type": "string", + "description": "Error description about validation failed field" + }, + "localizationKey": { + "type": "string", + "description": "Localized Key Name" + } + }, + "description": "Provide validation failed input field details" + } + } + }, + "description": "Error Bean" + }, + "examples": { + "application/json": { + "code": "VALIDATION_ERROR", + "correlationId": null, + "detail": null, + "fields": [ + { + "path": "organizationId", + "message": "Organization doesn't has access to File details", + "localizationKey": null + } + ], + "localizationKey": "cybsapi.validation.errors", + "message": "Field validation errors" + } + } + }, + "404": { + "description": "Files Info not found", + "schema": { + "title": "V1FileDetailsGet404Response", + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "description": "Error code" + }, + "message": { + "type": "string", + "description": "Error message" + }, + "localizationKey": { + "type": "string", + "description": "Localization Key Name" + }, + "correlationId": { + "type": "string", + "description": "Correlation Id" + }, + "detail": { + "type": "string", + "description": "Error Detail" + }, + "fields": { + "type": "array", + "description": "Error fields List", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "Path of the failed property" + }, + "message": { + "type": "string", + "description": "Error description about validation failed field" + }, + "localizationKey": { + "type": "string", + "description": "Localized Key Name" + } + }, + "description": "Provide validation failed input field details" + } + } + }, + "description": "Error Bean" + }, + "examples": { + "application/json": { + "code": "RESOURCE_NOTFOUND", + "correlationId": null, + "detail": "The requested resource is not found. Please try again later.", + "localizationKey": "cybsapi.resource.notfound", + "message": "Files Info not found for requested input values" + } + } + }, + "500": { + "description": "Internal Server Error", + "schema": { + "title": "V1FileDetailsGet500Response", + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "description": "Error code" + }, + "message": { + "type": "string", + "description": "Error message" + }, + "localizationKey": { + "type": "string", + "description": "Localization Key Name" + }, + "correlationId": { + "type": "string", + "description": "Correlation Id" + }, + "detail": { + "type": "string", + "description": "Error Detail" + }, + "fields": { + "type": "array", + "description": "Error fields List", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "Path of the failed property" + }, + "message": { + "type": "string", + "description": "Error description about validation failed field" + }, + "localizationKey": { + "type": "string", + "description": "Localized Key Name" + } + }, + "description": "Provide validation failed input field details" + } + } + }, + "description": "Error Bean" + }, + "examples": { + "application/json": { + "code": "SERVER_ERROR", + "correlationId": null, + "detail": "Internal Server Error. Please contact the customer support.", + "localizationKey": "cybsapi.server.error", + "message": "Error encountered while processing request" + } + } + } + } + } + }, + "/sfs/v1/files/{fileId}": { + "get": { + "tags": [ + "SecureFileShare" + ], + "summary": "Download a file with file identifier", + "description": "Download a file for the given file identifier", + "operationId": "getFile", + "x-devcenter-metaData": { + "categoryTag": "Secure_File_Share" + }, + "x-queryParameterDefaults": { + "organizationId": "testrest" + }, + "produces": [ + "application/xml", + "text/csv", + "application/pdf" + ], + "parameters": [ + { + "name": "fileId", + "in": "path", + "description": "Unique identifier for each file", + "required": true, + "type": "string" + }, + { + "name": "organizationId", + "in": "query", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, + "type": "string", + "minLength": 1, + "maxLength": 32 + } + ], + "responses": { + "200": { + "description": "OK" + }, + "400": { + "description": "Invalid Request", + "schema": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "description": "Error code" + }, + "message": { + "type": "string", + "description": "Error message" + }, + "localizationKey": { + "type": "string", + "description": "Localization Key Name" + }, + "correlationId": { + "type": "string", + "description": "Correlation Id" + }, + "detail": { + "type": "string", + "description": "Error Detail" + }, + "fields": { + "type": "array", + "description": "Error fields List", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "Path of the failed property" + }, + "message": { + "type": "string", + "description": "Error description about validation failed field" + }, + "localizationKey": { + "type": "string", + "description": "Localized Key Name" + } + }, + "description": "Provide validation failed input field details" + } + } + }, + "description": "Error Bean" + } + }, + "404": { + "description": "No Reports Found" + } + } + } + }, + "/tms/v1/instrumentidentifiers": { + "post": { + "summary": "Create an Instrument Identifier", + "parameters": [ + { + "name": "profile-id", + "in": "header", + "description": "The id of a profile containing user specific TMS configuration.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36 + }, + { + "name": "createInstrumentIdentifierRequest", + "in": "body", + "description": "Please specify either a Card, Bank Account or Enrollable Card", + "required": true, + "schema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "example": "enrollable card", + "description": "Type of Card" + }, + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "4622943127013705", + "minLength": 12, + "maxLength": 19, + "description": "Credit card number (PAN)." + }, + "expirationMonth": { + "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, + "maxLength": 2, + "description": "Card expiration month.\n\nFormat: `MM`.\nPossible values: `01` through `12`.\n" + }, + "expirationYear": { + "type": "string", + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Card expiration year.\n\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n" + }, + "securityCode": { + "type": "string", + "example": "838", + "minLength": 3, + "maxLength": 4, + "description": "Card security code." + } + } + }, + "billTo": { + "type": "object", + "properties": { + "address1": { + "type": "string", + "example": "8310 Capital of Texas Highway North", + "description": "First address line registered with card." + }, + "address2": { + "type": "string", + "example": "Bluffstone Drive", + "description": "Second address line registered with card." + }, + "locality": { + "type": "string", + "example": "Austin", + "description": "Locality registered with card." + }, + "administrativeArea": { + "type": "string", + "example": "TX", + "description": "Administrative area registered with card." + }, + "postalCode": { + "type": "string", + "example": "78731", + "description": "Postal code registered with card." + }, + "country": { + "type": "string", + "example": "US", + "description": "Country registered with card." + } + } + } + } + } + } + ], + "tags": [ + "Instrument Identifier" + ], + "operationId": "createInstrumentIdentifier", + "x-devcenter-metaData": { + "categoryTag": "Token_Management" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "200": { + "description": "An existing Instrument Identifier containing the same data has already been returned.", + "headers": { + "Location": { + "description": "Link to the Instrument Identifier.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1InstrumentIdentifiersPost200Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "instrumentIdentifier" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890123456800", + "minLength": 1, + "maxLength": 19, + "description": "Checking account number." + }, + "routingNumber": { + "type": "string", + "example": "123456789", + "minLength": 1, + "maxLength": 9, + "description": "Routing number." + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + } + } + } + } + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + } + } + }, + "examples": { + "application/json": { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + }, + "paymentInstruments": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments" + }, + "id": "1234567890123456789", + "object": "instrumentIdentifier", + "state": "ACTIVE", + "card": { + "number": "444444XXXXXX4444" + }, + "processingInformation": { + "authorizationOptions": { + "initiator": { + "merchantInitiatedTransaction": { + "previousTransactionId": "123456789012345" + } + } + } + }, + "metadata": { + "creator": "user" + } + } + } + }, + "201": { + "description": "A new Instrument Identifier has been created.", + "headers": { + "Location": { + "description": "Link to the Instrument Identifier.", + "type": "string" + }, + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1InstrumentIdentifiersPost201Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "instrumentIdentifier" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890123456800", + "minLength": 1, + "maxLength": 19, + "description": "Checking account number." + }, + "routingNumber": { + "type": "string", + "example": "123456789", + "minLength": 1, + "maxLength": 9, + "description": "Routing number." + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + } + } + } + } + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + } + } + }, + "examples": { + "application/json": { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + }, + "paymentInstruments": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments" + } + }, + "id": "1234567890123456789", + "object": "instrumentIdentifier", + "state": "ACTIVE", + "card": { + "number": "444444XXXXXX4444" + }, + "processingInformation": { + "authorizationOptions": { + "initiator": { + "merchantInitiatedTransaction": { + "previousTransactionId": "123456789012345" + } + } + } + }, + "metadata": { + "creator": "user" + } + } + } + }, + "400": { + "description": "Bad Request. A required header value could be missing.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1BadRequest400Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "Missing Headers": { + "errors": [ + { + "type": "missingHeaders", + "message": "Missing header values." + } + ] + } + } + }, + "403": { + "description": "Forbidden. The profile might not have permission to perform the token operation.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1Forbidden403Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted." + } + ] + } + } + }, + "424": { + "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1FailedDependency424Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Profile not found" + } + ] + } + } + }, + "500": { + "description": "Unexpected error.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, + "schema": { + "title": "tmsV1Error500Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Create Instrument Identifier (Card)", + "value": { + "card": { + "number": "411111111111112" + } + } + }, + "example1": { + "summary": "Create Instrument Identifier (Bank Account)", + "value": { + "bankAccount": { + "number": "4100", + "routingNumber": "071923284" + } + } + }, + "example2": { + "summary": "Create Instrument Identifier (Card & Enroll for Network Token)", + "value": { + "type": "enrollable card", + "card": { + "number": "4622943127013705", + "expirationMonth": "12", + "expirationYear": "2022", + "securityCode": "838" + }, + "billTo": { + "address1": "8310 Capital of Texas Highway North", + "address2": "Bluffstone Drive", + "locality": "Austin", + "administrativeArea": "TX", + "postalCode": "78731", + "country": "US" + } + } + } + } + } + }, + "/tms/v1/instrumentidentifiers/{tokenId}": { + "get": { + "summary": "Retrieve an Instrument Identifier", + "parameters": [ + { + "name": "profile-id", + "in": "header", + "description": "The id of a profile containing user specific TMS configuration.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36 + }, + { + "name": "tokenId", + "in": "path", + "description": "The TokenId of an Instrument Identifier.", + "required": true, + "type": "string", + "minLength": 16, + "maxLength": 32 + } + ], + "tags": [ + "Instrument Identifier" + ], + "operationId": "getInstrumentIdentifier", + "x-devcenter-metaData": { + "categoryTag": "Token_Management" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "200": { + "description": "An existing Instrument Identifier associated with the supplied `tokenId` has been returned.", + "headers": { + "uniqueTransactionID": { + "description": "A globally-unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1InstrumentIdentifiersGet200Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "instrumentIdentifier" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890123456800", + "minLength": 1, + "maxLength": 19, + "description": "Checking account number." + }, + "routingNumber": { + "type": "string", + "example": "123456789", + "minLength": 1, + "maxLength": 9, + "description": "Routing number." + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + } + } + } + } + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + } + } + }, + "examples": { + "application/json": { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + }, + "paymentInstruments": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments" + } + }, + "id": "1234567890123456789", + "object": "instrumentIdentifier", + "state": "ACTIVE", + "card": { + "number": "444444XXXXXX4444" + }, + "processingInformation": { + "authorizationOptions": { + "initiator": { + "merchantInitiatedTransaction": { + "previousTransactionId": "123456789012345" + } + } + } + }, + "metadata": { + "creator": "user" + } + } + } + }, + "400": { + "description": "Bad Request. A required header value could be missing.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1BadRequest400Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "Missing Headers": { + "errors": [ + { + "type": "missingHeaders", + "message": "Missing header values." + } + ] + } + } + }, + "403": { + "description": "Forbidden. The profile might not have permission to perform the token operation.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1Forbidden403Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted." + } + ] + } + } + }, + "404": { + "description": "Token Not Found. The `tokenid` may not exist or was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotFound404Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Token not found" + } + ] + } + } + }, + "410": { + "description": "Token Not Available. The token has been deleted.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotAvailable410Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notAvailable", + "message": "Token not available." + } + ] + } + } + }, + "424": { + "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1FailedDependency424Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Profile not found" + } + ] + } + } + }, + "500": { + "description": "Unexpected error.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, + "schema": { + "title": "tmsV1Error500Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + } + } + } + }, + "patch": { + "summary": "Update a Instrument Identifier", + "parameters": [ + { + "name": "profile-id", + "in": "header", + "description": "The id of a profile containing user specific TMS configuration.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36 + }, + { + "name": "tokenId", + "in": "path", + "description": "The TokenId of an Instrument Identifier.", + "required": true, + "type": "string", + "minLength": 16, + "maxLength": 32 + }, + { + "name": "updateInstrumentIdentifierRequest", + "in": "body", + "description": "Specify the previous transaction ID to update.", + "required": true, + "schema": { + "type": "object", + "properties": { + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + } + } + } + } + } + } + } + } + } + } + ], + "tags": [ + "Instrument Identifier" + ], + "operationId": "updateInstrumentIdentifier", + "x-devcenter-metaData": { + "categoryTag": "Token_Management" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "200": { + "description": "The updated Instrument Identifier has been returned.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1InstrumentIdentifiersPatch200Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "instrumentIdentifier" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890123456800", + "minLength": 1, + "maxLength": 19, + "description": "Checking account number." + }, + "routingNumber": { + "type": "string", + "example": "123456789", + "minLength": 1, + "maxLength": 9, + "description": "Routing number." + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + } + } + } + } + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + } + } + }, + "examples": { + "application/json": { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500" + } + }, + "id": "58FEBAEFD2EEFCE1E0539399D30A7500", + "object": "instrumentIdentifier", + "state": "ACTIVE", + "card": { + "number": "424242XXXXXX4242" + }, + "processingInformation": { + "authorizationOptions": { + "initiator": { + "merchantInitiatedTransaction": { + "previousTransactionId": 123456789012345 + } + } + } + }, + "metadata": { + "creator": "user" + } + } + } + }, + "400": { + "description": "Bad Request. A required header value could be missing.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1InstrumentIdentifiersPatch400Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "Missing Headers": { + "errors": [ + { + "type": "missingHeaders", + "message": "Missing header values." + } + ] + }, + "Invalid Parameters": { + "errors": [ + { + "type": "invalidParameters", + "message": "Invalid parameter values.", + "details": [ + { + "name": "id" + } + ] + } + ] + }, + "Unknown Field": { + "errors": [ + { + "type": "unknownField", + "message": "Unknown body values.", + "details": [ + { + "name": "id" + } + ] + } + ] + }, + "Unsupported Fields": { + "errors": [ + { + "type": "unsupportedFields", + "message": "Unsupported body values for this action.", + "details": [ + { + "name": "bankAccount" + }, + { + "name": "card" + } + ] + } + ] + } + } + }, + "403": { + "description": "Forbidden. The profile might not have permission to perform the token operation.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1Forbidden403Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted." + } + ] + } + } + }, + "404": { + "description": "Token Not Found. The `tokenid` may not exist or was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotFound404Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Token not found" + } + ] + } + } + }, + "410": { + "description": "Token Not Available. The token has been deleted.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotAvailable410Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notAvailable", + "message": "Token not available." + } + ] + } + } + }, + "424": { + "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1FailedDependency424Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Profile not found" + } + ] + } + } + }, + "500": { + "description": "Unexpected error.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, + "schema": { + "title": "tmsV1Error500Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete an Instrument Identifier", + "tags": [ + "Instrument Identifier" + ], + "operationId": "deleteInstrumentIdentifier", + "x-devcenter-metaData": { + "categoryTag": "Token_Management" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "parameters": [ + { + "name": "profile-id", + "in": "header", + "description": "The id of a profile containing user specific TMS configuration.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36 + }, + { + "name": "tokenId", + "in": "path", + "description": "The TokenId of an Instrument Identifier.", + "required": true, + "type": "string", + "minLength": 16, + "maxLength": 32 + } + ], + "responses": { + "204": { + "description": "An existing Instrument Identifier associated with the supplied `tokenId` has been deleted.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + } + }, + "403": { + "description": "Forbidden. The profile might not have permission to perform the token operation.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1Forbidden403Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted." + } + ] + } + } + }, + "404": { + "description": "Token Not Found. The `tokenid` may not exist or was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotFound404Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Token not found" + } + ] + } + } + }, + "409": { + "description": "Conflict. The token is linked to a Payment Instrument.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1InstrumentIdentifiersDelete409Response", + "type": "array", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "paymentInstruments": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments" + } + } + } + } + } + }, + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "_links": { + "paymentInstruments": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/7010000000001621111/paymentinstruments" + } + }, + "errors": [ + { + "type": "instrumentIdentifierDeletionError", + "message": "Action cannot be performed. The Instrument Identifier is associated with one or more Payment Instruments." + } + ] + } + } + }, + "410": { + "description": "Token Not Available. The token has been deleted.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotAvailable410Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notAvailable", + "message": "Token not available." + } + ] + } + } + }, + "424": { + "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1FailedDependency424Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Profile not found" + } + ] + } + } + }, + "500": { + "description": "Unexpected error.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, + "schema": { + "title": "tmsV1Error500Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + } + } + } + } + }, + "/tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments": { + "get": { + "summary": "Retrieve all Payment Instruments associated with an Instrument Identifier", + "parameters": [ + { + "name": "profile-id", + "in": "header", + "description": "The id of a profile containing user specific TMS configuration.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36 + }, + { + "name": "tokenId", + "in": "path", + "description": "The TokenId of an Instrument Identifier.", + "required": true, + "type": "string", + "minLength": 16, + "maxLength": 32 + }, + { + "name": "offset", + "in": "query", + "description": "Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0.", + "required": false, + "type": "integer", + "format": "int64", + "default": 0, + "minimum": 0 + }, + { + "name": "limit", + "in": "query", + "description": "The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100.", + "required": false, + "type": "integer", + "format": "int64", + "default": 20, + "minimum": 1, + "maximum": 100 + } + ], + "tags": [ + "Instrument Identifier" + ], + "operationId": "getAllPaymentInstruments", + "x-devcenter-metaData": { + "categoryTag": "Token_Management" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "200": { + "description": "Returns an array of Payment Instruments associated with the supplied Instrument Identifier.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + }, + "x-Total-Count": { + "description": "The total number of Payment Instruments associated with the Instrument Identifier in the zero-based dataset.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "A link to the current requested collection.", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=20&limit=5\"" + } + } + }, + "first": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "A link to the collection starting at offset zero for the supplied limit.", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=0&limit=5" + } + } + }, + "prev": { + "type": "object", + "description": "A link to the previous collection starting at the supplied offset minus the supplied limit.", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=15&limit=5" + } + } + }, + "next": { + "type": "object", + "properties": { + "href": { + "description": "A link to the next collection starting at the supplied offset plus the supplied limit.", + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=25&limit=5" + } + } + }, + "last": { + "type": "object", + "properties": { + "href": { + "description": "A link to the last collection containing the remaining objects.", + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=35&limit=5" + } + } + } + } + }, + "object": { + "type": "string", + "readOnly": true, + "example": "collection", + "description": "Shows the response is a collection of objects.", + "enum": [ + "collection" + ] + }, + "offset": { + "type": "string", + "readOnly": true, + "example": "20", + "description": "The offset parameter supplied in the request." + }, + "limit": { + "type": "string", + "readOnly": true, + "example": "1", + "description": "The limit parameter supplied in the request." + }, + "count": { + "type": "string", + "readOnly": true, + "example": "1", + "description": "The number of Payment Instruments returned in the array." + }, + "total": { + "type": "string", + "readOnly": true, + "example": "39", + "description": "The total number of Payment Instruments associated with the Instrument Identifier in the zero-based dataset." + }, + "_embedded": { + "type": "object", + "properties": { + "paymentInstruments": { + "description": "Array of Payment Instruments returned for the supplied Instrument Identifier.", + "type": "array", + "items": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "paymentInstrument" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "checking", + "savings", + "corporate checking", + "general ledger" + ], + "example": "savings", + "description": "Checking account type. Possible values:\n * C: checking\n * S: savings (USD only)\n * X: corporate checking (USD only)\n * G: general ledger\n" + } + } + }, + "card": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "expirationMonth": { + "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, + "maxLength": 2, + "description": "Two-digit month in which the credit card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. For more information about relaxed requirements, see the TMS REST API Developer Guide.\n\nImportant:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "expirationYear": { + "type": "string", + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n\n**FDC Nashville Global and FDMS South**\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See Relaxed Requirements for Address Data and Expiration Date page.\n\nImportant:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + }, + "type": { + "type": "string", + "enum": [ + "visa", + "mastercard", + "american express", + "discover", + "diners club", + "carte blanche", + "jcb", + "optima", + "twinpay credit", + "twinpay debit", + "walmart", + "enroute", + "lowes consumer", + "home depot consumer", + "mbna", + "dicks sportswear", + "casual corner", + "sears", + "jal", + "disney", + "maestro uk domestic", + "sams club consumer", + "sams club business", + "nicos", + "bill me later", + "bebe", + "restoration hardware", + "delta online", + "solo", + "visa electron", + "dankort", + "laser", + "carte bleue", + "carta si", + "pinless debit", + "encoded account", + "uatp", + "household", + "maestro international", + "ge money uk", + "korean cards", + "style", + "jcrew", + "payease china processing ewallet", + "payease china processing bank transfer", + "meijer private label", + "hipercard", + "aura", + "redecard", + "orico", + "elo", + "capital one private label", + "synchrony private label", + "china union pay", + "costco private label", + "mada", + "falabella private label" + ], + "description": "Type of credit card. Possible values:\n * Visa (001)\n * Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * American Express (003)\n * Discover (004)\n * Diners Club (005)\n * Carte Blanche (006)\n * JCB (007)\n * Optima (008)\n * Twinpay Credit (011)\n * Twinpay Debit (012)\n * Walmart (013)\n * EnRoute (014)\n * Lowes consumer (015)\n * Home Depot consumer (016)\n * MBNA (017)\n * Dicks Sportswear (018)\n * Casual Corner (019)\n * Sears (020)\n * JAL (021)\n * Disney (023)\n * Maestro (024) - UK Domestic\n * Sams Club consumer (025)\n * Sams Club business (026)\n * Nicos (027)\n * Bill me later (028)\n * Bebe (029)\n * Restoration Hardware (030)\n * Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * Solo (032)\n * Visa Electron (033)\n * Dankort (034)\n * Laser (035)\n * Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * Cartes Bancaires (036)\n * Carta Si (037)\n * pinless debit (038)\n * encoded account (039)\n * UATP (040)\n * Household (041)\n * Maestro (042) - International\n * GE Money UK (043)\n * Korean cards (044)\n * Style (045)\n * JCrew (046)\n * PayEase China processing eWallet (047)\n * PayEase China processing bank transfer (048)\n * Meijer Private Label (049)\n * Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * Aura (051) \u2014 supported only by the Comercio Latino processor.\n * Redecard (052)\n * ORICO (053)\n * Elo (054) \u2014 supported only by the Comercio Latino processor.\n * Capital One Private Label (055)\n * Synchrony Private Label (056)\n * Costco Private Label (057)\n * mada (060)\n * China Union Pay (062)\n * Falabella private label (063)\n" + }, + "issueNumber": { + "type": "string", + "example": "01", + "minLength": 1, + "maxLength": 2, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder." + }, + "startMonth": { + "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period.\n\nFormat: `MM`.\nPossible values: `01` through `12`.\n" + }, + "startYear": { + "type": "string", + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period.\n\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n" + }, + "useAs": { + "type": "string", + "example": "pinless debit", + "description": "Card Use As Field. Supported value of `pinless debit` only. Only for use with Pinless Debit tokens." + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "companyTaxID": { + "type": "string", + "example": "1234567890123456800", + "maxLength": 9, + "description": "Tax identifier for the customer\u2019s company.\n\n**Important**:\nContact your TeleCheck representative to find out whether this field is required or optional.\n" + }, + "currency": { + "type": "string", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "description": "Currency used by the customer. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha." + }, + "dateOBirth": { + "type": "string", + "format": "YYYY-MM-DD|YYYYMMDD", + "example": "1960-12-30", + "minLength": 8, + "maxLength": 10, + "description": "Date of birth of the customer.\n\nFormat: `YYYY-MM-DD` or `YYYYMMDD`\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "1234567890", + "description": "Customer's identification number.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + }, + "type": { + "type": "string", + "enum": [ + "driver license" + ], + "example": "driver license", + "description": "Type of personal identification.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + }, + "issuedBy": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "example": "CA", + "description": "State or province in which the customer\u2019s driver\u2019s license was issued. Use the State, Province, and Territory Codes for the United States and Canada.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "example": "John", + "maxLength": 60, + "description": "Customer\u2019s first name. For a credit card transaction, this name must match the name on the card.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "lastName": { + "type": "string", + "example": "Smith", + "maxLength": 60, + "description": "Customer\u2019s last name. For a credit card transaction, this name must match the name on the card.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "company": { + "type": "string", + "example": "CyberSource", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "address1": { + "type": "string", + "example": "12 Main Street", + "maxLength": 60, + "description": "First line of the billing street address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "address2": { + "type": "string", + "example": "20 My Street", + "maxLength": 60, + "description": "Additional address information." + }, + "locality": { + "type": "string", + "example": "Foster City", + "maxLength": 50, + "description": "City of the billing address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "administrativeArea": { + "type": "string", + "example": "CA", + "maxLength": 20, + "description": "State or province of the billing address. For an address in the U.S. or Canada, use the State, Province, and Territory Codes for the United States and Canada.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "postalCode": { + "type": "string", + "example": "90200", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n**Example** 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample A1B 2C3\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "country": { + "type": "string", + "example": "US", + "minLength": 2, + "maxLength": 3, + "description": "Country of the billing address. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "email": { + "type": "string", + "example": "john.smith@example.com", + "maxLength": 320, + "description": "Customer\u2019s email address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "phoneNumber": { + "type": "string", + "example": "555123456", + "minLength": 6, + "maxLength": 32, + "description": "Customer phone number. When you create a customer profile, the requirements depend on the payment method:\n * Credit cards \u2014 optional.\n * Electronic checks \u2014 contact your payment processor representative to find out if this field is required or optional.\n * PINless debits \u2014 optional.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "billPaymentProgramEnabled": { + "type": "boolean", + "example": true, + "default": false, + "description": "Indicates that the payments for this customer profile are for the Bill Payment program. Possible values:\n * false: Not a Visa Bill Payment.\n * true: Visa Bill Payment.\n" + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "SECCode": { + "type": "string", + "enum": [ + "CCD", + "PPD", + "TEL", + "WEB" + ], + "example": "WEB", + "description": "**Important** This field is required if your processor is TeleCheck.\n\nCode that specifies the authorization method for the transaction. Possible values:\n\n- **CCD**: corporate cash disbursement. Charge or credit against a business checking account. You can use one-time or recurring CCD transactions to transfer funds to or from a corporate entity. A standing authorization is required for recurring transactions.\n- **PPD**: prearranged payment and deposit entry. Charge or credit against a personal checking or savings account. You can originate a PPD entry only when the payment and deposit terms between you and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions.\n- **TEL**: telephone-initiated entry. One-time charge against a personal checking or savings account. You can originate a TEL entry only when there is a business relationship between you and the customer or when the customer initiates a telephone call to you. For a TEL entry, you must obtain a payment authorization from the customer over the telephone. There is no recurring billing option for TEL.\n- **WEB**: internet-initiated entry\u2014charge against a personal checking or savings account. You can originate a one-time or recurring WEB entry when the customer initiates the transaction over the Internet. For a WEB entry, you must obtain payment authorization from the customer over the Internet.\n" + } + } + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "alternateName": { + "type": "string", + "example": "Branch Name", + "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." + } + } + } + } + }, + "metaData": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "instrumentIdentifier" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "id": { + "type": "string", + "example": "1234567890123456789", + "minLength": 16, + "maxLength": 32, + "description": "The ID of the existing instrument identifier to be linked to the newly created payment instrument." + }, + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890123456800", + "minLength": 1, + "maxLength": 19, + "description": "Checking account number." + }, + "routingNumber": { + "type": "string", + "example": "123456789", + "minLength": 1, + "maxLength": 9, + "description": "Routing number." + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + } + } + } + } + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + } + } + } + } + } + } + } + } + } + }, + "examples": { + "application/json": { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=20&limit=1" + }, + "first": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=0&limit=1" + }, + "prev": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=19&limit=1" + }, + "next": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=21&limit=1\"" + }, + "last": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=38&limit=1" + } + }, + "object": "collection", + "offset": 20, + "limit": 1, + "count": 1, + "total": 39, + "_embedded": { + "paymentInstruments": [ + { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/paymentinstruments/6036673B73B12F19E0539399D30A2566" + } + }, + "id": "6036673B73B12F19E0539399D30A2566", + "object": "paymentInstrument", + "state": "ACTIVE", + "card": { + "expirationMonth": "09", + "expirationYear": "2027", + "type": "visa", + "issueNumber": "01", + "startMonth": "01", + "startYear": "2017" + }, + "buyerInformation": { + "companyTaxId": "12345", + "currency": "USD" + }, + "billTo": { + "firstName": "John", + "lastName": "Smith", + "company": "CyberSource", + "address1": "1 My Apartment", + "address2": "Main Street", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": "90211", + "country": "US", + "email": "john.smith@test.com", + "phoneNumber": "+44 2890447777" + }, + "processingInformation": { + "billPaymentProgramEnabled": true + }, + "metadata": { + "creator": "user" + }, + "_embedded": { + "instrumentIdentifier": { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1" + } + }, + "id": "5B32CE6167B09343E05333B9D30A53E1", + "object": "instrumentIdentifier", + "state": "ACTIVE", + "card": { + "number": "424242XXXXXX1237" + }, + "processingInformation": { + "authorizationOptions": { + "initiator": { + "merchantInitiatedTransaction": { + "previousTransactionId": "123456789012345" + } + } + } + }, + "metadata": { + "creator": "user" + } + } + } + } + ] + } + } + } + }, + "400": { + "description": "Bad Request. A required header value could be missing.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1BadRequest400Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "Missing Headers": { + "errors": [ + { + "type": "missingHeaders", + "message": "Missing header values." + } + ] + } + } + }, + "403": { + "description": "Forbidden. The profile might not have permission to perform the token operation.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1Forbidden403Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted." + } + ] + } + } + }, + "404": { + "description": "Token Not Found. The `tokenid` may not exist or was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotFound404Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Token not found" + } + ] + } + } + }, + "410": { + "description": "Token Not Available. The token has been deleted.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotAvailable410Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notAvailable", + "message": "Token not available." + } + ] + } + } + }, + "424": { + "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1FailedDependency424Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Profile not found" + } + ] + } + } + }, + "500": { + "description": "Unexpected error.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, + "schema": { + "title": "tmsV1Error500Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + } + } + } + } + }, + "/tms/v1/paymentinstruments": { + "post": { + "summary": "Create a Payment Instrument", + "parameters": [ + { + "name": "profile-id", + "in": "header", + "description": "The id of a profile containing user specific TMS configuration.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36 + }, + { + "name": "createPaymentInstrumentRequest", + "in": "body", + "description": "Specify the customer's payment details for card or bank account.", + "required": true, + "schema": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "paymentInstrument" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "checking", + "savings", + "corporate checking", + "general ledger" + ], + "example": "savings", + "description": "Checking account type. Possible values:\n * C: checking\n * S: savings (USD only)\n * X: corporate checking (USD only)\n * G: general ledger\n" + } + } + }, + "card": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "expirationMonth": { + "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, + "maxLength": 2, + "description": "Two-digit month in which the credit card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. For more information about relaxed requirements, see the TMS REST API Developer Guide.\n\nImportant:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "expirationYear": { + "type": "string", + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n\n**FDC Nashville Global and FDMS South**\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See Relaxed Requirements for Address Data and Expiration Date page.\n\nImportant:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + }, + "type": { + "type": "string", + "enum": [ + "visa", + "mastercard", + "american express", + "discover", + "diners club", + "carte blanche", + "jcb", + "optima", + "twinpay credit", + "twinpay debit", + "walmart", + "enroute", + "lowes consumer", + "home depot consumer", + "mbna", + "dicks sportswear", + "casual corner", + "sears", + "jal", + "disney", + "maestro uk domestic", + "sams club consumer", + "sams club business", + "nicos", + "bill me later", + "bebe", + "restoration hardware", + "delta online", + "solo", + "visa electron", + "dankort", + "laser", + "carte bleue", + "carta si", + "pinless debit", + "encoded account", + "uatp", + "household", + "maestro international", + "ge money uk", + "korean cards", + "style", + "jcrew", + "payease china processing ewallet", + "payease china processing bank transfer", + "meijer private label", + "hipercard", + "aura", + "redecard", + "orico", + "elo", + "capital one private label", + "synchrony private label", + "china union pay", + "costco private label", + "mada", + "falabella private label" + ], + "description": "Type of credit card. Possible values:\n * Visa (001)\n * Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * American Express (003)\n * Discover (004)\n * Diners Club (005)\n * Carte Blanche (006)\n * JCB (007)\n * Optima (008)\n * Twinpay Credit (011)\n * Twinpay Debit (012)\n * Walmart (013)\n * EnRoute (014)\n * Lowes consumer (015)\n * Home Depot consumer (016)\n * MBNA (017)\n * Dicks Sportswear (018)\n * Casual Corner (019)\n * Sears (020)\n * JAL (021)\n * Disney (023)\n * Maestro (024) - UK Domestic\n * Sams Club consumer (025)\n * Sams Club business (026)\n * Nicos (027)\n * Bill me later (028)\n * Bebe (029)\n * Restoration Hardware (030)\n * Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * Solo (032)\n * Visa Electron (033)\n * Dankort (034)\n * Laser (035)\n * Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * Cartes Bancaires (036)\n * Carta Si (037)\n * pinless debit (038)\n * encoded account (039)\n * UATP (040)\n * Household (041)\n * Maestro (042) - International\n * GE Money UK (043)\n * Korean cards (044)\n * Style (045)\n * JCrew (046)\n * PayEase China processing eWallet (047)\n * PayEase China processing bank transfer (048)\n * Meijer Private Label (049)\n * Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * Aura (051) \u2014 supported only by the Comercio Latino processor.\n * Redecard (052)\n * ORICO (053)\n * Elo (054) \u2014 supported only by the Comercio Latino processor.\n * Capital One Private Label (055)\n * Synchrony Private Label (056)\n * Costco Private Label (057)\n * mada (060)\n * China Union Pay (062)\n * Falabella private label (063)\n" + }, + "issueNumber": { + "type": "string", + "example": "01", + "minLength": 1, + "maxLength": 2, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder." + }, + "startMonth": { + "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period.\n\nFormat: `MM`.\nPossible values: `01` through `12`.\n" + }, + "startYear": { + "type": "string", + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period.\n\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n" + }, + "useAs": { + "type": "string", + "example": "pinless debit", + "description": "Card Use As Field. Supported value of `pinless debit` only. Only for use with Pinless Debit tokens." + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "companyTaxID": { + "type": "string", + "example": "1234567890123456800", + "maxLength": 9, + "description": "Tax identifier for the customer\u2019s company.\n\n**Important**:\nContact your TeleCheck representative to find out whether this field is required or optional.\n" + }, + "currency": { + "type": "string", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "description": "Currency used by the customer. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha." + }, + "dateOBirth": { + "type": "string", + "format": "YYYY-MM-DD|YYYYMMDD", + "example": "1960-12-30", + "minLength": 8, + "maxLength": 10, + "description": "Date of birth of the customer.\n\nFormat: `YYYY-MM-DD` or `YYYYMMDD`\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "1234567890", + "description": "Customer's identification number.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + }, + "type": { + "type": "string", + "enum": [ + "driver license" + ], + "example": "driver license", + "description": "Type of personal identification.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + }, + "issuedBy": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "example": "CA", + "description": "State or province in which the customer\u2019s driver\u2019s license was issued. Use the State, Province, and Territory Codes for the United States and Canada.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "example": "John", + "maxLength": 60, + "description": "Customer\u2019s first name. For a credit card transaction, this name must match the name on the card.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "lastName": { + "type": "string", + "example": "Smith", + "maxLength": 60, + "description": "Customer\u2019s last name. For a credit card transaction, this name must match the name on the card.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "company": { + "type": "string", + "example": "CyberSource", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "address1": { + "type": "string", + "example": "12 Main Street", + "maxLength": 60, + "description": "First line of the billing street address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "address2": { + "type": "string", + "example": "20 My Street", + "maxLength": 60, + "description": "Additional address information." + }, + "locality": { + "type": "string", + "example": "Foster City", + "maxLength": 50, + "description": "City of the billing address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "administrativeArea": { + "type": "string", + "example": "CA", + "maxLength": 20, + "description": "State or province of the billing address. For an address in the U.S. or Canada, use the State, Province, and Territory Codes for the United States and Canada.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "postalCode": { + "type": "string", + "example": "90200", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n**Example** 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample A1B 2C3\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "country": { + "type": "string", + "example": "US", + "minLength": 2, + "maxLength": 3, + "description": "Country of the billing address. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "email": { + "type": "string", + "example": "john.smith@example.com", + "maxLength": 320, + "description": "Customer\u2019s email address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "phoneNumber": { + "type": "string", + "example": "555123456", + "minLength": 6, + "maxLength": 32, + "description": "Customer phone number. When you create a customer profile, the requirements depend on the payment method:\n * Credit cards \u2014 optional.\n * Electronic checks \u2014 contact your payment processor representative to find out if this field is required or optional.\n * PINless debits \u2014 optional.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "billPaymentProgramEnabled": { + "type": "boolean", + "example": true, + "default": false, + "description": "Indicates that the payments for this customer profile are for the Bill Payment program. Possible values:\n * false: Not a Visa Bill Payment.\n * true: Visa Bill Payment.\n" + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "SECCode": { + "type": "string", + "enum": [ + "CCD", + "PPD", + "TEL", + "WEB" + ], + "example": "WEB", + "description": "**Important** This field is required if your processor is TeleCheck.\n\nCode that specifies the authorization method for the transaction. Possible values:\n\n- **CCD**: corporate cash disbursement. Charge or credit against a business checking account. You can use one-time or recurring CCD transactions to transfer funds to or from a corporate entity. A standing authorization is required for recurring transactions.\n- **PPD**: prearranged payment and deposit entry. Charge or credit against a personal checking or savings account. You can originate a PPD entry only when the payment and deposit terms between you and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions.\n- **TEL**: telephone-initiated entry. One-time charge against a personal checking or savings account. You can originate a TEL entry only when there is a business relationship between you and the customer or when the customer initiates a telephone call to you. For a TEL entry, you must obtain a payment authorization from the customer over the telephone. There is no recurring billing option for TEL.\n- **WEB**: internet-initiated entry\u2014charge against a personal checking or savings account. You can originate a one-time or recurring WEB entry when the customer initiates the transaction over the Internet. For a WEB entry, you must obtain payment authorization from the customer over the Internet.\n" + } + } + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "alternateName": { + "type": "string", + "example": "Branch Name", + "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." + } + } + } + } + }, + "metaData": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "instrumentIdentifier" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "id": { + "type": "string", + "example": "1234567890123456789", + "minLength": 16, + "maxLength": 32, + "description": "The ID of the existing instrument identifier to be linked to the newly created payment instrument." + }, + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890123456800", + "minLength": 1, + "maxLength": 19, + "description": "Checking account number." + }, + "routingNumber": { + "type": "string", + "example": "123456789", + "minLength": 1, + "maxLength": 9, + "description": "Routing number." + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + } + } + } + } + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + } + } + } + } + } + } + ], + "tags": [ + "Payment Instrument" + ], + "operationId": "createPaymentInstrument", + "x-devcenter-metaData": { + "categoryTag": "Token_Management" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "201": { + "description": "A new Payment Instrument has been created.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1PaymentInstrumentsPost201Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "paymentInstrument" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "checking", + "savings", + "corporate checking", + "general ledger" + ], + "example": "savings", + "description": "Checking account type. Possible values:\n * C: checking\n * S: savings (USD only)\n * X: corporate checking (USD only)\n * G: general ledger\n" + } + } + }, + "card": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "expirationMonth": { + "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, + "maxLength": 2, + "description": "Two-digit month in which the credit card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. For more information about relaxed requirements, see the TMS REST API Developer Guide.\n\nImportant:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "expirationYear": { + "type": "string", + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n\n**FDC Nashville Global and FDMS South**\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See Relaxed Requirements for Address Data and Expiration Date page.\n\nImportant:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + }, + "type": { + "type": "string", + "enum": [ + "visa", + "mastercard", + "american express", + "discover", + "diners club", + "carte blanche", + "jcb", + "optima", + "twinpay credit", + "twinpay debit", + "walmart", + "enroute", + "lowes consumer", + "home depot consumer", + "mbna", + "dicks sportswear", + "casual corner", + "sears", + "jal", + "disney", + "maestro uk domestic", + "sams club consumer", + "sams club business", + "nicos", + "bill me later", + "bebe", + "restoration hardware", + "delta online", + "solo", + "visa electron", + "dankort", + "laser", + "carte bleue", + "carta si", + "pinless debit", + "encoded account", + "uatp", + "household", + "maestro international", + "ge money uk", + "korean cards", + "style", + "jcrew", + "payease china processing ewallet", + "payease china processing bank transfer", + "meijer private label", + "hipercard", + "aura", + "redecard", + "orico", + "elo", + "capital one private label", + "synchrony private label", + "china union pay", + "costco private label", + "mada", + "falabella private label" + ], + "description": "Type of credit card. Possible values:\n * Visa (001)\n * Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * American Express (003)\n * Discover (004)\n * Diners Club (005)\n * Carte Blanche (006)\n * JCB (007)\n * Optima (008)\n * Twinpay Credit (011)\n * Twinpay Debit (012)\n * Walmart (013)\n * EnRoute (014)\n * Lowes consumer (015)\n * Home Depot consumer (016)\n * MBNA (017)\n * Dicks Sportswear (018)\n * Casual Corner (019)\n * Sears (020)\n * JAL (021)\n * Disney (023)\n * Maestro (024) - UK Domestic\n * Sams Club consumer (025)\n * Sams Club business (026)\n * Nicos (027)\n * Bill me later (028)\n * Bebe (029)\n * Restoration Hardware (030)\n * Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * Solo (032)\n * Visa Electron (033)\n * Dankort (034)\n * Laser (035)\n * Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * Cartes Bancaires (036)\n * Carta Si (037)\n * pinless debit (038)\n * encoded account (039)\n * UATP (040)\n * Household (041)\n * Maestro (042) - International\n * GE Money UK (043)\n * Korean cards (044)\n * Style (045)\n * JCrew (046)\n * PayEase China processing eWallet (047)\n * PayEase China processing bank transfer (048)\n * Meijer Private Label (049)\n * Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * Aura (051) \u2014 supported only by the Comercio Latino processor.\n * Redecard (052)\n * ORICO (053)\n * Elo (054) \u2014 supported only by the Comercio Latino processor.\n * Capital One Private Label (055)\n * Synchrony Private Label (056)\n * Costco Private Label (057)\n * mada (060)\n * China Union Pay (062)\n * Falabella private label (063)\n" + }, + "issueNumber": { + "type": "string", + "example": "01", + "minLength": 1, + "maxLength": 2, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder." + }, + "startMonth": { + "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period.\n\nFormat: `MM`.\nPossible values: `01` through `12`.\n" + }, + "startYear": { + "type": "string", + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period.\n\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n" + }, + "useAs": { + "type": "string", + "example": "pinless debit", + "description": "Card Use As Field. Supported value of `pinless debit` only. Only for use with Pinless Debit tokens." + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "companyTaxID": { + "type": "string", + "example": "1234567890123456800", + "maxLength": 9, + "description": "Tax identifier for the customer\u2019s company.\n\n**Important**:\nContact your TeleCheck representative to find out whether this field is required or optional.\n" + }, + "currency": { + "type": "string", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "description": "Currency used by the customer. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha." + }, + "dateOBirth": { + "type": "string", + "format": "YYYY-MM-DD|YYYYMMDD", + "example": "1960-12-30", + "minLength": 8, + "maxLength": 10, + "description": "Date of birth of the customer.\n\nFormat: `YYYY-MM-DD` or `YYYYMMDD`\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "1234567890", + "description": "Customer's identification number.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + }, + "type": { + "type": "string", + "enum": [ + "driver license" + ], + "example": "driver license", + "description": "Type of personal identification.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + }, + "issuedBy": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "example": "CA", + "description": "State or province in which the customer\u2019s driver\u2019s license was issued. Use the State, Province, and Territory Codes for the United States and Canada.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "example": "John", + "maxLength": 60, + "description": "Customer\u2019s first name. For a credit card transaction, this name must match the name on the card.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "lastName": { + "type": "string", + "example": "Smith", + "maxLength": 60, + "description": "Customer\u2019s last name. For a credit card transaction, this name must match the name on the card.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "company": { + "type": "string", + "example": "CyberSource", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "address1": { + "type": "string", + "example": "12 Main Street", + "maxLength": 60, + "description": "First line of the billing street address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "address2": { + "type": "string", + "example": "20 My Street", + "maxLength": 60, + "description": "Additional address information." + }, + "locality": { + "type": "string", + "example": "Foster City", + "maxLength": 50, + "description": "City of the billing address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "administrativeArea": { + "type": "string", + "example": "CA", + "maxLength": 20, + "description": "State or province of the billing address. For an address in the U.S. or Canada, use the State, Province, and Territory Codes for the United States and Canada.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "postalCode": { + "type": "string", + "example": "90200", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n**Example** 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample A1B 2C3\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "country": { + "type": "string", + "example": "US", + "minLength": 2, + "maxLength": 3, + "description": "Country of the billing address. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "email": { + "type": "string", + "example": "john.smith@example.com", + "maxLength": 320, + "description": "Customer\u2019s email address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "phoneNumber": { + "type": "string", + "example": "555123456", + "minLength": 6, + "maxLength": 32, + "description": "Customer phone number. When you create a customer profile, the requirements depend on the payment method:\n * Credit cards \u2014 optional.\n * Electronic checks \u2014 contact your payment processor representative to find out if this field is required or optional.\n * PINless debits \u2014 optional.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "billPaymentProgramEnabled": { + "type": "boolean", + "example": true, + "default": false, + "description": "Indicates that the payments for this customer profile are for the Bill Payment program. Possible values:\n * false: Not a Visa Bill Payment.\n * true: Visa Bill Payment.\n" + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "SECCode": { + "type": "string", + "enum": [ + "CCD", + "PPD", + "TEL", + "WEB" + ], + "example": "WEB", + "description": "**Important** This field is required if your processor is TeleCheck.\n\nCode that specifies the authorization method for the transaction. Possible values:\n\n- **CCD**: corporate cash disbursement. Charge or credit against a business checking account. You can use one-time or recurring CCD transactions to transfer funds to or from a corporate entity. A standing authorization is required for recurring transactions.\n- **PPD**: prearranged payment and deposit entry. Charge or credit against a personal checking or savings account. You can originate a PPD entry only when the payment and deposit terms between you and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions.\n- **TEL**: telephone-initiated entry. One-time charge against a personal checking or savings account. You can originate a TEL entry only when there is a business relationship between you and the customer or when the customer initiates a telephone call to you. For a TEL entry, you must obtain a payment authorization from the customer over the telephone. There is no recurring billing option for TEL.\n- **WEB**: internet-initiated entry\u2014charge against a personal checking or savings account. You can originate a one-time or recurring WEB entry when the customer initiates the transaction over the Internet. For a WEB entry, you must obtain payment authorization from the customer over the Internet.\n" + } + } + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "alternateName": { + "type": "string", + "example": "Branch Name", + "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." + } + } + } + } + }, + "metaData": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "instrumentIdentifier" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "id": { + "type": "string", + "example": "1234567890123456789", + "minLength": 16, + "maxLength": 32, + "description": "The ID of the existing instrument identifier to be linked to the newly created payment instrument." + }, + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890123456800", + "minLength": 1, + "maxLength": 19, + "description": "Checking account number." + }, + "routingNumber": { + "type": "string", + "example": "123456789", + "minLength": 1, + "maxLength": 9, + "description": "Routing number." + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + } + } + } + } + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + } + } + } + } + }, + "examples": { + "application/json": { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/paymentinstruments/5910683634E6B035E0539399D30A4B46" + } + }, + "id": "5910683634E6B035E0539399D30A4B46", + "object": "paymentInstrument", + "state": "ACTIVE", + "card": { + "expirationMonth": 11, + "expirationYear": 2020, + "type": "visa", + "issueNumber": 1, + "startMonth": 12, + "startYear": 2017 + }, + "buyerInformation": { + "companyTaxID": 12345, + "currency": "USD" + }, + "billTo": { + "firstName": "John", + "lastName": "Smith", + "company": "Cybersource", + "address1": "1 My Apartment", + "address2": "20 My Street", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": 90210, + "country": "US", + "email": "ohn.smith@test.com", + "phoneNumber": "+44 289044795" + }, + "processingInformation": { + "billPaymentProgramEnabled": true + }, + "metadata": { + "creator": "user" + }, + "_embedded": { + "instrumentIdentifier": { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500" + } + }, + "id": "58FEBAEFD2EEFCE1E0539399D30A7500", + "object": "instrumentIdentifier", + "state": "ACTIVE", + "card": { + "number": "424242XXXXXX4242" + }, + "processingInformation": { + "authorizationOptions": { + "initiator": { + "merchantInitiatedTransaction": { + "previousTransactionId": 123456789012345 + } + } + } + }, + "metadata": { + "creator": "user" + } + } + } + } + } + }, + "400": { + "description": "Bad Request. A required header value could be missing.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1PaymentInstruments400Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "Missing Headers": { + "errors": [ + { + "type": "missingHeaders", + "message": "Missing header values." + } + ] + }, + "Payment Instrument cannot be linked to instrument identifier because it does not exist": { + "errors": [ + { + "type": "instrumentIdentifierNotFound", + "message": "Action cannot be performed. The `InstrumentIdentifier` is not found" + } + ] + }, + "Payment Instrument cannot be linked to instrument identifier because it has been deleted": { + "errors": [ + { + "type": "instrumentIdentifierGone", + "message": "Action cannot be performed. The `InstrumentIdentifier` is gone." + } + ] + }, + "Payment Instrument cannot be linked to instrument identifier due to a token type mismatch": { + "errors": [ + { + "type": "invalidCombination", + "message": "The combination is invalid.", + "details": [ + { + "name": "bankAccount" + }, + { + "name": "card", + "location": "instrumentIdentifier" + } + ] + } + ] + }, + "Payment Instrument cannot be created due to invalid combination of Instrument Identifier fields": { + "errors": [ + { + "type": "invalidCombination", + "message": "The combination is invalid.", + "details": [ + { + "name": "id", + "location": "instrumentIdentifier" + }, + { + "name": "card", + "location": "instrumentIdentifier" + } + ] + } + ] + } + } + }, + "403": { + "description": "Forbidden. The profile might not have permission to perform the token operation.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1Forbidden403Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted." + } + ] + } + } + }, + "424": { + "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1FailedDependency424Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Profile not found" + } + ] + } + } + }, + "500": { + "description": "Unexpected error.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, + "schema": { + "title": "tmsV1Error500Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Create Payment Instrument (Card)", + "value": { + "card": { + "expirationMonth": "09", + "expirationYear": "2017", + "type": "visa", + "issueNumber": "01", + "startMonth": "01", + "startYear": "2016" + }, + "buyerInformation": { + "companyTaxID": "12345", + "currency": "USD" + }, + "billTo": { + "firstName": "John", + "lastName": "Smith", + "company": "Cybersource", + "address1": "8310 Capital of Texas Highwas North", + "address2": "Bluffstone Drive", + "locality": "Austin", + "administrativeArea": "TX", + "postalCode": "78731", + "country": "United States", + "email": "john.smith@test.com", + "phoneNumber": "+44 2890447951" + }, + "processingInformation": { + "billPaymentProgramEnabled": true + }, + "instrumentIdentifier": { + "card": { + "number": "411111111111112" + } + } + } + }, + "example1": { + "summary": "Create Payment Instrument (Bank Account)", + "value": { + "bankAccount": { + "type": "savings" + }, + "buyerInformation": { + "companyTaxID": "12345", + "currency": "USD", + "dateOfBirth": "2000-12-13", + "personalIdentification": [ + { + "id": "57684432111321", + "type": "driver license", + "issuedBy": { + "administrativeArea": "CA" + } + } + ] + }, + "billTo": { + "firstName": "John", + "lastName": "Smith", + "company": "Cybersource", + "address1": "8310 Capital of Texas Highwas North", + "address2": "Bluffstone Drive", + "locality": "Austin", + "administrativeArea": "TX", + "postalCode": "78731", + "country": "United States", + "email": "john.smith@test.com", + "phoneNumber": "+44 2890447951" + }, + "processingInformation": { + "billPaymentProgramEnabled": true, + "bankTransferOptions": { + "SECCode": "WEB" + } + }, + "merchantInformation": { + "merchantDescriptor": { + "alternateName": "Branch Name" + } + }, + "instrumentIdentifier": { + "bankAccount": { + "number": "4100", + "routingNumber": "071923284" + } + } + } + }, + "example2": { + "summary": "Create Payment Instrument (Pinless Debit)", + "value": { + "card": { + "expirationMonth": "09", + "expirationYear": "2017", + "type": "visa", + "issueNumber": "01", + "startMonth": "01", + "startYear": "2016", + "useAs": "pinless debit" + }, + "buyerInformation": { + "companyTaxID": "12345", + "currency": "USD" + }, + "billTo": { + "firstName": "John", + "lastName": "Smith", + "company": "Cybersource", + "address1": "8310 Capital of Texas Highwas North", + "address2": "Bluffstone Drive", + "locality": "Austin", + "administrativeArea": "TX", + "postalCode": "78731", + "country": "United States", + "email": "john.smith@test.com", + "phoneNumber": "+44 2890447951" + }, + "processingInformation": { + "billPaymentProgramEnabled": true + }, + "instrumentIdentifier": { + "card": { + "number": "411111111111112" + } + } + } + }, + "example3": { + "summary": "Create Payment Instrument (Card with Instrument Identifier Id)", + "value": { + "card": { + "expirationMonth": "09", + "expirationYear": "2017", + "type": "visa", + "issueNumber": "01", + "startMonth": "01", + "startYear": "2016" + }, + "buyerInformation": { + "companyTaxID": "12345", + "currency": "USD" + }, + "billTo": { + "firstName": "John", + "lastName": "Smith", + "company": "Cybersource", + "address1": "8310 Capital of Texas Highwas North", + "address2": "Bluffstone Drive", + "locality": "Austin", + "administrativeArea": "TX", + "postalCode": "78731", + "country": "United States", + "email": "john.smith@test.com", + "phoneNumber": "+44 2890447951" + }, + "processingInformation": { + "billPaymentProgramEnabled": true + }, + "instrumentIdentifier": { + "id": "9000000000000000001003" + } + } + }, + "example4": { + "summary": "Create Payment Instrument (Tokenized Card)", + "value": { + "card": { + "expirationMonth": "09", + "expirationYear": "2017", + "type": "visa", + "issueNumber": "01", + "startMonth": "01", + "startYear": "2016", + "tokenizedInformation": { + "requestorID": "payment_network_token_requestor_id", + "transactionType": "payment_network_token_transaction_type" + } + }, + "buyerInformation": { + "companyTaxID": "12345", + "currency": "USD" + }, + "billTo": { + "firstName": "John", + "lastName": "Smith", + "company": "Cybersource", + "address1": "8310 Capital of Texas Highwas North", + "address2": "Bluffstone Drive", + "locality": "Austin", + "administrativeArea": "TX", + "postalCode": "78731", + "country": "United States", + "email": "john.smith@test.com", + "phoneNumber": "+44 2890447951" + }, + "processingInformation": { + "billPaymentProgramEnabled": true + }, + "instrumentIdentifier": { + "card": { + "number": "411111111111112" + } + } + } + }, + "example5": { + "summary": "Create Payment Instrument (Card & Enroll for Network Token)", + "value": { + "card": { + "expirationMonth": "09", + "expirationYear": "2017", + "type": "visa", + "issueNumber": "01", + "startMonth": "01", + "startYear": "2016" + }, + "buyerInformation": { + "companyTaxID": "12345", + "currency": "USD" + }, + "billTo": { + "firstName": "John", + "lastName": "Smith", + "company": "Cybersource", + "address1": "8310 Capital of Texas Highwas North", + "address2": "Bluffstone Drive", + "locality": "Austin", + "administrativeArea": "TX", + "postalCode": "78731", + "country": "United States", + "email": "john.smith@test.com", + "phoneNumber": "+44 2890447951" + }, + "processingInformation": { + "billPaymentProgramEnabled": true + }, + "instrumentIdentifier": { + "type": "enrollable card", + "card": { + "number": "4622943127013705", + "expirationMonth": "12", + "expirationYear": "2022", + "securityCode": "838" + }, + "billTo": { + "address1": "8310 Capital of Texas Highway North", + "address2": "Bluffstone Drive", + "locality": "Austin", + "administrativeArea": "TX", + "postalCode": "78731", + "country": "US" + } + } + } + } + } + } + }, + "/tms/v1/paymentinstruments/{tokenId}": { + "patch": { + "summary": "Update a Payment Instrument", + "parameters": [ + { + "name": "profile-id", + "in": "header", + "description": "The id of a profile containing user specific TMS configuration.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36 + }, + { + "name": "tokenId", + "in": "path", + "description": "The TokenId of a Payment Instrument.", + "required": true, + "type": "string", + "minLength": 16, + "maxLength": 32 + }, + { + "name": "updatePaymentInstrumentRequest", + "in": "body", + "description": "Specify the customer's payment details.", + "required": true, + "schema": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "paymentInstrument" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "checking", + "savings", + "corporate checking", + "general ledger" + ], + "example": "savings", + "description": "Checking account type. Possible values:\n * C: checking\n * S: savings (USD only)\n * X: corporate checking (USD only)\n * G: general ledger\n" + } + } + }, + "card": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "expirationMonth": { + "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, + "maxLength": 2, + "description": "Two-digit month in which the credit card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. For more information about relaxed requirements, see the TMS REST API Developer Guide.\n\nImportant:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "expirationYear": { + "type": "string", + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n\n**FDC Nashville Global and FDMS South**\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See Relaxed Requirements for Address Data and Expiration Date page.\n\nImportant:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + }, + "type": { + "type": "string", + "enum": [ + "visa", + "mastercard", + "american express", + "discover", + "diners club", + "carte blanche", + "jcb", + "optima", + "twinpay credit", + "twinpay debit", + "walmart", + "enroute", + "lowes consumer", + "home depot consumer", + "mbna", + "dicks sportswear", + "casual corner", + "sears", + "jal", + "disney", + "maestro uk domestic", + "sams club consumer", + "sams club business", + "nicos", + "bill me later", + "bebe", + "restoration hardware", + "delta online", + "solo", + "visa electron", + "dankort", + "laser", + "carte bleue", + "carta si", + "pinless debit", + "encoded account", + "uatp", + "household", + "maestro international", + "ge money uk", + "korean cards", + "style", + "jcrew", + "payease china processing ewallet", + "payease china processing bank transfer", + "meijer private label", + "hipercard", + "aura", + "redecard", + "orico", + "elo", + "capital one private label", + "synchrony private label", + "china union pay", + "costco private label", + "mada", + "falabella private label" + ], + "description": "Type of credit card. Possible values:\n * Visa (001)\n * Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * American Express (003)\n * Discover (004)\n * Diners Club (005)\n * Carte Blanche (006)\n * JCB (007)\n * Optima (008)\n * Twinpay Credit (011)\n * Twinpay Debit (012)\n * Walmart (013)\n * EnRoute (014)\n * Lowes consumer (015)\n * Home Depot consumer (016)\n * MBNA (017)\n * Dicks Sportswear (018)\n * Casual Corner (019)\n * Sears (020)\n * JAL (021)\n * Disney (023)\n * Maestro (024) - UK Domestic\n * Sams Club consumer (025)\n * Sams Club business (026)\n * Nicos (027)\n * Bill me later (028)\n * Bebe (029)\n * Restoration Hardware (030)\n * Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * Solo (032)\n * Visa Electron (033)\n * Dankort (034)\n * Laser (035)\n * Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * Cartes Bancaires (036)\n * Carta Si (037)\n * pinless debit (038)\n * encoded account (039)\n * UATP (040)\n * Household (041)\n * Maestro (042) - International\n * GE Money UK (043)\n * Korean cards (044)\n * Style (045)\n * JCrew (046)\n * PayEase China processing eWallet (047)\n * PayEase China processing bank transfer (048)\n * Meijer Private Label (049)\n * Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * Aura (051) \u2014 supported only by the Comercio Latino processor.\n * Redecard (052)\n * ORICO (053)\n * Elo (054) \u2014 supported only by the Comercio Latino processor.\n * Capital One Private Label (055)\n * Synchrony Private Label (056)\n * Costco Private Label (057)\n * mada (060)\n * China Union Pay (062)\n * Falabella private label (063)\n" + }, + "issueNumber": { + "type": "string", + "example": "01", + "minLength": 1, + "maxLength": 2, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder." + }, + "startMonth": { + "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period.\n\nFormat: `MM`.\nPossible values: `01` through `12`.\n" + }, + "startYear": { + "type": "string", + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period.\n\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n" + }, + "useAs": { + "type": "string", + "example": "pinless debit", + "description": "Card Use As Field. Supported value of `pinless debit` only. Only for use with Pinless Debit tokens." + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "companyTaxID": { + "type": "string", + "example": "1234567890123456800", + "maxLength": 9, + "description": "Tax identifier for the customer\u2019s company.\n\n**Important**:\nContact your TeleCheck representative to find out whether this field is required or optional.\n" + }, + "currency": { + "type": "string", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "description": "Currency used by the customer. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha." + }, + "dateOBirth": { + "type": "string", + "format": "YYYY-MM-DD|YYYYMMDD", + "example": "1960-12-30", + "minLength": 8, + "maxLength": 10, + "description": "Date of birth of the customer.\n\nFormat: `YYYY-MM-DD` or `YYYYMMDD`\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "1234567890", + "description": "Customer's identification number.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + }, + "type": { + "type": "string", + "enum": [ + "driver license" + ], + "example": "driver license", + "description": "Type of personal identification.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + }, + "issuedBy": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "example": "CA", + "description": "State or province in which the customer\u2019s driver\u2019s license was issued. Use the State, Province, and Territory Codes for the United States and Canada.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "example": "John", + "maxLength": 60, + "description": "Customer\u2019s first name. For a credit card transaction, this name must match the name on the card.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "lastName": { + "type": "string", + "example": "Smith", + "maxLength": 60, + "description": "Customer\u2019s last name. For a credit card transaction, this name must match the name on the card.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "company": { + "type": "string", + "example": "CyberSource", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "address1": { + "type": "string", + "example": "12 Main Street", + "maxLength": 60, + "description": "First line of the billing street address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "address2": { + "type": "string", + "example": "20 My Street", + "maxLength": 60, + "description": "Additional address information." + }, + "locality": { + "type": "string", + "example": "Foster City", + "maxLength": 50, + "description": "City of the billing address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "administrativeArea": { + "type": "string", + "example": "CA", + "maxLength": 20, + "description": "State or province of the billing address. For an address in the U.S. or Canada, use the State, Province, and Territory Codes for the United States and Canada.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "postalCode": { + "type": "string", + "example": "90200", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n**Example** 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample A1B 2C3\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "country": { + "type": "string", + "example": "US", + "minLength": 2, + "maxLength": 3, + "description": "Country of the billing address. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "email": { + "type": "string", + "example": "john.smith@example.com", + "maxLength": 320, + "description": "Customer\u2019s email address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "phoneNumber": { + "type": "string", + "example": "555123456", + "minLength": 6, + "maxLength": 32, + "description": "Customer phone number. When you create a customer profile, the requirements depend on the payment method:\n * Credit cards \u2014 optional.\n * Electronic checks \u2014 contact your payment processor representative to find out if this field is required or optional.\n * PINless debits \u2014 optional.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "billPaymentProgramEnabled": { + "type": "boolean", + "example": true, + "default": false, + "description": "Indicates that the payments for this customer profile are for the Bill Payment program. Possible values:\n * false: Not a Visa Bill Payment.\n * true: Visa Bill Payment.\n" + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "SECCode": { + "type": "string", + "enum": [ + "CCD", + "PPD", + "TEL", + "WEB" + ], + "example": "WEB", + "description": "**Important** This field is required if your processor is TeleCheck.\n\nCode that specifies the authorization method for the transaction. Possible values:\n\n- **CCD**: corporate cash disbursement. Charge or credit against a business checking account. You can use one-time or recurring CCD transactions to transfer funds to or from a corporate entity. A standing authorization is required for recurring transactions.\n- **PPD**: prearranged payment and deposit entry. Charge or credit against a personal checking or savings account. You can originate a PPD entry only when the payment and deposit terms between you and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions.\n- **TEL**: telephone-initiated entry. One-time charge against a personal checking or savings account. You can originate a TEL entry only when there is a business relationship between you and the customer or when the customer initiates a telephone call to you. For a TEL entry, you must obtain a payment authorization from the customer over the telephone. There is no recurring billing option for TEL.\n- **WEB**: internet-initiated entry\u2014charge against a personal checking or savings account. You can originate a one-time or recurring WEB entry when the customer initiates the transaction over the Internet. For a WEB entry, you must obtain payment authorization from the customer over the Internet.\n" + } + } + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "alternateName": { + "type": "string", + "example": "Branch Name", + "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." + } + } + } + } + }, + "metaData": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "instrumentIdentifier" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "id": { + "type": "string", + "example": "1234567890123456789", + "minLength": 16, + "maxLength": 32, + "description": "The ID of the existing instrument identifier to be linked to the newly created payment instrument." + }, + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890123456800", + "minLength": 1, + "maxLength": 19, + "description": "Checking account number." + }, + "routingNumber": { + "type": "string", + "example": "123456789", + "minLength": 1, + "maxLength": 9, + "description": "Routing number." + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + } + } + } + } + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + } + } + } + } + } + } + ], + "tags": [ + "Payment Instrument" + ], + "operationId": "updatePaymentInstrument", + "x-devcenter-metaData": { + "categoryTag": "Token_Management" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "200": { + "description": "The updated Payment Instrument has been returned.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1PaymentinstrumentsPatch200Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "paymentInstrument" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "checking", + "savings", + "corporate checking", + "general ledger" + ], + "example": "savings", + "description": "Checking account type. Possible values:\n * C: checking\n * S: savings (USD only)\n * X: corporate checking (USD only)\n * G: general ledger\n" + } + } + }, + "card": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "expirationMonth": { + "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, + "maxLength": 2, + "description": "Two-digit month in which the credit card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. For more information about relaxed requirements, see the TMS REST API Developer Guide.\n\nImportant:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "expirationYear": { + "type": "string", + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n\n**FDC Nashville Global and FDMS South**\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See Relaxed Requirements for Address Data and Expiration Date page.\n\nImportant:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + }, + "type": { + "type": "string", + "enum": [ + "visa", + "mastercard", + "american express", + "discover", + "diners club", + "carte blanche", + "jcb", + "optima", + "twinpay credit", + "twinpay debit", + "walmart", + "enroute", + "lowes consumer", + "home depot consumer", + "mbna", + "dicks sportswear", + "casual corner", + "sears", + "jal", + "disney", + "maestro uk domestic", + "sams club consumer", + "sams club business", + "nicos", + "bill me later", + "bebe", + "restoration hardware", + "delta online", + "solo", + "visa electron", + "dankort", + "laser", + "carte bleue", + "carta si", + "pinless debit", + "encoded account", + "uatp", + "household", + "maestro international", + "ge money uk", + "korean cards", + "style", + "jcrew", + "payease china processing ewallet", + "payease china processing bank transfer", + "meijer private label", + "hipercard", + "aura", + "redecard", + "orico", + "elo", + "capital one private label", + "synchrony private label", + "china union pay", + "costco private label", + "mada", + "falabella private label" + ], + "description": "Type of credit card. Possible values:\n * Visa (001)\n * Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * American Express (003)\n * Discover (004)\n * Diners Club (005)\n * Carte Blanche (006)\n * JCB (007)\n * Optima (008)\n * Twinpay Credit (011)\n * Twinpay Debit (012)\n * Walmart (013)\n * EnRoute (014)\n * Lowes consumer (015)\n * Home Depot consumer (016)\n * MBNA (017)\n * Dicks Sportswear (018)\n * Casual Corner (019)\n * Sears (020)\n * JAL (021)\n * Disney (023)\n * Maestro (024) - UK Domestic\n * Sams Club consumer (025)\n * Sams Club business (026)\n * Nicos (027)\n * Bill me later (028)\n * Bebe (029)\n * Restoration Hardware (030)\n * Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * Solo (032)\n * Visa Electron (033)\n * Dankort (034)\n * Laser (035)\n * Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * Cartes Bancaires (036)\n * Carta Si (037)\n * pinless debit (038)\n * encoded account (039)\n * UATP (040)\n * Household (041)\n * Maestro (042) - International\n * GE Money UK (043)\n * Korean cards (044)\n * Style (045)\n * JCrew (046)\n * PayEase China processing eWallet (047)\n * PayEase China processing bank transfer (048)\n * Meijer Private Label (049)\n * Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * Aura (051) \u2014 supported only by the Comercio Latino processor.\n * Redecard (052)\n * ORICO (053)\n * Elo (054) \u2014 supported only by the Comercio Latino processor.\n * Capital One Private Label (055)\n * Synchrony Private Label (056)\n * Costco Private Label (057)\n * mada (060)\n * China Union Pay (062)\n * Falabella private label (063)\n" + }, + "issueNumber": { + "type": "string", + "example": "01", + "minLength": 1, + "maxLength": 2, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder." + }, + "startMonth": { + "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period.\n\nFormat: `MM`.\nPossible values: `01` through `12`.\n" + }, + "startYear": { + "type": "string", + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period.\n\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n" + }, + "useAs": { + "type": "string", + "example": "pinless debit", + "description": "Card Use As Field. Supported value of `pinless debit` only. Only for use with Pinless Debit tokens." + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "companyTaxID": { + "type": "string", + "example": "1234567890123456800", + "maxLength": 9, + "description": "Tax identifier for the customer\u2019s company.\n\n**Important**:\nContact your TeleCheck representative to find out whether this field is required or optional.\n" + }, + "currency": { + "type": "string", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "description": "Currency used by the customer. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha." + }, + "dateOBirth": { + "type": "string", + "format": "YYYY-MM-DD|YYYYMMDD", + "example": "1960-12-30", + "minLength": 8, + "maxLength": 10, + "description": "Date of birth of the customer.\n\nFormat: `YYYY-MM-DD` or `YYYYMMDD`\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "1234567890", + "description": "Customer's identification number.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + }, + "type": { + "type": "string", + "enum": [ + "driver license" + ], + "example": "driver license", + "description": "Type of personal identification.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + }, + "issuedBy": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "example": "CA", + "description": "State or province in which the customer\u2019s driver\u2019s license was issued. Use the State, Province, and Territory Codes for the United States and Canada.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "example": "John", + "maxLength": 60, + "description": "Customer\u2019s first name. For a credit card transaction, this name must match the name on the card.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "lastName": { + "type": "string", + "example": "Smith", + "maxLength": 60, + "description": "Customer\u2019s last name. For a credit card transaction, this name must match the name on the card.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "company": { + "type": "string", + "example": "CyberSource", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "address1": { + "type": "string", + "example": "12 Main Street", + "maxLength": 60, + "description": "First line of the billing street address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "address2": { + "type": "string", + "example": "20 My Street", + "maxLength": 60, + "description": "Additional address information." + }, + "locality": { + "type": "string", + "example": "Foster City", + "maxLength": 50, + "description": "City of the billing address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "administrativeArea": { + "type": "string", + "example": "CA", + "maxLength": 20, + "description": "State or province of the billing address. For an address in the U.S. or Canada, use the State, Province, and Territory Codes for the United States and Canada.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "postalCode": { + "type": "string", + "example": "90200", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n**Example** 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample A1B 2C3\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "country": { + "type": "string", + "example": "US", + "minLength": 2, + "maxLength": 3, + "description": "Country of the billing address. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "email": { + "type": "string", + "example": "john.smith@example.com", + "maxLength": 320, + "description": "Customer\u2019s email address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "phoneNumber": { + "type": "string", + "example": "555123456", + "minLength": 6, + "maxLength": 32, + "description": "Customer phone number. When you create a customer profile, the requirements depend on the payment method:\n * Credit cards \u2014 optional.\n * Electronic checks \u2014 contact your payment processor representative to find out if this field is required or optional.\n * PINless debits \u2014 optional.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "billPaymentProgramEnabled": { + "type": "boolean", + "example": true, + "default": false, + "description": "Indicates that the payments for this customer profile are for the Bill Payment program. Possible values:\n * false: Not a Visa Bill Payment.\n * true: Visa Bill Payment.\n" + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "SECCode": { + "type": "string", + "enum": [ + "CCD", + "PPD", + "TEL", + "WEB" + ], + "example": "WEB", + "description": "**Important** This field is required if your processor is TeleCheck.\n\nCode that specifies the authorization method for the transaction. Possible values:\n\n- **CCD**: corporate cash disbursement. Charge or credit against a business checking account. You can use one-time or recurring CCD transactions to transfer funds to or from a corporate entity. A standing authorization is required for recurring transactions.\n- **PPD**: prearranged payment and deposit entry. Charge or credit against a personal checking or savings account. You can originate a PPD entry only when the payment and deposit terms between you and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions.\n- **TEL**: telephone-initiated entry. One-time charge against a personal checking or savings account. You can originate a TEL entry only when there is a business relationship between you and the customer or when the customer initiates a telephone call to you. For a TEL entry, you must obtain a payment authorization from the customer over the telephone. There is no recurring billing option for TEL.\n- **WEB**: internet-initiated entry\u2014charge against a personal checking or savings account. You can originate a one-time or recurring WEB entry when the customer initiates the transaction over the Internet. For a WEB entry, you must obtain payment authorization from the customer over the Internet.\n" + } + } + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "alternateName": { + "type": "string", + "example": "Branch Name", + "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." + } + } + } + } + }, + "metaData": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "instrumentIdentifier" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "id": { + "type": "string", + "example": "1234567890123456789", + "minLength": 16, + "maxLength": 32, + "description": "The ID of the existing instrument identifier to be linked to the newly created payment instrument." + }, + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890123456800", + "minLength": 1, + "maxLength": 19, + "description": "Checking account number." + }, + "routingNumber": { + "type": "string", + "example": "123456789", + "minLength": 1, + "maxLength": 9, + "description": "Routing number." + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + } + } + } + } + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + } + } + } + } + }, + "examples": { + "application/json": { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/paymentinstruments/5910683634E6B035E0539399D30A4B46" + } + }, + "id": "5910683634E6B035E0539399D30A4B46", + "object": "paymentInstrument", + "state": "ACTIVE", + "card": { + "expirationMonth": 11, + "expirationYear": 2020, + "type": "visa", + "issueNumber": 1, + "startMonth": 12, + "startYear": 2017 + }, + "buyerInformation": { + "companyTaxID": 12345, + "currency": "USD" + }, + "billTo": { + "firstName": "John", + "lastName": "Smith", + "company": "Cybersource", + "address1": "1 My Apartment", + "address2": "20 My Street", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": 90210, + "country": "US", + "email": "ohn.smith@test.com", + "phoneNumber": "+44 289044795" + }, + "processingInformation": { + "billPaymentProgramEnabled": true + }, + "metadata": { + "creator": "user" + }, + "_embedded": { + "instrumentIdentifier": { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500" + } + }, + "id": "58FEBAEFD2EEFCE1E0539399D30A7500", + "object": "instrumentIdentifier", + "state": "ACTIVE", + "card": { + "number": "424242XXXXXX4242" + }, + "processingInformation": { + "authorizationOptions": { + "initiator": { + "merchantInitiatedTransaction": { + "previousTransactionId": 123456789012345 + } + } + } + }, + "metadata": { + "creator": "user" + } + } + } + } + } + }, + "400": { + "description": "Bad Request. A required header value could be missing.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1PaymentInstruments400Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "Missing Headers": { + "errors": [ + { + "type": "missingHeaders", + "message": "Missing header values." + } + ] + }, + "Payment Instrument cannot be linked to instrument identifier because it does not exist": { + "errors": [ + { + "type": "instrumentIdentifierNotFound", + "message": "Action cannot be performed. The `InstrumentIdentifier` is not found" + } + ] + }, + "Payment Instrument cannot be linked to instrument identifier because it has been deleted": { + "errors": [ + { + "type": "instrumentIdentifierGone", + "message": "Action cannot be performed. The `InstrumentIdentifier` is gone." + } + ] + }, + "Payment Instrument cannot be linked to instrument identifier due to a token type mismatch": { + "errors": [ + { + "type": "invalidCombination", + "message": "The combination is invalid.", + "details": [ + { + "name": "bankAccount" + }, + { + "name": "card", + "location": "instrumentIdentifier" + } + ] + } + ] + }, + "Payment Instrument cannot be created due to invalid combination of Instrument Identifier fields": { + "errors": [ + { + "type": "invalidCombination", + "message": "The combination is invalid.", + "details": [ + { + "name": "id", + "location": "instrumentIdentifier" + }, + { + "name": "card", + "location": "instrumentIdentifier" + } + ] + } + ] + } + } + }, + "403": { + "description": "Forbidden. The profile might not have permission to perform the token operation.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1Forbidden403Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted." + } + ] + } + } + }, + "404": { + "description": "Token Not Found. The `tokenid` may not exist or was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotFound404Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Token not found" + } + ] + } + } + }, + "410": { + "description": "Token Not Available. The token has been deleted.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotAvailable410Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notAvailable", + "message": "Token not available." + } + ] + } + } + }, + "424": { + "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1FailedDependency424Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Profile not found" + } + ] + } + } + }, + "500": { + "description": "Unexpected error.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, + "schema": { + "title": "tmsV1Error500Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + } + } + } + }, + "get": { + "summary": "Retrieve a Payment Instrument", + "parameters": [ + { + "name": "profile-id", + "in": "header", + "description": "The id of a profile containing user specific TMS configuration.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36 + }, + { + "name": "tokenId", + "in": "path", + "description": "The TokenId of a Payment Instrument.", + "required": true, + "type": "string", + "minLength": 16, + "maxLength": 32 + } + ], + "tags": [ + "Payment Instrument" + ], + "operationId": "getPaymentInstrument", + "x-devcenter-metaData": { + "categoryTag": "Token_Management" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "200": { + "description": "An existing Payment Instrument associated with the supplied `tokenId` has been returned.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1PaymentinstrumentsPatch200Response", + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "id": { + "type": "string", + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "paymentInstrument" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "checking", + "savings", + "corporate checking", + "general ledger" + ], + "example": "savings", + "description": "Checking account type. Possible values:\n * C: checking\n * S: savings (USD only)\n * X: corporate checking (USD only)\n * G: general ledger\n" + } + } + }, + "card": { + "type": "object", + "required": [ + "type" + ], + "properties": { + "expirationMonth": { + "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, + "maxLength": 2, + "description": "Two-digit month in which the credit card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. For more information about relaxed requirements, see the TMS REST API Developer Guide.\n\nImportant:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "expirationYear": { + "type": "string", + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n\n**FDC Nashville Global and FDMS South**\nYou can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See Relaxed Requirements for Address Data and Expiration Date page.\n\nImportant:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + }, + "type": { + "type": "string", + "enum": [ + "visa", + "mastercard", + "american express", + "discover", + "diners club", + "carte blanche", + "jcb", + "optima", + "twinpay credit", + "twinpay debit", + "walmart", + "enroute", + "lowes consumer", + "home depot consumer", + "mbna", + "dicks sportswear", + "casual corner", + "sears", + "jal", + "disney", + "maestro uk domestic", + "sams club consumer", + "sams club business", + "nicos", + "bill me later", + "bebe", + "restoration hardware", + "delta online", + "solo", + "visa electron", + "dankort", + "laser", + "carte bleue", + "carta si", + "pinless debit", + "encoded account", + "uatp", + "household", + "maestro international", + "ge money uk", + "korean cards", + "style", + "jcrew", + "payease china processing ewallet", + "payease china processing bank transfer", + "meijer private label", + "hipercard", + "aura", + "redecard", + "orico", + "elo", + "capital one private label", + "synchrony private label", + "china union pay", + "costco private label", + "mada", + "falabella private label" + ], + "description": "Type of credit card. Possible values:\n * Visa (001)\n * Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * American Express (003)\n * Discover (004)\n * Diners Club (005)\n * Carte Blanche (006)\n * JCB (007)\n * Optima (008)\n * Twinpay Credit (011)\n * Twinpay Debit (012)\n * Walmart (013)\n * EnRoute (014)\n * Lowes consumer (015)\n * Home Depot consumer (016)\n * MBNA (017)\n * Dicks Sportswear (018)\n * Casual Corner (019)\n * Sears (020)\n * JAL (021)\n * Disney (023)\n * Maestro (024) - UK Domestic\n * Sams Club consumer (025)\n * Sams Club business (026)\n * Nicos (027)\n * Bill me later (028)\n * Bebe (029)\n * Restoration Hardware (030)\n * Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * Solo (032)\n * Visa Electron (033)\n * Dankort (034)\n * Laser (035)\n * Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * Cartes Bancaires (036)\n * Carta Si (037)\n * pinless debit (038)\n * encoded account (039)\n * UATP (040)\n * Household (041)\n * Maestro (042) - International\n * GE Money UK (043)\n * Korean cards (044)\n * Style (045)\n * JCrew (046)\n * PayEase China processing eWallet (047)\n * PayEase China processing bank transfer (048)\n * Meijer Private Label (049)\n * Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * Aura (051) \u2014 supported only by the Comercio Latino processor.\n * Redecard (052)\n * ORICO (053)\n * Elo (054) \u2014 supported only by the Comercio Latino processor.\n * Capital One Private Label (055)\n * Synchrony Private Label (056)\n * Costco Private Label (057)\n * mada (060)\n * China Union Pay (062)\n * Falabella private label (063)\n" + }, + "issueNumber": { + "type": "string", + "example": "01", + "minLength": 1, + "maxLength": 2, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder." + }, + "startMonth": { + "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period.\n\nFormat: `MM`.\nPossible values: `01` through `12`.\n" + }, + "startYear": { + "type": "string", + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period.\n\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n" + }, + "useAs": { + "type": "string", + "example": "pinless debit", + "description": "Card Use As Field. Supported value of `pinless debit` only. Only for use with Pinless Debit tokens." + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "companyTaxID": { + "type": "string", + "example": "1234567890123456800", + "maxLength": 9, + "description": "Tax identifier for the customer\u2019s company.\n\n**Important**:\nContact your TeleCheck representative to find out whether this field is required or optional.\n" + }, + "currency": { + "type": "string", + "example": "USD", + "minLength": 3, + "maxLength": 3, + "description": "Currency used by the customer. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha." + }, + "dateOBirth": { + "type": "string", + "format": "YYYY-MM-DD|YYYYMMDD", + "example": "1960-12-30", + "minLength": 8, + "maxLength": 10, + "description": "Date of birth of the customer.\n\nFormat: `YYYY-MM-DD` or `YYYYMMDD`\n" + }, + "personalIdentification": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "1234567890", + "description": "Customer's identification number.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + }, + "type": { + "type": "string", + "enum": [ + "driver license" + ], + "example": "driver license", + "description": "Type of personal identification.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + }, + "issuedBy": { + "type": "object", + "properties": { + "administrativeArea": { + "type": "string", + "example": "CA", + "description": "State or province in which the customer\u2019s driver\u2019s license was issued. Use the State, Province, and Territory Codes for the United States and Canada.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" + } + } + } + } + } + } + } + }, + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "example": "John", + "maxLength": 60, + "description": "Customer\u2019s first name. For a credit card transaction, this name must match the name on the card.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "lastName": { + "type": "string", + "example": "Smith", + "maxLength": 60, + "description": "Customer\u2019s last name. For a credit card transaction, this name must match the name on the card.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "company": { + "type": "string", + "example": "CyberSource", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "address1": { + "type": "string", + "example": "12 Main Street", + "maxLength": 60, + "description": "First line of the billing street address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "address2": { + "type": "string", + "example": "20 My Street", + "maxLength": 60, + "description": "Additional address information." + }, + "locality": { + "type": "string", + "example": "Foster City", + "maxLength": 50, + "description": "City of the billing address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "administrativeArea": { + "type": "string", + "example": "CA", + "maxLength": 20, + "description": "State or province of the billing address. For an address in the U.S. or Canada, use the State, Province, and Territory Codes for the United States and Canada.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "postalCode": { + "type": "string", + "example": "90200", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n**Example** 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space]\n[numeric][alpha][numeric]\nExample A1B 2C3\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important**:\nIt is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "country": { + "type": "string", + "example": "US", + "minLength": 2, + "maxLength": 3, + "description": "Country of the billing address. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "email": { + "type": "string", + "example": "john.smith@example.com", + "maxLength": 320, + "description": "Customer\u2019s email address.\n\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n" + }, + "phoneNumber": { + "type": "string", + "example": "555123456", + "minLength": 6, + "maxLength": 32, + "description": "Customer phone number. When you create a customer profile, the requirements depend on the payment method:\n * Credit cards \u2014 optional.\n * Electronic checks \u2014 contact your payment processor representative to find out if this field is required or optional.\n * PINless debits \u2014 optional.\n" + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "billPaymentProgramEnabled": { + "type": "boolean", + "example": true, + "default": false, + "description": "Indicates that the payments for this customer profile are for the Bill Payment program. Possible values:\n * false: Not a Visa Bill Payment.\n * true: Visa Bill Payment.\n" + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "SECCode": { + "type": "string", + "enum": [ + "CCD", + "PPD", + "TEL", + "WEB" + ], + "example": "WEB", + "description": "**Important** This field is required if your processor is TeleCheck.\n\nCode that specifies the authorization method for the transaction. Possible values:\n\n- **CCD**: corporate cash disbursement. Charge or credit against a business checking account. You can use one-time or recurring CCD transactions to transfer funds to or from a corporate entity. A standing authorization is required for recurring transactions.\n- **PPD**: prearranged payment and deposit entry. Charge or credit against a personal checking or savings account. You can originate a PPD entry only when the payment and deposit terms between you and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions.\n- **TEL**: telephone-initiated entry. One-time charge against a personal checking or savings account. You can originate a TEL entry only when there is a business relationship between you and the customer or when the customer initiates a telephone call to you. For a TEL entry, you must obtain a payment authorization from the customer over the telephone. There is no recurring billing option for TEL.\n- **WEB**: internet-initiated entry\u2014charge against a personal checking or savings account. You can originate a one-time or recurring WEB entry when the customer initiates the transaction over the Internet. For a WEB entry, you must obtain payment authorization from the customer over the Internet.\n" + } + } + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "alternateName": { + "type": "string", + "example": "Branch Name", + "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." + } + } + } + } + }, + "metaData": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + }, + "instrumentIdentifier": { + "type": "object", + "properties": { + "_links": { + "type": "object", + "readOnly": true, + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } + } + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "Describes type of token.", + "enum": [ + "instrumentIdentifier" + ] + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "Current state of the token.", + "enum": [ + "ACTIVE", + "CLOSED" + ] + }, + "id": { + "type": "string", + "example": "1234567890123456789", + "minLength": 16, + "maxLength": 32, + "description": "The ID of the existing instrument identifier to be linked to the newly created payment instrument." + }, + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." + } + } + }, + "bankAccount": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890123456800", + "minLength": 1, + "maxLength": 19, + "description": "Checking account number." + }, + "routingNumber": { + "type": "string", + "example": "123456789", + "minLength": 1, + "maxLength": 9, + "description": "Routing number." + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + } + } + } + } + } + } + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } + } + } + } + } + }, + "examples": { + "application/json": { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/paymentinstruments/5910683634E6B035E0539399D30A4B46" + } + }, + "id": "5910683634E6B035E0539399D30A4B46", + "object": "paymentInstrument", + "state": "ACTIVE", + "card": { + "expirationMonth": 11, + "expirationYear": 2020, + "type": "visa", + "issueNumber": 1, + "startMonth": 12, + "startYear": 2017 + }, + "buyerInformation": { + "companyTaxID": 12345, + "currency": "USD" + }, + "billTo": { + "firstName": "John", + "lastName": "Smith", + "company": "Cybersource", + "address1": "1 My Apartment", + "address2": "20 My Street", + "locality": "San Francisco", + "administrativeArea": "CA", + "postalCode": 90210, + "country": "US", + "email": "ohn.smith@test.com", + "phoneNumber": "+44 289044795" + }, + "processingInformation": { + "billPaymentProgramEnabled": true + }, + "metadata": { + "creator": "user" + }, + "_embedded": { + "instrumentIdentifier": { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500" + } + }, + "id": "58FEBAEFD2EEFCE1E0539399D30A7500", + "object": "instrumentIdentifier", + "state": "ACTIVE", + "card": { + "number": "424242XXXXXX4242" + }, + "processingInformation": { + "authorizationOptions": { + "initiator": { + "merchantInitiatedTransaction": { + "previousTransactionId": 123456789012345 + } + } + } + }, + "metadata": { + "creator": "user" + } + } + } + } + } + }, + "400": { + "description": "Bad Request. A required header value could be missing.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1BadRequest400Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "Missing Headers": { + "errors": [ + { + "type": "missingHeaders", + "message": "Missing header values." + } + ] + } + } + }, + "403": { + "description": "Forbidden. The profile might not have permission to perform the token operation.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1Forbidden403Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted." + } + ] + } + } + }, + "404": { + "description": "Token Not Found. The `tokenid` may not exist or was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotFound404Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Token not found" + } + ] + } + } + }, + "410": { + "description": "Token Not Available. The token has been deleted.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotAvailable410Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notAvailable", + "message": "Token not available." + } + ] + } + } + }, + "424": { + "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1FailedDependency424Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Profile not found" + } + ] + } + } + }, + "500": { + "description": "Unexpected error.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, + "schema": { + "title": "tmsV1Error500Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete a Payment Instrument", + "tags": [ + "Payment Instrument" + ], + "parameters": [ + { + "name": "profile-id", + "in": "header", + "description": "The id of a profile containing user specific TMS configuration.", + "required": true, + "type": "string", + "minLength": 36, + "maxLength": 36 + }, + { + "name": "tokenId", + "in": "path", + "description": "The TokenId of a Payment Instrument.", + "required": true, + "type": "string", + "minLength": 16, + "maxLength": 32 + } + ], + "operationId": "deletePaymentInstrument", + "x-devcenter-metaData": { + "categoryTag": "Token_Management" + }, + "consumes": [ + "application/json;charset=utf-8" + ], + "produces": [ + "application/json;charset=utf-8" + ], + "responses": { + "204": { + "description": "An existing Payment Instrument associated with the supplied `tokenId` has been deleted.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + } + }, + "403": { + "description": "Forbidden. The profile might not have permission to perform the token operation.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1Forbidden403Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted." + } + ] + } + } + }, + "404": { + "description": "Token Not Found. The `tokenid` may not exist or was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotFound404Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Token not found" + } + ] + } + } + }, + "410": { + "description": "Token Not Available. The token has been deleted.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique ID associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1TokenNotAvailable410Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notAvailable", + "message": "Token not available." + } + ] + } + } + }, + "424": { + "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "schema": { + "title": "tmsV1FailedDependency424Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Profile not found" + } + ] + } + } + }, + "500": { + "description": "Unexpected error.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, + "schema": { + "title": "tmsV1Error500Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." + }, + "details": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the field that threw the error." + }, + "location": { + "type": "string", + "description": "The location of the field that threw the error." + } + } + } + } + } + } + } + } + } + }, + "/tss/v2/transactions/{id}": { + "get": { + "summary": "Retrieve a Transaction", + "description": "Include the Request ID in the GET request to retrieve the transaction details.", + "tags": [ + "TransactionDetails" + ], + "operationId": "getTransaction", + "x-devcenter-metaData": { + "categoryTag": "Transaction_Details" + }, + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Request ID.\n", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "title": "tssV2TransactionsGet200Response", + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "rootId": { + "type": "string", + "maxLength": 26, + "description": "Payment Request Id" + }, + "reconciliationId": { + "type": "string", + "maxLength": 60, + "description": "The reconciliation id for the submitted transaction. This value is not returned for all processors.\n" + }, + "merchantId": { + "type": "string", + "description": "The description for this field is not available." + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction." + }, + "submitTimeUTC": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "applicationInformation": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The status of the submitted transaction." + }, + "reasonCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "rCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "rFlag": { + "type": "string", + "description": "The description for this field is not available." + }, + "applications": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The description for this field is not available." + }, + "status": { + "type": "string", + "description": "The description for this field is not available." + }, + "reasonCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "rCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "rFlag": { + "type": "string", + "description": "The description for this field is not available." + }, + "reconciliationId": { + "type": "string", + "description": "The description for this field is not available." + }, + "rMessage": { + "type": "string", + "description": "The description for this field is not available." + }, + "returnCode": { + "type": "string", + "description": "The description for this field is not available." + } + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "merchantCustomerId": { + "type": "string", + "maxLength": 100, + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "hashedPassword": { + "type": "string", + "maxLength": 100, + "description": "The description for this field is not available.\n" + } + } + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "applicationVersion": { + "type": "string", + "description": "The description for this field is not available." + }, + "applicationName": { + "type": "string", + "description": "The application name of client which is used to submit the request." + }, + "applicationUser": { + "type": "string", + "description": "The description for this field is not available." + }, + "comments": { + "type": "string", + "maxLength": 255, + "description": "Brief description of the order or any comment you wish to add to the order." + } + } + }, + "consumerAuthenticationInformation": { + "type": "object", + "properties": { + "eciRaw": { + "type": "string", + "maxLength": 2, + "description": "Raw electronic commerce indicator (ECI). For the description and requirements, see \"Payer Authentication,\" page 180." + }, + "cavv": { + "type": "string", + "maxLength": 40, + "description": "Cardholder authentication verification value (CAVV)." + }, + "xid": { + "type": "string", + "maxLength": 40, + "description": "Transaction identifier. For the description and requirements, see \"Payer Authentication,\" page 180." + }, + "transactionId": { + "type": "string", + "description": "Payer auth Transaction identifier." + } + } + }, + "deviceInformation": { + "type": "object", + "properties": { + "ipAddress": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n" + }, + "hostName": { + "type": "string", + "maxLength": 60, + "description": "Host name reported by the customer\u2019s browser to your Web server identified via the HTTP header." + }, + "cookiesAccepted": { + "type": "string", + "description": "Boolean that indicates whether the customer\u2019s browser accepts cookies. This field can contain one of the following values:\n - `yes`: The customer\u2019s browser accepts cookies.\n - `no`: The customer\u2019s browser does not accept cookies.\n" + } + } + }, + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The description for this field is not available." + }, + "message": { + "type": "string", + "description": "The description for this field is not available." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + }, + "installmentInformation": { + "type": "object", + "properties": { + "numberOfInstallments": { + "type": "string", + "description": "Number of Installments." + } + } + }, + "fraudMarkingInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The description for this field is not available." + } + } + }, + "merchantDefinedInformation": { + "type": "array", + "description": "The description for this field is not available.", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 50, + "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n" + }, + "value": { + "type": "string", + "maxLength": 255, + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + } + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "For the descriptions, used-by information, data types, and lengths for these fields, see Merchant Descriptors\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nFor Payouts:\n* Paymentech (22)\n" + } + } + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "middelName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s middle name.\n" + }, + "nameSuffix": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s name suffix.\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the billing street address as it appears on the credit card issuer\u2019s records.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_address1 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Additional address information.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**Atos**\nThis field must not contain colons (:).\n\n**Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions**\nThis value is used for AVS.\n\n**CyberSource through VisaNet**\n**Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks.\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_address2 field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the billing address.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**: This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the bill_city field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the billing address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**American Express Direct**\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side.\n\n**Atos**\nThis field must not contain colons (:).\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the bill_zip field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "company": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "address1": { + "type": "string", + "maxLength": 40, + "description": "First line in the street address of the company purchasing the product." + }, + "address2": { + "type": "string", + "maxLength": 40, + "description": "Additional address information for the company purchasing the product." + }, + "locality": { + "type": "string", + "maxLength": 30, + "description": "City in the address of the company purchasing the product." + }, + "administrativeArea": { + "type": "string", + "maxLength": 2, + "description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code in the address of the company purchasing the product. The postal code must consist of 5 to 9 digits.\n\nWhen the company country is the U.S., the 9-digit postal code must follow this format:\n**[5 digits][dash][4 digits]**\nExample 12345-6789\n\nWhen the company country is Canada, the 6-digit postal code must follow this format:\n**[alpha][numeric][alpha][space][numeric][alpha][numeric]**\nExample A1B 2C3\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country in the address of the company purchasing the product. Use the two-character ISO Standard Country Codes.\n" + } + } + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "title": { + "type": "string", + "maxLength": 60, + "description": "Title.\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" + } + } + }, + "shipTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Last name of the recipient.\n\n**Processor-specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the shipping address." + }, + "address2": { + "type": "string", + "maxLength": 60, + "description": "Second line of the shipping address." + }, + "locality": { + "type": "string", + "maxLength": 50, + "description": "City of the shipping address." + }, + "administrativeArea": { + "type": "string", + "maxLength": 3, + "description": "State or province of the billing address. Use the State, Province, and Territory Codes for the United States\nand Canada.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_state field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "postalCode": { + "type": "string", + "maxLength": 10, + "description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nWhen the billing country is the U.S., the 9-digit postal code must follow this format:\n[5 digits][dash][4 digits]\n\nExample 12345-6789\n\nWhen the billing country is Canada, the 6-digit postal code must follow this format:\n[alpha][numeric][alpha][space][numeric][alpha][numeric]\n\nExample A1B 2C3\n\n**American Express Direct**\\\nBefore sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the\nremaining value is longer than nine characters, truncates the value starting from the right side.\n" + }, + "company": { + "type": "string", + "maxLength": 60, + "description": "Name of the customer\u2019s company.\n\nFor processor-specific information, see the company_name field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.", + "maxLength": 2 + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Phone number associated with the shipping address." + } + } + }, + "lineItems": { + "type": "array", + "description": "Transaction Line Item data.", + "items": { + "type": "object", + "properties": { + "productCode": { + "type": "string", + "maxLength": 255, + "description": "Type of product. This value is used to determine the category that the product is in: electronic, handling,\nphysical, service, or shipping. The default value is **default**.\n\nFor a payment, when you set this field to a value other than default or any of the values related to\nshipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required.\n" + }, + "productName": { + "type": "string", + "maxLength": 255, + "description": "For PAYMENT and CAPTURE API, this field is required when above _productCode_ is not **default** or one of the\nvalues related to shipping and handling.\n" + }, + "productSku": { + "type": "string", + "maxLength": 255, + "description": "Identification code for the product. For PAYMENT and CAPTURE API, this field is required when above\n_productCode_ is not **default** or one of the values related to shipping and/or handling.\n" + }, + "taxAmount": { + "type": "string", + "maxLength": 15, + "description": "Total tax to apply to the product. This value cannot be negative. The tax amount and the offer amount must\nbe in the same currency. The tax amount field is additive.\n\nThe following example uses a two-exponent currency such as USD:\n\n1. You include each line item in your request.\n..- 1st line item has amount=10.00, quantity=1, and taxAmount=0.80\n..- 2nd line item has amount=20.00, quantity=1, and taxAmount=1.60\n2. The total amount authorized will be 32.40, not 30.00 with 2.40 of tax included.\n\nThis field is frequently used for Level II and Level III transactions.\n" + }, + "quantity": { + "type": "number", + "minimum": 1, + "maximum": 9999999999, + "description": "For a payment or capture, this field is required when _productCode_ is not **default** or one of the values\nrelated to shipping and handling.\n", + "default": 1 + }, + "unitPrice": { + "type": "string", + "maxLength": 15, + "description": "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you\ncannot include any other special characters. CyberSource truncates the amount to the correct number of decimal\nplaces.\n\nFor processor-specific information, see the amount field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "fulfillmentType": { + "type": "string", + "description": "The description for this field is not available." + } + } + } + }, + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "maxLength": 19, + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + }, + "taxAmount": { + "type": "string", + "maxLength": 12, + "description": "Total tax amount for all the items in the order.\n\nFor processor-specific information, see the total_tax_amount field in\n[Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html)\n" + }, + "authorizedAmount": { + "type": "string", + "maxLength": 15, + "description": "Amount that was authorized.\n" + }, + "settlementAmount": { + "type": "string", + "maxLength": 12, + "description": "This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder\u2019s account.\n" + }, + "settlementCurrency": { + "type": "string", + "maxLength": 3, + "description": "This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account.\n" + } + } + }, + "shippingDetails": { + "type": "object", + "properties": { + "giftWrap": { + "type": "string", + "maxLength": 3, + "description": "Boolean that indicates whether the customer requested gift wrapping for this\npurchase. This field can contain one of the following\nvalues:\n\n- `yes`: The customer requested gift wrapping.\n- `no`: The customer did not request gift wrapping.\n" + }, + "shippingMethod": { + "type": "string", + "maxLength": 10, + "description": "Shipping method for the product. Possible values:\n\n - `lowcost`: Lowest-cost service\n - `sameday`: Courier or same-day service\n - `oneday`: Next-day or overnight service\n - `twoday`: Two-day service\n - `threeday`: Three-day service\n - `pickup`: Store pick-up\n - `other`: Other shipping method\n - `none`: No shipping method because product is a service or subscription\n" + } + } + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "paymentType": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of a payment method. This is required for non-credit card payment.\n\nExamples: `SEARS`, `JCREW`, `PAYPAL`, `IDEAL`, `EPS` ...etc.\n\nPlease contact CyberSource Customer Support to enable the payment method of your choice and the value you should\nsend in your payment request for this field.\n" + }, + "type": { + "type": "string", + "description": "The type of payment method. This is required for non-credit card payment.\n\nPossible values:\n - BANK_TRANSFER\n - CARD (Default)\n - EWALLET\n - DIGITAL\n - DIRECT_DEBIT\n - INVOICE\n - PUSH_PAYMENT\n - CARRIER_BILLING\n - CASH\n - CHECK\n - CRYPTOGRAPHIC\n\nPlease contact CyberSource Customer Support to enable the payment method of your choice and the value you should\nsend in your payment request for this field.\n" + }, + "method": { + "type": "string", + "description": "This is an optional field.\n\nPlease contact CyberSource Customer Support to enable the payment method of your choice and the value you should\nsend in your payment request for this field.\n" + }, + "fundingSource": { + "type": "string", + "description": "The description for this field is not available." + }, + "fundingSourceAffiliation": { + "type": "string", + "description": "The description for this field is not available." + }, + "credential": { + "type": "string", + "description": "The description for this field is not available." + } + } + }, + "customer": { + "type": "object", + "properties": { + "customerId": { + "type": "string", + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" + } + } + }, + "card": { + "type": "object", + "properties": { + "suffix": { + "type": "string", + "description": "Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n" + }, + "prefix": { + "type": "string", + "maxLength": 6, + "description": "The description for this field is not available." + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nValid values: `01` through `12`.\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`.\n\nFor processor-specific information, see the `customer_cc_expmo` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "expirationYear": { + "type": "string", + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n\n\n**Barclays and Streamline**\\\nFor Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request.\n\n**FDC Nashville Global and FDMS South**\\\nYou can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year.\n\n**Encoded Account Numbers**\\\nFor encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`.\n\nFor processor-specific information, see the `customer_cc_expyr` field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "startMonth": { + "type": "string", + "maxLength": 2, + "description": "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "startYear": { + "type": "string", + "maxLength": 4, + "description": "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`.\n\n**Note** The start date is not required for Maestro (UK Domestic) transactions.\n" + }, + "issueNumber": { + "type": "string", + "maxLength": 5, + "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card.\n\n**Note** The issue number is not required for Maestro (UK Domestic) transactions.\n" + }, + "type": { + "type": "string", + "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n" + }, + "accountEncoderId": { + "type": "string", + "maxLength": 3, + "description": "Identifier for the issuing bank that provided the customer\u2019s encoded account number. Contact your processor for the bank\u2019s ID.\n" + }, + "useAs": { + "type": "string", + "maxLength": 20, + "description": "Flag that specifies the type of account associated with the card. The cardholder provides this information\nduring the payment process.\n\n**Cielo** and **Comercio Latino**\n\nPossible values:\n\n - CREDIT: Credit card\n - DEBIT: Debit card\n\nThis field is required for:\n - Debit transactions on Cielo and Comercio Latino.\n - Transactions with Brazilian-issued cards on CyberSource through VisaNet.\n" + } + } + }, + "invoice": { + "type": "object", + "properties": { + "number": { + "type": "string", + "description": "Invoice Number." + }, + "barcodeNumber": { + "type": "string", + "description": "Barcode Number." + }, + "expirationDate": { + "type": "string", + "description": "Expiration Date." + } + } + }, + "bank": { + "type": "object", + "properties": { + "routingNumber": { + "type": "string", + "description": "The description for this field is not available." + }, + "branchCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "swiftCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "bankCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "iban": { + "type": "string", + "description": "The description for this field is not available." + }, + "account": { + "type": "object", + "properties": { + "suffix": { + "type": "string", + "description": "The description for this field is not available." + }, + "prefix": { + "type": "string", + "description": "The description for this field is not available." + }, + "checkNumber": { + "type": "string", + "maxLength": 8, + "description": "Check number.\n\nChase Paymentech Solutions - Optional.\nCyberSource ACH Service - Not used.\nRBS WorldPay Atlanta - Optional on debits. Required on credits.\nTeleCheck - Strongly recommended on debit requests. Optional on credits.\n" + }, + "type": { + "type": "string", + "maxLength": 1, + "description": "Account type.\n\nPossible values:\n - **C**: Checking.\n - **G**: General ledger. This value is supported only on Wells Fargo ACH.\n - **S**: Savings (U.S. dollars only).\n - **X**: Corporate checking (U.S. dollars only).\n" + }, + "name": { + "type": "string", + "description": "The description for this field is not available." + }, + "checkDigit": { + "type": "string", + "description": "The description for this field is not available." + }, + "encoderId": { + "type": "string", + "maxLength": 3, + "description": "Identifier for the bank that provided the customer\u2019s encoded account number.\n\nTo obtain the bank identifier, contact your processor. See \"Encoded Account Numbers,\" page 39.\n" + } + } + }, + "mandate": { + "type": "object", + "properties": { + "referenceNumber": { + "type": "string", + "description": "The description for this field is not available." + }, + "recurringType": { + "type": "string", + "description": "The description for this field is not available." + }, + "id": { + "type": "string", + "description": "The description for this field is not available." + } + } + } + } + }, + "accountFeatures": { + "type": "object", + "properties": { + "balanceAmount": { + "type": "string", + "maxLength": 12, + "description": "Remaining balance on the account.\n" + }, + "previousBalanceAmount": { + "type": "string", + "maxLength": 12, + "description": "Remaining balance on the account.\n" + }, + "currency": { + "type": "string", + "maxLength": 5, + "description": "Currency of the remaining balance on the account. For the possible values, see the ISO Standard Currency Codes.\n" + } + } + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "paymentSolution": { + "type": "string", + "maxLength": 12, + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" + }, + "commerceIndicator": { + "type": "string", + "maxLength": 20, + "description": "Type of transaction. Some payment card companies use this information when determining discount rates. When you\nomit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file\nfor you instead of the default value listed here.\n" + }, + "businessApplicationId": { + "type": "string", + "description": "The description for this field is not available." + }, + "authorizationOptions": { + "type": "object", + "properties": { + "authType": { + "type": "string", + "maxLength": 15, + "description": "Authorization type.\n\nPossible values:\n\n - **AUTOCAPTURE**: automatic capture.\n - **STANDARDCAPTURE**: standard capture.\n - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment.\n\n**Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing**\\\nSet this field to _AUTOCAPTURE_ and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to STANDARDCAPTURE and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see \"Automatic Captures,\" page 33.\n\n**Forced Capture**\\\nSet this field to _VERBAL_ and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. For more information, see \"Forced Captures,\" page 123.\n\n**Verbal Authorization**\\\nSet this field to _VERBAL_ and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations,\" page 84.\n\nFor processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "secCode": { + "type": "string", + "description": "The description for this field is not available." + } + } + } + } + }, + "processorInformation": { + "type": "object", + "properties": { + "processor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 30, + "description": "Name of the Processor.\n" + } + } + }, + "transactionId": { + "type": "string", + "maxLength": 50, + "description": "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are\ndiscussing the transaction with your processor. Not all processors provide this value.\n" + }, + "networkTransactionId": { + "type": "string", + "description": "The description for this field is not available." + }, + "responseId": { + "type": "string", + "description": "The description for this field is not available." + }, + "providerTransactionId": { + "type": "string", + "description": "The description for this field is not available." + }, + "approvalCode": { + "type": "string", + "description": "Authorization code. Returned only when the processor returns this value.\n" + }, + "responseCode": { + "type": "string", + "maxLength": 10, + "description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\nImportant Do not use this field to evaluate the result of the authorization.\n" + }, + "avs": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "AVS result code.\n" + }, + "codeRaw": { + "type": "string", + "maxLength": 10, + "description": "AVS result code sent directly from the processor. Returned only when the processor returns this value.\nImportant Do not use this field to evaluate the result of AVS. Use for debugging purposes only.\n" + } + } + }, + "cardVerification": { + "type": "object", + "properties": { + "resultCode": { + "type": "string", + "maxLength": 1, + "description": "Result of card verification. Returned by the authorization service in the `processorInformation.cardVerification.resultCode`\nreply field. If ics_auth and ics_score are requested at the same time, the value is automatically\npassed from ics_auth to ics_score. For more information on using this field, see\n\"\"Sending the Results of Address and Card Verification Tests,\"\" page 16.\nThe field contains one of the following values:\n - `I`: Card verification number failed processor's data\n validation check.\n - `M`: Card verification number matched.\n - `N`: Card verification number not matched.\n - `P`: Card verification number not processed.\n - `S`: Card verification number is on the card but was not included in the request.\n - `U`: Card verification is not supported by the issuing bank.\n - `X`: Card verification is not supported by the payment card company.\n - Space Character: Deprecated. Ignore this value.\n - `1`: CyberSource does not support card verification for this processor or card type.\n - `2`: Processor returned value unrecognized for card verification response.\n - `3`: Processor did not return card verification result code.\n" + } + } + }, + "achVerification": { + "type": "object", + "properties": { + "resultCode": { + "type": "string", + "maxLength": 2, + "description": "Results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the possible\nvalues, see Appendix H, \"Verification Codes,\" on page 91.\n" + }, + "resultCodeRaw": { + "type": "string", + "maxLength": 10, + "description": "Raw results from the ACH verification service, which is described in \"ACH Verification,\" page 25. For the\npossible values, see Appendix H, \"Verification Codes,\" on page 91.\n" + } + } + }, + "electronicVerificationResults": { + "type": "object", + "properties": { + "email": { + "type": "string", + "maxLength": 1, + "description": "Mapped Electronic Verification response code for the customer\u2019s email address.\n" + }, + "emailRaw": { + "type": "string", + "maxLength": 1, + "description": "Raw Electronic Verification response code from the processor for the customer\u2019s email address." + }, + "name": { + "type": "string", + "maxLength": 30, + "description": "The description for this field is not available.\n" + }, + "nameRaw": { + "type": "string", + "maxLength": 30, + "description": "The description for this field is not available." + }, + "phoneNumber": { + "type": "string", + "maxLength": 1, + "description": "Mapped Electronic Verification response code for the customer\u2019s phone number.\n" + }, + "phoneNumberRaw": { + "type": "string", + "maxLength": 1, + "description": "Raw Electronic Verification response code from the processor for the customer\u2019s phone number." + }, + "street": { + "type": "string", + "maxLength": 1, + "description": "Mapped Electronic Verification response code for the customer\u2019s street address.\n" + }, + "streetRaw": { + "type": "string", + "maxLength": 1, + "description": "Raw Electronic Verification response code from the processor for the customer\u2019s street address." + }, + "postalCode": { + "type": "string", + "maxLength": 1, + "description": "Mapped Electronic Verification response code for the customer\u2019s postal code.\n" + }, + "postalCodeRaw": { + "type": "string", + "maxLength": 1, + "description": "Raw Electronic Verification response code from the processor for the customer\u2019s postal code." + } + } + }, + "systemTraceAuditNumber": { + "type": "string", + "maxLength": 6, + "description": "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.\n\n**American Express Direct**\n\nSystem trace audit number (STAN). This value identifies the transaction and is useful when investigating a\nchargeback dispute.\n\n**CyberSource through VisaNet**\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n" + }, + "responseCodeSource": { + "type": "string", + "maxLength": 1, + "description": "Used by Visa only and contains the response source/reason code that identifies the source of the response decision.\n" + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "entryMode": { + "type": "string", + "maxLength": 11, + "description": "Method of entering credit card information into the POS terminal. Possible values:\n\n - contact: Read from direct contact with chip card.\n - contactless: Read from a contactless interface using chip data.\n - keyed: Manually keyed into POS terminal.\n - msd: Read from a contactless interface using magnetic stripe data (MSD).\n - swiped: Read from credit card magnetic stripe.\n\nThe contact, contactless, and msd values are supported only for EMV transactions.\n* Applicable only for CTV for Payouts.\n" + }, + "terminalCapability": { + "type": "integer", + "minimum": 1, + "maximum": 5, + "description": "POS terminal\u2019s capability. Possible values:\n\n - 1: Terminal has a magnetic stripe reader only.\n - 2: Terminal has a magnetic stripe reader and manual entry capability.\n - 3: Terminal has manual entry capability only.\n - 4: Terminal can read chip cards.\n - 5: Terminal can read contactless chip cards.\n\nThe values of 4 and 5 are supported only for EMV transactions.\n* Applicable only for CTV for Payouts. \n" + } + } + }, + "riskInformation": { + "type": "object", + "properties": { + "profile": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The description for this field is not available." + }, + "decision": { + "type": "string", + "description": "The description for this field is not available." + } + } + }, + "rules": { + "type": "array", + "items": { + "type": "object", + "description": "Names of one or more rules that were processed, and the decisions made by the rules.", + "properties": { + "name": { + "type": "string", + "maxLength": 255, + "description": "Description of the rule as it appears in the Profile Editor." + }, + "decision": { + "type": "string", + "maxLength": 255, + "description": "Summarizes the result for the rule according to the setting that you chose in the Profile Editor.\nThis field can contain one of the following values:\n- `IGNORE`\n- `REVIEW`\n- `REJECT`\n- `ACCEPT`\n" + } + } + } + }, + "passiveProfile": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The description for this field is not available." + }, + "decision": { + "type": "string", + "description": "The description for this field is not available." + } + } + }, + "passiveRules": { + "type": "array", + "items": { + "type": "object", + "description": "Names of one or more rules that were processed, and the decisions made by the rules.", + "properties": { + "name": { + "type": "string", + "maxLength": 255, + "description": "Description of the rule as it appears in the Profile Editor." + }, + "decision": { + "type": "string", + "maxLength": 255, + "description": "Summarizes the result for the rule according to the setting that you chose in the Profile Editor.\nThis field can contain one of the following values:\n- `IGNORE`\n- `REVIEW`\n- `REJECT`\n- `ACCEPT`\n" + } + } + } + }, + "score": { + "type": "object", + "properties": { + "factorCodes": { + "type": "array", + "description": "Array of factor codes.", + "items": { + "type": "string", + "description": "Represents a factor code." + } + }, + "result": { + "type": "integer", + "description": "The description for this field is not available.\n" + } + } + }, + "localTime": { + "type": "string", + "description": "Time that the transaction was submitted in local time." + } + } + }, + "senderInformation": { + "type": "object", + "properties": { + "referenceNumber": { + "type": "string", + "maxLength": 19, + "description": "Reference number generated by you that uniquely identifies the sender." + } + } + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + }, + "relatedTransactions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + } + } + }, + "example": { + "id": "5330579740206278601009", + "rootId": "5330571038726320201013", + "reconciliationId": "53703847LK9LPPXY", + "merchantId": "pa_rbsworldpay", + "status": "PENDING", + "submitTimeUtc": "2018-07-31T17:26:14Z", + "applicationInformation": { + "status": "PENDING", + "reasonCode": "100", + "rCode": "1", + "rFlag": "SOK", + "applications": [ + { + "name": "ics_bill", + "status": "PENDING", + "reasonCode": "100", + "rCode": "1", + "rFlag": "SOK", + "reconciliationId": "53703847LK9LPPXY", + "rMessage": "Request was processed successfully.", + "returnCode": "1260000" + } + ] + }, + "buyerInformation": { + "merchantCustomerId": "123456", + "hashedPassword": "fhjfhj" + }, + "clientReferenceInformation": { + "code": "ECERT001", + "applicationVersion": "1.0", + "applicationName": "SCMP API", + "applicationUser": "ng_paymentech", + "comments": "test comment" + }, + "consumerAuthenticationInformation": { + "eciRaw": "1234", + "cavv": "12345", + "xid": "12345678", + "transactionId": "00152259513040478521" + }, + "deviceInformation": { + "ipAddress": "1.10.10.10", + "hostName": "cybs test", + "cookiesAccepted": "no" + }, + "errorInformation": { + "reason": "1", + "message": "abc", + "details": [ + { + "field": "xyz", + "reason": "1" + } + ] + }, + "installmentInformation": { + "numberOfInstallments": 0 + }, + "fraudMarkingInformation": { + "reason": "suspected" + }, + "merchantDefinedInformation": [ + { + "key": "abc", + "value": "xyz" + } + ], + "merchantInformation": { + "merchantDescriptor": { + "name": "ng_paymentech" + } + }, + "orderInformation": { + "billTo": { + "firstName": "JAMES", + "lastName": "DOUGH", + "middleName": "ROY", + "nameSuffix": "Mr", + "address1": "600 Morgan Falls Road", + "address2": "Room 2-2123", + "locality": "Atlanta", + "administrativeArea": "GA", + "postalCode": "30350", + "company": "cybersource", + "email": "jdough@cybersource.com", + "country": "US", + "title": "Manager", + "phoneNumber": "6509656111" + }, + "shipTo": { + "firstName": "Test", + "lastName": "TSS", + "address1": "201S.DivisionSt._1", + "address2": "Suite500", + "locality": "Austin", + "administrativeArea": "TX", + "postalCode": "78750", + "company": "cybs", + "country": "US", + "phoneNumber": "5120000000" + }, + "lineItems": [ + { + "productCode": "code2", + "productName": "name2", + "productSku": "KKY", + "taxAmount": "3.00", + "quantity": 2, + "unitPrice": "5.00", + "fulfillmentType": "abc" + } + ], + "amountDetails": { + "totalAmount": "100.00", + "currency": "USD", + "taxAmount": "5", + "authorizedAmount": "100.00", + "settlementAmount": "97.50", + "settlementCurrency": "USD" + }, + "shippingDetails": { + "giftWrap": "none", + "shippingMethod": "xyz" + } + }, + "paymentInformation": { + "paymentType": { + "name": "paymentProcessor1234", + "type": "CARD", + "method": "MC", + "fundingSource": "abc", + "fundingSourceAffiliation": "ab", + "credential": "xy" + }, + "customer": { + "customerId": "123" + }, + "card": { + "suffix": "1111", + "prefix": "123", + "expirationMonth": "10", + "expirationYear": "2017", + "startMonth": "11", + "startYear": "2011", + "issueNumber": "1234", + "type": "credit card", + "accountEncoderId": "12", + "useAs": "overidepaymentmethod" + }, + "invoice": { + "number": "BOLETONUM34567890123barcode12345678901231234567890", + "barcodeNumber": "barcode1234567890123barcode12345678901231234567890", + "expirationDate": "2018-01-07T07:59:59.999Z" + }, + "bank": { + "routingNumber": "routing123", + "branchCode": "branchcode1234567", + "swiftCode": "bankswift1", + "bankCode": "bankcode1212345", + "iban": "SUFF", + "account": { + "suffix": "SUFF", + "prefix": "PREF", + "checkNumber": "123456", + "type": "check", + "name": "BankAccountName123456789012345", + "checkDigit": "CD", + "encoderId": "AID" + }, + "mandate": { + "referenceNumber": "mandaterefnum1234567", + "recurringType": "direct1234", + "id": "mandateId1" + } + }, + "accountFeatures": { + "balanceAmount": "3.00", + "previousBalanceAmount": "2.00", + "currency": "usd" + } + }, + "processingInformation": { + "paymentSolution": "Visa", + "commerceIndicator": "7", + "businessApplicationId": "12345", + "authorizationOptions": { + "authType": "O" + }, + "bankTransferOptions": { + "secCode": "web" + } + }, + "processorInformation": { + "processor": { + "name": "paymentProcessor1234" + }, + "transactionId": "processortransactionid123", + "networkTransactionId": "networktransactionid67890", + "responseId": "1212", + "providerTransactionId": "78906", + "approvalCode": "authcode1234567", + "responseCode": "responsecode12345678", + "avs": { + "code": "ARM", + "codeRaw": "avsResults" + }, + "cardVerification": { + "resultCode": "Y" + }, + "achVerification": { + "resultCode": "rspcodmap", + "resultCodeRaw": "responsecode12345678" + }, + "electronicVerificationResults": { + "email": "email@email.com", + "emailRaw": "emailRaw12", + "name": "ename", + "nameRaw": "enameRaw12", + "phoneNumber": "01179", + "phoneNumberRaw": "9925551608", + "street": "123 street", + "streetRaw": "SteertRaw12", + "postalCode": "78717", + "postalCodeRaw": "1166678717" + }, + "systemTraceAuditNumber": "123456", + "responseCodeSource": "0" + }, + "pointOfSaleInformation": { + "entryMode": "posentrymode1234512", + "terminalCapability": "integer" + }, + "riskInformation": { + "profile": { + "name": "abc", + "decision": "xyz" + }, + "rules": [ + { + "name": "abc2", + "decision": "xyz2" + } + ], + "passiveProfile": { + "name": "abc3", + "decision": "xyz3" + }, + "passiveRules": [ + { + "name": "abc4", + "decision": "xyz4" + } + ], + "localTime": "2018-07-31T17:26:14Z", + "score": { + "factorCodes": [ + "AB" + ], + "result": 10 + } + }, + "senderInformation": { + "referenceNumber": "senderRefNumber1" + }, + "_links": { + "self": { + "href": "https://api.visa.com/payment/tss/v2/transactions/5330579740206278601009", + "method": "GET" + }, + "relatedTransactions": [ + { + "href": "https://api.visa.com/payment/tss/v2/transactions/5330579740206278601010", + "method": "GET" + }, + { + "href": "https://api.visa.com/payment/tss/v2/transactions/5330579740206278601011", + "method": "GET" + } + ] + } + } + } + }, + "404": { + "description": "The specified resource not found in the system." + }, + "500": { + "description": "Unexpected server error" + } + } + } + }, + "/tss/v2/searches": { + "post": { + "summary": "Create a search request", + "description": "Create a search request.\n", + "tags": [ + "SearchTransactions" + ], + "operationId": "createSearch", + "x-devcenter-metaData": { + "categoryTag": "Transaction_Search" + }, + "parameters": [ + { + "name": "createSearchRequest", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "save": { + "type": "boolean", + "description": "save or not save." + }, + "name": { + "type": "string", + "description": "The description for this field is not available.\n" + }, + "timezone": { + "type": "string", + "description": "Time Zone." + }, + "query": { + "type": "string", + "description": "transaction search query string." + }, + "offset": { + "type": "integer", + "description": "offset." + }, + "limit": { + "type": "integer", + "description": "limit on number of results." + }, + "sort": { + "type": "string", + "description": "A comma separated list of the following form - fieldName1 asc or desc, fieldName2 asc or desc, etc." + } + }, + "example": { + "save": "false", + "name": "Search By Code", + "timezone": "America/Chicago", + "query": "clientReferenceInformation.code:123456 AND submitTimeUtc:[NOW/DAY-7DAYS TO NOW/DAY+1DAY}", + "offset": 0, + "limit": 100, + "sort": "id:asc, submitTimeUtc:asc" + } + } + } + ], + "responses": { + "201": { + "description": "Successful response.", + "schema": { + "type": "object", + "title": "tssV2TransactionsPost201Response", + "properties": { + "searchId": { + "type": "string", + "maxLength": 60, + "description": "An unique identification number assigned by CyberSource to identify each Search request." + }, + "save": { + "type": "boolean", + "description": "save or not save." + }, + "name": { + "type": "string", + "description": "The description for this field is not available.\n" + }, + "timezone": { + "type": "string", + "description": "Time Zone." + }, + "query": { + "type": "string", + "description": "transaction search query string." + }, + "offset": { + "type": "integer", + "description": "offset." + }, + "limit": { + "type": "integer", + "description": "limit on number of results." + }, + "sort": { + "type": "string", + "description": "A comma separated list of the following form - fieldName1 asc or desc, fieldName2 asc or desc, etc." + }, + "count": { + "type": "integer", + "description": "Results for this page, this could be below the limit." + }, + "totalCount": { + "type": "integer", + "description": "total number of results." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "_embedded": { + "type": "object", + "properties": { + "transactionSummaries": { + "type": "array", + "description": "transaction search summary", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "merchantId": { + "type": "string", + "description": "The description for this field is not available." + }, + "applicationInformation": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The status of the submitted transaction." + }, + "reasonCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "rCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "rFlag": { + "type": "string", + "description": "The description for this field is not available." + }, + "applications": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The description for this field is not available." + }, + "status": { + "type": "string", + "description": "The description for this field is not available." + }, + "reasonCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "rCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "rFlag": { + "type": "string", + "description": "The description for this field is not available." + }, + "reconciliationId": { + "type": "string", + "description": "The description for this field is not available." + }, + "rMessage": { + "type": "string", + "description": "The description for this field is not available." + }, + "returnCode": { + "type": "string", + "description": "The description for this field is not available." + } + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "merchantCustomerId": { + "type": "string", + "maxLength": 100, + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "applicationName": { + "type": "string", + "description": "The application name of client which is used to submit the request." + }, + "applicationUser": { + "type": "string", + "description": "The description for this field is not available." + } + } + }, + "consumerAuthenticationInformation": { + "type": "object", + "properties": { + "xid": { + "type": "string", + "maxLength": 40, + "description": "Transaction identifier. For the description and requirements, see \"Payer Authentication,\" page 180." + }, + "transactionId": { + "type": "string", + "description": "Payer auth Transaction identifier." + } + } + }, + "deviceInformation": { + "type": "object", + "properties": { + "ipAddress": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n" + } + } + }, + "fraudMarkingInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The description for this field is not available." + } + } + }, + "merchantDefinedInformation": { + "type": "array", + "description": "The description for this field is not available.", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 50, + "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n" + }, + "value": { + "type": "string", + "maxLength": 255, + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + } + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "resellerId": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" + } + } + }, + "shipTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Last name of the recipient.\n\n**Processor-specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the shipping address." + }, + "country": { + "type": "string", + "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.", + "maxLength": 2 + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Phone number associated with the shipping address." + } + } + }, + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "maxLength": 19, + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "paymentType": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of payment method. This is required for non-credit card payment.\n\nPossible values:\n - BANK_TRANSFER\n - CARD (Default)\n - EWALLET\n - DIGITAL\n - DIRECT_DEBIT\n - INVOICE\n - PUSH_PAYMENT\n - CARRIER_BILLING\n - CASH\n - CHECK\n - CRYPTOGRAPHIC\n\nPlease contact CyberSource Customer Support to enable the payment method of your choice and the value you should\nsend in your payment request for this field.\n" + }, + "method": { + "type": "string", + "description": "This is an optional field.\n\nPlease contact CyberSource Customer Support to enable the payment method of your choice and the value you should\nsend in your payment request for this field.\n" + } + } + }, + "customer": { + "type": "object", + "properties": { + "customerId": { + "type": "string", + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" + } + } + }, + "card": { + "type": "object", + "properties": { + "suffix": { + "type": "string", + "description": "Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n" + }, + "prefix": { + "type": "string", + "maxLength": 6, + "description": "The description for this field is not available." + }, + "type": { + "type": "string", + "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n" + } + } + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "paymentSolution": { + "type": "string", + "maxLength": 12, + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" + }, + "businessApplicationId": { + "type": "string", + "description": "The description for this field is not available." + } + } + }, + "processorInformation": { + "type": "object", + "properties": { + "processor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 30, + "description": "Name of the Processor.\n" + } + } + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "terminalId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the terminal at your retail location. You can define this value yourself, but consult the\nprocessor for requirements.\n\nFor Payouts: This field is applicable for CtV.\n" + }, + "terminalSerialNumber": { + "type": "string", + "maxLength": 32, + "description": "Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that\nis installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "deviceId": { + "type": "string", + "description": "The description for this field is not available." + }, + "partner": { + "type": "object", + "properties": { + "originalTransactionId": { + "type": "string", + "maxLength": 32, + "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + }, + "riskInformation": { + "type": "object", + "properties": { + "providers": { + "type": "object", + "properties": { + "fingerprint": { + "type": "object", + "properties": { + "true_ipaddress": { + "type": "string", + "maxLength": 255, + "description": "The description for this field is not available." + }, + "hash": { + "type": "string", + "maxLength": 255, + "description": "The description for this field is not available." + }, + "smartId": { + "type": "string", + "maxLength": 255, + "description": "The description for this field is not available." + } + } + } + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "transactionDetail": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + } + } + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + } + }, + "example": { + "searchId": "87e1e4bd-cac2-49b1-919a-4d5e29a2e55d", + "save": "false", + "name": "Search By Code", + "timezone": "America/Chicago", + "query": "clientReferenceInformation.code:12345 AND submitTimeUtc:[NOW/DAY-7DAYS TO NOW/DAY+1DAY}", + "offset": 0, + "limit": 2000, + "sort": "id:asc, submitTimeUtc:asc", + "count": 22, + "totalCount": 22, + "submitTimeUtc": "2018-09-18T16:59:28Z", + "_embedded": { + "transactionSummaries": [ + { + "id": "5217848115816817001541", + "submitTimeUtc": "2018-03-23T06:00:11Z", + "merchantId": "sandeep_wf", + "applicationInformation": { + "status": "TRANSMITTED", + "reasonCode": "123", + "rCode": "1", + "rFlag": "SOK", + "applications": [ + { + "name": "ics_service_fee_calculate", + "status": "TRANSMITTED", + "reasonCode": "123", + "rCode": "1", + "rFlag": "SOK", + "reconciliationId": "55557", + "rMessage": "Request was processed successfully", + "returnCode": "1040000" + } + ] + }, + "buyerInformation": { + "merchantCustomerId": "123456" + }, + "clientReferenceInformation": { + "code": "12345", + "applicationName": "Service Fee Request", + "applicationUser": "sandeep_wf" + }, + "consumerAuthenticationInformation": { + "xid": "12345678", + "transactionId": "00152259513040478521" + }, + "deviceInformation": { + "ipAddress": "1.10.10.10" + }, + "fraudMarkingInformation": { + "reason": "fraud txn" + }, + "merchantDefinedInformation": [ + { + "key": "abc", + "value": "xyz" + } + ], + "merchantInformation": { + "resellerId": "wfbmcp" + }, + "orderInformation": { + "billTo": { + "firstName": "Test", + "lastName": "TSS", + "email": "null@cybersource.com", + "country": "US", + "phoneNumber": "5120000000" + }, + "shipTo": { + "firstName": "Test", + "lastName": "TSS", + "address1": "201S.DivisionSt._1", + "country": "US", + "phoneNumber": "5120000000" + }, + "amountDetails": { + "totalAmount": "100.00", + "currency": "USD" + } + }, + "paymentInformation": { + "paymentType": { + "type": "CARD", + "method": "MC" + }, + "customer": { + "customerId": "12345" + }, + "card": { + "suffix": "1111", + "prefix": "123456", + "type": "credit card" + } + }, + "processingInformation": { + "paymentSolution": "xyz", + "businessApplicationId": "12345" + }, + "processorInformation": { + "processor": { + "name": "FirstData" + } + }, + "pointOfSaleInformation": { + "terminalId": "1", + "terminalSerialNumber": "123111123", + "deviceId": "asfaf12312313", + "partner": { + "originalTransactionId": "131231414414" + } + }, + "riskInformation": { + "providers": { + "fingerprint": { + "true_ipaddress": "1.101.102.112", + "hash": "tuWmt8Ubw0EAybBF3wrZcEqIcZsLr8YPldTQDUxAg2k=", + "smart_id": "23442fdadfa" + } + } + }, + "_links": { + "transactionDetail": { + "href": "https://sl73paysvapq002.visa.com:2031/payment/tss/v2/transactions/5217848115816817001541", + "method": "GET" + } + } + } + ] + }, + "_links": { + "self": { + "href": "https://sl73paysvapq002.visa.com:2031/payment/tss/v2/searches/87e1e4bd-cac2-49b1-919a-4d5e29a2e55d", + "method": "GET" + } + } + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "title": "tssV2TransactionsPost400Response", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "502": { + "description": "Unexpected system error or system timeout.", + "schema": { + "title": "tssV2TransactionsPost502Response", + "type": "object", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - SERVER_ERROR\n", + "enum": [ + "SERVER_ERROR" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - SYSTEM_ERROR\n - SERVER_TIMEOUT\n - SERVICE_TIMEOUT\n - INVALID_OR_MISSING_CONFIG\n - PROCESSOR_TIMEOUT\n", + "enum": [ + "SYSTEM_ERROR", + "SERVER_TIMEOUT", + "SERVICE_TIMEOUT", + "INVALID_OR_MISSING_CONFIG", + "PROCESSOR_TIMEOUT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + } + } + } + } + }, + "x-example": { + "example0": { + "summary": "Create a search request", + "value": { + "save": "false", + "name": "MRN", + "timezone": "America/Chicago", + "query": "clientReferenceInformation.code:TC50171_3 AND submitTimeUtc:[NOW/DAY-7DAYS TO NOW/DAY+1DAY}", + "offset": 0, + "limit": 100, + "sort": "id:asc,submitTimeUtc:asc" + } + } + } + } + }, + "/tss/v2/searches/{searchId}": { + "get": { + "summary": "Get Search results", + "description": "Include the Search ID in the GET request to retrieve the search results.\n", + "tags": [ + "SearchTransactions" + ], + "operationId": "getSearch", + "x-devcenter-metaData": { + "categoryTag": "Transaction_Search" + }, + "parameters": [ + { + "name": "searchId", + "in": "path", + "description": "Search ID.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Successful response.", + "schema": { + "type": "object", + "title": "tssV2TransactionsPost201Response", + "properties": { + "searchId": { + "type": "string", + "maxLength": 60, + "description": "An unique identification number assigned by CyberSource to identify each Search request." + }, + "save": { + "type": "boolean", + "description": "save or not save." + }, + "name": { + "type": "string", + "description": "The description for this field is not available.\n" + }, + "timezone": { + "type": "string", + "description": "Time Zone." + }, + "query": { + "type": "string", + "description": "transaction search query string." + }, + "offset": { + "type": "integer", + "description": "offset." + }, + "limit": { + "type": "integer", + "description": "limit on number of results." + }, + "sort": { + "type": "string", + "description": "A comma separated list of the following form - fieldName1 asc or desc, fieldName2 asc or desc, etc." + }, + "count": { + "type": "integer", + "description": "Results for this page, this could be below the limit." + }, + "totalCount": { + "type": "integer", + "description": "total number of results." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "_embedded": { + "type": "object", + "properties": { + "transactionSummaries": { + "type": "array", + "description": "transaction search summary", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + }, + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "merchantId": { + "type": "string", + "description": "The description for this field is not available." + }, + "applicationInformation": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The status of the submitted transaction." + }, + "reasonCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "rCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "rFlag": { + "type": "string", + "description": "The description for this field is not available." + }, + "applications": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The description for this field is not available." + }, + "status": { + "type": "string", + "description": "The description for this field is not available." + }, + "reasonCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "rCode": { + "type": "string", + "description": "The description for this field is not available." + }, + "rFlag": { + "type": "string", + "description": "The description for this field is not available." + }, + "reconciliationId": { + "type": "string", + "description": "The description for this field is not available." + }, + "rMessage": { + "type": "string", + "description": "The description for this field is not available." + }, + "returnCode": { + "type": "string", + "description": "The description for this field is not available." + } + } + } + } + } + }, + "buyerInformation": { + "type": "object", + "properties": { + "merchantCustomerId": { + "type": "string", + "maxLength": 100, + "description": "Your identifier for the customer.\n\nWhen a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100.\n\n**Comercio Latino**\\\nFor recurring payments in Mexico, the value is the customer\u2019s contract number.\nNote Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions.\n\n**Litle**\\\nFor a follow-on credit with Litle, CyberSource checks the following locations, in the order\ngiven, for a customer account ID value and uses the first value it finds:\n1. `customer_account_id` value in the follow-on credit request\n2. Customer account ID value that was used for the capture that is being credited\n3. Customer account ID value that was used for the original authorization\nIf a customer account ID value cannot be found in any of these locations, then no value is used.\n\nFor processor-specific information, see the customer_account_id field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } + } + }, + "clientReferenceInformation": { + "type": "object", + "properties": { + "code": { + "type": "string", + "maxLength": 50, + "description": "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each\ntransaction so that you can perform meaningful searches for the transaction.\n\nFor information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n**FDC Nashville Global**\\\nCertain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.\n" + }, + "applicationName": { + "type": "string", + "description": "The application name of client which is used to submit the request." + }, + "applicationUser": { + "type": "string", + "description": "The description for this field is not available." + } + } + }, + "consumerAuthenticationInformation": { + "type": "object", + "properties": { + "xid": { + "type": "string", + "maxLength": 40, + "description": "Transaction identifier. For the description and requirements, see \"Payer Authentication,\" page 180." + }, + "transactionId": { + "type": "string", + "description": "Payer auth Transaction identifier." + } + } + }, + "deviceInformation": { + "type": "object", + "properties": { + "ipAddress": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s IP address, such as 10.1.27.63, reported by your Web server via socket information.\n" + } + } + }, + "fraudMarkingInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "description": "The description for this field is not available." + } + } + }, + "merchantDefinedInformation": { + "type": "array", + "description": "The description for this field is not available.", + "items": { + "type": "object", + "properties": { + "key": { + "type": "string", + "maxLength": 50, + "description": "The name you assign for your merchant-defined data field.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].key and\nmerchantDefinedInformation[1].key for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n" + }, + "value": { + "type": "string", + "maxLength": 255, + "description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n**CyberSource through VisaNet**\\\nFor installment payments with Mastercard in Brazil, use merchantDefinedInformation[0].value and\nmerchantDefinedInformation[1].value for data that you want to provide to the issuer to identify the\ntransaction.\n\nSee \"Installment Payments on CyberSource through VisaNet,\" page 142.\n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n" + } + } + } + }, + "merchantInformation": { + "type": "object", + "properties": { + "resellerId": { + "type": "string", + "maxLength": 26, + "description": "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource." + } + } + }, + "orderInformation": { + "type": "object", + "properties": { + "billTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s first name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\n**For Payouts**:\\\nThis field may be sent only for FDC Compass.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_firstname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Customer\u2019s last name. This name must be the same as the name on the card.\n\n**CyberSource Latin American Processing**\\\n**Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\\n**Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports.\n\n**CyberSource through VisaNet**\\\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\\\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n**For Payouts** : This field may be sent only for FDC Compass.\n\nFor processor-specific information, see the customer_lastname field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "email": { + "type": "string", + "maxLength": 255, + "description": "Customer's email address, including the full domain name.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the customer_email field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "country": { + "type": "string", + "maxLength": 2, + "description": "Country of the billing address. Use the two-character ISO Standard Country Codes.\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n\nccAuthService\n(Required when the billing country is the U.S. or Canada; otherwise, optional.)\nThis field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75.\nImportant It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\nFor processor-specific information, see the bill_country field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Customer\u2019s phone number.\n\nFor Payouts: This field may be sent only for FDC Compass.\n\nCyberSource recommends that you include the country code when the order is from outside the U.S.\n\nFor processor-specific information, see the customer_phone field in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**CyberSource through VisaNet**\nCredit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks.\n" + } + } + }, + "shipTo": { + "type": "object", + "properties": { + "firstName": { + "type": "string", + "maxLength": 60, + "description": "First name of the recipient.\n\n**Processor specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" + }, + "lastName": { + "type": "string", + "maxLength": 60, + "description": "Last name of the recipient.\n\n**Processor-specific maximum length**\n\n- Litle: 25\n- All other processors: 60\n" + }, + "address1": { + "type": "string", + "maxLength": 60, + "description": "First line of the shipping address." + }, + "country": { + "type": "string", + "description": "Country of the shipping address. Use the two-character ISO Standard Country Codes.", + "maxLength": 2 + }, + "phoneNumber": { + "type": "string", + "maxLength": 15, + "description": "Phone number associated with the shipping address." + } + } + }, + "amountDetails": { + "type": "object", + "properties": { + "totalAmount": { + "type": "string", + "maxLength": 19, + "description": "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special\ncharacters. CyberSource truncates the amount to the correct number of decimal places.\n\n**Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.\n\n**Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:\n\uf06e Table 15, \"Authorization Information for Specific Processors,\" on page 43\n\uf06e Table 19, \"Capture Information for Specific Processors,\" on page 58\n\uf06e Table 23, \"Credit Information for Specific Processors,\" on page 75\nIf your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247.\n\n**DCC with a Third-Party Provider**\\\nSet this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.\n\n**FDMS South**\\\nIf you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.\n\n**DCC for First Data**\\\nNot used.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character ISO Standard Currency Codes.\n\nFor an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API.\n\n**DCC for First Data**\\\nYour local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113.\n" + } + } + } + } + }, + "paymentInformation": { + "type": "object", + "properties": { + "paymentType": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of payment method. This is required for non-credit card payment.\n\nPossible values:\n - BANK_TRANSFER\n - CARD (Default)\n - EWALLET\n - DIGITAL\n - DIRECT_DEBIT\n - INVOICE\n - PUSH_PAYMENT\n - CARRIER_BILLING\n - CASH\n - CHECK\n - CRYPTOGRAPHIC\n\nPlease contact CyberSource Customer Support to enable the payment method of your choice and the value you should\nsend in your payment request for this field.\n" + }, + "method": { + "type": "string", + "description": "This is an optional field.\n\nPlease contact CyberSource Customer Support to enable the payment method of your choice and the value you should\nsend in your payment request for this field.\n" + } + } + }, + "customer": { + "type": "object", + "properties": { + "customerId": { + "type": "string", + "description": "Unique identifier for the customer's card and billing information.\n\nWhen you use Payment Tokenization or Recurring Billing and you include this value in\nyour request, many of the fields that are normally required for an authorization or credit\nbecome optional.\n\n**NOTE** When you use Payment Tokenization or Recurring Billing, the value for the Customer ID is actually the Cybersource payment token for a customer. This token stores information such as the consumer\u2019s card number so it can be applied towards bill payments, recurring payments, or one-time payments. By using this token in a payment API request, the merchant doesn't need to pass in data such as the card number or expiration date in the request itself.\n\nSee \"Payment Tokenization,\" page 222, and \"Recurring Billing,\" page 225.\n" + } + } + }, + "card": { + "type": "object", + "properties": { + "suffix": { + "type": "string", + "description": "Last four digits of the cardholder\u2019s account number. This field is returned only for tokenized transactions.\nYou can use this value on the receipt that you give to the cardholder.\n" + }, + "prefix": { + "type": "string", + "maxLength": 6, + "description": "The description for this field is not available." + }, + "type": { + "type": "string", + "description": "Type of card to authorize.\n- 001 Visa\n- 002 Mastercard\n- 003 Amex\n- 004 Discover\n- 005: Diners Club\n- 007: JCB\n- 024: Maestro (UK Domestic)\n- 039 Encoded account number\n- 042: Maestro (International)\n" + } + } + } + } + }, + "processingInformation": { + "type": "object", + "properties": { + "paymentSolution": { + "type": "string", + "maxLength": 12, + "description": "Type of digital payment solution for the transaction. Possible Values:\n\n - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.\n - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153.\n" + }, + "businessApplicationId": { + "type": "string", + "description": "The description for this field is not available." + } + } + }, + "processorInformation": { + "type": "object", + "properties": { + "processor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "maxLength": 30, + "description": "Name of the Processor.\n" + } + } + } + } + }, + "pointOfSaleInformation": { + "type": "object", + "properties": { + "terminalId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the terminal at your retail location. You can define this value yourself, but consult the\nprocessor for requirements.\n\nFor Payouts: This field is applicable for CtV.\n" + }, + "terminalSerialNumber": { + "type": "string", + "maxLength": 32, + "description": "Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that\nis installed on the POS terminal.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "deviceId": { + "type": "string", + "description": "The description for this field is not available." + }, + "partner": { + "type": "object", + "properties": { + "originalTransactionId": { + "type": "string", + "maxLength": 32, + "description": "Value that links the previous transaction to the current follow-on request. This value is assigned by the client\nsoftware that is installed on the POS terminal, which makes it available to the terminal\u2019s software and to\nCyberSource. Therefore, you can use this value to reconcile transactions between CyberSource and the terminal\u2019s\nsoftware.\n\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource\nreporting functionality.\n\nThis field is supported only on American Express Direct, FDC Nashville Global, and SIX.\n" + }, + "developerId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the developer that helped integrate a partner solution to CyberSource.\n\nSend this value in all requests that are sent through the partner solutions built by that developer.\nCyberSource assigns the ID to the developer.\n\nNote When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + }, + "solutionId": { + "type": "string", + "maxLength": 8, + "description": "Identifier for the partner that is integrated to CyberSource.\n\nSend this value in all requests that are sent through the partner solution. CyberSource assigns the ID to the partner.\n\nNote When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } + } + } + }, + "riskInformation": { + "type": "object", + "properties": { + "providers": { + "type": "object", + "properties": { + "fingerprint": { + "type": "object", + "properties": { + "true_ipaddress": { + "type": "string", + "maxLength": 255, + "description": "The description for this field is not available." + }, + "hash": { + "type": "string", + "maxLength": 255, + "description": "The description for this field is not available." + }, + "smartId": { + "type": "string", + "maxLength": 255, + "description": "The description for this field is not available." + } + } + } + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "transactionDetail": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + } + } + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "This is the endpoint of the resource that was created by the successful request." + }, + "method": { + "type": "string", + "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + } + } + } + } + } + }, + "example": { + "searchId": "87e1e4bd-cac2-49b1-919a-4d5e29a2e55d", + "save": "false", + "name": "Search By Code", + "timezone": "America/Chicago", + "query": "clientReferenceInformation.code:12345 AND submitTimeUtc:[NOW/DAY-7DAYS TO NOW/DAY+1DAY}", + "offset": 0, + "limit": 2000, + "sort": "id:asc, submitTimeUtc:asc", + "count": 22, + "totalCount": 22, + "submitTimeUtc": "2018-09-18T16:59:28Z", + "_embedded": { + "transactionSummaries": [ + { + "id": "5217848115816817001541", + "submitTimeUtc": "2018-03-23T06:00:11Z", + "merchantId": "sandeep_wf", + "applicationInformation": { + "status": "TRANSMITTED", + "reasonCode": "123", + "rCode": "1", + "rFlag": "SOK", + "applications": [ + { + "name": "ics_service_fee_calculate", + "status": "TRANSMITTED", + "reasonCode": "123", + "rCode": "1", + "rFlag": "SOK", + "reconciliationId": "55557", + "rMessage": "Request was processed successfully", + "returnCode": "1040000" + } + ] + }, + "buyerInformation": { + "merchantCustomerId": "123456" + }, + "clientReferenceInformation": { + "code": "12345", + "applicationName": "Service Fee Request", + "applicationUser": "sandeep_wf" + }, + "consumerAuthenticationInformation": { + "xid": "12345678", + "transactionId": "00152259513040478521" + }, + "deviceInformation": { + "ipAddress": "1.10.10.10" + }, + "fraudMarkingInformation": { + "reason": "fraud txn" + }, + "merchantDefinedInformation": [ + { + "key": "abc", + "value": "xyz" + } + ], + "merchantInformation": { + "resellerId": "wfbmcp" + }, + "orderInformation": { + "billTo": { + "firstName": "Test", + "lastName": "TSS", + "email": "null@cybersource.com", + "country": "US", + "phoneNumber": "5120000000" + }, + "shipTo": { + "firstName": "Test", + "lastName": "TSS", + "address1": "201S.DivisionSt._1", + "country": "US", + "phoneNumber": "5120000000" + }, + "amountDetails": { + "totalAmount": "100.00", + "currency": "USD" + } + }, + "paymentInformation": { + "paymentType": { + "type": "CARD", + "method": "MC" + }, + "customer": { + "customerId": "12345" + }, + "card": { + "suffix": "1111", + "prefix": "123456", + "type": "credit card" + } + }, + "processingInformation": { + "paymentSolution": "xyz", + "businessApplicationId": "12345" + }, + "processorInformation": { + "processor": { + "name": "FirstData" + } + }, + "pointOfSaleInformation": { + "terminalId": "1", + "terminalSerialNumber": "123111123", + "deviceId": "asfaf12312313", + "partner": { + "originalTransactionId": "131231414414" + } + }, + "riskInformation": { + "providers": { + "fingerprint": { + "true_ipaddress": "1.101.102.112", + "hash": "tuWmt8Ubw0EAybBF3wrZcEqIcZsLr8YPldTQDUxAg2k=", + "smart_id": "23442fdadfa" + } + } + }, + "_links": { + "transactionDetail": { + "href": "https://sl73paysvapq002.visa.com:2031/payment/tss/v2/transactions/5217848115816817001541", + "method": "GET" + } + } + } + ] + }, + "_links": { + "self": { + "href": "https://sl73paysvapq002.visa.com:2031/payment/tss/v2/searches/87e1e4bd-cac2-49b1-919a-4d5e29a2e55d", + "method": "GET" + } + } + } + } + }, + "404": { + "description": "The specified resource not found in the system." + }, + "500": { + "description": "Unexpected server error." + } + } + } + }, + "/ums/v1/users": { + "get": { + "summary": "Get user based on organization Id, username, permission and role", + "description": "This endpoint is to get all the user information depending on the filter criteria passed in the query.", + "tags": [ + "UserManagement" + ], + "operationId": "getUsers", + "x-devcenter-metaData": { + "categoryTag": "User_Management" + }, + "x-queryParameterDefaults": { + "organizationId": "testrest", + "permissionId": "CustomerProfileViewPermission" + }, + "parameters": [ + { + "in": "query", + "name": "organizationId", + "type": "string", + "description": "This is the orgId of the organization which the user belongs to." + }, + { + "in": "query", + "name": "userName", + "type": "string", + "description": "User ID of the user you want to get details on." + }, + { + "in": "query", + "name": "permissionId", + "type": "string", + "description": "permission that you are trying to search user on." + }, + { + "in": "query", + "name": "roleId", + "type": "string", + "description": "role of the user you are trying to search on." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "title": "umsV1UsersGet200Response", + "properties": { + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "accountInformation": { + "type": "object", + "properties": { + "userName": { + "type": "string" + }, + "roleId": { + "type": "string" + }, + "permissions": { + "type": "array", + "items": { + "type": "string", + "description": "array of permissions" + } + }, + "status": { + "type": "string", + "enum": [ + "active", + "inactive", + "locked", + "disabled", + "forgotpassword", + "deleted" + ] + }, + "createdTime": { + "type": "string", + "format": "date-time" + }, + "lastAccessTime": { + "type": "string", + "format": "date-time" + }, + "languagePreference": { + "type": "string" + }, + "timezone": { + "type": "string" + } + } + }, + "organizationInformation": { + "type": "object", + "properties": { + "organizationId": { + "type": "string" + } + } + }, + "contactInformation": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "lastName": { + "type": "string" + } + } + }, + "customFields": { + "additionalProperties": { + "type": "string" + } + } + } + } + } + }, + "example": { + "users": [ + { + "accountInformation": { + "userName": "auto_nonmember", + "roleId": "admin", + "permissions": [ + "ReportViewPermission", + "ReportGeneratePermission" + ], + "status": "active", + "createdTime": "2018-06-14T19:45:52.093Z", + "lastAccessTime": "2018-06-14T19:45:52.093Z", + "languagePreference": "en-US", + "timezone": "America/Los_Angeles" + }, + "organizationInformation": { + "organizationId": "auto_nonmember" + }, + "contactInformation": { + "email": "auto_nonmember@exchange.com", + "phoneNumber": "4445551234", + "firstName": "Zeta", + "lastName": "DMH" + }, + "customFields": { + "employeeId": "12344", + "employeeName": "John Doe", + "employeeDesignation": "abc", + "zone": "NA", + "department": "map" + } + } + ] + } + } + }, + "400": { + "description": "Invalid request.", + "schema": { + "type": "object", + "title": "umsV1UsersGet400Response", + "properties": { + "submitTimeUtc": { + "type": "string", + "description": "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ`\nExample `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the\ntime. The `Z` indicates UTC.\n" + }, + "status": { + "type": "string", + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n", + "enum": [ + "INVALID_REQUEST" + ] + }, + "reason": { + "type": "string", + "description": "The reason of the status.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n - DUPLICATE_REQUEST\n - INVALID_CARD\n - INVALID_MERCHANT_CONFIGURATION\n - INVALID_AMOUNT\n - CAPTURE_ALREADY_VOIDED\n - ACCOUNT_NOT_ALLOWED_CREDIT\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA", + "DUPLICATE_REQUEST", + "INVALID_CARD", + "INVALID_MERCHANT_CONFIGURATION", + "CAPTURE_ALREADY_VOIDED", + "ACCOUNT_NOT_ALLOWED_CREDIT" + ] + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { + "type": "object", + "properties": { + "field": { + "type": "string", + "description": "This is the flattened JSON object field name/path that is either missing or invalid." + }, + "reason": { + "type": "string", + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n", + "enum": [ + "MISSING_FIELD", + "INVALID_DATA" + ] + } + } + } + } + } + } + }, + "500": { + "description": "Unexpected server error." + } + } + } + } + }, + "definitions": {} +} \ No newline at end of file diff --git a/generator/cybersource_java_sdk_gen.bat b/generator/cybersource_java_sdk_gen.bat index defb53a86..78151de23 100644 --- a/generator/cybersource_java_sdk_gen.bat +++ b/generator/cybersource_java_sdk_gen.bat @@ -12,7 +12,7 @@ powershell -Command " Set-Content ..\src\main\java\Api\CreditApi.java ((get-cont powershell -Command " Set-Content ..\src\main\java\Api\PaymentsApi.java ((get-content ..\src\main\java\Api\PaymentsApi.java -raw) -replace '(?m)(.*)^*final String\[\] localVarAccepts = {[\r\n\s]+\"application\/json;charset=utf-8\"[\r\n\s]+};', 'final String[] localVarAccepts = {\"application/hal+json;charset=utf-8\"};') " -powershell -Command " Set-Content ..\src\main\java\Api\ProcessAPayoutApi.java ((get-content ..\src\main\java\Api\ProcessAPayoutApi.java -raw) -replace '(?m)(.*)^*final String\[\] localVarAccepts = {[\r\n\s]+\"application\/json;charset=utf-8\"[\r\n\s]+};', 'final String[] localVarAccepts = {\"application/hal+json;charset=utf-8\"};') " +powershell -Command " Set-Content ..\src\main\java\Api\PayoutsApi.java ((get-content ..\src\main\java\Api\PayoutsApi.java -raw) -replace '(?m)(.*)^*final String\[\] localVarAccepts = {[\r\n\s]+\"application\/json;charset=utf-8\"[\r\n\s]+};', 'final String[] localVarAccepts = {\"application/hal+json;charset=utf-8\"};') " powershell -Command " Set-Content ..\src\main\java\Api\RefundApi.java ((get-content ..\src\main\java\Api\RefundApi.java -raw) -replace '(?m)(.*)^*final String\[\] localVarAccepts = {[\r\n\s]+\"application\/json;charset=utf-8\"[\r\n\s]+};', 'final String[] localVarAccepts = {\"application/hal+json;charset=utf-8\"};') " diff --git a/pom.xml b/pom.xml index 980ab3116..de742f2ad 100644 --- a/pom.xml +++ b/pom.xml @@ -258,7 +258,7 @@ com.cybersource AuthenticationSdk - 0.0.4 + 0.0.5 diff --git a/src/main/java/Api/CaptureApi.java b/src/main/java/Api/CaptureApi.java index 7c8a8a84f..77d2fed64 100644 --- a/src/main/java/Api/CaptureApi.java +++ b/src/main/java/Api/CaptureApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Api/ConversionDetailsApi.java b/src/main/java/Api/ConversionDetailsApi.java index 5ac805061..bb7df95b5 100644 --- a/src/main/java/Api/ConversionDetailsApi.java +++ b/src/main/java/Api/ConversionDetailsApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -58,8 +58,8 @@ public void setApiClient(ApiClient apiClient) { /** * Build call for getConversionDetail - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param progressListener Progress listener * @param progressRequestListener Progress request listener @@ -138,8 +138,8 @@ private com.squareup.okhttp.Call getConversionDetailValidateBeforeCall(DateTime /** * Get conversion detail transactions * Get conversion detail of transactions for a merchant. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param organizationId Valid Cybersource Organization Id (optional) * @return ReportingV3ConversionDetailsGet200Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -152,8 +152,8 @@ public ReportingV3ConversionDetailsGet200Response getConversionDetail(DateTime s /** * Get conversion detail transactions * Get conversion detail of transactions for a merchant. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param organizationId Valid Cybersource Organization Id (optional) * @return ApiResponse<ReportingV3ConversionDetailsGet200Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body @@ -167,8 +167,8 @@ public ApiResponse getConversionDeta /** * Get conversion detail transactions (asynchronously) * Get conversion detail of transactions for a merchant. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param callback The callback to be executed when the API call finishes * @return The request call diff --git a/src/main/java/Api/CreditApi.java b/src/main/java/Api/CreditApi.java index cfe1b4eac..0e9c94302 100644 --- a/src/main/java/Api/CreditApi.java +++ b/src/main/java/Api/CreditApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Api/InstrumentIdentifiersApi.java b/src/main/java/Api/DecisionManagerApi.java similarity index 54% rename from src/main/java/Api/InstrumentIdentifiersApi.java rename to src/main/java/Api/DecisionManagerApi.java index 522f71b4f..9404af007 100644 --- a/src/main/java/Api/InstrumentIdentifiersApi.java +++ b/src/main/java/Api/DecisionManagerApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,9 +27,10 @@ import java.io.IOException; -import Model.Body; -import Model.InlineResponse4001; -import Model.TmsV1InstrumentidentifiersPost200Response; +import Model.CreateDecisionManagerCaseRequest; +import Model.PtsV2PaymentsPost502Response; +import Model.RiskV1DecisionsPost201Response; +import Model.RiskV1DecisionsPost400Response; import java.lang.reflect.Type; import java.util.ArrayList; @@ -37,14 +38,14 @@ import java.util.List; import java.util.Map; -public class InstrumentIdentifiersApi { +public class DecisionManagerApi { private ApiClient apiClient; - public InstrumentIdentifiersApi() { + public DecisionManagerApi() { this(Configuration.getDefaultApiClient()); } - public InstrumentIdentifiersApi(ApiClient apiClient) { + public DecisionManagerApi(ApiClient apiClient) { this.apiClient = apiClient; } @@ -57,30 +58,27 @@ public void setApiClient(ApiClient apiClient) { } /** - * Build call for tmsV1InstrumentidentifiersPost - * @param profileId The id of a profile containing user specific TMS configuration. (required) - * @param body Please specify either a Card or Bank Account. (required) + * Build call for createDecisionManagerCase + * @param createDecisionManagerCaseRequest (required) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call tmsV1InstrumentidentifiersPostCall(String profileId, Body body, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { - Object localVarPostBody = body; + public com.squareup.okhttp.Call createDecisionManagerCaseCall(CreateDecisionManagerCaseRequest createDecisionManagerCaseRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = createDecisionManagerCaseRequest; // create path and map variables - String localVarPath = "/tms/v1/instrumentidentifiers"; + String localVarPath = "/risk/v1/decisions"; List localVarQueryParams = new ArrayList(); Map localVarHeaderParams = new HashMap(); - if (profileId != null) - localVarHeaderParams.put("profile-id", apiClient.parameterToString(profileId)); Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/json;charset=utf-8" + "application/hal+json;charset=utf-8" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); @@ -108,20 +106,15 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call tmsV1InstrumentidentifiersPostValidateBeforeCall(String profileId, Body body, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { - - // verify the required parameter 'profileId' is set - if (profileId == null) { - throw new ApiException("Missing the required parameter 'profileId' when calling tmsV1InstrumentidentifiersPost(Async)"); - } + private com.squareup.okhttp.Call createDecisionManagerCaseValidateBeforeCall(CreateDecisionManagerCaseRequest createDecisionManagerCaseRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { - // verify the required parameter 'body' is set - if (body == null) { - throw new ApiException("Missing the required parameter 'body' when calling tmsV1InstrumentidentifiersPost(Async)"); + // verify the required parameter 'createDecisionManagerCaseRequest' is set + if (createDecisionManagerCaseRequest == null) { + throw new ApiException("Missing the required parameter 'createDecisionManagerCaseRequest' when calling createDecisionManagerCase(Async)"); } - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersPostCall(profileId, body, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = createDecisionManagerCaseCall(createDecisionManagerCaseRequest, progressListener, progressRequestListener); return call; @@ -131,42 +124,39 @@ private com.squareup.okhttp.Call tmsV1InstrumentidentifiersPostValidateBeforeCal } /** - * Create an Instrument Identifier - * - * @param profileId The id of a profile containing user specific TMS configuration. (required) - * @param body Please specify either a Card or Bank Account. (required) - * @return TmsV1InstrumentidentifiersPost200Response + * Create Decision Manager case + * This is the combined request to the Decision Manager Service for a transaction sent to Cybersource. Decision Manager will return a decision based on the request values. + * @param createDecisionManagerCaseRequest (required) + * @return RiskV1DecisionsPost201Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public TmsV1InstrumentidentifiersPost200Response tmsV1InstrumentidentifiersPost(String profileId, Body body) throws ApiException { - ApiResponse resp = tmsV1InstrumentidentifiersPostWithHttpInfo(profileId, body); + public RiskV1DecisionsPost201Response createDecisionManagerCase(CreateDecisionManagerCaseRequest createDecisionManagerCaseRequest) throws ApiException { + ApiResponse resp = createDecisionManagerCaseWithHttpInfo(createDecisionManagerCaseRequest); return resp.getData(); } /** - * Create an Instrument Identifier - * - * @param profileId The id of a profile containing user specific TMS configuration. (required) - * @param body Please specify either a Card or Bank Account. (required) - * @return ApiResponse<TmsV1InstrumentidentifiersPost200Response> + * Create Decision Manager case + * This is the combined request to the Decision Manager Service for a transaction sent to Cybersource. Decision Manager will return a decision based on the request values. + * @param createDecisionManagerCaseRequest (required) + * @return ApiResponse<RiskV1DecisionsPost201Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse tmsV1InstrumentidentifiersPostWithHttpInfo(String profileId, Body body) throws ApiException { - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersPostValidateBeforeCall(profileId, body, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse createDecisionManagerCaseWithHttpInfo(CreateDecisionManagerCaseRequest createDecisionManagerCaseRequest) throws ApiException { + com.squareup.okhttp.Call call = createDecisionManagerCaseValidateBeforeCall(createDecisionManagerCaseRequest, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** - * Create an Instrument Identifier (asynchronously) - * - * @param profileId The id of a profile containing user specific TMS configuration. (required) - * @param body Please specify either a Card or Bank Account. (required) + * Create Decision Manager case (asynchronously) + * This is the combined request to the Decision Manager Service for a transaction sent to Cybersource. Decision Manager will return a decision based on the request values. + * @param createDecisionManagerCaseRequest (required) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call tmsV1InstrumentidentifiersPostAsync(String profileId, Body body, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call createDecisionManagerCaseAsync(CreateDecisionManagerCaseRequest createDecisionManagerCaseRequest, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -187,8 +177,8 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersPostValidateBeforeCall(profileId, body, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = createDecisionManagerCaseValidateBeforeCall(createDecisionManagerCaseRequest, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } diff --git a/src/main/java/Api/InstrumentIdentifierApi.java b/src/main/java/Api/InstrumentIdentifierApi.java index 5eef5b25d..c82ff6c64 100644 --- a/src/main/java/Api/InstrumentIdentifierApi.java +++ b/src/main/java/Api/InstrumentIdentifierApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,10 +27,12 @@ import java.io.IOException; -import Model.Body1; +import Model.CreateInstrumentIdentifierRequest; import Model.InlineResponse4001; -import Model.TmsV1InstrumentidentifiersDelete409Response; -import Model.TmsV1InstrumentidentifiersPost200Response; +import Model.TmsV1InstrumentIdentifiersDelete409Response; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response; +import Model.TmsV1InstrumentIdentifiersPost200Response; +import Model.UpdateInstrumentIdentifierRequest; import java.lang.reflect.Type; import java.util.ArrayList; @@ -58,7 +60,143 @@ public void setApiClient(ApiClient apiClient) { } /** - * Build call for tmsV1InstrumentidentifiersTokenIdDelete + * Build call for createInstrumentIdentifier + * @param profileId The id of a profile containing user specific TMS configuration. (required) + * @param createInstrumentIdentifierRequest Please specify either a Card, Bank Account or Enrollable Card (required) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call createInstrumentIdentifierCall(String profileId, CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = createInstrumentIdentifierRequest; + + // create path and map variables + String localVarPath = "/tms/v1/instrumentidentifiers"; + + List localVarQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + if (profileId != null) + localVarHeaderParams.put("profile-id", apiClient.parameterToString(profileId)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json;charset=utf-8" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + "application/json;charset=utf-8" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call createInstrumentIdentifierValidateBeforeCall(String profileId, CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'profileId' is set + if (profileId == null) { + throw new ApiException("Missing the required parameter 'profileId' when calling createInstrumentIdentifier(Async)"); + } + + // verify the required parameter 'createInstrumentIdentifierRequest' is set + if (createInstrumentIdentifierRequest == null) { + throw new ApiException("Missing the required parameter 'createInstrumentIdentifierRequest' when calling createInstrumentIdentifier(Async)"); + } + + + com.squareup.okhttp.Call call = createInstrumentIdentifierCall(profileId, createInstrumentIdentifierRequest, progressListener, progressRequestListener); + return call; + + + + + + } + + /** + * Create an Instrument Identifier + * + * @param profileId The id of a profile containing user specific TMS configuration. (required) + * @param createInstrumentIdentifierRequest Please specify either a Card, Bank Account or Enrollable Card (required) + * @return TmsV1InstrumentIdentifiersPost200Response + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public TmsV1InstrumentIdentifiersPost200Response createInstrumentIdentifier(String profileId, CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest) throws ApiException { + ApiResponse resp = createInstrumentIdentifierWithHttpInfo(profileId, createInstrumentIdentifierRequest); + return resp.getData(); + } + + /** + * Create an Instrument Identifier + * + * @param profileId The id of a profile containing user specific TMS configuration. (required) + * @param createInstrumentIdentifierRequest Please specify either a Card, Bank Account or Enrollable Card (required) + * @return ApiResponse<TmsV1InstrumentIdentifiersPost200Response> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse createInstrumentIdentifierWithHttpInfo(String profileId, CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest) throws ApiException { + com.squareup.okhttp.Call call = createInstrumentIdentifierValidateBeforeCall(profileId, createInstrumentIdentifierRequest, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Create an Instrument Identifier (asynchronously) + * + * @param profileId The id of a profile containing user specific TMS configuration. (required) + * @param createInstrumentIdentifierRequest Please specify either a Card, Bank Account or Enrollable Card (required) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call createInstrumentIdentifierAsync(String profileId, CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = createInstrumentIdentifierValidateBeforeCall(profileId, createInstrumentIdentifierRequest, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for deleteInstrumentIdentifier * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of an Instrument Identifier. (required) * @param progressListener Progress listener @@ -66,7 +204,7 @@ public void setApiClient(ApiClient apiClient) { * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdDeleteCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call deleteInstrumentIdentifierCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -110,20 +248,20 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdDeleteValidateBeforeCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call deleteInstrumentIdentifierValidateBeforeCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'profileId' is set if (profileId == null) { - throw new ApiException("Missing the required parameter 'profileId' when calling tmsV1InstrumentidentifiersTokenIdDelete(Async)"); + throw new ApiException("Missing the required parameter 'profileId' when calling deleteInstrumentIdentifier(Async)"); } // verify the required parameter 'tokenId' is set if (tokenId == null) { - throw new ApiException("Missing the required parameter 'tokenId' when calling tmsV1InstrumentidentifiersTokenIdDelete(Async)"); + throw new ApiException("Missing the required parameter 'tokenId' when calling deleteInstrumentIdentifier(Async)"); } - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersTokenIdDeleteCall(profileId, tokenId, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = deleteInstrumentIdentifierCall(profileId, tokenId, progressListener, progressRequestListener); return call; @@ -139,8 +277,8 @@ private com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdDeleteValidate * @param tokenId The TokenId of an Instrument Identifier. (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void tmsV1InstrumentidentifiersTokenIdDelete(String profileId, String tokenId) throws ApiException { - tmsV1InstrumentidentifiersTokenIdDeleteWithHttpInfo(profileId, tokenId); + public void deleteInstrumentIdentifier(String profileId, String tokenId) throws ApiException { + deleteInstrumentIdentifierWithHttpInfo(profileId, tokenId); } /** @@ -151,8 +289,8 @@ public void tmsV1InstrumentidentifiersTokenIdDelete(String profileId, String tok * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse tmsV1InstrumentidentifiersTokenIdDeleteWithHttpInfo(String profileId, String tokenId) throws ApiException { - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersTokenIdDeleteValidateBeforeCall(profileId, tokenId, null, null); + public ApiResponse deleteInstrumentIdentifierWithHttpInfo(String profileId, String tokenId) throws ApiException { + com.squareup.okhttp.Call call = deleteInstrumentIdentifierValidateBeforeCall(profileId, tokenId, null, null); return apiClient.execute(call); } @@ -165,7 +303,7 @@ public ApiResponse tmsV1InstrumentidentifiersTokenIdDeleteWithHttpInfo(Str * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdDeleteAsync(String profileId, String tokenId, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call deleteInstrumentIdentifierAsync(String profileId, String tokenId, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -186,12 +324,161 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersTokenIdDeleteValidateBeforeCall(profileId, tokenId, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = deleteInstrumentIdentifierValidateBeforeCall(profileId, tokenId, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } /** - * Build call for tmsV1InstrumentidentifiersTokenIdGet + * Build call for getAllPaymentInstruments + * @param profileId The id of a profile containing user specific TMS configuration. (required) + * @param tokenId The TokenId of an Instrument Identifier. (required) + * @param offset Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0) + * @param limit The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getAllPaymentInstrumentsCall(String profileId, String tokenId, Long offset, Long limit, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments" + .replaceAll("\\{" + "tokenId" + "\\}", apiClient.escapeString(tokenId.toString())); + + List localVarQueryParams = new ArrayList(); + if (offset != null) + localVarQueryParams.addAll(apiClient.parameterToPairs("", "offset", offset)); + if (limit != null) + localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); + + Map localVarHeaderParams = new HashMap(); + if (profileId != null) + localVarHeaderParams.put("profile-id", apiClient.parameterToString(profileId)); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/json;charset=utf-8" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + "application/json;charset=utf-8" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getAllPaymentInstrumentsValidateBeforeCall(String profileId, String tokenId, Long offset, Long limit, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'profileId' is set + if (profileId == null) { + throw new ApiException("Missing the required parameter 'profileId' when calling getAllPaymentInstruments(Async)"); + } + + // verify the required parameter 'tokenId' is set + if (tokenId == null) { + throw new ApiException("Missing the required parameter 'tokenId' when calling getAllPaymentInstruments(Async)"); + } + + + com.squareup.okhttp.Call call = getAllPaymentInstrumentsCall(profileId, tokenId, offset, limit, progressListener, progressRequestListener); + return call; + + + + + + } + + /** + * Retrieve all Payment Instruments associated with an Instrument Identifier + * + * @param profileId The id of a profile containing user specific TMS configuration. (required) + * @param tokenId The TokenId of an Instrument Identifier. (required) + * @param offset Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0) + * @param limit The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20) + * @return TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response getAllPaymentInstruments(String profileId, String tokenId, Long offset, Long limit) throws ApiException { + ApiResponse resp = getAllPaymentInstrumentsWithHttpInfo(profileId, tokenId, offset, limit); + return resp.getData(); + } + + /** + * Retrieve all Payment Instruments associated with an Instrument Identifier + * + * @param profileId The id of a profile containing user specific TMS configuration. (required) + * @param tokenId The TokenId of an Instrument Identifier. (required) + * @param offset Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0) + * @param limit The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20) + * @return ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getAllPaymentInstrumentsWithHttpInfo(String profileId, String tokenId, Long offset, Long limit) throws ApiException { + com.squareup.okhttp.Call call = getAllPaymentInstrumentsValidateBeforeCall(profileId, tokenId, offset, limit, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Retrieve all Payment Instruments associated with an Instrument Identifier (asynchronously) + * + * @param profileId The id of a profile containing user specific TMS configuration. (required) + * @param tokenId The TokenId of an Instrument Identifier. (required) + * @param offset Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0) + * @param limit The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getAllPaymentInstrumentsAsync(String profileId, String tokenId, Long offset, Long limit, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getAllPaymentInstrumentsValidateBeforeCall(profileId, tokenId, offset, limit, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } + /** + * Build call for getInstrumentIdentifier * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of an Instrument Identifier. (required) * @param progressListener Progress listener @@ -199,7 +486,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdGetCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getInstrumentIdentifierCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -243,20 +530,20 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdGetValidateBeforeCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getInstrumentIdentifierValidateBeforeCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'profileId' is set if (profileId == null) { - throw new ApiException("Missing the required parameter 'profileId' when calling tmsV1InstrumentidentifiersTokenIdGet(Async)"); + throw new ApiException("Missing the required parameter 'profileId' when calling getInstrumentIdentifier(Async)"); } // verify the required parameter 'tokenId' is set if (tokenId == null) { - throw new ApiException("Missing the required parameter 'tokenId' when calling tmsV1InstrumentidentifiersTokenIdGet(Async)"); + throw new ApiException("Missing the required parameter 'tokenId' when calling getInstrumentIdentifier(Async)"); } - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersTokenIdGetCall(profileId, tokenId, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getInstrumentIdentifierCall(profileId, tokenId, progressListener, progressRequestListener); return call; @@ -270,11 +557,11 @@ private com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdGetValidateBef * * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of an Instrument Identifier. (required) - * @return TmsV1InstrumentidentifiersPost200Response + * @return TmsV1InstrumentIdentifiersPost200Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public TmsV1InstrumentidentifiersPost200Response tmsV1InstrumentidentifiersTokenIdGet(String profileId, String tokenId) throws ApiException { - ApiResponse resp = tmsV1InstrumentidentifiersTokenIdGetWithHttpInfo(profileId, tokenId); + public TmsV1InstrumentIdentifiersPost200Response getInstrumentIdentifier(String profileId, String tokenId) throws ApiException { + ApiResponse resp = getInstrumentIdentifierWithHttpInfo(profileId, tokenId); return resp.getData(); } @@ -283,12 +570,12 @@ public TmsV1InstrumentidentifiersPost200Response tmsV1InstrumentidentifiersToken * * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of an Instrument Identifier. (required) - * @return ApiResponse<TmsV1InstrumentidentifiersPost200Response> + * @return ApiResponse<TmsV1InstrumentIdentifiersPost200Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse tmsV1InstrumentidentifiersTokenIdGetWithHttpInfo(String profileId, String tokenId) throws ApiException { - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersTokenIdGetValidateBeforeCall(profileId, tokenId, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse getInstrumentIdentifierWithHttpInfo(String profileId, String tokenId) throws ApiException { + com.squareup.okhttp.Call call = getInstrumentIdentifierValidateBeforeCall(profileId, tokenId, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -301,7 +588,7 @@ public ApiResponse tmsV1Instrumentide * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdGetAsync(String profileId, String tokenId, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getInstrumentIdentifierAsync(String profileId, String tokenId, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -322,23 +609,23 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersTokenIdGetValidateBeforeCall(profileId, tokenId, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = getInstrumentIdentifierValidateBeforeCall(profileId, tokenId, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** - * Build call for tmsV1InstrumentidentifiersTokenIdPatch + * Build call for updateInstrumentIdentifier * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of an Instrument Identifier. (required) - * @param body Please specify the previous transaction Id to update. (required) + * @param updateInstrumentIdentifierRequest Specify the previous transaction ID to update. (required) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdPatchCall(String profileId, String tokenId, Body1 body, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { - Object localVarPostBody = body; + public com.squareup.okhttp.Call updateInstrumentIdentifierCall(String profileId, String tokenId, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = updateInstrumentIdentifierRequest; // create path and map variables String localVarPath = "/tms/v1/instrumentidentifiers/{tokenId}" @@ -381,25 +668,25 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdPatchValidateBeforeCall(String profileId, String tokenId, Body1 body, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updateInstrumentIdentifierValidateBeforeCall(String profileId, String tokenId, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'profileId' is set if (profileId == null) { - throw new ApiException("Missing the required parameter 'profileId' when calling tmsV1InstrumentidentifiersTokenIdPatch(Async)"); + throw new ApiException("Missing the required parameter 'profileId' when calling updateInstrumentIdentifier(Async)"); } // verify the required parameter 'tokenId' is set if (tokenId == null) { - throw new ApiException("Missing the required parameter 'tokenId' when calling tmsV1InstrumentidentifiersTokenIdPatch(Async)"); + throw new ApiException("Missing the required parameter 'tokenId' when calling updateInstrumentIdentifier(Async)"); } - // verify the required parameter 'body' is set - if (body == null) { - throw new ApiException("Missing the required parameter 'body' when calling tmsV1InstrumentidentifiersTokenIdPatch(Async)"); + // verify the required parameter 'updateInstrumentIdentifierRequest' is set + if (updateInstrumentIdentifierRequest == null) { + throw new ApiException("Missing the required parameter 'updateInstrumentIdentifierRequest' when calling updateInstrumentIdentifier(Async)"); } - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersTokenIdPatchCall(profileId, tokenId, body, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updateInstrumentIdentifierCall(profileId, tokenId, updateInstrumentIdentifierRequest, progressListener, progressRequestListener); return call; @@ -413,12 +700,12 @@ private com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdPatchValidateB * * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of an Instrument Identifier. (required) - * @param body Please specify the previous transaction Id to update. (required) - * @return TmsV1InstrumentidentifiersPost200Response + * @param updateInstrumentIdentifierRequest Specify the previous transaction ID to update. (required) + * @return TmsV1InstrumentIdentifiersPost200Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public TmsV1InstrumentidentifiersPost200Response tmsV1InstrumentidentifiersTokenIdPatch(String profileId, String tokenId, Body1 body) throws ApiException { - ApiResponse resp = tmsV1InstrumentidentifiersTokenIdPatchWithHttpInfo(profileId, tokenId, body); + public TmsV1InstrumentIdentifiersPost200Response updateInstrumentIdentifier(String profileId, String tokenId, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest) throws ApiException { + ApiResponse resp = updateInstrumentIdentifierWithHttpInfo(profileId, tokenId, updateInstrumentIdentifierRequest); return resp.getData(); } @@ -427,13 +714,13 @@ public TmsV1InstrumentidentifiersPost200Response tmsV1InstrumentidentifiersToken * * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of an Instrument Identifier. (required) - * @param body Please specify the previous transaction Id to update. (required) - * @return ApiResponse<TmsV1InstrumentidentifiersPost200Response> + * @param updateInstrumentIdentifierRequest Specify the previous transaction ID to update. (required) + * @return ApiResponse<TmsV1InstrumentIdentifiersPost200Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse tmsV1InstrumentidentifiersTokenIdPatchWithHttpInfo(String profileId, String tokenId, Body1 body) throws ApiException { - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersTokenIdPatchValidateBeforeCall(profileId, tokenId, body, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse updateInstrumentIdentifierWithHttpInfo(String profileId, String tokenId, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest) throws ApiException { + com.squareup.okhttp.Call call = updateInstrumentIdentifierValidateBeforeCall(profileId, tokenId, updateInstrumentIdentifierRequest, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -442,12 +729,12 @@ public ApiResponse tmsV1Instrumentide * * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of an Instrument Identifier. (required) - * @param body Please specify the previous transaction Id to update. (required) + * @param updateInstrumentIdentifierRequest Specify the previous transaction ID to update. (required) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdPatchAsync(String profileId, String tokenId, Body1 body, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updateInstrumentIdentifierAsync(String profileId, String tokenId, UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -468,8 +755,8 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersTokenIdPatchValidateBeforeCall(profileId, tokenId, body, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = updateInstrumentIdentifierValidateBeforeCall(profileId, tokenId, updateInstrumentIdentifierRequest, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } diff --git a/src/main/java/Api/KeyGenerationApi.java b/src/main/java/Api/KeyGenerationApi.java index f4b289539..16ff1d99c 100644 --- a/src/main/java/Api/KeyGenerationApi.java +++ b/src/main/java/Api/KeyGenerationApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -58,7 +58,7 @@ public void setApiClient(ApiClient apiClient) { /** * Build call for generatePublicKey - * @param generatePublicKeyRequest (optional) + * @param generatePublicKeyRequest (required) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute @@ -68,7 +68,7 @@ public com.squareup.okhttp.Call generatePublicKeyCall(GeneratePublicKeyRequest g Object localVarPostBody = generatePublicKeyRequest; // create path and map variables - String localVarPath = "/flex/v1/keys/"; + String localVarPath = "/flex/v1/keys"; List localVarQueryParams = new ArrayList(); @@ -107,6 +107,11 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch @SuppressWarnings("rawtypes") private com.squareup.okhttp.Call generatePublicKeyValidateBeforeCall(GeneratePublicKeyRequest generatePublicKeyRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + // verify the required parameter 'generatePublicKeyRequest' is set + if (generatePublicKeyRequest == null) { + throw new ApiException("Missing the required parameter 'generatePublicKeyRequest' when calling generatePublicKey(Async)"); + } + com.squareup.okhttp.Call call = generatePublicKeyCall(generatePublicKeyRequest, progressListener, progressRequestListener); return call; @@ -120,7 +125,7 @@ private com.squareup.okhttp.Call generatePublicKeyValidateBeforeCall(GeneratePub /** * Generate Key * Generate a one-time use public key and key ID to encrypt the card number in the follow-on Tokenize Card request. The key used to encrypt the card number on the cardholder’s device or browser is valid for 15 minutes and must be used to verify the signature in the response message. CyberSource recommends creating a new key for each order. Generating a key is an authenticated request initiated from your servers, prior to requesting to tokenize the card data from your customer’s device or browser. - * @param generatePublicKeyRequest (optional) + * @param generatePublicKeyRequest (required) * @return FlexV1KeysPost200Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -132,7 +137,7 @@ public FlexV1KeysPost200Response generatePublicKey(GeneratePublicKeyRequest gene /** * Generate Key * Generate a one-time use public key and key ID to encrypt the card number in the follow-on Tokenize Card request. The key used to encrypt the card number on the cardholder’s device or browser is valid for 15 minutes and must be used to verify the signature in the response message. CyberSource recommends creating a new key for each order. Generating a key is an authenticated request initiated from your servers, prior to requesting to tokenize the card data from your customer’s device or browser. - * @param generatePublicKeyRequest (optional) + * @param generatePublicKeyRequest (required) * @return ApiResponse<FlexV1KeysPost200Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -145,7 +150,7 @@ public ApiResponse generatePublicKeyWithHttpInfo(Gene /** * Generate Key (asynchronously) * Generate a one-time use public key and key ID to encrypt the card number in the follow-on Tokenize Card request. The key used to encrypt the card number on the cardholder’s device or browser is valid for 15 minutes and must be used to verify the signature in the response message. CyberSource recommends creating a new key for each order. Generating a key is an authenticated request initiated from your servers, prior to requesting to tokenize the card data from your customer’s device or browser. - * @param generatePublicKeyRequest (optional) + * @param generatePublicKeyRequest (required) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object diff --git a/src/main/java/Api/NetFundingsApi.java b/src/main/java/Api/NetFundingsApi.java index 954a1e853..64b1fb2c7 100644 --- a/src/main/java/Api/NetFundingsApi.java +++ b/src/main/java/Api/NetFundingsApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -57,9 +57,9 @@ public void setApiClient(ApiClient apiClient) { } /** - * Build call for getNetFundingInfo - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * Build call for getNetFundingDetails + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param groupName Valid CyberSource Group Name. (optional) * @param progressListener Progress listener @@ -67,7 +67,7 @@ public void setApiClient(ApiClient apiClient) { * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getNetFundingInfoCall(DateTime startTime, DateTime endTime, String organizationId, String groupName, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getNetFundingDetailsCall(DateTime startTime, DateTime endTime, String organizationId, String groupName, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -116,20 +116,20 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getNetFundingInfoValidateBeforeCall(DateTime startTime, DateTime endTime, String organizationId, String groupName, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getNetFundingDetailsValidateBeforeCall(DateTime startTime, DateTime endTime, String organizationId, String groupName, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'startTime' is set if (startTime == null) { - throw new ApiException("Missing the required parameter 'startTime' when calling getNetFundingInfo(Async)"); + throw new ApiException("Missing the required parameter 'startTime' when calling getNetFundingDetails(Async)"); } // verify the required parameter 'endTime' is set if (endTime == null) { - throw new ApiException("Missing the required parameter 'endTime' when calling getNetFundingInfo(Async)"); + throw new ApiException("Missing the required parameter 'endTime' when calling getNetFundingDetails(Async)"); } - com.squareup.okhttp.Call call = getNetFundingInfoCall(startTime, endTime, organizationId, groupName, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getNetFundingDetailsCall(startTime, endTime, organizationId, groupName, progressListener, progressRequestListener); return call; @@ -141,30 +141,30 @@ private com.squareup.okhttp.Call getNetFundingInfoValidateBeforeCall(DateTime st /** * Get Netfunding information for an account or a merchant * Get Netfunding information for an account or a merchant. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param groupName Valid CyberSource Group Name. (optional) * @return ReportingV3NetFundingsGet200Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ReportingV3NetFundingsGet200Response getNetFundingInfo(DateTime startTime, DateTime endTime, String organizationId, String groupName) throws ApiException { - ApiResponse resp = getNetFundingInfoWithHttpInfo(startTime, endTime, organizationId, groupName); + public ReportingV3NetFundingsGet200Response getNetFundingDetails(DateTime startTime, DateTime endTime, String organizationId, String groupName) throws ApiException { + ApiResponse resp = getNetFundingDetailsWithHttpInfo(startTime, endTime, organizationId, groupName); return resp.getData(); } /** * Get Netfunding information for an account or a merchant * Get Netfunding information for an account or a merchant. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param groupName Valid CyberSource Group Name. (optional) * @return ApiResponse<ReportingV3NetFundingsGet200Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getNetFundingInfoWithHttpInfo(DateTime startTime, DateTime endTime, String organizationId, String groupName) throws ApiException { - com.squareup.okhttp.Call call = getNetFundingInfoValidateBeforeCall(startTime, endTime, organizationId, groupName, null, null); + public ApiResponse getNetFundingDetailsWithHttpInfo(DateTime startTime, DateTime endTime, String organizationId, String groupName) throws ApiException { + com.squareup.okhttp.Call call = getNetFundingDetailsValidateBeforeCall(startTime, endTime, organizationId, groupName, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -172,15 +172,15 @@ public ApiResponse getNetFundingInfoWithHt /** * Get Netfunding information for an account or a merchant (asynchronously) * Get Netfunding information for an account or a merchant. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param groupName Valid CyberSource Group Name. (optional) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getNetFundingInfoAsync(DateTime startTime, DateTime endTime, String organizationId, String groupName, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getNetFundingDetailsAsync(DateTime startTime, DateTime endTime, String organizationId, String groupName, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -201,7 +201,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getNetFundingInfoValidateBeforeCall(startTime, endTime, organizationId, groupName, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getNetFundingDetailsValidateBeforeCall(startTime, endTime, organizationId, groupName, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; diff --git a/src/main/java/Api/NotificationOfChangesApi.java b/src/main/java/Api/NotificationOfChangesApi.java index e38f9c6ea..e1e384869 100644 --- a/src/main/java/Api/NotificationOfChangesApi.java +++ b/src/main/java/Api/NotificationOfChangesApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -58,8 +58,8 @@ public void setApiClient(ApiClient apiClient) { /** * Build call for getNotificationOfChangeReport - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute @@ -135,8 +135,8 @@ private com.squareup.okhttp.Call getNotificationOfChangeReportValidateBeforeCall /** * Get Notification Of Changes * Download the Notification of Change report. This report shows eCheck-related fields updated as a result of a response to an eCheck settlement transaction. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @return ReportingV3NotificationofChangesGet200Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -148,8 +148,8 @@ public ReportingV3NotificationofChangesGet200Response getNotificationOfChangeRep /** * Get Notification Of Changes * Download the Notification of Change report. This report shows eCheck-related fields updated as a result of a response to an eCheck settlement transaction. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @return ApiResponse<ReportingV3NotificationofChangesGet200Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -162,8 +162,8 @@ public ApiResponse getNotificati /** * Get Notification Of Changes (asynchronously) * Download the Notification of Change report. This report shows eCheck-related fields updated as a result of a response to an eCheck settlement transaction. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object diff --git a/src/main/java/Api/PaymentBatchSummariesApi.java b/src/main/java/Api/PaymentBatchSummariesApi.java new file mode 100644 index 000000000..14e6d8d31 --- /dev/null +++ b/src/main/java/Api/PaymentBatchSummariesApi.java @@ -0,0 +1,221 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Api; + +import Invokers.ApiCallback; +import Invokers.ApiClient; +import Invokers.ApiException; +import Invokers.ApiResponse; +import Invokers.Configuration; +import Invokers.Pair; +import Invokers.ProgressRequestBody; +import Invokers.ProgressResponseBody; + +import com.google.gson.reflect.TypeToken; + +import java.io.IOException; + + +import org.joda.time.DateTime; +import Model.InlineResponse200; +import Model.Reportingv3ReportDownloadsGet400Response; + +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class PaymentBatchSummariesApi { + private ApiClient apiClient; + + public PaymentBatchSummariesApi() { + this(Configuration.getDefaultApiClient()); + } + + public PaymentBatchSummariesApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + public ApiClient getApiClient() { + return apiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Build call for getPaymentBatchSummary + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param organizationId Valid Cybersource Organization Id (optional) + * @param rollUp Conditional - RollUp for data for DAY/WEEK/MONTH. Required while getting breakdown data for a Merchant (optional) + * @param breakdown Conditional - Breakdown on account_rollup/allMerchants/selectedMerchant. Required while getting breakdown data for a Merchant. (optional) + * @param startDayOfWeek Optional - Start day of week to breakdown data for weeks in a month (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getPaymentBatchSummaryCall(DateTime startTime, DateTime endTime, String organizationId, String rollUp, String breakdown, Integer startDayOfWeek, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/reporting/v3/payment-batch-summaries"; + + List localVarQueryParams = new ArrayList(); + if (startTime != null) + localVarQueryParams.addAll(apiClient.parameterToPairs("", "startTime", startTime)); + if (endTime != null) + localVarQueryParams.addAll(apiClient.parameterToPairs("", "endTime", endTime)); + if (organizationId != null) + localVarQueryParams.addAll(apiClient.parameterToPairs("", "organizationId", organizationId)); + if (rollUp != null) + localVarQueryParams.addAll(apiClient.parameterToPairs("", "rollUp", rollUp)); + if (breakdown != null) + localVarQueryParams.addAll(apiClient.parameterToPairs("", "breakdown", breakdown)); + if (startDayOfWeek != null) + localVarQueryParams.addAll(apiClient.parameterToPairs("", "startDayOfWeek", startDayOfWeek)); + + Map localVarHeaderParams = new HashMap(); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/hal+json" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + "application/json;charset=utf-8" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getPaymentBatchSummaryValidateBeforeCall(DateTime startTime, DateTime endTime, String organizationId, String rollUp, String breakdown, Integer startDayOfWeek, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'startTime' is set + if (startTime == null) { + throw new ApiException("Missing the required parameter 'startTime' when calling getPaymentBatchSummary(Async)"); + } + + // verify the required parameter 'endTime' is set + if (endTime == null) { + throw new ApiException("Missing the required parameter 'endTime' when calling getPaymentBatchSummary(Async)"); + } + + + com.squareup.okhttp.Call call = getPaymentBatchSummaryCall(startTime, endTime, organizationId, rollUp, breakdown, startDayOfWeek, progressListener, progressRequestListener); + return call; + + + + + + } + + /** + * Get payment batch summary data + * Scope can be either account/merchant or reseller. + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param organizationId Valid Cybersource Organization Id (optional) + * @param rollUp Conditional - RollUp for data for DAY/WEEK/MONTH. Required while getting breakdown data for a Merchant (optional) + * @param breakdown Conditional - Breakdown on account_rollup/allMerchants/selectedMerchant. Required while getting breakdown data for a Merchant. (optional) + * @param startDayOfWeek Optional - Start day of week to breakdown data for weeks in a month (optional) + * @return InlineResponse200 + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public InlineResponse200 getPaymentBatchSummary(DateTime startTime, DateTime endTime, String organizationId, String rollUp, String breakdown, Integer startDayOfWeek) throws ApiException { + ApiResponse resp = getPaymentBatchSummaryWithHttpInfo(startTime, endTime, organizationId, rollUp, breakdown, startDayOfWeek); + return resp.getData(); + } + + /** + * Get payment batch summary data + * Scope can be either account/merchant or reseller. + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param organizationId Valid Cybersource Organization Id (optional) + * @param rollUp Conditional - RollUp for data for DAY/WEEK/MONTH. Required while getting breakdown data for a Merchant (optional) + * @param breakdown Conditional - Breakdown on account_rollup/allMerchants/selectedMerchant. Required while getting breakdown data for a Merchant. (optional) + * @param startDayOfWeek Optional - Start day of week to breakdown data for weeks in a month (optional) + * @return ApiResponse<InlineResponse200> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getPaymentBatchSummaryWithHttpInfo(DateTime startTime, DateTime endTime, String organizationId, String rollUp, String breakdown, Integer startDayOfWeek) throws ApiException { + com.squareup.okhttp.Call call = getPaymentBatchSummaryValidateBeforeCall(startTime, endTime, organizationId, rollUp, breakdown, startDayOfWeek, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Get payment batch summary data (asynchronously) + * Scope can be either account/merchant or reseller. + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param organizationId Valid Cybersource Organization Id (optional) + * @param rollUp Conditional - RollUp for data for DAY/WEEK/MONTH. Required while getting breakdown data for a Merchant (optional) + * @param breakdown Conditional - Breakdown on account_rollup/allMerchants/selectedMerchant. Required while getting breakdown data for a Merchant. (optional) + * @param startDayOfWeek Optional - Start day of week to breakdown data for weeks in a month (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getPaymentBatchSummaryAsync(DateTime startTime, DateTime endTime, String organizationId, String rollUp, String breakdown, Integer startDayOfWeek, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getPaymentBatchSummaryValidateBeforeCall(startTime, endTime, organizationId, rollUp, breakdown, startDayOfWeek, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } +} diff --git a/src/main/java/Api/PaymentInstrumentsApi.java b/src/main/java/Api/PaymentInstrumentApi.java similarity index 52% rename from src/main/java/Api/PaymentInstrumentsApi.java rename to src/main/java/Api/PaymentInstrumentApi.java index b78110dcf..03ea5ff61 100644 --- a/src/main/java/Api/PaymentInstrumentsApi.java +++ b/src/main/java/Api/PaymentInstrumentApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,12 +27,10 @@ import java.io.IOException; -import Model.Body2; -import Model.Body3; +import Model.CreatePaymentInstrumentRequest; import Model.InlineResponse4001; -import Model.TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response; -import Model.TmsV1PaymentinstrumentsGet200Response; -import Model.TmsV1PaymentinstrumentsPost201Response; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments; +import Model.UpdatePaymentInstrumentRequest; import java.lang.reflect.Type; import java.util.ArrayList; @@ -40,14 +38,14 @@ import java.util.List; import java.util.Map; -public class PaymentInstrumentsApi { +public class PaymentInstrumentApi { private ApiClient apiClient; - public PaymentInstrumentsApi() { + public PaymentInstrumentApi() { this(Configuration.getDefaultApiClient()); } - public PaymentInstrumentsApi(ApiClient apiClient) { + public PaymentInstrumentApi(ApiClient apiClient) { this.apiClient = apiClient; } @@ -60,165 +58,16 @@ public void setApiClient(ApiClient apiClient) { } /** - * Build call for tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet + * Build call for createPaymentInstrument * @param profileId The id of a profile containing user specific TMS configuration. (required) - * @param tokenId The TokenId of an Instrument Identifier. (required) - * @param offset Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional) - * @param limit The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20) + * @param createPaymentInstrumentRequest Specify the customer's payment details for card or bank account. (required) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetCall(String profileId, String tokenId, String offset, String limit, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { - Object localVarPostBody = null; - - // create path and map variables - String localVarPath = "/tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments" - .replaceAll("\\{" + "tokenId" + "\\}", apiClient.escapeString(tokenId.toString())); - - List localVarQueryParams = new ArrayList(); - if (offset != null) - localVarQueryParams.addAll(apiClient.parameterToPairs("", "offset", offset)); - if (limit != null) - localVarQueryParams.addAll(apiClient.parameterToPairs("", "limit", limit)); - - Map localVarHeaderParams = new HashMap(); - if (profileId != null) - localVarHeaderParams.put("profile-id", apiClient.parameterToString(profileId)); - - Map localVarFormParams = new HashMap(); - - final String[] localVarAccepts = { - "application/json;charset=utf-8" - }; - final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); - if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); - - final String[] localVarContentTypes = { - "application/json;charset=utf-8" - }; - final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); - localVarHeaderParams.put("Content-Type", localVarContentType); - - if(progressListener != null) { - apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { - @Override - public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { - com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); - return originalResponse.newBuilder() - .body(new ProgressResponseBody(originalResponse.body(), progressListener)) - .build(); - } - }); - } - - String[] localVarAuthNames = new String[] { }; - return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); - } - - @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetValidateBeforeCall(String profileId, String tokenId, String offset, String limit, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { - - // verify the required parameter 'profileId' is set - if (profileId == null) { - throw new ApiException("Missing the required parameter 'profileId' when calling tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet(Async)"); - } - - // verify the required parameter 'tokenId' is set - if (tokenId == null) { - throw new ApiException("Missing the required parameter 'tokenId' when calling tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet(Async)"); - } - - - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetCall(profileId, tokenId, offset, limit, progressListener, progressRequestListener); - return call; - - - - - - } - - /** - * Retrieve all Payment Instruments associated with an Instrument Identifier - * - * @param profileId The id of a profile containing user specific TMS configuration. (required) - * @param tokenId The TokenId of an Instrument Identifier. (required) - * @param offset Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional) - * @param limit The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20) - * @return TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - */ - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet(String profileId, String tokenId, String offset, String limit) throws ApiException { - ApiResponse resp = tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetWithHttpInfo(profileId, tokenId, offset, limit); - return resp.getData(); - } - - /** - * Retrieve all Payment Instruments associated with an Instrument Identifier - * - * @param profileId The id of a profile containing user specific TMS configuration. (required) - * @param tokenId The TokenId of an Instrument Identifier. (required) - * @param offset Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional) - * @param limit The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20) - * @return ApiResponse<TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response> - * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body - */ - public ApiResponse tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetWithHttpInfo(String profileId, String tokenId, String offset, String limit) throws ApiException { - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetValidateBeforeCall(profileId, tokenId, offset, limit, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); - return apiClient.execute(call, localVarReturnType); - } - - /** - * Retrieve all Payment Instruments associated with an Instrument Identifier (asynchronously) - * - * @param profileId The id of a profile containing user specific TMS configuration. (required) - * @param tokenId The TokenId of an Instrument Identifier. (required) - * @param offset Starting Payment Instrument record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional) - * @param limit The maximum number of Payment Instruments that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20) - * @param callback The callback to be executed when the API call finishes - * @return The request call - * @throws ApiException If fail to process the API call, e.g. serializing the request body object - */ - public com.squareup.okhttp.Call tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetAsync(String profileId, String tokenId, String offset, String limit, final ApiCallback callback) throws ApiException { - - ProgressResponseBody.ProgressListener progressListener = null; - ProgressRequestBody.ProgressRequestListener progressRequestListener = null; - - if (callback != null) { - progressListener = new ProgressResponseBody.ProgressListener() { - @Override - public void update(long bytesRead, long contentLength, boolean done) { - callback.onDownloadProgress(bytesRead, contentLength, done); - } - }; - - progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { - @Override - public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { - callback.onUploadProgress(bytesWritten, contentLength, done); - } - }; - } - - com.squareup.okhttp.Call call = tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetValidateBeforeCall(profileId, tokenId, offset, limit, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); - apiClient.executeAsync(call, localVarReturnType, callback); - return call; - } - /** - * Build call for tmsV1PaymentinstrumentsPost - * @param profileId The id of a profile containing user specific TMS configuration. (required) - * @param body Please specify the customers payment details for card or bank account. (required) - * @param progressListener Progress listener - * @param progressRequestListener Progress request listener - * @return Call to execute - * @throws ApiException If fail to serialize the request body object - */ - public com.squareup.okhttp.Call tmsV1PaymentinstrumentsPostCall(String profileId, Body2 body, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { - Object localVarPostBody = body; + public com.squareup.okhttp.Call createPaymentInstrumentCall(String profileId, CreatePaymentInstrumentRequest createPaymentInstrumentRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = createPaymentInstrumentRequest; // create path and map variables String localVarPath = "/tms/v1/paymentinstruments"; @@ -260,20 +109,20 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call tmsV1PaymentinstrumentsPostValidateBeforeCall(String profileId, Body2 body, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call createPaymentInstrumentValidateBeforeCall(String profileId, CreatePaymentInstrumentRequest createPaymentInstrumentRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'profileId' is set if (profileId == null) { - throw new ApiException("Missing the required parameter 'profileId' when calling tmsV1PaymentinstrumentsPost(Async)"); + throw new ApiException("Missing the required parameter 'profileId' when calling createPaymentInstrument(Async)"); } - // verify the required parameter 'body' is set - if (body == null) { - throw new ApiException("Missing the required parameter 'body' when calling tmsV1PaymentinstrumentsPost(Async)"); + // verify the required parameter 'createPaymentInstrumentRequest' is set + if (createPaymentInstrumentRequest == null) { + throw new ApiException("Missing the required parameter 'createPaymentInstrumentRequest' when calling createPaymentInstrument(Async)"); } - com.squareup.okhttp.Call call = tmsV1PaymentinstrumentsPostCall(profileId, body, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = createPaymentInstrumentCall(profileId, createPaymentInstrumentRequest, progressListener, progressRequestListener); return call; @@ -286,12 +135,12 @@ private com.squareup.okhttp.Call tmsV1PaymentinstrumentsPostValidateBeforeCall(S * Create a Payment Instrument * * @param profileId The id of a profile containing user specific TMS configuration. (required) - * @param body Please specify the customers payment details for card or bank account. (required) - * @return TmsV1PaymentinstrumentsPost201Response + * @param createPaymentInstrumentRequest Specify the customer's payment details for card or bank account. (required) + * @return TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public TmsV1PaymentinstrumentsPost201Response tmsV1PaymentinstrumentsPost(String profileId, Body2 body) throws ApiException { - ApiResponse resp = tmsV1PaymentinstrumentsPostWithHttpInfo(profileId, body); + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments createPaymentInstrument(String profileId, CreatePaymentInstrumentRequest createPaymentInstrumentRequest) throws ApiException { + ApiResponse resp = createPaymentInstrumentWithHttpInfo(profileId, createPaymentInstrumentRequest); return resp.getData(); } @@ -299,13 +148,13 @@ public TmsV1PaymentinstrumentsPost201Response tmsV1PaymentinstrumentsPost(String * Create a Payment Instrument * * @param profileId The id of a profile containing user specific TMS configuration. (required) - * @param body Please specify the customers payment details for card or bank account. (required) - * @return ApiResponse<TmsV1PaymentinstrumentsPost201Response> + * @param createPaymentInstrumentRequest Specify the customer's payment details for card or bank account. (required) + * @return ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse tmsV1PaymentinstrumentsPostWithHttpInfo(String profileId, Body2 body) throws ApiException { - com.squareup.okhttp.Call call = tmsV1PaymentinstrumentsPostValidateBeforeCall(profileId, body, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse createPaymentInstrumentWithHttpInfo(String profileId, CreatePaymentInstrumentRequest createPaymentInstrumentRequest) throws ApiException { + com.squareup.okhttp.Call call = createPaymentInstrumentValidateBeforeCall(profileId, createPaymentInstrumentRequest, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -313,12 +162,12 @@ public ApiResponse tmsV1Paymentinstrumen * Create a Payment Instrument (asynchronously) * * @param profileId The id of a profile containing user specific TMS configuration. (required) - * @param body Please specify the customers payment details for card or bank account. (required) + * @param createPaymentInstrumentRequest Specify the customer's payment details for card or bank account. (required) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call tmsV1PaymentinstrumentsPostAsync(String profileId, Body2 body, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call createPaymentInstrumentAsync(String profileId, CreatePaymentInstrumentRequest createPaymentInstrumentRequest, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -339,13 +188,13 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = tmsV1PaymentinstrumentsPostValidateBeforeCall(profileId, body, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = createPaymentInstrumentValidateBeforeCall(profileId, createPaymentInstrumentRequest, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** - * Build call for tmsV1PaymentinstrumentsTokenIdDelete + * Build call for deletePaymentInstrument * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of a Payment Instrument. (required) * @param progressListener Progress listener @@ -353,7 +202,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdDeleteCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call deletePaymentInstrumentCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -397,20 +246,20 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdDeleteValidateBeforeCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call deletePaymentInstrumentValidateBeforeCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'profileId' is set if (profileId == null) { - throw new ApiException("Missing the required parameter 'profileId' when calling tmsV1PaymentinstrumentsTokenIdDelete(Async)"); + throw new ApiException("Missing the required parameter 'profileId' when calling deletePaymentInstrument(Async)"); } // verify the required parameter 'tokenId' is set if (tokenId == null) { - throw new ApiException("Missing the required parameter 'tokenId' when calling tmsV1PaymentinstrumentsTokenIdDelete(Async)"); + throw new ApiException("Missing the required parameter 'tokenId' when calling deletePaymentInstrument(Async)"); } - com.squareup.okhttp.Call call = tmsV1PaymentinstrumentsTokenIdDeleteCall(profileId, tokenId, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = deletePaymentInstrumentCall(profileId, tokenId, progressListener, progressRequestListener); return call; @@ -426,8 +275,8 @@ private com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdDeleteValidateBef * @param tokenId The TokenId of a Payment Instrument. (required) * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public void tmsV1PaymentinstrumentsTokenIdDelete(String profileId, String tokenId) throws ApiException { - tmsV1PaymentinstrumentsTokenIdDeleteWithHttpInfo(profileId, tokenId); + public void deletePaymentInstrument(String profileId, String tokenId) throws ApiException { + deletePaymentInstrumentWithHttpInfo(profileId, tokenId); } /** @@ -438,8 +287,8 @@ public void tmsV1PaymentinstrumentsTokenIdDelete(String profileId, String tokenI * @return ApiResponse<Void> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse tmsV1PaymentinstrumentsTokenIdDeleteWithHttpInfo(String profileId, String tokenId) throws ApiException { - com.squareup.okhttp.Call call = tmsV1PaymentinstrumentsTokenIdDeleteValidateBeforeCall(profileId, tokenId, null, null); + public ApiResponse deletePaymentInstrumentWithHttpInfo(String profileId, String tokenId) throws ApiException { + com.squareup.okhttp.Call call = deletePaymentInstrumentValidateBeforeCall(profileId, tokenId, null, null); return apiClient.execute(call); } @@ -452,7 +301,7 @@ public ApiResponse tmsV1PaymentinstrumentsTokenIdDeleteWithHttpInfo(String * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdDeleteAsync(String profileId, String tokenId, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call deletePaymentInstrumentAsync(String profileId, String tokenId, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -473,12 +322,12 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = tmsV1PaymentinstrumentsTokenIdDeleteValidateBeforeCall(profileId, tokenId, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = deletePaymentInstrumentValidateBeforeCall(profileId, tokenId, progressListener, progressRequestListener); apiClient.executeAsync(call, callback); return call; } /** - * Build call for tmsV1PaymentinstrumentsTokenIdGet + * Build call for getPaymentInstrument * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of a Payment Instrument. (required) * @param progressListener Progress listener @@ -486,7 +335,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdGetCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getPaymentInstrumentCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -530,20 +379,20 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdGetValidateBeforeCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getPaymentInstrumentValidateBeforeCall(String profileId, String tokenId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'profileId' is set if (profileId == null) { - throw new ApiException("Missing the required parameter 'profileId' when calling tmsV1PaymentinstrumentsTokenIdGet(Async)"); + throw new ApiException("Missing the required parameter 'profileId' when calling getPaymentInstrument(Async)"); } // verify the required parameter 'tokenId' is set if (tokenId == null) { - throw new ApiException("Missing the required parameter 'tokenId' when calling tmsV1PaymentinstrumentsTokenIdGet(Async)"); + throw new ApiException("Missing the required parameter 'tokenId' when calling getPaymentInstrument(Async)"); } - com.squareup.okhttp.Call call = tmsV1PaymentinstrumentsTokenIdGetCall(profileId, tokenId, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getPaymentInstrumentCall(profileId, tokenId, progressListener, progressRequestListener); return call; @@ -557,11 +406,11 @@ private com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdGetValidateBefore * * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of a Payment Instrument. (required) - * @return TmsV1PaymentinstrumentsGet200Response + * @return TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public TmsV1PaymentinstrumentsGet200Response tmsV1PaymentinstrumentsTokenIdGet(String profileId, String tokenId) throws ApiException { - ApiResponse resp = tmsV1PaymentinstrumentsTokenIdGetWithHttpInfo(profileId, tokenId); + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments getPaymentInstrument(String profileId, String tokenId) throws ApiException { + ApiResponse resp = getPaymentInstrumentWithHttpInfo(profileId, tokenId); return resp.getData(); } @@ -570,12 +419,12 @@ public TmsV1PaymentinstrumentsGet200Response tmsV1PaymentinstrumentsTokenIdGet(S * * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of a Payment Instrument. (required) - * @return ApiResponse<TmsV1PaymentinstrumentsGet200Response> + * @return ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse tmsV1PaymentinstrumentsTokenIdGetWithHttpInfo(String profileId, String tokenId) throws ApiException { - com.squareup.okhttp.Call call = tmsV1PaymentinstrumentsTokenIdGetValidateBeforeCall(profileId, tokenId, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse getPaymentInstrumentWithHttpInfo(String profileId, String tokenId) throws ApiException { + com.squareup.okhttp.Call call = getPaymentInstrumentValidateBeforeCall(profileId, tokenId, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -588,7 +437,7 @@ public ApiResponse tmsV1Paymentinstrument * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdGetAsync(String profileId, String tokenId, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getPaymentInstrumentAsync(String profileId, String tokenId, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -609,23 +458,23 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = tmsV1PaymentinstrumentsTokenIdGetValidateBeforeCall(profileId, tokenId, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = getPaymentInstrumentValidateBeforeCall(profileId, tokenId, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } /** - * Build call for tmsV1PaymentinstrumentsTokenIdPatch + * Build call for updatePaymentInstrument * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of a Payment Instrument. (required) - * @param body Please specify the customers payment details. (required) + * @param updatePaymentInstrumentRequest Specify the customer's payment details. (required) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdPatchCall(String profileId, String tokenId, Body3 body, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { - Object localVarPostBody = body; + public com.squareup.okhttp.Call updatePaymentInstrumentCall(String profileId, String tokenId, UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = updatePaymentInstrumentRequest; // create path and map variables String localVarPath = "/tms/v1/paymentinstruments/{tokenId}" @@ -668,25 +517,25 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdPatchValidateBeforeCall(String profileId, String tokenId, Body3 body, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call updatePaymentInstrumentValidateBeforeCall(String profileId, String tokenId, UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'profileId' is set if (profileId == null) { - throw new ApiException("Missing the required parameter 'profileId' when calling tmsV1PaymentinstrumentsTokenIdPatch(Async)"); + throw new ApiException("Missing the required parameter 'profileId' when calling updatePaymentInstrument(Async)"); } // verify the required parameter 'tokenId' is set if (tokenId == null) { - throw new ApiException("Missing the required parameter 'tokenId' when calling tmsV1PaymentinstrumentsTokenIdPatch(Async)"); + throw new ApiException("Missing the required parameter 'tokenId' when calling updatePaymentInstrument(Async)"); } - // verify the required parameter 'body' is set - if (body == null) { - throw new ApiException("Missing the required parameter 'body' when calling tmsV1PaymentinstrumentsTokenIdPatch(Async)"); + // verify the required parameter 'updatePaymentInstrumentRequest' is set + if (updatePaymentInstrumentRequest == null) { + throw new ApiException("Missing the required parameter 'updatePaymentInstrumentRequest' when calling updatePaymentInstrument(Async)"); } - com.squareup.okhttp.Call call = tmsV1PaymentinstrumentsTokenIdPatchCall(profileId, tokenId, body, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = updatePaymentInstrumentCall(profileId, tokenId, updatePaymentInstrumentRequest, progressListener, progressRequestListener); return call; @@ -700,12 +549,12 @@ private com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdPatchValidateBefo * * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of a Payment Instrument. (required) - * @param body Please specify the customers payment details. (required) - * @return TmsV1PaymentinstrumentsGet200Response + * @param updatePaymentInstrumentRequest Specify the customer's payment details. (required) + * @return TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public TmsV1PaymentinstrumentsGet200Response tmsV1PaymentinstrumentsTokenIdPatch(String profileId, String tokenId, Body3 body) throws ApiException { - ApiResponse resp = tmsV1PaymentinstrumentsTokenIdPatchWithHttpInfo(profileId, tokenId, body); + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments updatePaymentInstrument(String profileId, String tokenId, UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest) throws ApiException { + ApiResponse resp = updatePaymentInstrumentWithHttpInfo(profileId, tokenId, updatePaymentInstrumentRequest); return resp.getData(); } @@ -714,13 +563,13 @@ public TmsV1PaymentinstrumentsGet200Response tmsV1PaymentinstrumentsTokenIdPatch * * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of a Payment Instrument. (required) - * @param body Please specify the customers payment details. (required) - * @return ApiResponse<TmsV1PaymentinstrumentsGet200Response> + * @param updatePaymentInstrumentRequest Specify the customer's payment details. (required) + * @return ApiResponse<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse tmsV1PaymentinstrumentsTokenIdPatchWithHttpInfo(String profileId, String tokenId, Body3 body) throws ApiException { - com.squareup.okhttp.Call call = tmsV1PaymentinstrumentsTokenIdPatchValidateBeforeCall(profileId, tokenId, body, null, null); - Type localVarReturnType = new TypeToken(){}.getType(); + public ApiResponse updatePaymentInstrumentWithHttpInfo(String profileId, String tokenId, UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest) throws ApiException { + com.squareup.okhttp.Call call = updatePaymentInstrumentValidateBeforeCall(profileId, tokenId, updatePaymentInstrumentRequest, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -729,12 +578,12 @@ public ApiResponse tmsV1Paymentinstrument * * @param profileId The id of a profile containing user specific TMS configuration. (required) * @param tokenId The TokenId of a Payment Instrument. (required) - * @param body Please specify the customers payment details. (required) + * @param updatePaymentInstrumentRequest Specify the customer's payment details. (required) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call tmsV1PaymentinstrumentsTokenIdPatchAsync(String profileId, String tokenId, Body3 body, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call updatePaymentInstrumentAsync(String profileId, String tokenId, UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -755,8 +604,8 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = tmsV1PaymentinstrumentsTokenIdPatchValidateBeforeCall(profileId, tokenId, body, progressListener, progressRequestListener); - Type localVarReturnType = new TypeToken(){}.getType(); + com.squareup.okhttp.Call call = updatePaymentInstrumentValidateBeforeCall(profileId, tokenId, updatePaymentInstrumentRequest, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; } diff --git a/src/main/java/Api/PaymentsApi.java b/src/main/java/Api/PaymentsApi.java index c7409ff71..44b86b054 100644 --- a/src/main/java/Api/PaymentsApi.java +++ b/src/main/java/Api/PaymentsApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Api/ProcessAPayoutApi.java b/src/main/java/Api/PayoutsApi.java similarity index 83% rename from src/main/java/Api/ProcessAPayoutApi.java rename to src/main/java/Api/PayoutsApi.java index 801bd213d..482ea7f4c 100644 --- a/src/main/java/Api/ProcessAPayoutApi.java +++ b/src/main/java/Api/PayoutsApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,10 +27,10 @@ import java.io.IOException; +import Model.OctCreatePaymentRequest; +import Model.PtsV2PaymentsPost502Response; import Model.PtsV2PayoutsPost201Response; import Model.PtsV2PayoutsPost400Response; -import Model.PtsV2PayoutsPost502Response; -import Model.PtsV2PayoutsPostResponse; import java.lang.reflect.Type; import java.util.ArrayList; @@ -38,14 +38,14 @@ import java.util.List; import java.util.Map; -public class ProcessAPayoutApi { +public class PayoutsApi { private ApiClient apiClient; - public ProcessAPayoutApi() { + public PayoutsApi() { this(Configuration.getDefaultApiClient()); } - public ProcessAPayoutApi(ApiClient apiClient) { + public PayoutsApi(ApiClient apiClient) { this.apiClient = apiClient; } @@ -65,11 +65,11 @@ public void setApiClient(ApiClient apiClient) { * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call octCreatePaymentCall(PtsV2PayoutsPostResponse octCreatePaymentRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call octCreatePaymentCall(OctCreatePaymentRequest octCreatePaymentRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = octCreatePaymentRequest; // create path and map variables - String localVarPath = "/pts/v2/payouts/"; + String localVarPath = "/pts/v2/payouts"; List localVarQueryParams = new ArrayList(); @@ -104,7 +104,7 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call octCreatePaymentValidateBeforeCall(PtsV2PayoutsPostResponse octCreatePaymentRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call octCreatePaymentValidateBeforeCall(OctCreatePaymentRequest octCreatePaymentRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'octCreatePaymentRequest' is set if (octCreatePaymentRequest == null) { @@ -128,7 +128,7 @@ private com.squareup.okhttp.Call octCreatePaymentValidateBeforeCall(PtsV2Payouts * @return PtsV2PayoutsPost201Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public PtsV2PayoutsPost201Response octCreatePayment(PtsV2PayoutsPostResponse octCreatePaymentRequest) throws ApiException { + public PtsV2PayoutsPost201Response octCreatePayment(OctCreatePaymentRequest octCreatePaymentRequest) throws ApiException { ApiResponse resp = octCreatePaymentWithHttpInfo(octCreatePaymentRequest); return resp.getData(); } @@ -140,7 +140,7 @@ public PtsV2PayoutsPost201Response octCreatePayment(PtsV2PayoutsPostResponse oct * @return ApiResponse<PtsV2PayoutsPost201Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse octCreatePaymentWithHttpInfo(PtsV2PayoutsPostResponse octCreatePaymentRequest) throws ApiException { + public ApiResponse octCreatePaymentWithHttpInfo(OctCreatePaymentRequest octCreatePaymentRequest) throws ApiException { com.squareup.okhttp.Call call = octCreatePaymentValidateBeforeCall(octCreatePaymentRequest, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); @@ -154,7 +154,7 @@ public ApiResponse octCreatePaymentWithHttpInfo(Pts * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call octCreatePaymentAsync(PtsV2PayoutsPostResponse octCreatePaymentRequest, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call octCreatePaymentAsync(OctCreatePaymentRequest octCreatePaymentRequest, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; diff --git a/src/main/java/Api/PurchaseAndRefundDetailsApi.java b/src/main/java/Api/PurchaseAndRefundDetailsApi.java index 3d3143cf9..ee142b725 100644 --- a/src/main/java/Api/PurchaseAndRefundDetailsApi.java +++ b/src/main/java/Api/PurchaseAndRefundDetailsApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -58,8 +58,8 @@ public void setApiClient(ApiClient apiClient) { /** * Build call for getPurchaseAndRefundDetails - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param paymentSubtype Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit (optional, default to ALL) * @param viewBy View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date (optional, default to requestDate) @@ -153,8 +153,8 @@ private com.squareup.okhttp.Call getPurchaseAndRefundDetailsValidateBeforeCall(D /** * Get Purchase and Refund details * Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param paymentSubtype Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit (optional, default to ALL) * @param viewBy View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date (optional, default to requestDate) @@ -172,8 +172,8 @@ public ReportingV3PurchaseRefundDetailsGet200Response getPurchaseAndRefundDetail /** * Get Purchase and Refund details * Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param paymentSubtype Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit (optional, default to ALL) * @param viewBy View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date (optional, default to requestDate) @@ -192,8 +192,8 @@ public ApiResponse getPurchaseAn /** * Get Purchase and Refund details (asynchronously) * Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param paymentSubtype Payment Subtypes. - **ALL**: All Payment Subtypes - **VI** : Visa - **MC** : Master Card - **AX** : American Express - **DI** : Discover - **DP** : Pinless Debit (optional, default to ALL) * @param viewBy View results by Request Date or Submission Date. - **requestDate** : Request Date - **submissionDate**: Submission Date (optional, default to requestDate) diff --git a/src/main/java/Api/RefundApi.java b/src/main/java/Api/RefundApi.java index 85d3780ef..a61470c83 100644 --- a/src/main/java/Api/RefundApi.java +++ b/src/main/java/Api/RefundApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Api/ReportDefinitionsApi.java b/src/main/java/Api/ReportDefinitionsApi.java index 43dfeace8..5aa26c6fe 100644 --- a/src/main/java/Api/ReportDefinitionsApi.java +++ b/src/main/java/Api/ReportDefinitionsApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Api/ReportDownloadsApi.java b/src/main/java/Api/ReportDownloadsApi.java index a5fbfb923..ca8738c4b 100644 --- a/src/main/java/Api/ReportDownloadsApi.java +++ b/src/main/java/Api/ReportDownloadsApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Api/ReportSubscriptionsApi.java b/src/main/java/Api/ReportSubscriptionsApi.java index ac6b625bb..0009b764a 100644 --- a/src/main/java/Api/ReportSubscriptionsApi.java +++ b/src/main/java/Api/ReportSubscriptionsApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Api/ReportsApi.java b/src/main/java/Api/ReportsApi.java index b4769a45c..8dca05ae6 100644 --- a/src/main/java/Api/ReportsApi.java +++ b/src/main/java/Api/ReportsApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -319,8 +319,8 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don } /** * Build call for searchReports - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param timeQueryType Specify time you would like to search (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param reportMimeType Valid Report Format (optional) @@ -422,8 +422,8 @@ private com.squareup.okhttp.Call searchReportsValidateBeforeCall(DateTime startT /** * Retrieve available reports * Retrieve a list of the available reports to which you are subscribed. This will also give you the reportId value, which you can also use to download a report. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param timeQueryType Specify time you would like to search (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param reportMimeType Valid Report Format (optional) @@ -442,8 +442,8 @@ public ReportingV3ReportsGet200Response searchReports(DateTime startTime, DateTi /** * Retrieve available reports * Retrieve a list of the available reports to which you are subscribed. This will also give you the reportId value, which you can also use to download a report. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param timeQueryType Specify time you would like to search (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param reportMimeType Valid Report Format (optional) @@ -463,8 +463,8 @@ public ApiResponse searchReportsWithHttpInfo(D /** * Retrieve available reports (asynchronously) * Retrieve a list of the available reports to which you are subscribed. This will also give you the reportId value, which you can also use to download a report. - * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) - * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ssXXX (required) + * @param startTime Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) + * @param endTime Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) (required) * @param timeQueryType Specify time you would like to search (required) * @param organizationId Valid Cybersource Organization Id (optional) * @param reportMimeType Valid Report Format (optional) diff --git a/src/main/java/Api/ReversalApi.java b/src/main/java/Api/ReversalApi.java index d8ed9b4fc..e4c732e94 100644 --- a/src/main/java/Api/ReversalApi.java +++ b/src/main/java/Api/ReversalApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,6 +28,7 @@ import Model.AuthReversalRequest; +import Model.MitReversalRequest; import Model.PtsV2PaymentsPost502Response; import Model.PtsV2PaymentsReversalsPost201Response; import Model.PtsV2PaymentsReversalsPost400Response; @@ -190,5 +191,128 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don apiClient.executeAsync(call, localVarReturnType, callback); return call; } + /** + * Build call for mitReversal + * @param mitReversalRequest (required) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call mitReversalCall(MitReversalRequest mitReversalRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = mitReversalRequest; + + // create path and map variables + String localVarPath = "/pts/v2/reversals/"; + + List localVarQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + + Map localVarFormParams = new HashMap(); + +final String[] localVarAccepts = {"application/hal+json;charset=utf-8"}; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + "application/json;charset=utf-8" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call mitReversalValidateBeforeCall(MitReversalRequest mitReversalRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'mitReversalRequest' is set + if (mitReversalRequest == null) { + throw new ApiException("Missing the required parameter 'mitReversalRequest' when calling mitReversal(Async)"); + } + + + com.squareup.okhttp.Call call = mitReversalCall(mitReversalRequest, progressListener, progressRequestListener); + return call; + + + + + + } + + /** + * Merchant Initiated Reversal + * This is to reverse a previous payment that merchant does not receive a reply. + * @param mitReversalRequest (required) + * @return PtsV2PaymentsReversalsPost201Response + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public PtsV2PaymentsReversalsPost201Response mitReversal(MitReversalRequest mitReversalRequest) throws ApiException { + ApiResponse resp = mitReversalWithHttpInfo(mitReversalRequest); + return resp.getData(); + } + + /** + * Merchant Initiated Reversal + * This is to reverse a previous payment that merchant does not receive a reply. + * @param mitReversalRequest (required) + * @return ApiResponse<PtsV2PaymentsReversalsPost201Response> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse mitReversalWithHttpInfo(MitReversalRequest mitReversalRequest) throws ApiException { + com.squareup.okhttp.Call call = mitReversalValidateBeforeCall(mitReversalRequest, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Merchant Initiated Reversal (asynchronously) + * This is to reverse a previous payment that merchant does not receive a reply. + * @param mitReversalRequest (required) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call mitReversalAsync(MitReversalRequest mitReversalRequest, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = mitReversalValidateBeforeCall(mitReversalRequest, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } } diff --git a/src/main/java/Api/SearchTransactionsApi.java b/src/main/java/Api/SearchTransactionsApi.java index b6285a0ad..8b634f4d3 100644 --- a/src/main/java/Api/SearchTransactionsApi.java +++ b/src/main/java/Api/SearchTransactionsApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,10 +27,10 @@ import java.io.IOException; -import Model.PtsV2PayoutsPost502Response; +import Model.CreateSearchRequest; +import Model.PtsV2PaymentsPost502Response; import Model.TssV2TransactionsPost201Response; import Model.TssV2TransactionsPost400Response; -import Model.TssV2TransactionsPostResponse; import java.lang.reflect.Type; import java.util.ArrayList; @@ -65,7 +65,7 @@ public void setApiClient(ApiClient apiClient) { * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call createSearchCall(TssV2TransactionsPostResponse createSearchRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call createSearchCall(CreateSearchRequest createSearchRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = createSearchRequest; // create path and map variables @@ -104,7 +104,7 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call createSearchValidateBeforeCall(TssV2TransactionsPostResponse createSearchRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call createSearchValidateBeforeCall(CreateSearchRequest createSearchRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'createSearchRequest' is set if (createSearchRequest == null) { @@ -128,7 +128,7 @@ private com.squareup.okhttp.Call createSearchValidateBeforeCall(TssV2Transaction * @return TssV2TransactionsPost201Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public TssV2TransactionsPost201Response createSearch(TssV2TransactionsPostResponse createSearchRequest) throws ApiException { + public TssV2TransactionsPost201Response createSearch(CreateSearchRequest createSearchRequest) throws ApiException { ApiResponse resp = createSearchWithHttpInfo(createSearchRequest); return resp.getData(); } @@ -140,7 +140,7 @@ public TssV2TransactionsPost201Response createSearch(TssV2TransactionsPostRespon * @return ApiResponse<TssV2TransactionsPost201Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse createSearchWithHttpInfo(TssV2TransactionsPostResponse createSearchRequest) throws ApiException { + public ApiResponse createSearchWithHttpInfo(CreateSearchRequest createSearchRequest) throws ApiException { com.squareup.okhttp.Call call = createSearchValidateBeforeCall(createSearchRequest, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); @@ -154,7 +154,7 @@ public ApiResponse createSearchWithHttpInfo(Ts * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call createSearchAsync(TssV2TransactionsPostResponse createSearchRequest, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call createSearchAsync(CreateSearchRequest createSearchRequest, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -182,18 +182,18 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don } /** * Build call for getSearch - * @param id Search ID. (required) + * @param searchId Search ID. (required) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getSearchCall(String id, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getSearchCall(String searchId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables - String localVarPath = "/tss/v2/searches/{id}" - .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + String localVarPath = "/tss/v2/searches/{searchId}" + .replaceAll("\\{" + "searchId" + "\\}", apiClient.escapeString(searchId.toString())); List localVarQueryParams = new ArrayList(); @@ -228,15 +228,15 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getSearchValidateBeforeCall(String id, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getSearchValidateBeforeCall(String searchId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { - // verify the required parameter 'id' is set - if (id == null) { - throw new ApiException("Missing the required parameter 'id' when calling getSearch(Async)"); + // verify the required parameter 'searchId' is set + if (searchId == null) { + throw new ApiException("Missing the required parameter 'searchId' when calling getSearch(Async)"); } - com.squareup.okhttp.Call call = getSearchCall(id, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getSearchCall(searchId, progressListener, progressRequestListener); return call; @@ -247,38 +247,38 @@ private com.squareup.okhttp.Call getSearchValidateBeforeCall(String id, final Pr /** * Get Search results - * Include the Search ID in the GET request to retrieve the search results. - * @param id Search ID. (required) + * Include the Search ID in the GET request to retrieve the search results. + * @param searchId Search ID. (required) * @return TssV2TransactionsPost201Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public TssV2TransactionsPost201Response getSearch(String id) throws ApiException { - ApiResponse resp = getSearchWithHttpInfo(id); + public TssV2TransactionsPost201Response getSearch(String searchId) throws ApiException { + ApiResponse resp = getSearchWithHttpInfo(searchId); return resp.getData(); } /** * Get Search results - * Include the Search ID in the GET request to retrieve the search results. - * @param id Search ID. (required) + * Include the Search ID in the GET request to retrieve the search results. + * @param searchId Search ID. (required) * @return ApiResponse<TssV2TransactionsPost201Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getSearchWithHttpInfo(String id) throws ApiException { - com.squareup.okhttp.Call call = getSearchValidateBeforeCall(id, null, null); + public ApiResponse getSearchWithHttpInfo(String searchId) throws ApiException { + com.squareup.okhttp.Call call = getSearchValidateBeforeCall(searchId, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } /** * Get Search results (asynchronously) - * Include the Search ID in the GET request to retrieve the search results. - * @param id Search ID. (required) + * Include the Search ID in the GET request to retrieve the search results. + * @param searchId Search ID. (required) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getSearchAsync(String id, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getSearchAsync(String searchId, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -299,7 +299,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getSearchValidateBeforeCall(id, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getSearchValidateBeforeCall(searchId, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; diff --git a/src/main/java/Api/SecureFileShareApi.java b/src/main/java/Api/SecureFileShareApi.java index f41367dee..ae833a51f 100644 --- a/src/main/java/Api/SecureFileShareApi.java +++ b/src/main/java/Api/SecureFileShareApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -183,7 +183,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don return call; } /** - * Build call for getFileDetails + * Build call for getFileDetail * @param startDate Valid start date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd (required) * @param endDate Valid end date in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format. - https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14 **Example date format:** - yyyy-MM-dd (required) * @param organizationId Valid Cybersource Organization Id (optional) @@ -192,7 +192,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don * @return Call to execute * @throws ApiException If fail to serialize the request body object */ - public com.squareup.okhttp.Call getFileDetailsCall(LocalDate startDate, LocalDate endDate, String organizationId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + public com.squareup.okhttp.Call getFileDetailCall(LocalDate startDate, LocalDate endDate, String organizationId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { Object localVarPostBody = null; // create path and map variables @@ -237,20 +237,20 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch } @SuppressWarnings("rawtypes") - private com.squareup.okhttp.Call getFileDetailsValidateBeforeCall(LocalDate startDate, LocalDate endDate, String organizationId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + private com.squareup.okhttp.Call getFileDetailValidateBeforeCall(LocalDate startDate, LocalDate endDate, String organizationId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { // verify the required parameter 'startDate' is set if (startDate == null) { - throw new ApiException("Missing the required parameter 'startDate' when calling getFileDetails(Async)"); + throw new ApiException("Missing the required parameter 'startDate' when calling getFileDetail(Async)"); } // verify the required parameter 'endDate' is set if (endDate == null) { - throw new ApiException("Missing the required parameter 'endDate' when calling getFileDetails(Async)"); + throw new ApiException("Missing the required parameter 'endDate' when calling getFileDetail(Async)"); } - com.squareup.okhttp.Call call = getFileDetailsCall(startDate, endDate, organizationId, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getFileDetailCall(startDate, endDate, organizationId, progressListener, progressRequestListener); return call; @@ -268,8 +268,8 @@ private com.squareup.okhttp.Call getFileDetailsValidateBeforeCall(LocalDate star * @return V1FileDetailsGet200Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public V1FileDetailsGet200Response getFileDetails(LocalDate startDate, LocalDate endDate, String organizationId) throws ApiException { - ApiResponse resp = getFileDetailsWithHttpInfo(startDate, endDate, organizationId); + public V1FileDetailsGet200Response getFileDetail(LocalDate startDate, LocalDate endDate, String organizationId) throws ApiException { + ApiResponse resp = getFileDetailWithHttpInfo(startDate, endDate, organizationId); return resp.getData(); } @@ -282,8 +282,8 @@ public V1FileDetailsGet200Response getFileDetails(LocalDate startDate, LocalDate * @return ApiResponse<V1FileDetailsGet200Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ - public ApiResponse getFileDetailsWithHttpInfo(LocalDate startDate, LocalDate endDate, String organizationId) throws ApiException { - com.squareup.okhttp.Call call = getFileDetailsValidateBeforeCall(startDate, endDate, organizationId, null, null); + public ApiResponse getFileDetailWithHttpInfo(LocalDate startDate, LocalDate endDate, String organizationId) throws ApiException { + com.squareup.okhttp.Call call = getFileDetailValidateBeforeCall(startDate, endDate, organizationId, null, null); Type localVarReturnType = new TypeToken(){}.getType(); return apiClient.execute(call, localVarReturnType); } @@ -298,7 +298,7 @@ public ApiResponse getFileDetailsWithHttpInfo(Local * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ - public com.squareup.okhttp.Call getFileDetailsAsync(LocalDate startDate, LocalDate endDate, String organizationId, final ApiCallback callback) throws ApiException { + public com.squareup.okhttp.Call getFileDetailAsync(LocalDate startDate, LocalDate endDate, String organizationId, final ApiCallback callback) throws ApiException { ProgressResponseBody.ProgressListener progressListener = null; ProgressRequestBody.ProgressRequestListener progressRequestListener = null; @@ -319,7 +319,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don }; } - com.squareup.okhttp.Call call = getFileDetailsValidateBeforeCall(startDate, endDate, organizationId, progressListener, progressRequestListener); + com.squareup.okhttp.Call call = getFileDetailValidateBeforeCall(startDate, endDate, organizationId, progressListener, progressRequestListener); Type localVarReturnType = new TypeToken(){}.getType(); apiClient.executeAsync(call, localVarReturnType, callback); return call; diff --git a/src/main/java/Api/FlexTokenApi.java b/src/main/java/Api/TokenizationApi.java similarity index 89% rename from src/main/java/Api/FlexTokenApi.java rename to src/main/java/Api/TokenizationApi.java index 6efd1781b..26cbdc385 100644 --- a/src/main/java/Api/FlexTokenApi.java +++ b/src/main/java/Api/TokenizationApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -37,14 +37,14 @@ import java.util.List; import java.util.Map; -public class FlexTokenApi { +public class TokenizationApi { private ApiClient apiClient; - public FlexTokenApi() { + public TokenizationApi() { this(Configuration.getDefaultApiClient()); } - public FlexTokenApi(ApiClient apiClient) { + public TokenizationApi(ApiClient apiClient) { this.apiClient = apiClient; } @@ -58,7 +58,7 @@ public void setApiClient(ApiClient apiClient) { /** * Build call for tokenize - * @param tokenizeRequest (optional) + * @param tokenizeRequest (required) * @param progressListener Progress listener * @param progressRequestListener Progress request listener * @return Call to execute @@ -68,7 +68,7 @@ public com.squareup.okhttp.Call tokenizeCall(TokenizeRequest tokenizeRequest, fi Object localVarPostBody = tokenizeRequest; // create path and map variables - String localVarPath = "/flex/v1/tokens/"; + String localVarPath = "/flex/v1/tokens"; List localVarQueryParams = new ArrayList(); @@ -107,6 +107,11 @@ public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Ch @SuppressWarnings("rawtypes") private com.squareup.okhttp.Call tokenizeValidateBeforeCall(TokenizeRequest tokenizeRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + // verify the required parameter 'tokenizeRequest' is set + if (tokenizeRequest == null) { + throw new ApiException("Missing the required parameter 'tokenizeRequest' when calling tokenize(Async)"); + } + com.squareup.okhttp.Call call = tokenizeCall(tokenizeRequest, progressListener, progressRequestListener); return call; @@ -118,9 +123,9 @@ private com.squareup.okhttp.Call tokenizeValidateBeforeCall(TokenizeRequest toke } /** - * Flex Tokenize card + * Tokenize card * Returns a token representing the supplied card details. The token replaces card data and can be used as the Subscription ID in the CyberSource Simple Order API or SCMP API. This is an unauthenticated call that you should initiate from your customer’s device or browser. - * @param tokenizeRequest (optional) + * @param tokenizeRequest (required) * @return FlexV1TokensPost200Response * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -130,9 +135,9 @@ public FlexV1TokensPost200Response tokenize(TokenizeRequest tokenizeRequest) thr } /** - * Flex Tokenize card + * Tokenize card * Returns a token representing the supplied card details. The token replaces card data and can be used as the Subscription ID in the CyberSource Simple Order API or SCMP API. This is an unauthenticated call that you should initiate from your customer’s device or browser. - * @param tokenizeRequest (optional) + * @param tokenizeRequest (required) * @return ApiResponse<FlexV1TokensPost200Response> * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body */ @@ -143,9 +148,9 @@ public ApiResponse tokenizeWithHttpInfo(TokenizeReq } /** - * Flex Tokenize card (asynchronously) + * Tokenize card (asynchronously) * Returns a token representing the supplied card details. The token replaces card data and can be used as the Subscription ID in the CyberSource Simple Order API or SCMP API. This is an unauthenticated call that you should initiate from your customer’s device or browser. - * @param tokenizeRequest (optional) + * @param tokenizeRequest (required) * @param callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object diff --git a/src/main/java/Api/TransactionBatchesApi.java b/src/main/java/Api/TransactionBatchesApi.java index e8fba8d84..cd2bfa123 100644 --- a/src/main/java/Api/TransactionBatchesApi.java +++ b/src/main/java/Api/TransactionBatchesApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,6 +28,7 @@ import org.joda.time.DateTime; +import org.joda.time.LocalDate; import Model.PtsV1TransactionBatchesGet200Response; import Model.PtsV1TransactionBatchesGet400Response; import Model.PtsV1TransactionBatchesGet500Response; @@ -58,6 +59,141 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } + /** + * Build call for getTransactionBatchDetails + * @param transactionBatchId Transaction Batch Id, this is unique. (required) + * @param uploadDate Date in which the original batch file was uploaded. Date must be in ISO-8601 format. (optional) + * @param status Allows you to filter by rejected response. (optional) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call getTransactionBatchDetailsCall(String transactionBatchId, LocalDate uploadDate, String status, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/pts/v1/transaction-batch-details"; + + List localVarQueryParams = new ArrayList(); + if (transactionBatchId != null) + localVarQueryParams.addAll(apiClient.parameterToPairs("", "transactionBatchId", transactionBatchId)); + if (uploadDate != null) + localVarQueryParams.addAll(apiClient.parameterToPairs("", "uploadDate", uploadDate)); + if (status != null) + localVarQueryParams.addAll(apiClient.parameterToPairs("", "status", status)); + + Map localVarHeaderParams = new HashMap(); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "text/vnd.cybersource.map-csv" + }; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + "application/json;charset=utf-8" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call getTransactionBatchDetailsValidateBeforeCall(String transactionBatchId, LocalDate uploadDate, String status, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'transactionBatchId' is set + if (transactionBatchId == null) { + throw new ApiException("Missing the required parameter 'transactionBatchId' when calling getTransactionBatchDetails(Async)"); + } + + + com.squareup.okhttp.Call call = getTransactionBatchDetailsCall(transactionBatchId, uploadDate, status, progressListener, progressRequestListener); + return call; + + + + + + } + + /** + * Filters batch response. + * Filters batch response. + * @param transactionBatchId Transaction Batch Id, this is unique. (required) + * @param uploadDate Date in which the original batch file was uploaded. Date must be in ISO-8601 format. (optional) + * @param status Allows you to filter by rejected response. (optional) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public void getTransactionBatchDetails(String transactionBatchId, LocalDate uploadDate, String status) throws ApiException { + getTransactionBatchDetailsWithHttpInfo(transactionBatchId, uploadDate, status); + } + + /** + * Filters batch response. + * Filters batch response. + * @param transactionBatchId Transaction Batch Id, this is unique. (required) + * @param uploadDate Date in which the original batch file was uploaded. Date must be in ISO-8601 format. (optional) + * @param status Allows you to filter by rejected response. (optional) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getTransactionBatchDetailsWithHttpInfo(String transactionBatchId, LocalDate uploadDate, String status) throws ApiException { + com.squareup.okhttp.Call call = getTransactionBatchDetailsValidateBeforeCall(transactionBatchId, uploadDate, status, null, null); + return apiClient.execute(call); + } + + /** + * Filters batch response. (asynchronously) + * Filters batch response. + * @param transactionBatchId Transaction Batch Id, this is unique. (required) + * @param uploadDate Date in which the original batch file was uploaded. Date must be in ISO-8601 format. (optional) + * @param status Allows you to filter by rejected response. (optional) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call getTransactionBatchDetailsAsync(String transactionBatchId, LocalDate uploadDate, String status, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = getTransactionBatchDetailsValidateBeforeCall(transactionBatchId, uploadDate, status, progressListener, progressRequestListener); + apiClient.executeAsync(call, callback); + return call; + } /** * Build call for getTransactionBatchId * @param id The batch id assigned for the template. (required) diff --git a/src/main/java/Api/TransactionDetailsApi.java b/src/main/java/Api/TransactionDetailsApi.java index 0341deae7..4c4bb11e5 100644 --- a/src/main/java/Api/TransactionDetailsApi.java +++ b/src/main/java/Api/TransactionDetailsApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Api/UserManagementApi.java b/src/main/java/Api/UserManagementApi.java index b670fbf16..c7316e6c5 100644 --- a/src/main/java/Api/UserManagementApi.java +++ b/src/main/java/Api/UserManagementApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,8 +27,8 @@ import java.io.IOException; +import Model.PtsV2PaymentsRefundPost400Response; import Model.UmsV1UsersGet200Response; -import Model.UmsV1UsersGet400Response; import java.lang.reflect.Type; import java.util.ArrayList; diff --git a/src/main/java/Api/VoidApi.java b/src/main/java/Api/VoidApi.java index b4e1fb32e..3fad82c5e 100644 --- a/src/main/java/Api/VoidApi.java +++ b/src/main/java/Api/VoidApi.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,6 +27,7 @@ import java.io.IOException; +import Model.MitVoidRequest; import Model.PtsV2PaymentsPost502Response; import Model.PtsV2PaymentsVoidsPost201Response; import Model.PtsV2PaymentsVoidsPost400Response; @@ -60,6 +61,129 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } + /** + * Build call for mitVoid + * @param mitVoidRequest (required) + * @param progressListener Progress listener + * @param progressRequestListener Progress request listener + * @return Call to execute + * @throws ApiException If fail to serialize the request body object + */ + public com.squareup.okhttp.Call mitVoidCall(MitVoidRequest mitVoidRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = mitVoidRequest; + + // create path and map variables + String localVarPath = "/pts/v2/voids/"; + + List localVarQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + + Map localVarFormParams = new HashMap(); + +final String[] localVarAccepts = {"application/hal+json;charset=utf-8"}; + final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); + if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); + + final String[] localVarContentTypes = { + "application/json;charset=utf-8" + }; + final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes); + localVarHeaderParams.put("Content-Type", localVarContentType); + + if(progressListener != null) { + apiClient.getHttpClient().networkInterceptors().add(new com.squareup.okhttp.Interceptor() { + @Override + public com.squareup.okhttp.Response intercept(com.squareup.okhttp.Interceptor.Chain chain) throws IOException { + com.squareup.okhttp.Response originalResponse = chain.proceed(chain.request()); + return originalResponse.newBuilder() + .body(new ProgressResponseBody(originalResponse.body(), progressListener)) + .build(); + } + }); + } + + String[] localVarAuthNames = new String[] { }; + return apiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarPostBody, localVarHeaderParams, localVarFormParams, localVarAuthNames, progressRequestListener); + } + + @SuppressWarnings("rawtypes") + private com.squareup.okhttp.Call mitVoidValidateBeforeCall(MitVoidRequest mitVoidRequest, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'mitVoidRequest' is set + if (mitVoidRequest == null) { + throw new ApiException("Missing the required parameter 'mitVoidRequest' when calling mitVoid(Async)"); + } + + + com.squareup.okhttp.Call call = mitVoidCall(mitVoidRequest, progressListener, progressRequestListener); + return call; + + + + + + } + + /** + * Merchant Initiated Void + * This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply. + * @param mitVoidRequest (required) + * @return PtsV2PaymentsVoidsPost201Response + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public PtsV2PaymentsVoidsPost201Response mitVoid(MitVoidRequest mitVoidRequest) throws ApiException { + ApiResponse resp = mitVoidWithHttpInfo(mitVoidRequest); + return resp.getData(); + } + + /** + * Merchant Initiated Void + * This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply. + * @param mitVoidRequest (required) + * @return ApiResponse<PtsV2PaymentsVoidsPost201Response> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse mitVoidWithHttpInfo(MitVoidRequest mitVoidRequest) throws ApiException { + com.squareup.okhttp.Call call = mitVoidValidateBeforeCall(mitVoidRequest, null, null); + Type localVarReturnType = new TypeToken(){}.getType(); + return apiClient.execute(call, localVarReturnType); + } + + /** + * Merchant Initiated Void (asynchronously) + * This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply. + * @param mitVoidRequest (required) + * @param callback The callback to be executed when the API call finishes + * @return The request call + * @throws ApiException If fail to process the API call, e.g. serializing the request body object + */ + public com.squareup.okhttp.Call mitVoidAsync(MitVoidRequest mitVoidRequest, final ApiCallback callback) throws ApiException { + + ProgressResponseBody.ProgressListener progressListener = null; + ProgressRequestBody.ProgressRequestListener progressRequestListener = null; + + if (callback != null) { + progressListener = new ProgressResponseBody.ProgressListener() { + @Override + public void update(long bytesRead, long contentLength, boolean done) { + callback.onDownloadProgress(bytesRead, contentLength, done); + } + }; + + progressRequestListener = new ProgressRequestBody.ProgressRequestListener() { + @Override + public void onRequestProgress(long bytesWritten, long contentLength, boolean done) { + callback.onUploadProgress(bytesWritten, contentLength, done); + } + }; + } + + com.squareup.okhttp.Call call = mitVoidValidateBeforeCall(mitVoidRequest, progressListener, progressRequestListener); + Type localVarReturnType = new TypeToken(){}.getType(); + apiClient.executeAsync(call, localVarReturnType, callback); + return call; + } /** * Build call for voidCapture * @param voidCaptureRequest (required) diff --git a/src/main/java/Invokers/ApiCallback.java b/src/main/java/Invokers/ApiCallback.java index b5660bae4..35b4536f4 100644 --- a/src/main/java/Invokers/ApiCallback.java +++ b/src/main/java/Invokers/ApiCallback.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Invokers/ApiException.java b/src/main/java/Invokers/ApiException.java index 262e887bb..241854d26 100644 --- a/src/main/java/Invokers/ApiException.java +++ b/src/main/java/Invokers/ApiException.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -16,7 +16,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ApiException extends Exception { private int code = 0; private Map> responseHeaders = null; diff --git a/src/main/java/Invokers/ApiResponse.java b/src/main/java/Invokers/ApiResponse.java index 684111b6a..95554d189 100644 --- a/src/main/java/Invokers/ApiResponse.java +++ b/src/main/java/Invokers/ApiResponse.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Invokers/Configuration.java b/src/main/java/Invokers/Configuration.java index 271de3cc7..a33058118 100644 --- a/src/main/java/Invokers/Configuration.java +++ b/src/main/java/Invokers/Configuration.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -13,7 +13,7 @@ package Invokers; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Configuration { private static ApiClient defaultApiClient = new ApiClient(); diff --git a/src/main/java/Invokers/GzipRequestInterceptor.java b/src/main/java/Invokers/GzipRequestInterceptor.java index 941fa978f..ad4e50e06 100644 --- a/src/main/java/Invokers/GzipRequestInterceptor.java +++ b/src/main/java/Invokers/GzipRequestInterceptor.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Invokers/JSON.java b/src/main/java/Invokers/JSON.java index 6b606f850..46a79b46f 100644 --- a/src/main/java/Invokers/JSON.java +++ b/src/main/java/Invokers/JSON.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Invokers/Pair.java b/src/main/java/Invokers/Pair.java index cbe1f4ba8..1e8f49927 100644 --- a/src/main/java/Invokers/Pair.java +++ b/src/main/java/Invokers/Pair.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -13,7 +13,7 @@ package Invokers; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Pair { private String name = ""; private String value = ""; diff --git a/src/main/java/Invokers/ProgressRequestBody.java b/src/main/java/Invokers/ProgressRequestBody.java index 125052674..6f013ef09 100644 --- a/src/main/java/Invokers/ProgressRequestBody.java +++ b/src/main/java/Invokers/ProgressRequestBody.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Invokers/ProgressResponseBody.java b/src/main/java/Invokers/ProgressResponseBody.java index 5e7f2a54d..af7994c22 100644 --- a/src/main/java/Invokers/ProgressResponseBody.java +++ b/src/main/java/Invokers/ProgressResponseBody.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Invokers/StringUtil.java b/src/main/java/Invokers/StringUtil.java index 03571dd49..25ff79a51 100644 --- a/src/main/java/Invokers/StringUtil.java +++ b/src/main/java/Invokers/StringUtil.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -13,7 +13,7 @@ package Invokers; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class StringUtil { /** * Check if the given array contains the given value (with case-insensitive comparison). diff --git a/src/main/java/Invokers/auth/ApiKeyAuth.java b/src/main/java/Invokers/auth/ApiKeyAuth.java index 14fef1aa6..814c08b41 100644 --- a/src/main/java/Invokers/auth/ApiKeyAuth.java +++ b/src/main/java/Invokers/auth/ApiKeyAuth.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -18,7 +18,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ApiKeyAuth implements Authentication { private final String location; private final String paramName; diff --git a/src/main/java/Invokers/auth/Authentication.java b/src/main/java/Invokers/auth/Authentication.java index ad88d1164..3715b8aca 100644 --- a/src/main/java/Invokers/auth/Authentication.java +++ b/src/main/java/Invokers/auth/Authentication.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Invokers/auth/HttpBasicAuth.java b/src/main/java/Invokers/auth/HttpBasicAuth.java index abec1bfe6..1b4dff535 100644 --- a/src/main/java/Invokers/auth/HttpBasicAuth.java +++ b/src/main/java/Invokers/auth/HttpBasicAuth.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Invokers/auth/OAuth.java b/src/main/java/Invokers/auth/OAuth.java index a58a5f06d..cad21e2b3 100644 --- a/src/main/java/Invokers/auth/OAuth.java +++ b/src/main/java/Invokers/auth/OAuth.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -18,7 +18,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class OAuth implements Authentication { private String accessToken; diff --git a/src/main/java/Invokers/auth/OAuthFlow.java b/src/main/java/Invokers/auth/OAuthFlow.java index 3581e9bc0..3f958df4b 100644 --- a/src/main/java/Invokers/auth/OAuthFlow.java +++ b/src/main/java/Invokers/auth/OAuthFlow.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/main/java/Model/AuthReversalRequest.java b/src/main/java/Model/AuthReversalRequest.java index ab37223a4..6d27d4da2 100644 --- a/src/main/java/Model/AuthReversalRequest.java +++ b/src/main/java/Model/AuthReversalRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -31,7 +31,7 @@ /** * AuthReversalRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class AuthReversalRequest { @SerializedName("clientReferenceInformation") private Ptsv2paymentsidreversalsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/main/java/Model/Body.java b/src/main/java/Model/Body.java deleted file mode 100644 index 9d5ccf8ac..000000000 --- a/src/main/java/Model/Body.java +++ /dev/null @@ -1,324 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import Model.Tmsv1instrumentidentifiersBankAccount; -import Model.Tmsv1instrumentidentifiersCard; -import Model.Tmsv1instrumentidentifiersLinks; -import Model.Tmsv1instrumentidentifiersMetadata; -import Model.Tmsv1instrumentidentifiersProcessingInformation; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Body - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Body { - @SerializedName("_links") - private Tmsv1instrumentidentifiersLinks links = null; - - @SerializedName("id") - private String id = null; - - /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. - */ - @JsonAdapter(ObjectEnum.Adapter.class) - public enum ObjectEnum { - INSTRUMENTIDENTIFIER("instrumentIdentifier"); - - private String value; - - ObjectEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static ObjectEnum fromValue(String text) { - for (ObjectEnum b : ObjectEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final ObjectEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public ObjectEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return ObjectEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("object") - private ObjectEnum object = null; - - /** - * Current state of the token. - */ - @JsonAdapter(StateEnum.Adapter.class) - public enum StateEnum { - ACTIVE("ACTIVE"), - - CLOSED("CLOSED"); - - private String value; - - StateEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static StateEnum fromValue(String text) { - for (StateEnum b : StateEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public StateEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return StateEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("state") - private StateEnum state = null; - - @SerializedName("card") - private Tmsv1instrumentidentifiersCard card = null; - - @SerializedName("bankAccount") - private Tmsv1instrumentidentifiersBankAccount bankAccount = null; - - @SerializedName("processingInformation") - private Tmsv1instrumentidentifiersProcessingInformation processingInformation = null; - - @SerializedName("metadata") - private Tmsv1instrumentidentifiersMetadata metadata = null; - - public Body links(Tmsv1instrumentidentifiersLinks links) { - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersLinks getLinks() { - return links; - } - - public void setLinks(Tmsv1instrumentidentifiersLinks links) { - this.links = links; - } - - /** - * Unique identification number assigned by CyberSource to the submitted request. - * @return id - **/ - @ApiModelProperty(example = "1234567890123456800", value = "Unique identification number assigned by CyberSource to the submitted request.") - public String getId() { - return id; - } - - /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. - * @return object - **/ - @ApiModelProperty(example = "instrumentIdentifier", value = "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.") - public ObjectEnum getObject() { - return object; - } - - /** - * Current state of the token. - * @return state - **/ - @ApiModelProperty(example = "ACTIVE", value = "Current state of the token.") - public StateEnum getState() { - return state; - } - - public Body card(Tmsv1instrumentidentifiersCard card) { - this.card = card; - return this; - } - - /** - * Get card - * @return card - **/ - @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersCard getCard() { - return card; - } - - public void setCard(Tmsv1instrumentidentifiersCard card) { - this.card = card; - } - - public Body bankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { - this.bankAccount = bankAccount; - return this; - } - - /** - * Get bankAccount - * @return bankAccount - **/ - @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersBankAccount getBankAccount() { - return bankAccount; - } - - public void setBankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { - this.bankAccount = bankAccount; - } - - public Body processingInformation(Tmsv1instrumentidentifiersProcessingInformation processingInformation) { - this.processingInformation = processingInformation; - return this; - } - - /** - * Get processingInformation - * @return processingInformation - **/ - @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersProcessingInformation getProcessingInformation() { - return processingInformation; - } - - public void setProcessingInformation(Tmsv1instrumentidentifiersProcessingInformation processingInformation) { - this.processingInformation = processingInformation; - } - - public Body metadata(Tmsv1instrumentidentifiersMetadata metadata) { - this.metadata = metadata; - return this; - } - - /** - * Get metadata - * @return metadata - **/ - @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersMetadata getMetadata() { - return metadata; - } - - public void setMetadata(Tmsv1instrumentidentifiersMetadata metadata) { - this.metadata = metadata; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Body body = (Body) o; - return Objects.equals(this.links, body.links) && - Objects.equals(this.id, body.id) && - Objects.equals(this.object, body.object) && - Objects.equals(this.state, body.state) && - Objects.equals(this.card, body.card) && - Objects.equals(this.bankAccount, body.bankAccount) && - Objects.equals(this.processingInformation, body.processingInformation) && - Objects.equals(this.metadata, body.metadata); - } - - @Override - public int hashCode() { - return Objects.hash(links, id, object, state, card, bankAccount, processingInformation, metadata); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Body {\n"); - - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" object: ").append(toIndentedString(object)).append("\n"); - sb.append(" state: ").append(toIndentedString(state)).append("\n"); - sb.append(" card: ").append(toIndentedString(card)).append("\n"); - sb.append(" bankAccount: ").append(toIndentedString(bankAccount)).append("\n"); - sb.append(" processingInformation: ").append(toIndentedString(processingInformation)).append("\n"); - sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Body3.java b/src/main/java/Model/Body3.java deleted file mode 100644 index 57eab9a0e..000000000 --- a/src/main/java/Model/Body3.java +++ /dev/null @@ -1,420 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import Model.Tmsv1instrumentidentifiersLinks; -import Model.Tmsv1instrumentidentifiersMetadata; -import Model.Tmsv1paymentinstrumentsBankAccount; -import Model.Tmsv1paymentinstrumentsBillTo; -import Model.Tmsv1paymentinstrumentsBuyerInformation; -import Model.Tmsv1paymentinstrumentsCard; -import Model.Tmsv1paymentinstrumentsInstrumentIdentifier; -import Model.Tmsv1paymentinstrumentsMerchantInformation; -import Model.Tmsv1paymentinstrumentsProcessingInformation; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Body3 - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Body3 { - @SerializedName("_links") - private Tmsv1instrumentidentifiersLinks links = null; - - @SerializedName("id") - private String id = null; - - /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. - */ - @JsonAdapter(ObjectEnum.Adapter.class) - public enum ObjectEnum { - PAYMENTINSTRUMENT("paymentInstrument"); - - private String value; - - ObjectEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static ObjectEnum fromValue(String text) { - for (ObjectEnum b : ObjectEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final ObjectEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public ObjectEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return ObjectEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("object") - private ObjectEnum object = null; - - /** - * Current state of the token. - */ - @JsonAdapter(StateEnum.Adapter.class) - public enum StateEnum { - ACTIVE("ACTIVE"), - - CLOSED("CLOSED"); - - private String value; - - StateEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static StateEnum fromValue(String text) { - for (StateEnum b : StateEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public StateEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return StateEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("state") - private StateEnum state = null; - - @SerializedName("bankAccount") - private Tmsv1paymentinstrumentsBankAccount bankAccount = null; - - @SerializedName("card") - private Tmsv1paymentinstrumentsCard card = null; - - @SerializedName("buyerInformation") - private Tmsv1paymentinstrumentsBuyerInformation buyerInformation = null; - - @SerializedName("billTo") - private Tmsv1paymentinstrumentsBillTo billTo = null; - - @SerializedName("processingInformation") - private Tmsv1paymentinstrumentsProcessingInformation processingInformation = null; - - @SerializedName("merchantInformation") - private Tmsv1paymentinstrumentsMerchantInformation merchantInformation = null; - - @SerializedName("metaData") - private Tmsv1instrumentidentifiersMetadata metaData = null; - - @SerializedName("instrumentIdentifier") - private Tmsv1paymentinstrumentsInstrumentIdentifier instrumentIdentifier = null; - - public Body3 links(Tmsv1instrumentidentifiersLinks links) { - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersLinks getLinks() { - return links; - } - - public void setLinks(Tmsv1instrumentidentifiersLinks links) { - this.links = links; - } - - /** - * Unique identification number assigned by CyberSource to the submitted request. - * @return id - **/ - @ApiModelProperty(example = "1234567890123456800", value = "Unique identification number assigned by CyberSource to the submitted request.") - public String getId() { - return id; - } - - /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. - * @return object - **/ - @ApiModelProperty(example = "instrumentIdentifier", value = "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.") - public ObjectEnum getObject() { - return object; - } - - /** - * Current state of the token. - * @return state - **/ - @ApiModelProperty(example = "ACTIVE", value = "Current state of the token.") - public StateEnum getState() { - return state; - } - - public Body3 bankAccount(Tmsv1paymentinstrumentsBankAccount bankAccount) { - this.bankAccount = bankAccount; - return this; - } - - /** - * Get bankAccount - * @return bankAccount - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsBankAccount getBankAccount() { - return bankAccount; - } - - public void setBankAccount(Tmsv1paymentinstrumentsBankAccount bankAccount) { - this.bankAccount = bankAccount; - } - - public Body3 card(Tmsv1paymentinstrumentsCard card) { - this.card = card; - return this; - } - - /** - * Get card - * @return card - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsCard getCard() { - return card; - } - - public void setCard(Tmsv1paymentinstrumentsCard card) { - this.card = card; - } - - public Body3 buyerInformation(Tmsv1paymentinstrumentsBuyerInformation buyerInformation) { - this.buyerInformation = buyerInformation; - return this; - } - - /** - * Get buyerInformation - * @return buyerInformation - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsBuyerInformation getBuyerInformation() { - return buyerInformation; - } - - public void setBuyerInformation(Tmsv1paymentinstrumentsBuyerInformation buyerInformation) { - this.buyerInformation = buyerInformation; - } - - public Body3 billTo(Tmsv1paymentinstrumentsBillTo billTo) { - this.billTo = billTo; - return this; - } - - /** - * Get billTo - * @return billTo - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsBillTo getBillTo() { - return billTo; - } - - public void setBillTo(Tmsv1paymentinstrumentsBillTo billTo) { - this.billTo = billTo; - } - - public Body3 processingInformation(Tmsv1paymentinstrumentsProcessingInformation processingInformation) { - this.processingInformation = processingInformation; - return this; - } - - /** - * Get processingInformation - * @return processingInformation - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsProcessingInformation getProcessingInformation() { - return processingInformation; - } - - public void setProcessingInformation(Tmsv1paymentinstrumentsProcessingInformation processingInformation) { - this.processingInformation = processingInformation; - } - - public Body3 merchantInformation(Tmsv1paymentinstrumentsMerchantInformation merchantInformation) { - this.merchantInformation = merchantInformation; - return this; - } - - /** - * Get merchantInformation - * @return merchantInformation - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsMerchantInformation getMerchantInformation() { - return merchantInformation; - } - - public void setMerchantInformation(Tmsv1paymentinstrumentsMerchantInformation merchantInformation) { - this.merchantInformation = merchantInformation; - } - - public Body3 metaData(Tmsv1instrumentidentifiersMetadata metaData) { - this.metaData = metaData; - return this; - } - - /** - * Get metaData - * @return metaData - **/ - @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersMetadata getMetaData() { - return metaData; - } - - public void setMetaData(Tmsv1instrumentidentifiersMetadata metaData) { - this.metaData = metaData; - } - - public Body3 instrumentIdentifier(Tmsv1paymentinstrumentsInstrumentIdentifier instrumentIdentifier) { - this.instrumentIdentifier = instrumentIdentifier; - return this; - } - - /** - * Get instrumentIdentifier - * @return instrumentIdentifier - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsInstrumentIdentifier getInstrumentIdentifier() { - return instrumentIdentifier; - } - - public void setInstrumentIdentifier(Tmsv1paymentinstrumentsInstrumentIdentifier instrumentIdentifier) { - this.instrumentIdentifier = instrumentIdentifier; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Body3 body3 = (Body3) o; - return Objects.equals(this.links, body3.links) && - Objects.equals(this.id, body3.id) && - Objects.equals(this.object, body3.object) && - Objects.equals(this.state, body3.state) && - Objects.equals(this.bankAccount, body3.bankAccount) && - Objects.equals(this.card, body3.card) && - Objects.equals(this.buyerInformation, body3.buyerInformation) && - Objects.equals(this.billTo, body3.billTo) && - Objects.equals(this.processingInformation, body3.processingInformation) && - Objects.equals(this.merchantInformation, body3.merchantInformation) && - Objects.equals(this.metaData, body3.metaData) && - Objects.equals(this.instrumentIdentifier, body3.instrumentIdentifier); - } - - @Override - public int hashCode() { - return Objects.hash(links, id, object, state, bankAccount, card, buyerInformation, billTo, processingInformation, merchantInformation, metaData, instrumentIdentifier); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Body3 {\n"); - - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" object: ").append(toIndentedString(object)).append("\n"); - sb.append(" state: ").append(toIndentedString(state)).append("\n"); - sb.append(" bankAccount: ").append(toIndentedString(bankAccount)).append("\n"); - sb.append(" card: ").append(toIndentedString(card)).append("\n"); - sb.append(" buyerInformation: ").append(toIndentedString(buyerInformation)).append("\n"); - sb.append(" billTo: ").append(toIndentedString(billTo)).append("\n"); - sb.append(" processingInformation: ").append(toIndentedString(processingInformation)).append("\n"); - sb.append(" merchantInformation: ").append(toIndentedString(merchantInformation)).append("\n"); - sb.append(" metaData: ").append(toIndentedString(metaData)).append("\n"); - sb.append(" instrumentIdentifier: ").append(toIndentedString(instrumentIdentifier)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/CapturePaymentRequest.java b/src/main/java/Model/CapturePaymentRequest.java index bb557c48f..25c5408be 100644 --- a/src/main/java/Model/CapturePaymentRequest.java +++ b/src/main/java/Model/CapturePaymentRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -39,7 +39,7 @@ /** * CapturePaymentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class CapturePaymentRequest { @SerializedName("clientReferenceInformation") private Ptsv2paymentsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/main/java/Model/CardInfo.java b/src/main/java/Model/CardInfo.java deleted file mode 100644 index 305f86d24..000000000 --- a/src/main/java/Model/CardInfo.java +++ /dev/null @@ -1,162 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * CardInfo - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class CardInfo { - @SerializedName("cardNumber") - private String cardNumber = null; - - @SerializedName("cardExpirationMonth") - private String cardExpirationMonth = null; - - @SerializedName("cardExpirationYear") - private String cardExpirationYear = null; - - @SerializedName("cardType") - private String cardType = null; - - public CardInfo cardNumber(String cardNumber) { - this.cardNumber = cardNumber; - return this; - } - - /** - * Encrypted or plain text card number. If the encryption type of “None” was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders’ device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request. - * @return cardNumber - **/ - @ApiModelProperty(value = "Encrypted or plain text card number. If the encryption type of “None” was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders’ device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request.") - public String getCardNumber() { - return cardNumber; - } - - public void setCardNumber(String cardNumber) { - this.cardNumber = cardNumber; - } - - public CardInfo cardExpirationMonth(String cardExpirationMonth) { - this.cardExpirationMonth = cardExpirationMonth; - return this; - } - - /** - * Two digit expiration month - * @return cardExpirationMonth - **/ - @ApiModelProperty(value = "Two digit expiration month") - public String getCardExpirationMonth() { - return cardExpirationMonth; - } - - public void setCardExpirationMonth(String cardExpirationMonth) { - this.cardExpirationMonth = cardExpirationMonth; - } - - public CardInfo cardExpirationYear(String cardExpirationYear) { - this.cardExpirationYear = cardExpirationYear; - return this; - } - - /** - * Four digit expiration year - * @return cardExpirationYear - **/ - @ApiModelProperty(value = "Four digit expiration year") - public String getCardExpirationYear() { - return cardExpirationYear; - } - - public void setCardExpirationYear(String cardExpirationYear) { - this.cardExpirationYear = cardExpirationYear; - } - - public CardInfo cardType(String cardType) { - this.cardType = cardType; - return this; - } - - /** - * Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types. - * @return cardType - **/ - @ApiModelProperty(value = "Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types.") - public String getCardType() { - return cardType; - } - - public void setCardType(String cardType) { - this.cardType = cardType; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - CardInfo cardInfo = (CardInfo) o; - return Objects.equals(this.cardNumber, cardInfo.cardNumber) && - Objects.equals(this.cardExpirationMonth, cardInfo.cardExpirationMonth) && - Objects.equals(this.cardExpirationYear, cardInfo.cardExpirationYear) && - Objects.equals(this.cardType, cardInfo.cardType); - } - - @Override - public int hashCode() { - return Objects.hash(cardNumber, cardExpirationMonth, cardExpirationYear, cardType); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class CardInfo {\n"); - - sb.append(" cardNumber: ").append(toIndentedString(cardNumber)).append("\n"); - sb.append(" cardExpirationMonth: ").append(toIndentedString(cardExpirationMonth)).append("\n"); - sb.append(" cardExpirationYear: ").append(toIndentedString(cardExpirationYear)).append("\n"); - sb.append(" cardType: ").append(toIndentedString(cardType)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/CreateCreditRequest.java b/src/main/java/Model/CreateCreditRequest.java index 9a296d73b..da931f9d4 100644 --- a/src/main/java/Model/CreateCreditRequest.java +++ b/src/main/java/Model/CreateCreditRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -38,7 +38,7 @@ /** * CreateCreditRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class CreateCreditRequest { @SerializedName("clientReferenceInformation") private Ptsv2paymentsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/main/java/Model/CreateDecisionManagerCaseRequest.java b/src/main/java/Model/CreateDecisionManagerCaseRequest.java new file mode 100644 index 000000000..750b0c989 --- /dev/null +++ b/src/main/java/Model/CreateDecisionManagerCaseRequest.java @@ -0,0 +1,320 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.Riskv1decisionsBuyerInformation; +import Model.Riskv1decisionsCardVerification; +import Model.Riskv1decisionsClientReferenceInformation; +import Model.Riskv1decisionsDeviceInformation; +import Model.Riskv1decisionsMerchantDefinedInformation; +import Model.Riskv1decisionsOrderInformation; +import Model.Riskv1decisionsPaymentInformation; +import Model.Riskv1decisionsProcessorInformation; +import Model.Riskv1decisionsRiskInformation; +import Model.Riskv1decisionsTravelInformation; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * CreateDecisionManagerCaseRequest + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class CreateDecisionManagerCaseRequest { + @SerializedName("clientReferenceInformation") + private Riskv1decisionsClientReferenceInformation clientReferenceInformation = null; + + @SerializedName("processorInformation") + private Riskv1decisionsProcessorInformation processorInformation = null; + + @SerializedName("paymentInformation") + private Riskv1decisionsPaymentInformation paymentInformation = null; + + @SerializedName("orderInformation") + private Riskv1decisionsOrderInformation orderInformation = null; + + @SerializedName("buyerInformation") + private Riskv1decisionsBuyerInformation buyerInformation = null; + + @SerializedName("deviceInformation") + private Riskv1decisionsDeviceInformation deviceInformation = null; + + @SerializedName("cardVerification") + private Riskv1decisionsCardVerification cardVerification = null; + + @SerializedName("riskInformation") + private Riskv1decisionsRiskInformation riskInformation = null; + + @SerializedName("travelInformation") + private Riskv1decisionsTravelInformation travelInformation = null; + + @SerializedName("merchantDefinedInformation") + private List merchantDefinedInformation = null; + + public CreateDecisionManagerCaseRequest clientReferenceInformation(Riskv1decisionsClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + return this; + } + + /** + * Get clientReferenceInformation + * @return clientReferenceInformation + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsClientReferenceInformation getClientReferenceInformation() { + return clientReferenceInformation; + } + + public void setClientReferenceInformation(Riskv1decisionsClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + } + + public CreateDecisionManagerCaseRequest processorInformation(Riskv1decisionsProcessorInformation processorInformation) { + this.processorInformation = processorInformation; + return this; + } + + /** + * Get processorInformation + * @return processorInformation + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsProcessorInformation getProcessorInformation() { + return processorInformation; + } + + public void setProcessorInformation(Riskv1decisionsProcessorInformation processorInformation) { + this.processorInformation = processorInformation; + } + + public CreateDecisionManagerCaseRequest paymentInformation(Riskv1decisionsPaymentInformation paymentInformation) { + this.paymentInformation = paymentInformation; + return this; + } + + /** + * Get paymentInformation + * @return paymentInformation + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsPaymentInformation getPaymentInformation() { + return paymentInformation; + } + + public void setPaymentInformation(Riskv1decisionsPaymentInformation paymentInformation) { + this.paymentInformation = paymentInformation; + } + + public CreateDecisionManagerCaseRequest orderInformation(Riskv1decisionsOrderInformation orderInformation) { + this.orderInformation = orderInformation; + return this; + } + + /** + * Get orderInformation + * @return orderInformation + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsOrderInformation getOrderInformation() { + return orderInformation; + } + + public void setOrderInformation(Riskv1decisionsOrderInformation orderInformation) { + this.orderInformation = orderInformation; + } + + public CreateDecisionManagerCaseRequest buyerInformation(Riskv1decisionsBuyerInformation buyerInformation) { + this.buyerInformation = buyerInformation; + return this; + } + + /** + * Get buyerInformation + * @return buyerInformation + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsBuyerInformation getBuyerInformation() { + return buyerInformation; + } + + public void setBuyerInformation(Riskv1decisionsBuyerInformation buyerInformation) { + this.buyerInformation = buyerInformation; + } + + public CreateDecisionManagerCaseRequest deviceInformation(Riskv1decisionsDeviceInformation deviceInformation) { + this.deviceInformation = deviceInformation; + return this; + } + + /** + * Get deviceInformation + * @return deviceInformation + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsDeviceInformation getDeviceInformation() { + return deviceInformation; + } + + public void setDeviceInformation(Riskv1decisionsDeviceInformation deviceInformation) { + this.deviceInformation = deviceInformation; + } + + public CreateDecisionManagerCaseRequest cardVerification(Riskv1decisionsCardVerification cardVerification) { + this.cardVerification = cardVerification; + return this; + } + + /** + * Get cardVerification + * @return cardVerification + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsCardVerification getCardVerification() { + return cardVerification; + } + + public void setCardVerification(Riskv1decisionsCardVerification cardVerification) { + this.cardVerification = cardVerification; + } + + public CreateDecisionManagerCaseRequest riskInformation(Riskv1decisionsRiskInformation riskInformation) { + this.riskInformation = riskInformation; + return this; + } + + /** + * Get riskInformation + * @return riskInformation + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsRiskInformation getRiskInformation() { + return riskInformation; + } + + public void setRiskInformation(Riskv1decisionsRiskInformation riskInformation) { + this.riskInformation = riskInformation; + } + + public CreateDecisionManagerCaseRequest travelInformation(Riskv1decisionsTravelInformation travelInformation) { + this.travelInformation = travelInformation; + return this; + } + + /** + * Get travelInformation + * @return travelInformation + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsTravelInformation getTravelInformation() { + return travelInformation; + } + + public void setTravelInformation(Riskv1decisionsTravelInformation travelInformation) { + this.travelInformation = travelInformation; + } + + public CreateDecisionManagerCaseRequest merchantDefinedInformation(List merchantDefinedInformation) { + this.merchantDefinedInformation = merchantDefinedInformation; + return this; + } + + public CreateDecisionManagerCaseRequest addMerchantDefinedInformationItem(Riskv1decisionsMerchantDefinedInformation merchantDefinedInformationItem) { + if (this.merchantDefinedInformation == null) { + this.merchantDefinedInformation = new ArrayList(); + } + this.merchantDefinedInformation.add(merchantDefinedInformationItem); + return this; + } + + /** + * Get merchantDefinedInformation + * @return merchantDefinedInformation + **/ + @ApiModelProperty(value = "") + public List getMerchantDefinedInformation() { + return merchantDefinedInformation; + } + + public void setMerchantDefinedInformation(List merchantDefinedInformation) { + this.merchantDefinedInformation = merchantDefinedInformation; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CreateDecisionManagerCaseRequest createDecisionManagerCaseRequest = (CreateDecisionManagerCaseRequest) o; + return Objects.equals(this.clientReferenceInformation, createDecisionManagerCaseRequest.clientReferenceInformation) && + Objects.equals(this.processorInformation, createDecisionManagerCaseRequest.processorInformation) && + Objects.equals(this.paymentInformation, createDecisionManagerCaseRequest.paymentInformation) && + Objects.equals(this.orderInformation, createDecisionManagerCaseRequest.orderInformation) && + Objects.equals(this.buyerInformation, createDecisionManagerCaseRequest.buyerInformation) && + Objects.equals(this.deviceInformation, createDecisionManagerCaseRequest.deviceInformation) && + Objects.equals(this.cardVerification, createDecisionManagerCaseRequest.cardVerification) && + Objects.equals(this.riskInformation, createDecisionManagerCaseRequest.riskInformation) && + Objects.equals(this.travelInformation, createDecisionManagerCaseRequest.travelInformation) && + Objects.equals(this.merchantDefinedInformation, createDecisionManagerCaseRequest.merchantDefinedInformation); + } + + @Override + public int hashCode() { + return Objects.hash(clientReferenceInformation, processorInformation, paymentInformation, orderInformation, buyerInformation, deviceInformation, cardVerification, riskInformation, travelInformation, merchantDefinedInformation); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CreateDecisionManagerCaseRequest {\n"); + + sb.append(" clientReferenceInformation: ").append(toIndentedString(clientReferenceInformation)).append("\n"); + sb.append(" processorInformation: ").append(toIndentedString(processorInformation)).append("\n"); + sb.append(" paymentInformation: ").append(toIndentedString(paymentInformation)).append("\n"); + sb.append(" orderInformation: ").append(toIndentedString(orderInformation)).append("\n"); + sb.append(" buyerInformation: ").append(toIndentedString(buyerInformation)).append("\n"); + sb.append(" deviceInformation: ").append(toIndentedString(deviceInformation)).append("\n"); + sb.append(" cardVerification: ").append(toIndentedString(cardVerification)).append("\n"); + sb.append(" riskInformation: ").append(toIndentedString(riskInformation)).append("\n"); + sb.append(" travelInformation: ").append(toIndentedString(travelInformation)).append("\n"); + sb.append(" merchantDefinedInformation: ").append(toIndentedString(merchantDefinedInformation)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/CreateInstrumentIdentifierRequest.java b/src/main/java/Model/CreateInstrumentIdentifierRequest.java new file mode 100644 index 000000000..17490eab3 --- /dev/null +++ b/src/main/java/Model/CreateInstrumentIdentifierRequest.java @@ -0,0 +1,141 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.Tmsv1instrumentidentifiersBillTo; +import Model.Tmsv1instrumentidentifiersCard; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * CreateInstrumentIdentifierRequest + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class CreateInstrumentIdentifierRequest { + @SerializedName("type") + private String type = null; + + @SerializedName("card") + private Tmsv1instrumentidentifiersCard card = null; + + @SerializedName("billTo") + private Tmsv1instrumentidentifiersBillTo billTo = null; + + public CreateInstrumentIdentifierRequest type(String type) { + this.type = type; + return this; + } + + /** + * Type of Card + * @return type + **/ + @ApiModelProperty(example = "enrollable card", value = "Type of Card") + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public CreateInstrumentIdentifierRequest card(Tmsv1instrumentidentifiersCard card) { + this.card = card; + return this; + } + + /** + * Get card + * @return card + **/ + @ApiModelProperty(value = "") + public Tmsv1instrumentidentifiersCard getCard() { + return card; + } + + public void setCard(Tmsv1instrumentidentifiersCard card) { + this.card = card; + } + + public CreateInstrumentIdentifierRequest billTo(Tmsv1instrumentidentifiersBillTo billTo) { + this.billTo = billTo; + return this; + } + + /** + * Get billTo + * @return billTo + **/ + @ApiModelProperty(value = "") + public Tmsv1instrumentidentifiersBillTo getBillTo() { + return billTo; + } + + public void setBillTo(Tmsv1instrumentidentifiersBillTo billTo) { + this.billTo = billTo; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest = (CreateInstrumentIdentifierRequest) o; + return Objects.equals(this.type, createInstrumentIdentifierRequest.type) && + Objects.equals(this.card, createInstrumentIdentifierRequest.card) && + Objects.equals(this.billTo, createInstrumentIdentifierRequest.billTo); + } + + @Override + public int hashCode() { + return Objects.hash(type, card, billTo); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CreateInstrumentIdentifierRequest {\n"); + + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" card: ").append(toIndentedString(card)).append("\n"); + sb.append(" billTo: ").append(toIndentedString(billTo)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TmsV1PaymentinstrumentsGet200Response.java b/src/main/java/Model/CreatePaymentInstrumentRequest.java similarity index 54% rename from src/main/java/Model/TmsV1PaymentinstrumentsGet200Response.java rename to src/main/java/Model/CreatePaymentInstrumentRequest.java index b2a2d8d9a..1807255e8 100644 --- a/src/main/java/Model/TmsV1PaymentinstrumentsGet200Response.java +++ b/src/main/java/Model/CreatePaymentInstrumentRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,15 +14,15 @@ package Model; import java.util.Objects; -import Model.Tmsv1instrumentidentifiersLinks; -import Model.Tmsv1instrumentidentifiersMetadata; -import Model.Tmsv1paymentinstrumentsBankAccount; -import Model.Tmsv1paymentinstrumentsBillTo; -import Model.Tmsv1paymentinstrumentsBuyerInformation; -import Model.Tmsv1paymentinstrumentsCard; -import Model.Tmsv1paymentinstrumentsInstrumentIdentifier; -import Model.Tmsv1paymentinstrumentsMerchantInformation; -import Model.Tmsv1paymentinstrumentsProcessingInformation; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation; +import Model.TmsV1InstrumentIdentifiersPost200ResponseLinks; +import Model.TmsV1InstrumentIdentifiersPost200ResponseMetadata; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -33,18 +33,18 @@ import java.io.IOException; /** - * TmsV1PaymentinstrumentsGet200Response + * CreatePaymentInstrumentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1PaymentinstrumentsGet200Response { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class CreatePaymentInstrumentRequest { @SerializedName("_links") - private Tmsv1instrumentidentifiersLinks links = null; + private TmsV1InstrumentIdentifiersPost200ResponseLinks links = null; @SerializedName("id") private String id = null; /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. + * Describes type of token. */ @JsonAdapter(ObjectEnum.Adapter.class) public enum ObjectEnum { @@ -142,30 +142,30 @@ public StateEnum read(final JsonReader jsonReader) throws IOException { private StateEnum state = null; @SerializedName("bankAccount") - private Tmsv1paymentinstrumentsBankAccount bankAccount = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount bankAccount = null; @SerializedName("card") - private Tmsv1paymentinstrumentsCard card = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard card = null; @SerializedName("buyerInformation") - private Tmsv1paymentinstrumentsBuyerInformation buyerInformation = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation buyerInformation = null; @SerializedName("billTo") - private Tmsv1paymentinstrumentsBillTo billTo = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo billTo = null; @SerializedName("processingInformation") - private Tmsv1paymentinstrumentsProcessingInformation processingInformation = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation processingInformation = null; @SerializedName("merchantInformation") - private Tmsv1paymentinstrumentsMerchantInformation merchantInformation = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation merchantInformation = null; @SerializedName("metaData") - private Tmsv1instrumentidentifiersMetadata metaData = null; + private TmsV1InstrumentIdentifiersPost200ResponseMetadata metaData = null; @SerializedName("instrumentIdentifier") - private Tmsv1paymentinstrumentsInstrumentIdentifier instrumentIdentifier = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier instrumentIdentifier = null; - public TmsV1PaymentinstrumentsGet200Response links(Tmsv1instrumentidentifiersLinks links) { + public CreatePaymentInstrumentRequest links(TmsV1InstrumentIdentifiersPost200ResponseLinks links) { this.links = links; return this; } @@ -175,11 +175,11 @@ public TmsV1PaymentinstrumentsGet200Response links(Tmsv1instrumentidentifiersLin * @return links **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersLinks getLinks() { + public TmsV1InstrumentIdentifiersPost200ResponseLinks getLinks() { return links; } - public void setLinks(Tmsv1instrumentidentifiersLinks links) { + public void setLinks(TmsV1InstrumentIdentifiersPost200ResponseLinks links) { this.links = links; } @@ -193,10 +193,10 @@ public String getId() { } /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. + * Describes type of token. * @return object **/ - @ApiModelProperty(example = "instrumentIdentifier", value = "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.") + @ApiModelProperty(example = "instrumentIdentifier", value = "Describes type of token.") public ObjectEnum getObject() { return object; } @@ -210,7 +210,7 @@ public StateEnum getState() { return state; } - public TmsV1PaymentinstrumentsGet200Response bankAccount(Tmsv1paymentinstrumentsBankAccount bankAccount) { + public CreatePaymentInstrumentRequest bankAccount(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount bankAccount) { this.bankAccount = bankAccount; return this; } @@ -220,15 +220,15 @@ public TmsV1PaymentinstrumentsGet200Response bankAccount(Tmsv1paymentinstruments * @return bankAccount **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsBankAccount getBankAccount() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount getBankAccount() { return bankAccount; } - public void setBankAccount(Tmsv1paymentinstrumentsBankAccount bankAccount) { + public void setBankAccount(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount bankAccount) { this.bankAccount = bankAccount; } - public TmsV1PaymentinstrumentsGet200Response card(Tmsv1paymentinstrumentsCard card) { + public CreatePaymentInstrumentRequest card(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard card) { this.card = card; return this; } @@ -238,15 +238,15 @@ public TmsV1PaymentinstrumentsGet200Response card(Tmsv1paymentinstrumentsCard ca * @return card **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsCard getCard() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard getCard() { return card; } - public void setCard(Tmsv1paymentinstrumentsCard card) { + public void setCard(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard card) { this.card = card; } - public TmsV1PaymentinstrumentsGet200Response buyerInformation(Tmsv1paymentinstrumentsBuyerInformation buyerInformation) { + public CreatePaymentInstrumentRequest buyerInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation buyerInformation) { this.buyerInformation = buyerInformation; return this; } @@ -256,15 +256,15 @@ public TmsV1PaymentinstrumentsGet200Response buyerInformation(Tmsv1paymentinstru * @return buyerInformation **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsBuyerInformation getBuyerInformation() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation getBuyerInformation() { return buyerInformation; } - public void setBuyerInformation(Tmsv1paymentinstrumentsBuyerInformation buyerInformation) { + public void setBuyerInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation buyerInformation) { this.buyerInformation = buyerInformation; } - public TmsV1PaymentinstrumentsGet200Response billTo(Tmsv1paymentinstrumentsBillTo billTo) { + public CreatePaymentInstrumentRequest billTo(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo billTo) { this.billTo = billTo; return this; } @@ -274,15 +274,15 @@ public TmsV1PaymentinstrumentsGet200Response billTo(Tmsv1paymentinstrumentsBillT * @return billTo **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsBillTo getBillTo() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo getBillTo() { return billTo; } - public void setBillTo(Tmsv1paymentinstrumentsBillTo billTo) { + public void setBillTo(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo billTo) { this.billTo = billTo; } - public TmsV1PaymentinstrumentsGet200Response processingInformation(Tmsv1paymentinstrumentsProcessingInformation processingInformation) { + public CreatePaymentInstrumentRequest processingInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation processingInformation) { this.processingInformation = processingInformation; return this; } @@ -292,15 +292,15 @@ public TmsV1PaymentinstrumentsGet200Response processingInformation(Tmsv1paymenti * @return processingInformation **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsProcessingInformation getProcessingInformation() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation getProcessingInformation() { return processingInformation; } - public void setProcessingInformation(Tmsv1paymentinstrumentsProcessingInformation processingInformation) { + public void setProcessingInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation processingInformation) { this.processingInformation = processingInformation; } - public TmsV1PaymentinstrumentsGet200Response merchantInformation(Tmsv1paymentinstrumentsMerchantInformation merchantInformation) { + public CreatePaymentInstrumentRequest merchantInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation merchantInformation) { this.merchantInformation = merchantInformation; return this; } @@ -310,15 +310,15 @@ public TmsV1PaymentinstrumentsGet200Response merchantInformation(Tmsv1paymentins * @return merchantInformation **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsMerchantInformation getMerchantInformation() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation getMerchantInformation() { return merchantInformation; } - public void setMerchantInformation(Tmsv1paymentinstrumentsMerchantInformation merchantInformation) { + public void setMerchantInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation merchantInformation) { this.merchantInformation = merchantInformation; } - public TmsV1PaymentinstrumentsGet200Response metaData(Tmsv1instrumentidentifiersMetadata metaData) { + public CreatePaymentInstrumentRequest metaData(TmsV1InstrumentIdentifiersPost200ResponseMetadata metaData) { this.metaData = metaData; return this; } @@ -328,15 +328,15 @@ public TmsV1PaymentinstrumentsGet200Response metaData(Tmsv1instrumentidentifiers * @return metaData **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersMetadata getMetaData() { + public TmsV1InstrumentIdentifiersPost200ResponseMetadata getMetaData() { return metaData; } - public void setMetaData(Tmsv1instrumentidentifiersMetadata metaData) { + public void setMetaData(TmsV1InstrumentIdentifiersPost200ResponseMetadata metaData) { this.metaData = metaData; } - public TmsV1PaymentinstrumentsGet200Response instrumentIdentifier(Tmsv1paymentinstrumentsInstrumentIdentifier instrumentIdentifier) { + public CreatePaymentInstrumentRequest instrumentIdentifier(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier instrumentIdentifier) { this.instrumentIdentifier = instrumentIdentifier; return this; } @@ -346,11 +346,11 @@ public TmsV1PaymentinstrumentsGet200Response instrumentIdentifier(Tmsv1paymentin * @return instrumentIdentifier **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsInstrumentIdentifier getInstrumentIdentifier() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier getInstrumentIdentifier() { return instrumentIdentifier; } - public void setInstrumentIdentifier(Tmsv1paymentinstrumentsInstrumentIdentifier instrumentIdentifier) { + public void setInstrumentIdentifier(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier instrumentIdentifier) { this.instrumentIdentifier = instrumentIdentifier; } @@ -363,19 +363,19 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TmsV1PaymentinstrumentsGet200Response tmsV1PaymentinstrumentsGet200Response = (TmsV1PaymentinstrumentsGet200Response) o; - return Objects.equals(this.links, tmsV1PaymentinstrumentsGet200Response.links) && - Objects.equals(this.id, tmsV1PaymentinstrumentsGet200Response.id) && - Objects.equals(this.object, tmsV1PaymentinstrumentsGet200Response.object) && - Objects.equals(this.state, tmsV1PaymentinstrumentsGet200Response.state) && - Objects.equals(this.bankAccount, tmsV1PaymentinstrumentsGet200Response.bankAccount) && - Objects.equals(this.card, tmsV1PaymentinstrumentsGet200Response.card) && - Objects.equals(this.buyerInformation, tmsV1PaymentinstrumentsGet200Response.buyerInformation) && - Objects.equals(this.billTo, tmsV1PaymentinstrumentsGet200Response.billTo) && - Objects.equals(this.processingInformation, tmsV1PaymentinstrumentsGet200Response.processingInformation) && - Objects.equals(this.merchantInformation, tmsV1PaymentinstrumentsGet200Response.merchantInformation) && - Objects.equals(this.metaData, tmsV1PaymentinstrumentsGet200Response.metaData) && - Objects.equals(this.instrumentIdentifier, tmsV1PaymentinstrumentsGet200Response.instrumentIdentifier); + CreatePaymentInstrumentRequest createPaymentInstrumentRequest = (CreatePaymentInstrumentRequest) o; + return Objects.equals(this.links, createPaymentInstrumentRequest.links) && + Objects.equals(this.id, createPaymentInstrumentRequest.id) && + Objects.equals(this.object, createPaymentInstrumentRequest.object) && + Objects.equals(this.state, createPaymentInstrumentRequest.state) && + Objects.equals(this.bankAccount, createPaymentInstrumentRequest.bankAccount) && + Objects.equals(this.card, createPaymentInstrumentRequest.card) && + Objects.equals(this.buyerInformation, createPaymentInstrumentRequest.buyerInformation) && + Objects.equals(this.billTo, createPaymentInstrumentRequest.billTo) && + Objects.equals(this.processingInformation, createPaymentInstrumentRequest.processingInformation) && + Objects.equals(this.merchantInformation, createPaymentInstrumentRequest.merchantInformation) && + Objects.equals(this.metaData, createPaymentInstrumentRequest.metaData) && + Objects.equals(this.instrumentIdentifier, createPaymentInstrumentRequest.instrumentIdentifier); } @Override @@ -387,7 +387,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1PaymentinstrumentsGet200Response {\n"); + sb.append("class CreatePaymentInstrumentRequest {\n"); sb.append(" links: ").append(toIndentedString(links)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); diff --git a/src/main/java/Model/CreatePaymentRequest.java b/src/main/java/Model/CreatePaymentRequest.java index f19432e89..97816ea08 100644 --- a/src/main/java/Model/CreatePaymentRequest.java +++ b/src/main/java/Model/CreatePaymentRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -42,7 +42,7 @@ /** * CreatePaymentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class CreatePaymentRequest { @SerializedName("clientReferenceInformation") private Ptsv2paymentsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/main/java/Model/TssV2TransactionsPostResponse.java b/src/main/java/Model/CreateSearchRequest.java similarity index 77% rename from src/main/java/Model/TssV2TransactionsPostResponse.java rename to src/main/java/Model/CreateSearchRequest.java index 20bd4e242..7dee9b2f7 100644 --- a/src/main/java/Model/TssV2TransactionsPostResponse.java +++ b/src/main/java/Model/CreateSearchRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,10 +24,10 @@ import java.io.IOException; /** - * TssV2TransactionsPostResponse + * CreateSearchRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TssV2TransactionsPostResponse { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class CreateSearchRequest { @SerializedName("save") private Boolean save = null; @@ -49,7 +49,7 @@ public class TssV2TransactionsPostResponse { @SerializedName("sort") private String sort = null; - public TssV2TransactionsPostResponse save(Boolean save) { + public CreateSearchRequest save(Boolean save) { this.save = save; return this; } @@ -67,7 +67,7 @@ public void setSave(Boolean save) { this.save = save; } - public TssV2TransactionsPostResponse name(String name) { + public CreateSearchRequest name(String name) { this.name = name; return this; } @@ -85,7 +85,7 @@ public void setName(String name) { this.name = name; } - public TssV2TransactionsPostResponse timezone(String timezone) { + public CreateSearchRequest timezone(String timezone) { this.timezone = timezone; return this; } @@ -103,7 +103,7 @@ public void setTimezone(String timezone) { this.timezone = timezone; } - public TssV2TransactionsPostResponse query(String query) { + public CreateSearchRequest query(String query) { this.query = query; return this; } @@ -121,7 +121,7 @@ public void setQuery(String query) { this.query = query; } - public TssV2TransactionsPostResponse offset(Integer offset) { + public CreateSearchRequest offset(Integer offset) { this.offset = offset; return this; } @@ -139,7 +139,7 @@ public void setOffset(Integer offset) { this.offset = offset; } - public TssV2TransactionsPostResponse limit(Integer limit) { + public CreateSearchRequest limit(Integer limit) { this.limit = limit; return this; } @@ -157,7 +157,7 @@ public void setLimit(Integer limit) { this.limit = limit; } - public TssV2TransactionsPostResponse sort(String sort) { + public CreateSearchRequest sort(String sort) { this.sort = sort; return this; } @@ -184,14 +184,14 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TssV2TransactionsPostResponse tssV2TransactionsPostResponse = (TssV2TransactionsPostResponse) o; - return Objects.equals(this.save, tssV2TransactionsPostResponse.save) && - Objects.equals(this.name, tssV2TransactionsPostResponse.name) && - Objects.equals(this.timezone, tssV2TransactionsPostResponse.timezone) && - Objects.equals(this.query, tssV2TransactionsPostResponse.query) && - Objects.equals(this.offset, tssV2TransactionsPostResponse.offset) && - Objects.equals(this.limit, tssV2TransactionsPostResponse.limit) && - Objects.equals(this.sort, tssV2TransactionsPostResponse.sort); + CreateSearchRequest createSearchRequest = (CreateSearchRequest) o; + return Objects.equals(this.save, createSearchRequest.save) && + Objects.equals(this.name, createSearchRequest.name) && + Objects.equals(this.timezone, createSearchRequest.timezone) && + Objects.equals(this.query, createSearchRequest.query) && + Objects.equals(this.offset, createSearchRequest.offset) && + Objects.equals(this.limit, createSearchRequest.limit) && + Objects.equals(this.sort, createSearchRequest.sort); } @Override @@ -203,7 +203,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsPostResponse {\n"); + sb.append("class CreateSearchRequest {\n"); sb.append(" save: ").append(toIndentedString(save)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); diff --git a/src/main/java/Model/DerPublicKey.java b/src/main/java/Model/DerPublicKey.java deleted file mode 100644 index 9545e79bc..000000000 --- a/src/main/java/Model/DerPublicKey.java +++ /dev/null @@ -1,140 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * The public key in DER format. Used to validate the response from the Tokenize Card request. Additionally this format is useful for client side encryption in Android and iOS implementations. - */ -@ApiModel(description = "The public key in DER format. Used to validate the response from the Tokenize Card request. Additionally this format is useful for client side encryption in Android and iOS implementations.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class DerPublicKey { - @SerializedName("format") - private String format = null; - - @SerializedName("algorithm") - private String algorithm = null; - - @SerializedName("publicKey") - private String publicKey = null; - - public DerPublicKey format(String format) { - this.format = format; - return this; - } - - /** - * Specifies the format of the public key; currently X.509. - * @return format - **/ - @ApiModelProperty(value = "Specifies the format of the public key; currently X.509.") - public String getFormat() { - return format; - } - - public void setFormat(String format) { - this.format = format; - } - - public DerPublicKey algorithm(String algorithm) { - this.algorithm = algorithm; - return this; - } - - /** - * Algorithm used to encrypt the public key. - * @return algorithm - **/ - @ApiModelProperty(value = "Algorithm used to encrypt the public key.") - public String getAlgorithm() { - return algorithm; - } - - public void setAlgorithm(String algorithm) { - this.algorithm = algorithm; - } - - public DerPublicKey publicKey(String publicKey) { - this.publicKey = publicKey; - return this; - } - - /** - * Base64 encoded public key value. - * @return publicKey - **/ - @ApiModelProperty(value = "Base64 encoded public key value.") - public String getPublicKey() { - return publicKey; - } - - public void setPublicKey(String publicKey) { - this.publicKey = publicKey; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - DerPublicKey derPublicKey = (DerPublicKey) o; - return Objects.equals(this.format, derPublicKey.format) && - Objects.equals(this.algorithm, derPublicKey.algorithm) && - Objects.equals(this.publicKey, derPublicKey.publicKey); - } - - @Override - public int hashCode() { - return Objects.hash(format, algorithm, publicKey); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class DerPublicKey {\n"); - - sb.append(" format: ").append(toIndentedString(format)).append("\n"); - sb.append(" algorithm: ").append(toIndentedString(algorithm)).append("\n"); - sb.append(" publicKey: ").append(toIndentedString(publicKey)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Error.java b/src/main/java/Model/Error.java deleted file mode 100644 index 77b02d346..000000000 --- a/src/main/java/Model/Error.java +++ /dev/null @@ -1,118 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import Model.ErrorLinks; -import Model.InlineResponseDefaultResponseStatus; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Error - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Error { - @SerializedName("responseStatus") - private InlineResponseDefaultResponseStatus responseStatus = null; - - @SerializedName("_links") - private ErrorLinks links = null; - - public Error responseStatus(InlineResponseDefaultResponseStatus responseStatus) { - this.responseStatus = responseStatus; - return this; - } - - /** - * Get responseStatus - * @return responseStatus - **/ - @ApiModelProperty(value = "") - public InlineResponseDefaultResponseStatus getResponseStatus() { - return responseStatus; - } - - public void setResponseStatus(InlineResponseDefaultResponseStatus responseStatus) { - this.responseStatus = responseStatus; - } - - public Error links(ErrorLinks links) { - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @ApiModelProperty(value = "") - public ErrorLinks getLinks() { - return links; - } - - public void setLinks(ErrorLinks links) { - this.links = links; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Error error = (Error) o; - return Objects.equals(this.responseStatus, error.responseStatus) && - Objects.equals(this.links, error.links); - } - - @Override - public int hashCode() { - return Objects.hash(responseStatus, links); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Error {\n"); - - sb.append(" responseStatus: ").append(toIndentedString(responseStatus)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/ErrorLinks.java b/src/main/java/Model/ErrorLinks.java deleted file mode 100644 index 43a038b22..000000000 --- a/src/main/java/Model/ErrorLinks.java +++ /dev/null @@ -1,158 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import Model.InlineResponseDefaultLinksNext; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; -import java.util.ArrayList; -import java.util.List; - -/** - * ErrorLinks - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class ErrorLinks { - @SerializedName("self") - private InlineResponseDefaultLinksNext self = null; - - @SerializedName("documentation") - private List documentation = null; - - @SerializedName("next") - private List next = null; - - public ErrorLinks self(InlineResponseDefaultLinksNext self) { - this.self = self; - return this; - } - - /** - * Get self - * @return self - **/ - @ApiModelProperty(value = "") - public InlineResponseDefaultLinksNext getSelf() { - return self; - } - - public void setSelf(InlineResponseDefaultLinksNext self) { - this.self = self; - } - - public ErrorLinks documentation(List documentation) { - this.documentation = documentation; - return this; - } - - public ErrorLinks addDocumentationItem(InlineResponseDefaultLinksNext documentationItem) { - if (this.documentation == null) { - this.documentation = new ArrayList(); - } - this.documentation.add(documentationItem); - return this; - } - - /** - * Get documentation - * @return documentation - **/ - @ApiModelProperty(value = "") - public List getDocumentation() { - return documentation; - } - - public void setDocumentation(List documentation) { - this.documentation = documentation; - } - - public ErrorLinks next(List next) { - this.next = next; - return this; - } - - public ErrorLinks addNextItem(InlineResponseDefaultLinksNext nextItem) { - if (this.next == null) { - this.next = new ArrayList(); - } - this.next.add(nextItem); - return this; - } - - /** - * Get next - * @return next - **/ - @ApiModelProperty(value = "") - public List getNext() { - return next; - } - - public void setNext(List next) { - this.next = next; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ErrorLinks errorLinks = (ErrorLinks) o; - return Objects.equals(this.self, errorLinks.self) && - Objects.equals(this.documentation, errorLinks.documentation) && - Objects.equals(this.next, errorLinks.next); - } - - @Override - public int hashCode() { - return Objects.hash(self, documentation, next); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ErrorLinks {\n"); - - sb.append(" self: ").append(toIndentedString(self)).append("\n"); - sb.append(" documentation: ").append(toIndentedString(documentation)).append("\n"); - sb.append(" next: ").append(toIndentedString(next)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/ErrorResponse.java b/src/main/java/Model/ErrorResponse.java deleted file mode 100644 index 9bac257d6..000000000 --- a/src/main/java/Model/ErrorResponse.java +++ /dev/null @@ -1,118 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import Model.InlineResponseDefaultLinks; -import Model.InlineResponseDefaultResponseStatus; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * ErrorResponse - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class ErrorResponse { - @SerializedName("responseStatus") - private InlineResponseDefaultResponseStatus responseStatus = null; - - @SerializedName("_links") - private InlineResponseDefaultLinks links = null; - - public ErrorResponse responseStatus(InlineResponseDefaultResponseStatus responseStatus) { - this.responseStatus = responseStatus; - return this; - } - - /** - * Get responseStatus - * @return responseStatus - **/ - @ApiModelProperty(value = "") - public InlineResponseDefaultResponseStatus getResponseStatus() { - return responseStatus; - } - - public void setResponseStatus(InlineResponseDefaultResponseStatus responseStatus) { - this.responseStatus = responseStatus; - } - - public ErrorResponse links(InlineResponseDefaultLinks links) { - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @ApiModelProperty(value = "") - public InlineResponseDefaultLinks getLinks() { - return links; - } - - public void setLinks(InlineResponseDefaultLinks links) { - this.links = links; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ErrorResponse errorResponse = (ErrorResponse) o; - return Objects.equals(this.responseStatus, errorResponse.responseStatus) && - Objects.equals(this.links, errorResponse.links); - } - - @Override - public int hashCode() { - return Objects.hash(responseStatus, links); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ErrorResponse {\n"); - - sb.append(" responseStatus: ").append(toIndentedString(responseStatus)).append("\n"); - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/FlexV1KeysPost200Response.java b/src/main/java/Model/FlexV1KeysPost200Response.java index 59d46560b..49710b40a 100644 --- a/src/main/java/Model/FlexV1KeysPost200Response.java +++ b/src/main/java/Model/FlexV1KeysPost200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ /** * FlexV1KeysPost200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class FlexV1KeysPost200Response { @SerializedName("keyId") private String keyId = null; diff --git a/src/main/java/Model/FlexV1KeysPost200ResponseDer.java b/src/main/java/Model/FlexV1KeysPost200ResponseDer.java index 952d5e316..f833bd592 100644 --- a/src/main/java/Model/FlexV1KeysPost200ResponseDer.java +++ b/src/main/java/Model/FlexV1KeysPost200ResponseDer.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ * The public key in DER format. Used to validate the response from the Tokenize Card request. Additionally this format is useful for client side encryption in Android and iOS implementations. */ @ApiModel(description = "The public key in DER format. Used to validate the response from the Tokenize Card request. Additionally this format is useful for client side encryption in Android and iOS implementations.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class FlexV1KeysPost200ResponseDer { @SerializedName("format") private String format = null; diff --git a/src/main/java/Model/FlexV1KeysPost200ResponseJwk.java b/src/main/java/Model/FlexV1KeysPost200ResponseJwk.java index e36c2f33e..fb10aa502 100644 --- a/src/main/java/Model/FlexV1KeysPost200ResponseJwk.java +++ b/src/main/java/Model/FlexV1KeysPost200ResponseJwk.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ * The public key in JSON Web Key (JWK) format. This format is useful for client side encryption in JavaScript based implementations. */ @ApiModel(description = "The public key in JSON Web Key (JWK) format. This format is useful for client side encryption in JavaScript based implementations.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class FlexV1KeysPost200ResponseJwk { @SerializedName("kty") private String kty = null; diff --git a/src/main/java/Model/FlexV1TokensPost200Response.java b/src/main/java/Model/FlexV1TokensPost200Response.java index 3391f5b09..4bcfb0595 100644 --- a/src/main/java/Model/FlexV1TokensPost200Response.java +++ b/src/main/java/Model/FlexV1TokensPost200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * FlexV1TokensPost200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class FlexV1TokensPost200Response { @SerializedName("keyId") private String keyId = null; diff --git a/src/main/java/Model/Flexv1tokensCardInfo.java b/src/main/java/Model/Flexv1tokensCardInfo.java index ab59b740c..eee9f18cd 100644 --- a/src/main/java/Model/Flexv1tokensCardInfo.java +++ b/src/main/java/Model/Flexv1tokensCardInfo.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Flexv1tokensCardInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Flexv1tokensCardInfo { @SerializedName("cardNumber") private String cardNumber = null; @@ -49,7 +49,7 @@ public Flexv1tokensCardInfo cardNumber(String cardNumber) { * Encrypted or plain text card number. If the encryption type of “None” was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders’ device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request. * @return cardNumber **/ - @ApiModelProperty(value = "Encrypted or plain text card number. If the encryption type of “None” was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders’ device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request.") + @ApiModelProperty(required = true, value = "Encrypted or plain text card number. If the encryption type of “None” was used in the Generate Key request, this value can be set to the plaintext card number/Personal Account Number (PAN). If the encryption type of RsaOaep256 was used in the Generate Key request, this value needs to be the RSA OAEP 256 encrypted card number. The card number should be encrypted on the cardholders’ device. The [WebCrypto API] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/resources/public/flex.js) can be used with the JWK obtained in the Generate Key request.") public String getCardNumber() { return cardNumber; } @@ -103,7 +103,7 @@ public Flexv1tokensCardInfo cardType(String cardType) { * Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types. * @return cardType **/ - @ApiModelProperty(value = "Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types.") + @ApiModelProperty(required = true, value = "Card Type. This field is required. Refer to the CyberSource Credit Card Services documentation for supported card types.") public String getCardType() { return cardType; } diff --git a/src/main/java/Model/GeneratePublicKeyRequest.java b/src/main/java/Model/GeneratePublicKeyRequest.java index 75b82606e..8a36008c4 100644 --- a/src/main/java/Model/GeneratePublicKeyRequest.java +++ b/src/main/java/Model/GeneratePublicKeyRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,29 +26,11 @@ /** * GeneratePublicKeyRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class GeneratePublicKeyRequest { @SerializedName("encryptionType") private String encryptionType = null; - @SerializedName("targetOrigin") - private String targetOrigin = null; - - @SerializedName("unmaskedLeft") - private Integer unmaskedLeft = null; - - @SerializedName("unmaskedRight") - private Integer unmaskedRight = null; - - @SerializedName("enableBillingAddress") - private Boolean enableBillingAddress = null; - - @SerializedName("currency") - private String currency = null; - - @SerializedName("enableAutoAuth") - private Boolean enableAutoAuth = null; - public GeneratePublicKeyRequest encryptionType(String encryptionType) { this.encryptionType = encryptionType; return this; @@ -67,114 +49,6 @@ public void setEncryptionType(String encryptionType) { this.encryptionType = encryptionType; } - public GeneratePublicKeyRequest targetOrigin(String targetOrigin) { - this.targetOrigin = targetOrigin; - return this; - } - - /** - * This should only be used if using the Microform implementation. This is the protocol, URL, and if used, port number of the page that will host the Microform. Unless using http://localhost, the protocol must be https://. For example, if serving Microform on example.com, the targetOrigin is https://example.com The value is used to restrict the frame ancestor of the Microform. If there is a mismatch between this value and the frame ancestor, the Microfrom will not load. - * @return targetOrigin - **/ - @ApiModelProperty(value = "This should only be used if using the Microform implementation. This is the protocol, URL, and if used, port number of the page that will host the Microform. Unless using http://localhost, the protocol must be https://. For example, if serving Microform on example.com, the targetOrigin is https://example.com The value is used to restrict the frame ancestor of the Microform. If there is a mismatch between this value and the frame ancestor, the Microfrom will not load.") - public String getTargetOrigin() { - return targetOrigin; - } - - public void setTargetOrigin(String targetOrigin) { - this.targetOrigin = targetOrigin; - } - - public GeneratePublicKeyRequest unmaskedLeft(Integer unmaskedLeft) { - this.unmaskedLeft = unmaskedLeft; - return this; - } - - /** - * Specifies the number of card number digits to be returned un-masked from the left. For example, setting this value to 6 will return: 411111XXXXXXXXXX Default value: 6 Maximum value: 6 - * @return unmaskedLeft - **/ - @ApiModelProperty(value = "Specifies the number of card number digits to be returned un-masked from the left. For example, setting this value to 6 will return: 411111XXXXXXXXXX Default value: 6 Maximum value: 6") - public Integer getUnmaskedLeft() { - return unmaskedLeft; - } - - public void setUnmaskedLeft(Integer unmaskedLeft) { - this.unmaskedLeft = unmaskedLeft; - } - - public GeneratePublicKeyRequest unmaskedRight(Integer unmaskedRight) { - this.unmaskedRight = unmaskedRight; - return this; - } - - /** - * Specifies the number of card number digits to be returned un-masked from the right. For example, setting this value to 4 will return: 411111XXXXXX1111 Default value: 4 Maximum value: 4 - * @return unmaskedRight - **/ - @ApiModelProperty(value = "Specifies the number of card number digits to be returned un-masked from the right. For example, setting this value to 4 will return: 411111XXXXXX1111 Default value: 4 Maximum value: 4") - public Integer getUnmaskedRight() { - return unmaskedRight; - } - - public void setUnmaskedRight(Integer unmaskedRight) { - this.unmaskedRight = unmaskedRight; - } - - public GeneratePublicKeyRequest enableBillingAddress(Boolean enableBillingAddress) { - this.enableBillingAddress = enableBillingAddress; - return this; - } - - /** - * Specifies whether or not 'dummy' address data should be specified in the create token request. If you have 'Relaxed AVS' enabled for your MID, this value can be set to False.Default value: true - * @return enableBillingAddress - **/ - @ApiModelProperty(value = "Specifies whether or not 'dummy' address data should be specified in the create token request. If you have 'Relaxed AVS' enabled for your MID, this value can be set to False.Default value: true") - public Boolean getEnableBillingAddress() { - return enableBillingAddress; - } - - public void setEnableBillingAddress(Boolean enableBillingAddress) { - this.enableBillingAddress = enableBillingAddress; - } - - public GeneratePublicKeyRequest currency(String currency) { - this.currency = currency; - return this; - } - - /** - * Three character ISO currency code to be associated with the token. Required for legacy integrations. Default value: USD. - * @return currency - **/ - @ApiModelProperty(value = "Three character ISO currency code to be associated with the token. Required for legacy integrations. Default value: USD.") - public String getCurrency() { - return currency; - } - - public void setCurrency(String currency) { - this.currency = currency; - } - - public GeneratePublicKeyRequest enableAutoAuth(Boolean enableAutoAuth) { - this.enableAutoAuth = enableAutoAuth; - return this; - } - - /** - * Specifies whether or not an account verification authorization ($0 Authorization) is carried out on token creation. Default is false, as it is assumed a full or zero amount authorization will be carried out in a separate call from your server. - * @return enableAutoAuth - **/ - @ApiModelProperty(value = "Specifies whether or not an account verification authorization ($0 Authorization) is carried out on token creation. Default is false, as it is assumed a full or zero amount authorization will be carried out in a separate call from your server.") - public Boolean getEnableAutoAuth() { - return enableAutoAuth; - } - - public void setEnableAutoAuth(Boolean enableAutoAuth) { - this.enableAutoAuth = enableAutoAuth; - } - @Override public boolean equals(java.lang.Object o) { @@ -185,18 +59,12 @@ public boolean equals(java.lang.Object o) { return false; } GeneratePublicKeyRequest generatePublicKeyRequest = (GeneratePublicKeyRequest) o; - return Objects.equals(this.encryptionType, generatePublicKeyRequest.encryptionType) && - Objects.equals(this.targetOrigin, generatePublicKeyRequest.targetOrigin) && - Objects.equals(this.unmaskedLeft, generatePublicKeyRequest.unmaskedLeft) && - Objects.equals(this.unmaskedRight, generatePublicKeyRequest.unmaskedRight) && - Objects.equals(this.enableBillingAddress, generatePublicKeyRequest.enableBillingAddress) && - Objects.equals(this.currency, generatePublicKeyRequest.currency) && - Objects.equals(this.enableAutoAuth, generatePublicKeyRequest.enableAutoAuth); + return Objects.equals(this.encryptionType, generatePublicKeyRequest.encryptionType); } @Override public int hashCode() { - return Objects.hash(encryptionType, targetOrigin, unmaskedLeft, unmaskedRight, enableBillingAddress, currency, enableAutoAuth); + return Objects.hash(encryptionType); } @@ -206,12 +74,6 @@ public String toString() { sb.append("class GeneratePublicKeyRequest {\n"); sb.append(" encryptionType: ").append(toIndentedString(encryptionType)).append("\n"); - sb.append(" targetOrigin: ").append(toIndentedString(targetOrigin)).append("\n"); - sb.append(" unmaskedLeft: ").append(toIndentedString(unmaskedLeft)).append("\n"); - sb.append(" unmaskedRight: ").append(toIndentedString(unmaskedRight)).append("\n"); - sb.append(" enableBillingAddress: ").append(toIndentedString(enableBillingAddress)).append("\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append(" enableAutoAuth: ").append(toIndentedString(enableAutoAuth)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/InlineResponse200.java b/src/main/java/Model/InlineResponse200.java new file mode 100644 index 000000000..de6d69dae --- /dev/null +++ b/src/main/java/Model/InlineResponse200.java @@ -0,0 +1,151 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.InlineResponse200PaymentBatchSummaries; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; +import org.joda.time.DateTime; + +/** + * InlineResponse200 + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class InlineResponse200 { + @SerializedName("startTime") + private DateTime startTime = null; + + @SerializedName("endTime") + private DateTime endTime = null; + + @SerializedName("paymentBatchSummaries") + private List paymentBatchSummaries = null; + + public InlineResponse200 startTime(DateTime startTime) { + this.startTime = startTime; + return this; + } + + /** + * Get startTime + * @return startTime + **/ + @ApiModelProperty(value = "") + public DateTime getStartTime() { + return startTime; + } + + public void setStartTime(DateTime startTime) { + this.startTime = startTime; + } + + public InlineResponse200 endTime(DateTime endTime) { + this.endTime = endTime; + return this; + } + + /** + * Get endTime + * @return endTime + **/ + @ApiModelProperty(value = "") + public DateTime getEndTime() { + return endTime; + } + + public void setEndTime(DateTime endTime) { + this.endTime = endTime; + } + + public InlineResponse200 paymentBatchSummaries(List paymentBatchSummaries) { + this.paymentBatchSummaries = paymentBatchSummaries; + return this; + } + + public InlineResponse200 addPaymentBatchSummariesItem(InlineResponse200PaymentBatchSummaries paymentBatchSummariesItem) { + if (this.paymentBatchSummaries == null) { + this.paymentBatchSummaries = new ArrayList(); + } + this.paymentBatchSummaries.add(paymentBatchSummariesItem); + return this; + } + + /** + * Get paymentBatchSummaries + * @return paymentBatchSummaries + **/ + @ApiModelProperty(value = "") + public List getPaymentBatchSummaries() { + return paymentBatchSummaries; + } + + public void setPaymentBatchSummaries(List paymentBatchSummaries) { + this.paymentBatchSummaries = paymentBatchSummaries; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + InlineResponse200 inlineResponse200 = (InlineResponse200) o; + return Objects.equals(this.startTime, inlineResponse200.startTime) && + Objects.equals(this.endTime, inlineResponse200.endTime) && + Objects.equals(this.paymentBatchSummaries, inlineResponse200.paymentBatchSummaries); + } + + @Override + public int hashCode() { + return Objects.hash(startTime, endTime, paymentBatchSummaries); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class InlineResponse200 {\n"); + + sb.append(" startTime: ").append(toIndentedString(startTime)).append("\n"); + sb.append(" endTime: ").append(toIndentedString(endTime)).append("\n"); + sb.append(" paymentBatchSummaries: ").append(toIndentedString(paymentBatchSummaries)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/InlineResponse200PaymentBatchSummaries.java b/src/main/java/Model/InlineResponse200PaymentBatchSummaries.java new file mode 100644 index 000000000..c20791265 --- /dev/null +++ b/src/main/java/Model/InlineResponse200PaymentBatchSummaries.java @@ -0,0 +1,347 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import org.joda.time.DateTime; + +/** + * InlineResponse200PaymentBatchSummaries + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class InlineResponse200PaymentBatchSummaries { + @SerializedName("currencyCode") + private String currencyCode = null; + + @SerializedName("paymentSubTypeDescription") + private String paymentSubTypeDescription = null; + + @SerializedName("startTime") + private DateTime startTime = null; + + @SerializedName("endTime") + private DateTime endTime = null; + + @SerializedName("salesCount") + private Integer salesCount = null; + + @SerializedName("salesAmount") + private String salesAmount = null; + + @SerializedName("creditCount") + private Integer creditCount = null; + + @SerializedName("creditAmount") + private String creditAmount = null; + + @SerializedName("accountName") + private String accountName = null; + + @SerializedName("accountId") + private String accountId = null; + + @SerializedName("merchantId") + private String merchantId = null; + + @SerializedName("merchantName") + private String merchantName = null; + + public InlineResponse200PaymentBatchSummaries currencyCode(String currencyCode) { + this.currencyCode = currencyCode; + return this; + } + + /** + * Get currencyCode + * @return currencyCode + **/ + @ApiModelProperty(example = "USD", value = "") + public String getCurrencyCode() { + return currencyCode; + } + + public void setCurrencyCode(String currencyCode) { + this.currencyCode = currencyCode; + } + + public InlineResponse200PaymentBatchSummaries paymentSubTypeDescription(String paymentSubTypeDescription) { + this.paymentSubTypeDescription = paymentSubTypeDescription; + return this; + } + + /** + * Get paymentSubTypeDescription + * @return paymentSubTypeDescription + **/ + @ApiModelProperty(example = "Diners Club", value = "") + public String getPaymentSubTypeDescription() { + return paymentSubTypeDescription; + } + + public void setPaymentSubTypeDescription(String paymentSubTypeDescription) { + this.paymentSubTypeDescription = paymentSubTypeDescription; + } + + public InlineResponse200PaymentBatchSummaries startTime(DateTime startTime) { + this.startTime = startTime; + return this; + } + + /** + * Get startTime + * @return startTime + **/ + @ApiModelProperty(value = "") + public DateTime getStartTime() { + return startTime; + } + + public void setStartTime(DateTime startTime) { + this.startTime = startTime; + } + + public InlineResponse200PaymentBatchSummaries endTime(DateTime endTime) { + this.endTime = endTime; + return this; + } + + /** + * Get endTime + * @return endTime + **/ + @ApiModelProperty(value = "") + public DateTime getEndTime() { + return endTime; + } + + public void setEndTime(DateTime endTime) { + this.endTime = endTime; + } + + public InlineResponse200PaymentBatchSummaries salesCount(Integer salesCount) { + this.salesCount = salesCount; + return this; + } + + /** + * Get salesCount + * @return salesCount + **/ + @ApiModelProperty(example = "10", value = "") + public Integer getSalesCount() { + return salesCount; + } + + public void setSalesCount(Integer salesCount) { + this.salesCount = salesCount; + } + + public InlineResponse200PaymentBatchSummaries salesAmount(String salesAmount) { + this.salesAmount = salesAmount; + return this; + } + + /** + * Get salesAmount + * @return salesAmount + **/ + @ApiModelProperty(example = "5000.01", value = "") + public String getSalesAmount() { + return salesAmount; + } + + public void setSalesAmount(String salesAmount) { + this.salesAmount = salesAmount; + } + + public InlineResponse200PaymentBatchSummaries creditCount(Integer creditCount) { + this.creditCount = creditCount; + return this; + } + + /** + * Get creditCount + * @return creditCount + **/ + @ApiModelProperty(example = "10", value = "") + public Integer getCreditCount() { + return creditCount; + } + + public void setCreditCount(Integer creditCount) { + this.creditCount = creditCount; + } + + public InlineResponse200PaymentBatchSummaries creditAmount(String creditAmount) { + this.creditAmount = creditAmount; + return this; + } + + /** + * Get creditAmount + * @return creditAmount + **/ + @ApiModelProperty(example = "5000.01", value = "") + public String getCreditAmount() { + return creditAmount; + } + + public void setCreditAmount(String creditAmount) { + this.creditAmount = creditAmount; + } + + public InlineResponse200PaymentBatchSummaries accountName(String accountName) { + this.accountName = accountName; + return this; + } + + /** + * Get accountName + * @return accountName + **/ + @ApiModelProperty(example = "ubmerchant296", value = "") + public String getAccountName() { + return accountName; + } + + public void setAccountName(String accountName) { + this.accountName = accountName; + } + + public InlineResponse200PaymentBatchSummaries accountId(String accountId) { + this.accountId = accountId; + return this; + } + + /** + * Get accountId + * @return accountId + **/ + @ApiModelProperty(example = "ubmerchant296_acct", value = "") + public String getAccountId() { + return accountId; + } + + public void setAccountId(String accountId) { + this.accountId = accountId; + } + + public InlineResponse200PaymentBatchSummaries merchantId(String merchantId) { + this.merchantId = merchantId; + return this; + } + + /** + * Get merchantId + * @return merchantId + **/ + @ApiModelProperty(example = "ubmerchant296_3", value = "") + public String getMerchantId() { + return merchantId; + } + + public void setMerchantId(String merchantId) { + this.merchantId = merchantId; + } + + public InlineResponse200PaymentBatchSummaries merchantName(String merchantName) { + this.merchantName = merchantName; + return this; + } + + /** + * Get merchantName + * @return merchantName + **/ + @ApiModelProperty(example = "ubmerchant296_3", value = "") + public String getMerchantName() { + return merchantName; + } + + public void setMerchantName(String merchantName) { + this.merchantName = merchantName; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + InlineResponse200PaymentBatchSummaries inlineResponse200PaymentBatchSummaries = (InlineResponse200PaymentBatchSummaries) o; + return Objects.equals(this.currencyCode, inlineResponse200PaymentBatchSummaries.currencyCode) && + Objects.equals(this.paymentSubTypeDescription, inlineResponse200PaymentBatchSummaries.paymentSubTypeDescription) && + Objects.equals(this.startTime, inlineResponse200PaymentBatchSummaries.startTime) && + Objects.equals(this.endTime, inlineResponse200PaymentBatchSummaries.endTime) && + Objects.equals(this.salesCount, inlineResponse200PaymentBatchSummaries.salesCount) && + Objects.equals(this.salesAmount, inlineResponse200PaymentBatchSummaries.salesAmount) && + Objects.equals(this.creditCount, inlineResponse200PaymentBatchSummaries.creditCount) && + Objects.equals(this.creditAmount, inlineResponse200PaymentBatchSummaries.creditAmount) && + Objects.equals(this.accountName, inlineResponse200PaymentBatchSummaries.accountName) && + Objects.equals(this.accountId, inlineResponse200PaymentBatchSummaries.accountId) && + Objects.equals(this.merchantId, inlineResponse200PaymentBatchSummaries.merchantId) && + Objects.equals(this.merchantName, inlineResponse200PaymentBatchSummaries.merchantName); + } + + @Override + public int hashCode() { + return Objects.hash(currencyCode, paymentSubTypeDescription, startTime, endTime, salesCount, salesAmount, creditCount, creditAmount, accountName, accountId, merchantId, merchantName); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class InlineResponse200PaymentBatchSummaries {\n"); + + sb.append(" currencyCode: ").append(toIndentedString(currencyCode)).append("\n"); + sb.append(" paymentSubTypeDescription: ").append(toIndentedString(paymentSubTypeDescription)).append("\n"); + sb.append(" startTime: ").append(toIndentedString(startTime)).append("\n"); + sb.append(" endTime: ").append(toIndentedString(endTime)).append("\n"); + sb.append(" salesCount: ").append(toIndentedString(salesCount)).append("\n"); + sb.append(" salesAmount: ").append(toIndentedString(salesAmount)).append("\n"); + sb.append(" creditCount: ").append(toIndentedString(creditCount)).append("\n"); + sb.append(" creditAmount: ").append(toIndentedString(creditAmount)).append("\n"); + sb.append(" accountName: ").append(toIndentedString(accountName)).append("\n"); + sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n"); + sb.append(" merchantId: ").append(toIndentedString(merchantId)).append("\n"); + sb.append(" merchantName: ").append(toIndentedString(merchantName)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/InlineResponse400.java b/src/main/java/Model/InlineResponse400.java index 4fa21ae95..55a764a70 100644 --- a/src/main/java/Model/InlineResponse400.java +++ b/src/main/java/Model/InlineResponse400.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ * Error Bean */ @ApiModel(description = "Error Bean") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class InlineResponse400 { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/InlineResponse4001.java b/src/main/java/Model/InlineResponse4001.java index bcf2684d3..ba86ecc98 100644 --- a/src/main/java/Model/InlineResponse4001.java +++ b/src/main/java/Model/InlineResponse4001.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * InlineResponse4001 */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class InlineResponse4001 { @SerializedName("type") private String type = null; diff --git a/src/main/java/Model/InlineResponse400Fields.java b/src/main/java/Model/InlineResponse400Fields.java index 7ff9fb3cd..68bc5a659 100644 --- a/src/main/java/Model/InlineResponse400Fields.java +++ b/src/main/java/Model/InlineResponse400Fields.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ * Provide validation failed input field details */ @ApiModel(description = "Provide validation failed input field details") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class InlineResponse400Fields { @SerializedName("path") private String path = null; diff --git a/src/main/java/Model/InlineResponseDefault.java b/src/main/java/Model/InlineResponseDefault.java index 62db07d22..6a6fad2f5 100644 --- a/src/main/java/Model/InlineResponseDefault.java +++ b/src/main/java/Model/InlineResponseDefault.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ /** * InlineResponseDefault */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class InlineResponseDefault { @SerializedName("responseStatus") private InlineResponseDefaultResponseStatus responseStatus = null; diff --git a/src/main/java/Model/InlineResponseDefaultLinks.java b/src/main/java/Model/InlineResponseDefaultLinks.java index bb5d834be..3ab872f9d 100644 --- a/src/main/java/Model/InlineResponseDefaultLinks.java +++ b/src/main/java/Model/InlineResponseDefaultLinks.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * InlineResponseDefaultLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class InlineResponseDefaultLinks { @SerializedName("next") private List next = null; diff --git a/src/main/java/Model/InlineResponseDefaultLinksNext.java b/src/main/java/Model/InlineResponseDefaultLinksNext.java index 82dcd71e5..5974f54e3 100644 --- a/src/main/java/Model/InlineResponseDefaultLinksNext.java +++ b/src/main/java/Model/InlineResponseDefaultLinksNext.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * InlineResponseDefaultLinksNext */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class InlineResponseDefaultLinksNext { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/InlineResponseDefaultResponseStatus.java b/src/main/java/Model/InlineResponseDefaultResponseStatus.java index 652b5ceb5..f16e5b8b0 100644 --- a/src/main/java/Model/InlineResponseDefaultResponseStatus.java +++ b/src/main/java/Model/InlineResponseDefaultResponseStatus.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * InlineResponseDefaultResponseStatus */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class InlineResponseDefaultResponseStatus { @SerializedName("status") private BigDecimal status = null; diff --git a/src/main/java/Model/InlineResponseDefaultResponseStatusDetails.java b/src/main/java/Model/InlineResponseDefaultResponseStatusDetails.java index ccfb7b42a..320d7f39f 100644 --- a/src/main/java/Model/InlineResponseDefaultResponseStatusDetails.java +++ b/src/main/java/Model/InlineResponseDefaultResponseStatusDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * InlineResponseDefaultResponseStatusDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class InlineResponseDefaultResponseStatusDetails { @SerializedName("location") private String location = null; diff --git a/src/main/java/Model/JsonWebKey.java b/src/main/java/Model/JsonWebKey.java deleted file mode 100644 index ca7eecd67..000000000 --- a/src/main/java/Model/JsonWebKey.java +++ /dev/null @@ -1,186 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * The public key in JSON Web Key (JWK) format. This format is useful for client side encryption in JavaScript based implementations. - */ -@ApiModel(description = "The public key in JSON Web Key (JWK) format. This format is useful for client side encryption in JavaScript based implementations.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class JsonWebKey { - @SerializedName("kty") - private String kty = null; - - @SerializedName("use") - private String use = null; - - @SerializedName("kid") - private String kid = null; - - @SerializedName("n") - private String n = null; - - @SerializedName("e") - private String e = null; - - public JsonWebKey kty(String kty) { - this.kty = kty; - return this; - } - - /** - * Algorithm used to encrypt the public key. - * @return kty - **/ - @ApiModelProperty(value = "Algorithm used to encrypt the public key.") - public String getKty() { - return kty; - } - - public void setKty(String kty) { - this.kty = kty; - } - - public JsonWebKey use(String use) { - this.use = use; - return this; - } - - /** - * Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc. - * @return use - **/ - @ApiModelProperty(value = "Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc.") - public String getUse() { - return use; - } - - public void setUse(String use) { - this.use = use; - } - - public JsonWebKey kid(String kid) { - this.kid = kid; - return this; - } - - /** - * The key ID in JWK format. - * @return kid - **/ - @ApiModelProperty(value = "The key ID in JWK format.") - public String getKid() { - return kid; - } - - public void setKid(String kid) { - this.kid = kid; - } - - public JsonWebKey n(String n) { - this.n = n; - return this; - } - - /** - * JWK RSA Modulus - * @return n - **/ - @ApiModelProperty(value = "JWK RSA Modulus") - public String getN() { - return n; - } - - public void setN(String n) { - this.n = n; - } - - public JsonWebKey e(String e) { - this.e = e; - return this; - } - - /** - * JWK RSA Exponent - * @return e - **/ - @ApiModelProperty(value = "JWK RSA Exponent") - public String getE() { - return e; - } - - public void setE(String e) { - this.e = e; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - JsonWebKey jsonWebKey = (JsonWebKey) o; - return Objects.equals(this.kty, jsonWebKey.kty) && - Objects.equals(this.use, jsonWebKey.use) && - Objects.equals(this.kid, jsonWebKey.kid) && - Objects.equals(this.n, jsonWebKey.n) && - Objects.equals(this.e, jsonWebKey.e); - } - - @Override - public int hashCode() { - return Objects.hash(kty, use, kid, n, e); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class JsonWebKey {\n"); - - sb.append(" kty: ").append(toIndentedString(kty)).append("\n"); - sb.append(" use: ").append(toIndentedString(use)).append("\n"); - sb.append(" kid: ").append(toIndentedString(kid)).append("\n"); - sb.append(" n: ").append(toIndentedString(n)).append("\n"); - sb.append(" e: ").append(toIndentedString(e)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/KeyParameters.java b/src/main/java/Model/KeyParameters.java deleted file mode 100644 index d8ca274e4..000000000 --- a/src/main/java/Model/KeyParameters.java +++ /dev/null @@ -1,93 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * KeyParameters - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class KeyParameters { - @SerializedName("encryptionType") - private String encryptionType = null; - - public KeyParameters encryptionType(String encryptionType) { - this.encryptionType = encryptionType; - return this; - } - - /** - * How the card number should be encrypted in the subsequent Tokenize Card request. Possible values are RsaOaep256 or None (if using this value the card number must be in plain text when included in the Tokenize Card request). The Tokenize Card request uses a secure connection (TLS 1.2+) regardless of what encryption type is specified. - * @return encryptionType - **/ - @ApiModelProperty(value = "How the card number should be encrypted in the subsequent Tokenize Card request. Possible values are RsaOaep256 or None (if using this value the card number must be in plain text when included in the Tokenize Card request). The Tokenize Card request uses a secure connection (TLS 1.2+) regardless of what encryption type is specified.") - public String getEncryptionType() { - return encryptionType; - } - - public void setEncryptionType(String encryptionType) { - this.encryptionType = encryptionType; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - KeyParameters keyParameters = (KeyParameters) o; - return Objects.equals(this.encryptionType, keyParameters.encryptionType); - } - - @Override - public int hashCode() { - return Objects.hash(encryptionType); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class KeyParameters {\n"); - - sb.append(" encryptionType: ").append(toIndentedString(encryptionType)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/KeyResult.java b/src/main/java/Model/KeyResult.java deleted file mode 100644 index ff590040d..000000000 --- a/src/main/java/Model/KeyResult.java +++ /dev/null @@ -1,141 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import Model.FlexV1KeysPost200ResponseDer; -import Model.FlexV1KeysPost200ResponseJwk; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * KeyResult - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class KeyResult { - @SerializedName("keyId") - private String keyId = null; - - @SerializedName("der") - private FlexV1KeysPost200ResponseDer der = null; - - @SerializedName("jwk") - private FlexV1KeysPost200ResponseJwk jwk = null; - - public KeyResult keyId(String keyId) { - this.keyId = keyId; - return this; - } - - /** - * Unique identifier for the generated token. Used in the subsequent Tokenize Card request from your customer’s device or browser. - * @return keyId - **/ - @ApiModelProperty(value = "Unique identifier for the generated token. Used in the subsequent Tokenize Card request from your customer’s device or browser.") - public String getKeyId() { - return keyId; - } - - public void setKeyId(String keyId) { - this.keyId = keyId; - } - - public KeyResult der(FlexV1KeysPost200ResponseDer der) { - this.der = der; - return this; - } - - /** - * Get der - * @return der - **/ - @ApiModelProperty(value = "") - public FlexV1KeysPost200ResponseDer getDer() { - return der; - } - - public void setDer(FlexV1KeysPost200ResponseDer der) { - this.der = der; - } - - public KeyResult jwk(FlexV1KeysPost200ResponseJwk jwk) { - this.jwk = jwk; - return this; - } - - /** - * Get jwk - * @return jwk - **/ - @ApiModelProperty(value = "") - public FlexV1KeysPost200ResponseJwk getJwk() { - return jwk; - } - - public void setJwk(FlexV1KeysPost200ResponseJwk jwk) { - this.jwk = jwk; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - KeyResult keyResult = (KeyResult) o; - return Objects.equals(this.keyId, keyResult.keyId) && - Objects.equals(this.der, keyResult.der) && - Objects.equals(this.jwk, keyResult.jwk); - } - - @Override - public int hashCode() { - return Objects.hash(keyId, der, jwk); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class KeyResult {\n"); - - sb.append(" keyId: ").append(toIndentedString(keyId)).append("\n"); - sb.append(" der: ").append(toIndentedString(der)).append("\n"); - sb.append(" jwk: ").append(toIndentedString(jwk)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Link.java b/src/main/java/Model/Link.java deleted file mode 100644 index ef7c74968..000000000 --- a/src/main/java/Model/Link.java +++ /dev/null @@ -1,139 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Link - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Link { - @SerializedName("href") - private String href = null; - - @SerializedName("title") - private String title = null; - - @SerializedName("method") - private String method = null; - - public Link href(String href) { - this.href = href; - return this; - } - - /** - * URI of the linked resource. - * @return href - **/ - @ApiModelProperty(value = "URI of the linked resource.") - public String getHref() { - return href; - } - - public void setHref(String href) { - this.href = href; - } - - public Link title(String title) { - this.title = title; - return this; - } - - /** - * Label of the linked resource. - * @return title - **/ - @ApiModelProperty(value = "Label of the linked resource.") - public String getTitle() { - return title; - } - - public void setTitle(String title) { - this.title = title; - } - - public Link method(String method) { - this.method = method; - return this; - } - - /** - * HTTP method of the linked resource. - * @return method - **/ - @ApiModelProperty(value = "HTTP method of the linked resource.") - public String getMethod() { - return method; - } - - public void setMethod(String method) { - this.method = method; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Link link = (Link) o; - return Objects.equals(this.href, link.href) && - Objects.equals(this.title, link.title) && - Objects.equals(this.method, link.method); - } - - @Override - public int hashCode() { - return Objects.hash(href, title, method); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Link {\n"); - - sb.append(" href: ").append(toIndentedString(href)).append("\n"); - sb.append(" title: ").append(toIndentedString(title)).append("\n"); - sb.append(" method: ").append(toIndentedString(method)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Links.java b/src/main/java/Model/Links.java deleted file mode 100644 index fc123a169..000000000 --- a/src/main/java/Model/Links.java +++ /dev/null @@ -1,158 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import Model.InlineResponseDefaultLinksNext; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; -import java.util.ArrayList; -import java.util.List; - -/** - * Links - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Links { - @SerializedName("self") - private InlineResponseDefaultLinksNext self = null; - - @SerializedName("documentation") - private List documentation = null; - - @SerializedName("next") - private List next = null; - - public Links self(InlineResponseDefaultLinksNext self) { - this.self = self; - return this; - } - - /** - * Get self - * @return self - **/ - @ApiModelProperty(value = "") - public InlineResponseDefaultLinksNext getSelf() { - return self; - } - - public void setSelf(InlineResponseDefaultLinksNext self) { - this.self = self; - } - - public Links documentation(List documentation) { - this.documentation = documentation; - return this; - } - - public Links addDocumentationItem(InlineResponseDefaultLinksNext documentationItem) { - if (this.documentation == null) { - this.documentation = new ArrayList(); - } - this.documentation.add(documentationItem); - return this; - } - - /** - * Get documentation - * @return documentation - **/ - @ApiModelProperty(value = "") - public List getDocumentation() { - return documentation; - } - - public void setDocumentation(List documentation) { - this.documentation = documentation; - } - - public Links next(List next) { - this.next = next; - return this; - } - - public Links addNextItem(InlineResponseDefaultLinksNext nextItem) { - if (this.next == null) { - this.next = new ArrayList(); - } - this.next.add(nextItem); - return this; - } - - /** - * Get next - * @return next - **/ - @ApiModelProperty(value = "") - public List getNext() { - return next; - } - - public void setNext(List next) { - this.next = next; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Links links = (Links) o; - return Objects.equals(this.self, links.self) && - Objects.equals(this.documentation, links.documentation) && - Objects.equals(this.next, links.next); - } - - @Override - public int hashCode() { - return Objects.hash(self, documentation, next); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Links {\n"); - - sb.append(" self: ").append(toIndentedString(self)).append("\n"); - sb.append(" documentation: ").append(toIndentedString(documentation)).append("\n"); - sb.append(" next: ").append(toIndentedString(next)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/MitReversalRequest.java b/src/main/java/Model/MitReversalRequest.java new file mode 100644 index 000000000..7e96dc4ec --- /dev/null +++ b/src/main/java/Model/MitReversalRequest.java @@ -0,0 +1,190 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.Ptsv2paymentsClientReferenceInformation; +import Model.Ptsv2paymentsidreversalsOrderInformation; +import Model.Ptsv2paymentsidreversalsPointOfSaleInformation; +import Model.Ptsv2paymentsidreversalsProcessingInformation; +import Model.Ptsv2paymentsidreversalsReversalInformation; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * MitReversalRequest + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class MitReversalRequest { + @SerializedName("clientReferenceInformation") + private Ptsv2paymentsClientReferenceInformation clientReferenceInformation = null; + + @SerializedName("reversalInformation") + private Ptsv2paymentsidreversalsReversalInformation reversalInformation = null; + + @SerializedName("processingInformation") + private Ptsv2paymentsidreversalsProcessingInformation processingInformation = null; + + @SerializedName("orderInformation") + private Ptsv2paymentsidreversalsOrderInformation orderInformation = null; + + @SerializedName("pointOfSaleInformation") + private Ptsv2paymentsidreversalsPointOfSaleInformation pointOfSaleInformation = null; + + public MitReversalRequest clientReferenceInformation(Ptsv2paymentsClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + return this; + } + + /** + * Get clientReferenceInformation + * @return clientReferenceInformation + **/ + @ApiModelProperty(value = "") + public Ptsv2paymentsClientReferenceInformation getClientReferenceInformation() { + return clientReferenceInformation; + } + + public void setClientReferenceInformation(Ptsv2paymentsClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + } + + public MitReversalRequest reversalInformation(Ptsv2paymentsidreversalsReversalInformation reversalInformation) { + this.reversalInformation = reversalInformation; + return this; + } + + /** + * Get reversalInformation + * @return reversalInformation + **/ + @ApiModelProperty(value = "") + public Ptsv2paymentsidreversalsReversalInformation getReversalInformation() { + return reversalInformation; + } + + public void setReversalInformation(Ptsv2paymentsidreversalsReversalInformation reversalInformation) { + this.reversalInformation = reversalInformation; + } + + public MitReversalRequest processingInformation(Ptsv2paymentsidreversalsProcessingInformation processingInformation) { + this.processingInformation = processingInformation; + return this; + } + + /** + * Get processingInformation + * @return processingInformation + **/ + @ApiModelProperty(value = "") + public Ptsv2paymentsidreversalsProcessingInformation getProcessingInformation() { + return processingInformation; + } + + public void setProcessingInformation(Ptsv2paymentsidreversalsProcessingInformation processingInformation) { + this.processingInformation = processingInformation; + } + + public MitReversalRequest orderInformation(Ptsv2paymentsidreversalsOrderInformation orderInformation) { + this.orderInformation = orderInformation; + return this; + } + + /** + * Get orderInformation + * @return orderInformation + **/ + @ApiModelProperty(value = "") + public Ptsv2paymentsidreversalsOrderInformation getOrderInformation() { + return orderInformation; + } + + public void setOrderInformation(Ptsv2paymentsidreversalsOrderInformation orderInformation) { + this.orderInformation = orderInformation; + } + + public MitReversalRequest pointOfSaleInformation(Ptsv2paymentsidreversalsPointOfSaleInformation pointOfSaleInformation) { + this.pointOfSaleInformation = pointOfSaleInformation; + return this; + } + + /** + * Get pointOfSaleInformation + * @return pointOfSaleInformation + **/ + @ApiModelProperty(value = "") + public Ptsv2paymentsidreversalsPointOfSaleInformation getPointOfSaleInformation() { + return pointOfSaleInformation; + } + + public void setPointOfSaleInformation(Ptsv2paymentsidreversalsPointOfSaleInformation pointOfSaleInformation) { + this.pointOfSaleInformation = pointOfSaleInformation; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + MitReversalRequest mitReversalRequest = (MitReversalRequest) o; + return Objects.equals(this.clientReferenceInformation, mitReversalRequest.clientReferenceInformation) && + Objects.equals(this.reversalInformation, mitReversalRequest.reversalInformation) && + Objects.equals(this.processingInformation, mitReversalRequest.processingInformation) && + Objects.equals(this.orderInformation, mitReversalRequest.orderInformation) && + Objects.equals(this.pointOfSaleInformation, mitReversalRequest.pointOfSaleInformation); + } + + @Override + public int hashCode() { + return Objects.hash(clientReferenceInformation, reversalInformation, processingInformation, orderInformation, pointOfSaleInformation); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class MitReversalRequest {\n"); + + sb.append(" clientReferenceInformation: ").append(toIndentedString(clientReferenceInformation)).append("\n"); + sb.append(" reversalInformation: ").append(toIndentedString(reversalInformation)).append("\n"); + sb.append(" processingInformation: ").append(toIndentedString(processingInformation)).append("\n"); + sb.append(" orderInformation: ").append(toIndentedString(orderInformation)).append("\n"); + sb.append(" pointOfSaleInformation: ").append(toIndentedString(pointOfSaleInformation)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/MitVoidRequest.java b/src/main/java/Model/MitVoidRequest.java new file mode 100644 index 000000000..fa010162a --- /dev/null +++ b/src/main/java/Model/MitVoidRequest.java @@ -0,0 +1,94 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.Ptsv2paymentsClientReferenceInformation; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * MitVoidRequest + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class MitVoidRequest { + @SerializedName("clientReferenceInformation") + private Ptsv2paymentsClientReferenceInformation clientReferenceInformation = null; + + public MitVoidRequest clientReferenceInformation(Ptsv2paymentsClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + return this; + } + + /** + * Get clientReferenceInformation + * @return clientReferenceInformation + **/ + @ApiModelProperty(value = "") + public Ptsv2paymentsClientReferenceInformation getClientReferenceInformation() { + return clientReferenceInformation; + } + + public void setClientReferenceInformation(Ptsv2paymentsClientReferenceInformation clientReferenceInformation) { + this.clientReferenceInformation = clientReferenceInformation; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + MitVoidRequest mitVoidRequest = (MitVoidRequest) o; + return Objects.equals(this.clientReferenceInformation, mitVoidRequest.clientReferenceInformation); + } + + @Override + public int hashCode() { + return Objects.hash(clientReferenceInformation); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class MitVoidRequest {\n"); + + sb.append(" clientReferenceInformation: ").append(toIndentedString(clientReferenceInformation)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/PtsV2PayoutsPostResponse.java b/src/main/java/Model/OctCreatePaymentRequest.java similarity index 77% rename from src/main/java/Model/PtsV2PayoutsPostResponse.java rename to src/main/java/Model/OctCreatePaymentRequest.java index e5159ad9f..6254e04ba 100644 --- a/src/main/java/Model/PtsV2PayoutsPostResponse.java +++ b/src/main/java/Model/OctCreatePaymentRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -31,10 +31,10 @@ import java.io.IOException; /** - * PtsV2PayoutsPostResponse + * OctCreatePaymentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class PtsV2PayoutsPostResponse { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class OctCreatePaymentRequest { @SerializedName("clientReferenceInformation") private Ptsv2payoutsClientReferenceInformation clientReferenceInformation = null; @@ -56,7 +56,7 @@ public class PtsV2PayoutsPostResponse { @SerializedName("paymentInformation") private Ptsv2payoutsPaymentInformation paymentInformation = null; - public PtsV2PayoutsPostResponse clientReferenceInformation(Ptsv2payoutsClientReferenceInformation clientReferenceInformation) { + public OctCreatePaymentRequest clientReferenceInformation(Ptsv2payoutsClientReferenceInformation clientReferenceInformation) { this.clientReferenceInformation = clientReferenceInformation; return this; } @@ -74,7 +74,7 @@ public void setClientReferenceInformation(Ptsv2payoutsClientReferenceInformation this.clientReferenceInformation = clientReferenceInformation; } - public PtsV2PayoutsPostResponse orderInformation(Ptsv2payoutsOrderInformation orderInformation) { + public OctCreatePaymentRequest orderInformation(Ptsv2payoutsOrderInformation orderInformation) { this.orderInformation = orderInformation; return this; } @@ -92,7 +92,7 @@ public void setOrderInformation(Ptsv2payoutsOrderInformation orderInformation) { this.orderInformation = orderInformation; } - public PtsV2PayoutsPostResponse merchantInformation(Ptsv2payoutsMerchantInformation merchantInformation) { + public OctCreatePaymentRequest merchantInformation(Ptsv2payoutsMerchantInformation merchantInformation) { this.merchantInformation = merchantInformation; return this; } @@ -110,7 +110,7 @@ public void setMerchantInformation(Ptsv2payoutsMerchantInformation merchantInfor this.merchantInformation = merchantInformation; } - public PtsV2PayoutsPostResponse recipientInformation(Ptsv2payoutsRecipientInformation recipientInformation) { + public OctCreatePaymentRequest recipientInformation(Ptsv2payoutsRecipientInformation recipientInformation) { this.recipientInformation = recipientInformation; return this; } @@ -128,7 +128,7 @@ public void setRecipientInformation(Ptsv2payoutsRecipientInformation recipientIn this.recipientInformation = recipientInformation; } - public PtsV2PayoutsPostResponse senderInformation(Ptsv2payoutsSenderInformation senderInformation) { + public OctCreatePaymentRequest senderInformation(Ptsv2payoutsSenderInformation senderInformation) { this.senderInformation = senderInformation; return this; } @@ -146,7 +146,7 @@ public void setSenderInformation(Ptsv2payoutsSenderInformation senderInformation this.senderInformation = senderInformation; } - public PtsV2PayoutsPostResponse processingInformation(Ptsv2payoutsProcessingInformation processingInformation) { + public OctCreatePaymentRequest processingInformation(Ptsv2payoutsProcessingInformation processingInformation) { this.processingInformation = processingInformation; return this; } @@ -164,7 +164,7 @@ public void setProcessingInformation(Ptsv2payoutsProcessingInformation processin this.processingInformation = processingInformation; } - public PtsV2PayoutsPostResponse paymentInformation(Ptsv2payoutsPaymentInformation paymentInformation) { + public OctCreatePaymentRequest paymentInformation(Ptsv2payoutsPaymentInformation paymentInformation) { this.paymentInformation = paymentInformation; return this; } @@ -191,14 +191,14 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - PtsV2PayoutsPostResponse ptsV2PayoutsPostResponse = (PtsV2PayoutsPostResponse) o; - return Objects.equals(this.clientReferenceInformation, ptsV2PayoutsPostResponse.clientReferenceInformation) && - Objects.equals(this.orderInformation, ptsV2PayoutsPostResponse.orderInformation) && - Objects.equals(this.merchantInformation, ptsV2PayoutsPostResponse.merchantInformation) && - Objects.equals(this.recipientInformation, ptsV2PayoutsPostResponse.recipientInformation) && - Objects.equals(this.senderInformation, ptsV2PayoutsPostResponse.senderInformation) && - Objects.equals(this.processingInformation, ptsV2PayoutsPostResponse.processingInformation) && - Objects.equals(this.paymentInformation, ptsV2PayoutsPostResponse.paymentInformation); + OctCreatePaymentRequest octCreatePaymentRequest = (OctCreatePaymentRequest) o; + return Objects.equals(this.clientReferenceInformation, octCreatePaymentRequest.clientReferenceInformation) && + Objects.equals(this.orderInformation, octCreatePaymentRequest.orderInformation) && + Objects.equals(this.merchantInformation, octCreatePaymentRequest.merchantInformation) && + Objects.equals(this.recipientInformation, octCreatePaymentRequest.recipientInformation) && + Objects.equals(this.senderInformation, octCreatePaymentRequest.senderInformation) && + Objects.equals(this.processingInformation, octCreatePaymentRequest.processingInformation) && + Objects.equals(this.paymentInformation, octCreatePaymentRequest.paymentInformation); } @Override @@ -210,7 +210,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class PtsV2PayoutsPostResponse {\n"); + sb.append("class OctCreatePaymentRequest {\n"); sb.append(" clientReferenceInformation: ").append(toIndentedString(clientReferenceInformation)).append("\n"); sb.append(" orderInformation: ").append(toIndentedString(orderInformation)).append("\n"); diff --git a/src/main/java/Model/PtsV1TransactionBatchesGet200Response.java b/src/main/java/Model/PtsV1TransactionBatchesGet200Response.java index a46794325..4799b552e 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet200Response.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * PtsV1TransactionBatchesGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV1TransactionBatchesGet200Response { @SerializedName("transactionBatches") private List transactionBatches = null; @@ -91,10 +91,10 @@ public PtsV1TransactionBatchesGet200Response submitTimeUtc(String submitTimeUtc) } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinks.java b/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinks.java index 1d1a09c83..252d20174 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinks.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinks.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV1TransactionBatchesGet200ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV1TransactionBatchesGet200ResponseLinks { @SerializedName("self") private PtsV1TransactionBatchesGet200ResponseLinksSelf self = null; diff --git a/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinksSelf.java b/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinksSelf.java index 7d4088913..85471740c 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinksSelf.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinksSelf.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV1TransactionBatchesGet200ResponseLinksSelf */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV1TransactionBatchesGet200ResponseLinksSelf { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.java b/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.java index 19469185f..f692d0b87 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV1TransactionBatchesGet200ResponseTransactionBatches */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV1TransactionBatchesGet200ResponseTransactionBatches { @SerializedName("id") private String id = null; diff --git a/src/main/java/Model/PtsV1TransactionBatchesGet400Response.java b/src/main/java/Model/PtsV1TransactionBatchesGet400Response.java index e3ab7ed5c..bb0d4f53d 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet400Response.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet400Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV1TransactionBatchesGet400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV1TransactionBatchesGet400Response { @SerializedName("errorInformation") private PtsV1TransactionBatchesGet400ResponseErrorInformation errorInformation = null; @@ -59,10 +59,10 @@ public PtsV1TransactionBatchesGet400Response submitTimeUtc(String submitTimeUtc) } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformation.java b/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformation.java index 14ba9f75c..51faa1897 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformation.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * PtsV1TransactionBatchesGet400ResponseErrorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV1TransactionBatchesGet400ResponseErrorInformation { @SerializedName("reason") private String reason = null; diff --git a/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails.java b/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails.java index f039050b0..7cbcd2a74 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV1TransactionBatchesGet400ResponseErrorInformationDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV1TransactionBatchesGet400ResponseErrorInformationDetails { @SerializedName("field") private String field = null; diff --git a/src/main/java/Model/PtsV1TransactionBatchesGet500Response.java b/src/main/java/Model/PtsV1TransactionBatchesGet500Response.java index 2171654ab..0626f5fca 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet500Response.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet500Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV1TransactionBatchesGet500Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV1TransactionBatchesGet500Response { @SerializedName("errorInformation") private PtsV1TransactionBatchesGet500ResponseErrorInformation errorInformation = null; @@ -59,10 +59,10 @@ public PtsV1TransactionBatchesGet500Response submitTimeUtc(String submitTimeUtc) } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV1TransactionBatchesGet500ResponseErrorInformation.java b/src/main/java/Model/PtsV1TransactionBatchesGet500ResponseErrorInformation.java index 3943211a0..6959bef5c 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet500ResponseErrorInformation.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet500ResponseErrorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV1TransactionBatchesGet500ResponseErrorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV1TransactionBatchesGet500ResponseErrorInformation { @SerializedName("reason") private String reason = null; diff --git a/src/main/java/Model/PtsV1TransactionBatchesIdGet200Response.java b/src/main/java/Model/PtsV1TransactionBatchesIdGet200Response.java index fab3da7c4..4334c0f0f 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesIdGet200Response.java +++ b/src/main/java/Model/PtsV1TransactionBatchesIdGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV1TransactionBatchesIdGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV1TransactionBatchesIdGet200Response { @SerializedName("id") private String id = null; diff --git a/src/main/java/Model/PtsV1TransactionBatchesIdGet200ResponseLinks.java b/src/main/java/Model/PtsV1TransactionBatchesIdGet200ResponseLinks.java index d69513be3..ef65d7bcc 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesIdGet200ResponseLinks.java +++ b/src/main/java/Model/PtsV1TransactionBatchesIdGet200ResponseLinks.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * PtsV1TransactionBatchesIdGet200ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV1TransactionBatchesIdGet200ResponseLinks { @SerializedName("transactions") private List transactions = null; diff --git a/src/main/java/Model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions.java b/src/main/java/Model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions.java index 27cb9aca3..e7eb1f128 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions.java +++ b/src/main/java/Model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV1TransactionBatchesIdGet200ResponseLinksTransactions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV1TransactionBatchesIdGet200ResponseLinksTransactions { @SerializedName("href") private String href = null; @@ -43,7 +43,7 @@ public PtsV1TransactionBatchesIdGet200ResponseLinksTransactions href(String href * Self link for this request * @return href **/ - @ApiModelProperty(example = "v1/payments/5289798134206292501013", value = "Self link for this request") + @ApiModelProperty(example = "/tss/v2/transactions/5289798134206292501013", value = "Self link for this request") public String getHref() { return href; } diff --git a/src/main/java/Model/PtsV2CreditsPost201Response.java b/src/main/java/Model/PtsV2CreditsPost201Response.java index 9f7c0c813..57b6f3abe 100644 --- a/src/main/java/Model/PtsV2CreditsPost201Response.java +++ b/src/main/java/Model/PtsV2CreditsPost201Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -33,7 +33,7 @@ /** * PtsV2CreditsPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2CreditsPost201Response { @SerializedName("_links") private PtsV2PaymentsRefundPost201ResponseLinks links = null; @@ -137,10 +137,10 @@ public PtsV2CreditsPost201Response id(String id) { } /** - * An unique identification number assigned by CyberSource to identify the submitted request. + * An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. * @return id **/ - @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request.") + @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.") public String getId() { return id; } @@ -155,10 +155,10 @@ public PtsV2CreditsPost201Response submitTimeUtc(String submitTimeUtc) { } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.java b/src/main/java/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.java index 150fe620d..23c0d3ee3 100644 --- a/src/main/java/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.java +++ b/src/main/java/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2CreditsPost201ResponseCreditAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2CreditsPost201ResponseCreditAmountDetails { @SerializedName("creditAmount") private String creditAmount = null; diff --git a/src/main/java/Model/PtsV2CreditsPost201ResponsePaymentInformation.java b/src/main/java/Model/PtsV2CreditsPost201ResponsePaymentInformation.java index 84cc11831..eb81754c1 100644 --- a/src/main/java/Model/PtsV2CreditsPost201ResponsePaymentInformation.java +++ b/src/main/java/Model/PtsV2CreditsPost201ResponsePaymentInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2CreditsPost201ResponsePaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2CreditsPost201ResponsePaymentInformation { @SerializedName("bank") private PtsV2PaymentsPost201ResponsePaymentInformationBank bank = null; diff --git a/src/main/java/Model/PtsV2CreditsPost201ResponseProcessingInformation.java b/src/main/java/Model/PtsV2CreditsPost201ResponseProcessingInformation.java index 52845b5f5..d4d35edde 100644 --- a/src/main/java/Model/PtsV2CreditsPost201ResponseProcessingInformation.java +++ b/src/main/java/Model/PtsV2CreditsPost201ResponseProcessingInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2CreditsPost201ResponseProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2CreditsPost201ResponseProcessingInformation { @SerializedName("bankTransferOptions") private PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions bankTransferOptions = null; diff --git a/src/main/java/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.java b/src/main/java/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.java index 20a031a42..f195ad504 100644 --- a/src/main/java/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.java +++ b/src/main/java/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions { @SerializedName("settlementMethod") private String settlementMethod = null; diff --git a/src/main/java/Model/PtsV2PaymentsCapturesPost201Response.java b/src/main/java/Model/PtsV2PaymentsCapturesPost201Response.java index 4eec57472..c83fa2f30 100644 --- a/src/main/java/Model/PtsV2PaymentsCapturesPost201Response.java +++ b/src/main/java/Model/PtsV2PaymentsCapturesPost201Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * PtsV2PaymentsCapturesPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsCapturesPost201Response { @SerializedName("_links") private PtsV2PaymentsCapturesPost201ResponseLinks links = null; @@ -125,10 +125,10 @@ public PtsV2PaymentsCapturesPost201Response id(String id) { } /** - * An unique identification number assigned by CyberSource to identify the submitted request. + * An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. * @return id **/ - @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request.") + @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.") public String getId() { return id; } @@ -143,10 +143,10 @@ public PtsV2PaymentsCapturesPost201Response submitTimeUtc(String submitTimeUtc) } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseLinks.java b/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseLinks.java index acdada4aa..93cd8320e 100644 --- a/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseLinks.java +++ b/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseLinks.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2PaymentsCapturesPost201ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsCapturesPost201ResponseLinks { @SerializedName("self") private PtsV2PaymentsPost201ResponseLinksSelf self = null; diff --git a/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformation.java b/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformation.java index ceec3e930..53a983b91 100644 --- a/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformation.java +++ b/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ /** * PtsV2PaymentsCapturesPost201ResponseOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsCapturesPost201ResponseOrderInformation { @SerializedName("amountDetails") private PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails amountDetails = null; diff --git a/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.java b/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.java index 3f088c19c..b3b432dc6 100644 --- a/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.java +++ b/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails { @SerializedName("totalAmount") private String totalAmount = null; diff --git a/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation.java b/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation.java index 7d45fd2b2..af00785fb 100644 --- a/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation.java +++ b/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsCapturesPost201ResponseProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsCapturesPost201ResponseProcessorInformation { @SerializedName("transactionId") private String transactionId = null; diff --git a/src/main/java/Model/PtsV2PaymentsCapturesPost400Response.java b/src/main/java/Model/PtsV2PaymentsCapturesPost400Response.java index bdd939c7e..aeee139fc 100644 --- a/src/main/java/Model/PtsV2PaymentsCapturesPost400Response.java +++ b/src/main/java/Model/PtsV2PaymentsCapturesPost400Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * PtsV2PaymentsCapturesPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsCapturesPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; @@ -158,10 +158,10 @@ public PtsV2PaymentsCapturesPost400Response submitTimeUtc(String submitTimeUtc) } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV2PaymentsPost201Response.java b/src/main/java/Model/PtsV2PaymentsPost201Response.java index cdd3690b5..24e293005 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201Response.java +++ b/src/main/java/Model/PtsV2PaymentsPost201Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -36,7 +36,7 @@ /** * PtsV2PaymentsPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201Response { @SerializedName("_links") private PtsV2PaymentsPost201ResponseLinks links = null; @@ -159,10 +159,10 @@ public PtsV2PaymentsPost201Response id(String id) { } /** - * An unique identification number assigned by CyberSource to identify the submitted request. + * An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. * @return id **/ - @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request.") + @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.") public String getId() { return id; } @@ -177,10 +177,10 @@ public PtsV2PaymentsPost201Response submitTimeUtc(String submitTimeUtc) { } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseClientReferenceInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseClientReferenceInformation.java index 488014010..190523f62 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseClientReferenceInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseClientReferenceInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseClientReferenceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseClientReferenceInformation { @SerializedName("code") private String code = null; @@ -43,10 +43,10 @@ public PtsV2PaymentsPost201ResponseClientReferenceInformation code(String code) } /** - * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API. **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. + * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. * @return code **/ - @ApiModelProperty(value = "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API. **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ") + @ApiModelProperty(value = "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ") public String getCode() { return code; } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformation.java index ecdadba3a..95cabfb3b 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,10 +29,10 @@ /** * PtsV2PaymentsPost201ResponseErrorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseErrorInformation { /** - * The reason of the status. Possible values: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - DECLINED_CHECK - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION + * The reason of the status. Possible values: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - DECLINED_CHECK - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION - DECISION_PROFILE_REJECT - SCORE_EXCEEDS_THRESHOLD */ @JsonAdapter(ReasonEnum.Adapter.class) public enum ReasonEnum { @@ -64,7 +64,11 @@ public enum ReasonEnum { INVALID_ACCOUNT("INVALID_ACCOUNT"), - GENERAL_DECLINE("GENERAL_DECLINE"); + GENERAL_DECLINE("GENERAL_DECLINE"), + + DECISION_PROFILE_REJECT("DECISION_PROFILE_REJECT"), + + SCORE_EXCEEDS_THRESHOLD("SCORE_EXCEEDS_THRESHOLD"); private String value; @@ -119,10 +123,10 @@ public PtsV2PaymentsPost201ResponseErrorInformation reason(ReasonEnum reason) { } /** - * The reason of the status. Possible values: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - DECLINED_CHECK - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION + * The reason of the status. Possible values: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - DECLINED_CHECK - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION - DECISION_PROFILE_REJECT - SCORE_EXCEEDS_THRESHOLD * @return reason **/ - @ApiModelProperty(value = "The reason of the status. Possible values: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - DECLINED_CHECK - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION ") + @ApiModelProperty(value = "The reason of the status. Possible values: - AVS_FAILED - CONTACT_PROCESSOR - EXPIRED_CARD - PROCESSOR_DECLINED - INSUFFICIENT_FUND - STOLEN_LOST_CARD - ISSUER_UNAVAILABLE - UNAUTHORIZED_CARD - CVN_NOT_MATCH - EXCEEDS_CREDIT_LIMIT - INVALID_CVN - DECLINED_CHECK - BLACKLISTED_CUSTOMER - SUSPENDED_ACCOUNT - PAYMENT_REFUSED - CV_FAILED - INVALID_ACCOUNT - GENERAL_DECLINE - INVALID_MERCHANT_CONFIGURATION - DECISION_PROFILE_REJECT - SCORE_EXCEEDS_THRESHOLD ") public ReasonEnum getReason() { return reason; } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformationDetails.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformationDetails.java index ff12cb1e8..5fa4a8948 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformationDetails.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformationDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseErrorInformationDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseErrorInformationDetails { @SerializedName("field") private String field = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseInstallmentInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseInstallmentInformation.java index 13d747c74..0130ab969 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseInstallmentInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseInstallmentInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseInstallmentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseInstallmentInformation { @SerializedName("additionalCosts") private String additionalCosts = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseIssuerInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseIssuerInformation.java index c850077ce..fdfc3a760 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseIssuerInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseIssuerInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseIssuerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseIssuerInformation { @SerializedName("country") private String country = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseLinks.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseLinks.java index b16e39bc3..73f0f9bda 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseLinks.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseLinks.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2PaymentsPost201ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseLinks { @SerializedName("self") private PtsV2PaymentsPost201ResponseLinksSelf self = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseLinksSelf.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseLinksSelf.java index 529b735f2..12c7570c9 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseLinksSelf.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseLinksSelf.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseLinksSelf */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseLinksSelf { @SerializedName("href") private String href = null; @@ -40,10 +40,10 @@ public PtsV2PaymentsPost201ResponseLinksSelf href(String href) { } /** - * URL + * This is the endpoint of the resource that was created by the successful request. * @return href **/ - @ApiModelProperty(value = "URL") + @ApiModelProperty(value = "This is the endpoint of the resource that was created by the successful request.") public String getHref() { return href; } @@ -58,10 +58,10 @@ public PtsV2PaymentsPost201ResponseLinksSelf method(String method) { } /** - * HTTP method applied to above URL + * `method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource. * @return method **/ - @ApiModelProperty(value = "HTTP method applied to above URL") + @ApiModelProperty(value = "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource.") public String getMethod() { return method; } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformation.java index ea4dccf63..3a644e167 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ /** * PtsV2PaymentsPost201ResponseOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseOrderInformation { @SerializedName("amountDetails") private PtsV2PaymentsPost201ResponseOrderInformationAmountDetails amountDetails = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.java index fdaeb2ff6..248364682 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseOrderInformationAmountDetails { @SerializedName("totalAmount") private String totalAmount = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails.java index ad5e07830..974208b09 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails { @SerializedName("level3TransmissionStatus") private Boolean level3TransmissionStatus = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformation.java index 4a1a45241..877d74542 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * PtsV2PaymentsPost201ResponsePaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponsePaymentInformation { @SerializedName("card") private PtsV2PaymentsPost201ResponsePaymentInformationCard card = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.java b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.java index d7739f7f9..76aa48eef 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures { @SerializedName("accountType") private String accountType = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.java b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.java index e63ac3319..8eaead1f8 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2PaymentsPost201ResponsePaymentInformationBank */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponsePaymentInformationBank { @SerializedName("account") private PtsV2PaymentsPost201ResponsePaymentInformationBankAccount account = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.java b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.java index 1f3ff6e9e..6daf26859 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponsePaymentInformationBankAccount */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponsePaymentInformationBankAccount { @SerializedName("correctedAccountNumber") private String correctedAccountNumber = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationCard.java b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationCard.java index dfc3e4ceb..b12fac77c 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationCard.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationCard.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponsePaymentInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponsePaymentInformationCard { @SerializedName("suffix") private String suffix = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.java b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.java index f97807649..3fa593ddf 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard { @SerializedName("prefix") private String prefix = null; @@ -91,10 +91,10 @@ public PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard type(String t } /** - * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover + * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) * @return type **/ - @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover ") + @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) ") public String getType() { return type; } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformation.java index 70173a0ff..570b2c857 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2PaymentsPost201ResponsePointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponsePointOfSaleInformation { @SerializedName("emv") private PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv emv = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.java b/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.java index 0ade9410f..742d67cb5 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv { @SerializedName("tags") private String tags = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformation.java index 9109d8be4..92f691490 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2PaymentsPost201ResponseProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseProcessingInformation { @SerializedName("bankTransferOptions") private PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions bankTransferOptions = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.java index 7110b3e2b..905ac2e66 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions { @SerializedName("settlementMethod") private String settlementMethod = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformation.java index 1c00739a9..7ae748317 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -35,7 +35,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseProcessorInformation { @SerializedName("authIndicator") private String authIndicator = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.java index db7c3034a..f718cb275 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationAchVerification */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseProcessorInformationAchVerification { @SerializedName("resultCode") private String resultCode = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAvs.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAvs.java index 039aa7c65..127d43dab 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAvs.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAvs.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationAvs */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseProcessorInformationAvs { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.java index a391a1015..00bb0e2c6 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationCardVerification */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseProcessorInformationCardVerification { @SerializedName("resultCode") private String resultCode = null; @@ -40,10 +40,10 @@ public PtsV2PaymentsPost201ResponseProcessorInformationCardVerification resultCo } /** - * CVN result code. + * Result of card verification. Returned by the authorization service in the `processorInformation.cardVerification.resultCode` reply field. If ics_auth and ics_score are requested at the same time, the value is automatically passed from ics_auth to ics_score. For more information on using this field, see \"\"Sending the Results of Address and Card Verification Tests,\"\" page 16. The field contains one of the following values: - `I`: Card verification number failed processor's data validation check. - `M`: Card verification number matched. - `N`: Card verification number not matched. - `P`: Card verification number not processed. - `S`: Card verification number is on the card but was not included in the request. - `U`: Card verification is not supported by the issuing bank. - `X`: Card verification is not supported by the payment card company. - Space Character: Deprecated. Ignore this value. - `1`: CyberSource does not support card verification for this processor or card type. - `2`: Processor returned value unrecognized for card verification response. - `3`: Processor did not return card verification result code. * @return resultCode **/ - @ApiModelProperty(value = "CVN result code. ") + @ApiModelProperty(value = "Result of card verification. Returned by the authorization service in the `processorInformation.cardVerification.resultCode` reply field. If ics_auth and ics_score are requested at the same time, the value is automatically passed from ics_auth to ics_score. For more information on using this field, see \"\"Sending the Results of Address and Card Verification Tests,\"\" page 16. The field contains one of the following values: - `I`: Card verification number failed processor's data validation check. - `M`: Card verification number matched. - `N`: Card verification number not matched. - `P`: Card verification number not processed. - `S`: Card verification number is on the card but was not included in the request. - `U`: Card verification is not supported by the issuing bank. - `X`: Card verification is not supported by the payment card company. - Space Character: Deprecated. Ignore this value. - `1`: CyberSource does not support card verification for this processor or card type. - `2`: Processor returned value unrecognized for card verification response. - `3`: Processor did not return card verification result code. ") public String getResultCode() { return resultCode; } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse.java index a2c826a6c..93ca297dd 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer.java index 2e874dcaa..0ffc4416f 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationCustomer */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseProcessorInformationCustomer { @SerializedName("personalIdResult") private String personalIdResult = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.java index eb571bdf8..574a7f259 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.java index d3f391e38..ede07f29c 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationRouting.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationRouting.java index fdcce6ac3..9ae5e5065 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationRouting.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationRouting.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationRouting */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost201ResponseProcessorInformationRouting { @SerializedName("network") private String network = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost400Response.java b/src/main/java/Model/PtsV2PaymentsPost400Response.java index d84d102f7..9fa3d93dd 100644 --- a/src/main/java/Model/PtsV2PaymentsPost400Response.java +++ b/src/main/java/Model/PtsV2PaymentsPost400Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * PtsV2PaymentsPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; @@ -160,10 +160,10 @@ public PtsV2PaymentsPost400Response submitTimeUtc(String submitTimeUtc) { } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV2PaymentsPost502Response.java b/src/main/java/Model/PtsV2PaymentsPost502Response.java index 9cfead7d6..f0bb7fec0 100644 --- a/src/main/java/Model/PtsV2PaymentsPost502Response.java +++ b/src/main/java/Model/PtsV2PaymentsPost502Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost502Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsPost502Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; @@ -90,6 +90,8 @@ public enum ReasonEnum { SERVICE_TIMEOUT("SERVICE_TIMEOUT"), + INVALID_OR_MISSING_CONFIG("INVALID_OR_MISSING_CONFIG"), + PROCESSOR_TIMEOUT("PROCESSOR_TIMEOUT"); private String value; @@ -142,10 +144,10 @@ public PtsV2PaymentsPost502Response submitTimeUtc(String submitTimeUtc) { } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV2PaymentsRefundPost201Response.java b/src/main/java/Model/PtsV2PaymentsRefundPost201Response.java index a5efe1ad6..38ba4c0b7 100644 --- a/src/main/java/Model/PtsV2PaymentsRefundPost201Response.java +++ b/src/main/java/Model/PtsV2PaymentsRefundPost201Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -31,7 +31,7 @@ /** * PtsV2PaymentsRefundPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsRefundPost201Response { @SerializedName("_links") private PtsV2PaymentsRefundPost201ResponseLinks links = null; @@ -129,10 +129,10 @@ public PtsV2PaymentsRefundPost201Response id(String id) { } /** - * An unique identification number assigned by CyberSource to identify the submitted request. + * An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. * @return id **/ - @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request.") + @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.") public String getId() { return id; } @@ -147,10 +147,10 @@ public PtsV2PaymentsRefundPost201Response submitTimeUtc(String submitTimeUtc) { } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseLinks.java b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseLinks.java index 80dadb1da..bbb477852 100644 --- a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseLinks.java +++ b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseLinks.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2PaymentsRefundPost201ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsRefundPost201ResponseLinks { @SerializedName("self") private PtsV2PaymentsPost201ResponseLinksSelf self = null; diff --git a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseOrderInformation.java b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseOrderInformation.java index f84c8f7da..bc94c5633 100644 --- a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseOrderInformation.java +++ b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseOrderInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2PaymentsRefundPost201ResponseOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsRefundPost201ResponseOrderInformation { @SerializedName("invoiceDetails") private PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails invoiceDetails = null; diff --git a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.java b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.java index cdeb9aa50..55c6fce10 100644 --- a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.java +++ b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2PaymentsRefundPost201ResponseProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsRefundPost201ResponseProcessorInformation { @SerializedName("transactionId") private String transactionId = null; diff --git a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.java b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.java index 1097b812a..fdfd0a01c 100644 --- a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.java +++ b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsRefundPost201ResponseRefundAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsRefundPost201ResponseRefundAmountDetails { @SerializedName("refundAmount") private String refundAmount = null; diff --git a/src/main/java/Model/PtsV2PaymentsRefundPost400Response.java b/src/main/java/Model/PtsV2PaymentsRefundPost400Response.java index d872614af..243192950 100644 --- a/src/main/java/Model/PtsV2PaymentsRefundPost400Response.java +++ b/src/main/java/Model/PtsV2PaymentsRefundPost400Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * PtsV2PaymentsRefundPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsRefundPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; @@ -154,10 +154,10 @@ public PtsV2PaymentsRefundPost400Response submitTimeUtc(String submitTimeUtc) { } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV2PaymentsReversalsPost201Response.java b/src/main/java/Model/PtsV2PaymentsReversalsPost201Response.java index 854568b7a..4e593c96a 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost201Response.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost201Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -33,7 +33,7 @@ /** * PtsV2PaymentsReversalsPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsReversalsPost201Response { @SerializedName("_links") private PtsV2PaymentsReversalsPost201ResponseLinks links = null; @@ -137,10 +137,10 @@ public PtsV2PaymentsReversalsPost201Response id(String id) { } /** - * An unique identification number assigned by CyberSource to identify the submitted request. + * An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. * @return id **/ - @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request.") + @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.") public String getId() { return id; } @@ -155,10 +155,10 @@ public PtsV2PaymentsReversalsPost201Response submitTimeUtc(String submitTimeUtc) } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation.java b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation.java index 3009b9fed..afa4de05e 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation { @SerializedName("approvalCode") private String approvalCode = null; diff --git a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation.java b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation.java index 8e30e43d0..20d80bc5b 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsReversalsPost201ResponseIssuerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsReversalsPost201ResponseIssuerInformation { @SerializedName("responseCode") private String responseCode = null; diff --git a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseLinks.java b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseLinks.java index c5728bc9c..e2e83412c 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseLinks.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseLinks.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2PaymentsReversalsPost201ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsReversalsPost201ResponseLinks { @SerializedName("self") private PtsV2PaymentsPost201ResponseLinksSelf self = null; diff --git a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.java b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.java index 527fcf4cc..f4bc97e76 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsReversalsPost201ResponseProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsReversalsPost201ResponseProcessorInformation { @SerializedName("transactionId") private String transactionId = null; diff --git a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.java b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.java index ab9701964..d9625af5b 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails { @SerializedName("reversedAmount") private String reversedAmount = null; diff --git a/src/main/java/Model/PtsV2PaymentsReversalsPost400Response.java b/src/main/java/Model/PtsV2PaymentsReversalsPost400Response.java index ba95d824b..4736f65bd 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost400Response.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost400Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * PtsV2PaymentsReversalsPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsReversalsPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; @@ -154,10 +154,10 @@ public PtsV2PaymentsReversalsPost400Response submitTimeUtc(String submitTimeUtc) } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV2PaymentsVoidsPost201Response.java b/src/main/java/Model/PtsV2PaymentsVoidsPost201Response.java index 111a77c4e..c94560fca 100644 --- a/src/main/java/Model/PtsV2PaymentsVoidsPost201Response.java +++ b/src/main/java/Model/PtsV2PaymentsVoidsPost201Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * PtsV2PaymentsVoidsPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsVoidsPost201Response { @SerializedName("_links") private PtsV2PaymentsReversalsPost201ResponseLinks links = null; @@ -118,10 +118,10 @@ public PtsV2PaymentsVoidsPost201Response id(String id) { } /** - * An unique identification number assigned by CyberSource to identify the submitted request. + * An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. * @return id **/ - @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request.") + @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.") public String getId() { return id; } @@ -136,10 +136,10 @@ public PtsV2PaymentsVoidsPost201Response submitTimeUtc(String submitTimeUtc) { } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.java b/src/main/java/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.java index 06c1c8088..3cb71ad4d 100644 --- a/src/main/java/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.java +++ b/src/main/java/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails { @SerializedName("voidAmount") private String voidAmount = null; diff --git a/src/main/java/Model/PtsV2PaymentsVoidsPost400Response.java b/src/main/java/Model/PtsV2PaymentsVoidsPost400Response.java index c36cb3334..e185d5d79 100644 --- a/src/main/java/Model/PtsV2PaymentsVoidsPost400Response.java +++ b/src/main/java/Model/PtsV2PaymentsVoidsPost400Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * PtsV2PaymentsVoidsPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PaymentsVoidsPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; @@ -150,10 +150,10 @@ public PtsV2PaymentsVoidsPost400Response submitTimeUtc(String submitTimeUtc) { } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } diff --git a/src/main/java/Model/PtsV2PayoutsPost201Response.java b/src/main/java/Model/PtsV2PayoutsPost201Response.java index 3d158fad5..342e5cc52 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201Response.java +++ b/src/main/java/Model/PtsV2PayoutsPost201Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,14 +14,13 @@ package Model; import java.util.Objects; +import Model.PtsV2PaymentsPost201ResponseClientReferenceInformation; import Model.PtsV2PaymentsReversalsPost201ResponseLinks; import Model.PtsV2PayoutsPost201ResponseErrorInformation; import Model.PtsV2PayoutsPost201ResponseMerchantInformation; import Model.PtsV2PayoutsPost201ResponseOrderInformation; import Model.PtsV2PayoutsPost201ResponseProcessorInformation; import Model.PtsV2PayoutsPost201ResponseRecipientInformation; -import Model.PtsV2PayoutsPost201ResponseStatusInformation; -import Model.Ptsv2payoutsClientReferenceInformation; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -34,7 +33,7 @@ /** * PtsV2PayoutsPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PayoutsPost201Response { @SerializedName("_links") private PtsV2PaymentsReversalsPost201ResponseLinks links = null; @@ -46,13 +45,15 @@ public class PtsV2PayoutsPost201Response { private String submitTimeUtc = null; /** - * The status of the submitted transaction. + * The status of the submitted transaction. Possible values: - ACCEPTED - DECLINED - INVALID_REQUEST */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { ACCEPTED("ACCEPTED"), - DECLINED("DECLINED"); + DECLINED("DECLINED"), + + INVALID_REQUEST("INVALID_REQUEST"); private String value; @@ -98,14 +99,11 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("reconciliationId") private String reconciliationId = null; - @SerializedName("statusInformation") - private PtsV2PayoutsPost201ResponseStatusInformation statusInformation = null; - @SerializedName("errorInformation") private PtsV2PayoutsPost201ResponseErrorInformation errorInformation = null; @SerializedName("clientReferenceInformation") - private Ptsv2payoutsClientReferenceInformation clientReferenceInformation = null; + private PtsV2PaymentsPost201ResponseClientReferenceInformation clientReferenceInformation = null; @SerializedName("merchantInformation") private PtsV2PayoutsPost201ResponseMerchantInformation merchantInformation = null; @@ -143,10 +141,10 @@ public PtsV2PayoutsPost201Response id(String id) { } /** - * An unique identification number assigned by CyberSource to identify the submitted request. + * An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. * @return id **/ - @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request.") + @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.") public String getId() { return id; } @@ -179,10 +177,10 @@ public PtsV2PayoutsPost201Response status(StatusEnum status) { } /** - * The status of the submitted transaction. + * The status of the submitted transaction. Possible values: - ACCEPTED - DECLINED - INVALID_REQUEST * @return status **/ - @ApiModelProperty(value = "The status of the submitted transaction.") + @ApiModelProperty(value = "The status of the submitted transaction. Possible values: - ACCEPTED - DECLINED - INVALID_REQUEST ") public StatusEnum getStatus() { return status; } @@ -209,24 +207,6 @@ public void setReconciliationId(String reconciliationId) { this.reconciliationId = reconciliationId; } - public PtsV2PayoutsPost201Response statusInformation(PtsV2PayoutsPost201ResponseStatusInformation statusInformation) { - this.statusInformation = statusInformation; - return this; - } - - /** - * Get statusInformation - * @return statusInformation - **/ - @ApiModelProperty(value = "") - public PtsV2PayoutsPost201ResponseStatusInformation getStatusInformation() { - return statusInformation; - } - - public void setStatusInformation(PtsV2PayoutsPost201ResponseStatusInformation statusInformation) { - this.statusInformation = statusInformation; - } - public PtsV2PayoutsPost201Response errorInformation(PtsV2PayoutsPost201ResponseErrorInformation errorInformation) { this.errorInformation = errorInformation; return this; @@ -245,7 +225,7 @@ public void setErrorInformation(PtsV2PayoutsPost201ResponseErrorInformation erro this.errorInformation = errorInformation; } - public PtsV2PayoutsPost201Response clientReferenceInformation(Ptsv2payoutsClientReferenceInformation clientReferenceInformation) { + public PtsV2PayoutsPost201Response clientReferenceInformation(PtsV2PaymentsPost201ResponseClientReferenceInformation clientReferenceInformation) { this.clientReferenceInformation = clientReferenceInformation; return this; } @@ -255,11 +235,11 @@ public PtsV2PayoutsPost201Response clientReferenceInformation(Ptsv2payoutsClient * @return clientReferenceInformation **/ @ApiModelProperty(value = "") - public Ptsv2payoutsClientReferenceInformation getClientReferenceInformation() { + public PtsV2PaymentsPost201ResponseClientReferenceInformation getClientReferenceInformation() { return clientReferenceInformation; } - public void setClientReferenceInformation(Ptsv2payoutsClientReferenceInformation clientReferenceInformation) { + public void setClientReferenceInformation(PtsV2PaymentsPost201ResponseClientReferenceInformation clientReferenceInformation) { this.clientReferenceInformation = clientReferenceInformation; } @@ -350,7 +330,6 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.submitTimeUtc, ptsV2PayoutsPost201Response.submitTimeUtc) && Objects.equals(this.status, ptsV2PayoutsPost201Response.status) && Objects.equals(this.reconciliationId, ptsV2PayoutsPost201Response.reconciliationId) && - Objects.equals(this.statusInformation, ptsV2PayoutsPost201Response.statusInformation) && Objects.equals(this.errorInformation, ptsV2PayoutsPost201Response.errorInformation) && Objects.equals(this.clientReferenceInformation, ptsV2PayoutsPost201Response.clientReferenceInformation) && Objects.equals(this.merchantInformation, ptsV2PayoutsPost201Response.merchantInformation) && @@ -361,7 +340,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(links, id, submitTimeUtc, status, reconciliationId, statusInformation, errorInformation, clientReferenceInformation, merchantInformation, orderInformation, processorInformation, recipientInformation); + return Objects.hash(links, id, submitTimeUtc, status, reconciliationId, errorInformation, clientReferenceInformation, merchantInformation, orderInformation, processorInformation, recipientInformation); } @@ -375,7 +354,6 @@ public String toString() { sb.append(" submitTimeUtc: ").append(toIndentedString(submitTimeUtc)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append(" reconciliationId: ").append(toIndentedString(reconciliationId)).append("\n"); - sb.append(" statusInformation: ").append(toIndentedString(statusInformation)).append("\n"); sb.append(" errorInformation: ").append(toIndentedString(errorInformation)).append("\n"); sb.append(" clientReferenceInformation: ").append(toIndentedString(clientReferenceInformation)).append("\n"); sb.append(" merchantInformation: ").append(toIndentedString(merchantInformation)).append("\n"); diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseErrorInformation.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseErrorInformation.java index c867059b0..6f04f7979 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseErrorInformation.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseErrorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.PtsV2PayoutsPost201ResponseErrorInformationDetails; +import Model.PtsV2PaymentsPost201ResponseErrorInformationDetails; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -29,10 +29,10 @@ /** * PtsV2PayoutsPost201ResponseErrorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PayoutsPost201ResponseErrorInformation { /** - * The reason of the status. + * The reason of the status. Possible values: - EXPIRED_CARD - PROCESSOR_DECLINED - STOLEN_LOST_CARD - UNAUTHORIZED_CARD - CVN_NOT_MATCH - INVALID_CVN - BLACKLISTED_CUSTOMER - INVALID_ACCOUNT - GENERAL_DECLINE - RISK_CONTROL_DECLINE - PROCESSOR_RISK_CONTROL_DECLINE */ @JsonAdapter(ReasonEnum.Adapter.class) public enum ReasonEnum { @@ -103,7 +103,7 @@ public ReasonEnum read(final JsonReader jsonReader) throws IOException { private String message = null; @SerializedName("details") - private List details = null; + private List details = null; public PtsV2PayoutsPost201ResponseErrorInformation reason(ReasonEnum reason) { this.reason = reason; @@ -111,10 +111,10 @@ public PtsV2PayoutsPost201ResponseErrorInformation reason(ReasonEnum reason) { } /** - * The reason of the status. + * The reason of the status. Possible values: - EXPIRED_CARD - PROCESSOR_DECLINED - STOLEN_LOST_CARD - UNAUTHORIZED_CARD - CVN_NOT_MATCH - INVALID_CVN - BLACKLISTED_CUSTOMER - INVALID_ACCOUNT - GENERAL_DECLINE - RISK_CONTROL_DECLINE - PROCESSOR_RISK_CONTROL_DECLINE * @return reason **/ - @ApiModelProperty(value = "The reason of the status. ") + @ApiModelProperty(value = "The reason of the status. Possible values: - EXPIRED_CARD - PROCESSOR_DECLINED - STOLEN_LOST_CARD - UNAUTHORIZED_CARD - CVN_NOT_MATCH - INVALID_CVN - BLACKLISTED_CUSTOMER - INVALID_ACCOUNT - GENERAL_DECLINE - RISK_CONTROL_DECLINE - PROCESSOR_RISK_CONTROL_DECLINE ") public ReasonEnum getReason() { return reason; } @@ -141,14 +141,14 @@ public void setMessage(String message) { this.message = message; } - public PtsV2PayoutsPost201ResponseErrorInformation details(List details) { + public PtsV2PayoutsPost201ResponseErrorInformation details(List details) { this.details = details; return this; } - public PtsV2PayoutsPost201ResponseErrorInformation addDetailsItem(PtsV2PayoutsPost201ResponseErrorInformationDetails detailsItem) { + public PtsV2PayoutsPost201ResponseErrorInformation addDetailsItem(PtsV2PaymentsPost201ResponseErrorInformationDetails detailsItem) { if (this.details == null) { - this.details = new ArrayList(); + this.details = new ArrayList(); } this.details.add(detailsItem); return this; @@ -159,11 +159,11 @@ public PtsV2PayoutsPost201ResponseErrorInformation addDetailsItem(PtsV2PayoutsPo * @return details **/ @ApiModelProperty(value = "") - public List getDetails() { + public List getDetails() { return details; } - public void setDetails(List details) { + public void setDetails(List details) { this.details = details; } diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseErrorInformationDetails.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseErrorInformationDetails.java deleted file mode 100644 index 25d976a3e..000000000 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseErrorInformationDetails.java +++ /dev/null @@ -1,163 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * PtsV2PayoutsPost201ResponseErrorInformationDetails - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class PtsV2PayoutsPost201ResponseErrorInformationDetails { - @SerializedName("field") - private String field = null; - - /** - * Possible reasons for the error. - */ - @JsonAdapter(ReasonEnum.Adapter.class) - public enum ReasonEnum { - MISSING_FIELD("MISSING_FIELD"), - - INVALID_DATA("INVALID_DATA"); - - private String value; - - ReasonEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static ReasonEnum fromValue(String text) { - for (ReasonEnum b : ReasonEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final ReasonEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public ReasonEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return ReasonEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("reason") - private ReasonEnum reason = null; - - public PtsV2PayoutsPost201ResponseErrorInformationDetails field(String field) { - this.field = field; - return this; - } - - /** - * This is the flattened JSON object field name/path that is either missing or invalid. - * @return field - **/ - @ApiModelProperty(value = "This is the flattened JSON object field name/path that is either missing or invalid.") - public String getField() { - return field; - } - - public void setField(String field) { - this.field = field; - } - - public PtsV2PayoutsPost201ResponseErrorInformationDetails reason(ReasonEnum reason) { - this.reason = reason; - return this; - } - - /** - * Possible reasons for the error. - * @return reason - **/ - @ApiModelProperty(value = "Possible reasons for the error. ") - public ReasonEnum getReason() { - return reason; - } - - public void setReason(ReasonEnum reason) { - this.reason = reason; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PtsV2PayoutsPost201ResponseErrorInformationDetails ptsV2PayoutsPost201ResponseErrorInformationDetails = (PtsV2PayoutsPost201ResponseErrorInformationDetails) o; - return Objects.equals(this.field, ptsV2PayoutsPost201ResponseErrorInformationDetails.field) && - Objects.equals(this.reason, ptsV2PayoutsPost201ResponseErrorInformationDetails.reason); - } - - @Override - public int hashCode() { - return Objects.hash(field, reason); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PtsV2PayoutsPost201ResponseErrorInformationDetails {\n"); - - sb.append(" field: ").append(toIndentedString(field)).append("\n"); - sb.append(" reason: ").append(toIndentedString(reason)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformation.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformation.java index b76a9ac0c..b1b847a8c 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformation.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2PayoutsPost201ResponseMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PayoutsPost201ResponseMerchantInformation { @SerializedName("merchantDescriptor") private PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor merchantDescriptor = null; diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor.java index 092f63ebd..5285ebfa8 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseOrderInformation.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseOrderInformation.java index a272fb2f9..45eb378a4 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseOrderInformation.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseOrderInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2PayoutsPost201ResponseOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PayoutsPost201ResponseOrderInformation { @SerializedName("amountDetails") private PtsV2PayoutsPost201ResponseOrderInformationAmountDetails amountDetails = null; diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.java index 8ebce6354..a6dc154d0 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PayoutsPost201ResponseOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PayoutsPost201ResponseOrderInformationAmountDetails { @SerializedName("totalAmount") private String totalAmount = null; @@ -46,10 +46,10 @@ public PtsV2PayoutsPost201ResponseOrderInformationAmountDetails totalAmount(Stri } /** - * Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:  Table 15, \"Authorization Information for Specific Processors,\" on page 43  Table 19, \"Capture Information for Specific Processors,\" on page 58  Table 23, \"Credit Information for Specific Processors,\" on page 75 If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247. **DCC with a Third-Party Provider**\\ Set this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used. * @return totalAmount **/ - @ApiModelProperty(value = "Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:  Table 15, \"Authorization Information for Specific Processors,\" on page 43  Table 19, \"Capture Information for Specific Processors,\" on page 58  Table 23, \"Credit Information for Specific Processors,\" on page 75 If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247. **DCC with a Third-Party Provider**\\ Set this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used. ") public String getTotalAmount() { return totalAmount; } @@ -64,10 +64,10 @@ public PtsV2PayoutsPost201ResponseOrderInformationAmountDetails currency(String } /** - * Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. + * Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. * @return currency **/ - @ApiModelProperty(value = "Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. ") + @ApiModelProperty(value = "Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. ") public String getCurrency() { return currency; } diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseProcessorInformation.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseProcessorInformation.java index edbf21826..38f8d3c66 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseProcessorInformation.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseProcessorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PayoutsPost201ResponseProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PayoutsPost201ResponseProcessorInformation { @SerializedName("approvalCode") private String approvalCode = null; diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformation.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformation.java index 1123d900a..571938d34 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformation.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * PtsV2PayoutsPost201ResponseRecipientInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PayoutsPost201ResponseRecipientInformation { @SerializedName("card") private PtsV2PayoutsPost201ResponseRecipientInformationCard card = null; diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformationCard.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformationCard.java index cf2500e26..034b633fb 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformationCard.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformationCard.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * PtsV2PayoutsPost201ResponseRecipientInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PayoutsPost201ResponseRecipientInformationCard { @SerializedName("balance") private String balance = null; diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseStatusInformation.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseStatusInformation.java deleted file mode 100644 index 4f35b05a1..000000000 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseStatusInformation.java +++ /dev/null @@ -1,163 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * PtsV2PayoutsPost201ResponseStatusInformation - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class PtsV2PayoutsPost201ResponseStatusInformation { - /** - * The reason of the status. - */ - @JsonAdapter(ReasonEnum.Adapter.class) - public enum ReasonEnum { - SUCCESS("SUCCESS"), - - CONTACT_PROCESSOR("CONTACT_PROCESSOR"); - - private String value; - - ReasonEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static ReasonEnum fromValue(String text) { - for (ReasonEnum b : ReasonEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final ReasonEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public ReasonEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return ReasonEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("reason") - private ReasonEnum reason = null; - - @SerializedName("message") - private String message = null; - - public PtsV2PayoutsPost201ResponseStatusInformation reason(ReasonEnum reason) { - this.reason = reason; - return this; - } - - /** - * The reason of the status. - * @return reason - **/ - @ApiModelProperty(value = "The reason of the status. ") - public ReasonEnum getReason() { - return reason; - } - - public void setReason(ReasonEnum reason) { - this.reason = reason; - } - - public PtsV2PayoutsPost201ResponseStatusInformation message(String message) { - this.message = message; - return this; - } - - /** - * The detail message related to the status and reason listed above. Possible value is: - Transaction was successful. - You must call the issuing bank to proceed with the transaction. - * @return message - **/ - @ApiModelProperty(value = "The detail message related to the status and reason listed above. Possible value is: - Transaction was successful. - You must call the issuing bank to proceed with the transaction. ") - public String getMessage() { - return message; - } - - public void setMessage(String message) { - this.message = message; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PtsV2PayoutsPost201ResponseStatusInformation ptsV2PayoutsPost201ResponseStatusInformation = (PtsV2PayoutsPost201ResponseStatusInformation) o; - return Objects.equals(this.reason, ptsV2PayoutsPost201ResponseStatusInformation.reason) && - Objects.equals(this.message, ptsV2PayoutsPost201ResponseStatusInformation.message); - } - - @Override - public int hashCode() { - return Objects.hash(reason, message); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PtsV2PayoutsPost201ResponseStatusInformation {\n"); - - sb.append(" reason: ").append(toIndentedString(reason)).append("\n"); - sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/PtsV2PayoutsPost400Response.java b/src/main/java/Model/PtsV2PayoutsPost400Response.java index 977c88409..ce65aaf43 100644 --- a/src/main/java/Model/PtsV2PayoutsPost400Response.java +++ b/src/main/java/Model/PtsV2PayoutsPost400Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.PtsV2PayoutsPost201ResponseErrorInformationDetails; +import Model.PtsV2PaymentsPost201ResponseErrorInformationDetails; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -29,7 +29,7 @@ /** * PtsV2PayoutsPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class PtsV2PayoutsPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; @@ -38,7 +38,7 @@ public class PtsV2PayoutsPost400Response { private String status = null; /** - * The reason of the status. + * The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_CARD - INVALID_MERCHANT_CONFIGURATION - INVALID_AMOUNT - DEBIT_CARD_USEAGE_EXCEEDD_LIMIT */ @JsonAdapter(ReasonEnum.Adapter.class) public enum ReasonEnum { @@ -48,6 +48,8 @@ public enum ReasonEnum { DUPLICATE_REQUEST("DUPLICATE_REQUEST"), + INVALID_CARD("INVALID_CARD"), + INVALID_MERCHANT_CONFIGURATION("INVALID_MERCHANT_CONFIGURATION"), INVALID_AMOUNT("INVALID_AMOUNT"), @@ -99,7 +101,7 @@ public ReasonEnum read(final JsonReader jsonReader) throws IOException { private String message = null; @SerializedName("details") - private List details = null; + private List details = null; public PtsV2PayoutsPost400Response submitTimeUtc(String submitTimeUtc) { this.submitTimeUtc = submitTimeUtc; @@ -143,10 +145,10 @@ public PtsV2PayoutsPost400Response reason(ReasonEnum reason) { } /** - * The reason of the status. + * The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_CARD - INVALID_MERCHANT_CONFIGURATION - INVALID_AMOUNT - DEBIT_CARD_USEAGE_EXCEEDD_LIMIT * @return reason **/ - @ApiModelProperty(value = "The reason of the status. ") + @ApiModelProperty(value = "The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_CARD - INVALID_MERCHANT_CONFIGURATION - INVALID_AMOUNT - DEBIT_CARD_USEAGE_EXCEEDD_LIMIT ") public ReasonEnum getReason() { return reason; } @@ -161,10 +163,10 @@ public PtsV2PayoutsPost400Response message(String message) { } /** - * The detail message related to the status and reason listed above. Possible value is: - Your aggregator or acquirer is not accepting transactions from you at this time. - Your aggregator or acquirer is not accepting this transaction. - CyberSource declined the request because the credit card has expired. You might also receive this value if the expiration date you provided does not match the date the issuing bank has on file. - The bank declined the transaction. - The merchant reference number for this authorization request matches the merchant reference number of another authorization request that you sent within the past 15 minutes. Resend the request with a unique merchant reference number. - The credit card number did not pass CyberSource basic checks. - Data provided is not consistent with the request. For example, you requested a product with negative cost. - The request is missing a required field. + * The detail message related to the status and reason listed above. * @return message **/ - @ApiModelProperty(value = "The detail message related to the status and reason listed above. Possible value is: - Your aggregator or acquirer is not accepting transactions from you at this time. - Your aggregator or acquirer is not accepting this transaction. - CyberSource declined the request because the credit card has expired. You might also receive this value if the expiration date you provided does not match the date the issuing bank has on file. - The bank declined the transaction. - The merchant reference number for this authorization request matches the merchant reference number of another authorization request that you sent within the past 15 minutes. Resend the request with a unique merchant reference number. - The credit card number did not pass CyberSource basic checks. - Data provided is not consistent with the request. For example, you requested a product with negative cost. - The request is missing a required field. ") + @ApiModelProperty(value = "The detail message related to the status and reason listed above.") public String getMessage() { return message; } @@ -173,14 +175,14 @@ public void setMessage(String message) { this.message = message; } - public PtsV2PayoutsPost400Response details(List details) { + public PtsV2PayoutsPost400Response details(List details) { this.details = details; return this; } - public PtsV2PayoutsPost400Response addDetailsItem(PtsV2PayoutsPost201ResponseErrorInformationDetails detailsItem) { + public PtsV2PayoutsPost400Response addDetailsItem(PtsV2PaymentsPost201ResponseErrorInformationDetails detailsItem) { if (this.details == null) { - this.details = new ArrayList(); + this.details = new ArrayList(); } this.details.add(detailsItem); return this; @@ -191,11 +193,11 @@ public PtsV2PayoutsPost400Response addDetailsItem(PtsV2PayoutsPost201ResponseErr * @return details **/ @ApiModelProperty(value = "") - public List getDetails() { + public List getDetails() { return details; } - public void setDetails(List details) { + public void setDetails(List details) { this.details = details; } diff --git a/src/main/java/Model/PtsV2PayoutsPost502Response.java b/src/main/java/Model/PtsV2PayoutsPost502Response.java deleted file mode 100644 index 9a21e6e93..000000000 --- a/src/main/java/Model/PtsV2PayoutsPost502Response.java +++ /dev/null @@ -1,258 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * PtsV2PayoutsPost502Response - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class PtsV2PayoutsPost502Response { - @SerializedName("submitTimeUtc") - private String submitTimeUtc = null; - - /** - * The status of the submitted transaction. - */ - @JsonAdapter(StatusEnum.Adapter.class) - public enum StatusEnum { - ERROR("SERVER_ERROR"); - - private String value; - - StatusEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static StatusEnum fromValue(String text) { - for (StatusEnum b : StatusEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final StatusEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public StatusEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return StatusEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("status") - private StatusEnum status = null; - - /** - * The reason of the status. - */ - @JsonAdapter(ReasonEnum.Adapter.class) - public enum ReasonEnum { - SYSTEM_ERROR("SYSTEM_ERROR"), - - SERVER_TIMEOUT("SERVER_TIMEOUT"), - - SERVICE_TIMEOUT("SERVICE_TIMEOUT"), - - PROCESSOR_TIMEOUT("PROCESSOR_TIMEOUT"); - - private String value; - - ReasonEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static ReasonEnum fromValue(String text) { - for (ReasonEnum b : ReasonEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final ReasonEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public ReasonEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return ReasonEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("reason") - private ReasonEnum reason = null; - - @SerializedName("message") - private String message = null; - - public PtsV2PayoutsPost502Response submitTimeUtc(String submitTimeUtc) { - this.submitTimeUtc = submitTimeUtc; - return this; - } - - /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. - * @return submitTimeUtc - **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") - public String getSubmitTimeUtc() { - return submitTimeUtc; - } - - public void setSubmitTimeUtc(String submitTimeUtc) { - this.submitTimeUtc = submitTimeUtc; - } - - public PtsV2PayoutsPost502Response status(StatusEnum status) { - this.status = status; - return this; - } - - /** - * The status of the submitted transaction. - * @return status - **/ - @ApiModelProperty(value = "The status of the submitted transaction.") - public StatusEnum getStatus() { - return status; - } - - public void setStatus(StatusEnum status) { - this.status = status; - } - - public PtsV2PayoutsPost502Response reason(ReasonEnum reason) { - this.reason = reason; - return this; - } - - /** - * The reason of the status. - * @return reason - **/ - @ApiModelProperty(value = "The reason of the status. ") - public ReasonEnum getReason() { - return reason; - } - - public void setReason(ReasonEnum reason) { - this.reason = reason; - } - - public PtsV2PayoutsPost502Response message(String message) { - this.message = message; - return this; - } - - /** - * The detail message related to the status and reason listed above. - * @return message - **/ - @ApiModelProperty(value = "The detail message related to the status and reason listed above.") - public String getMessage() { - return message; - } - - public void setMessage(String message) { - this.message = message; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - PtsV2PayoutsPost502Response ptsV2PayoutsPost502Response = (PtsV2PayoutsPost502Response) o; - return Objects.equals(this.submitTimeUtc, ptsV2PayoutsPost502Response.submitTimeUtc) && - Objects.equals(this.status, ptsV2PayoutsPost502Response.status) && - Objects.equals(this.reason, ptsV2PayoutsPost502Response.reason) && - Objects.equals(this.message, ptsV2PayoutsPost502Response.message); - } - - @Override - public int hashCode() { - return Objects.hash(submitTimeUtc, status, reason, message); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class PtsV2PayoutsPost502Response {\n"); - - sb.append(" submitTimeUtc: ").append(toIndentedString(submitTimeUtc)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" reason: ").append(toIndentedString(reason)).append("\n"); - sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Ptsv2creditsPointOfSaleInformation.java b/src/main/java/Model/Ptsv2creditsPointOfSaleInformation.java index 74959be66..7fa77c034 100644 --- a/src/main/java/Model/Ptsv2creditsPointOfSaleInformation.java +++ b/src/main/java/Model/Ptsv2creditsPointOfSaleInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * Ptsv2creditsPointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2creditsPointOfSaleInformation { @SerializedName("emv") private Ptsv2creditsPointOfSaleInformationEmv emv = null; diff --git a/src/main/java/Model/Ptsv2creditsPointOfSaleInformationEmv.java b/src/main/java/Model/Ptsv2creditsPointOfSaleInformationEmv.java index 65938c488..0d8e16d89 100644 --- a/src/main/java/Model/Ptsv2creditsPointOfSaleInformationEmv.java +++ b/src/main/java/Model/Ptsv2creditsPointOfSaleInformationEmv.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2creditsPointOfSaleInformationEmv */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2creditsPointOfSaleInformationEmv { @SerializedName("tags") private String tags = null; diff --git a/src/main/java/Model/Ptsv2creditsProcessingInformation.java b/src/main/java/Model/Ptsv2creditsProcessingInformation.java index 2d9381e34..9ee85cc55 100644 --- a/src/main/java/Model/Ptsv2creditsProcessingInformation.java +++ b/src/main/java/Model/Ptsv2creditsProcessingInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ /** * Ptsv2creditsProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2creditsProcessingInformation { @SerializedName("commerceIndicator") private String commerceIndicator = null; diff --git a/src/main/java/Model/Ptsv2creditsProcessingInformationBankTransferOptions.java b/src/main/java/Model/Ptsv2creditsProcessingInformationBankTransferOptions.java index 7e879dca5..3651e76a6 100644 --- a/src/main/java/Model/Ptsv2creditsProcessingInformationBankTransferOptions.java +++ b/src/main/java/Model/Ptsv2creditsProcessingInformationBankTransferOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2creditsProcessingInformationBankTransferOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2creditsProcessingInformationBankTransferOptions { @SerializedName("customerMemo") private String customerMemo = null; diff --git a/src/main/java/Model/Ptsv2paymentsAggregatorInformation.java b/src/main/java/Model/Ptsv2paymentsAggregatorInformation.java index fdf009e45..8a72b08b1 100644 --- a/src/main/java/Model/Ptsv2paymentsAggregatorInformation.java +++ b/src/main/java/Model/Ptsv2paymentsAggregatorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsAggregatorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsAggregatorInformation { @SerializedName("aggregatorId") private String aggregatorId = null; diff --git a/src/main/java/Model/Ptsv2paymentsAggregatorInformationSubMerchant.java b/src/main/java/Model/Ptsv2paymentsAggregatorInformationSubMerchant.java index f15d31a14..88cac5480 100644 --- a/src/main/java/Model/Ptsv2paymentsAggregatorInformationSubMerchant.java +++ b/src/main/java/Model/Ptsv2paymentsAggregatorInformationSubMerchant.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsAggregatorInformationSubMerchant */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsAggregatorInformationSubMerchant { @SerializedName("cardAcceptorId") private String cardAcceptorId = null; diff --git a/src/main/java/Model/Ptsv2paymentsBuyerInformation.java b/src/main/java/Model/Ptsv2paymentsBuyerInformation.java index c3b46e964..1bc0cacc8 100644 --- a/src/main/java/Model/Ptsv2paymentsBuyerInformation.java +++ b/src/main/java/Model/Ptsv2paymentsBuyerInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * Ptsv2paymentsBuyerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsBuyerInformation { @SerializedName("merchantCustomerId") private String merchantCustomerId = null; diff --git a/src/main/java/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.java b/src/main/java/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.java index 6bd95f2e9..65456d220 100644 --- a/src/main/java/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.java +++ b/src/main/java/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,16 +26,24 @@ /** * Ptsv2paymentsBuyerInformationPersonalIdentification */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsBuyerInformationPersonalIdentification { /** - * The type of the indentification. Possible values: - **NATIONAL** - **CPF** - **CURP** - **SSN** - **DRIVER_LICENSE** This field is supported only on the processors listed in this description. **ComercioLatino**\\ Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing**\\ Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. + * The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` This field is supported only on the following processors. **ComercioLatino**\\ Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing**\\ Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. */ @JsonAdapter(TypeEnum.Adapter.class) public enum TypeEnum { - SSN("ssn"), + NATIONAL("NATIONAL"), - DRIVERLICENSE("driverlicense"); + CPF("CPF"), + + CPNJ("CPNJ"), + + CURP("CURP"), + + SSN("SSN"), + + DRIVER_LICENSE("DRIVER_LICENSE"); private String value; @@ -90,10 +98,10 @@ public Ptsv2paymentsBuyerInformationPersonalIdentification type(TypeEnum type) { } /** - * The type of the indentification. Possible values: - **NATIONAL** - **CPF** - **CURP** - **SSN** - **DRIVER_LICENSE** This field is supported only on the processors listed in this description. **ComercioLatino**\\ Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing**\\ Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. + * The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` This field is supported only on the following processors. **ComercioLatino**\\ Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing**\\ Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. * @return type **/ - @ApiModelProperty(value = "The type of the indentification. Possible values: - **NATIONAL** - **CPF** - **CURP** - **SSN** - **DRIVER_LICENSE** This field is supported only on the processors listed in this description. **ComercioLatino**\\ Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing**\\ Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. ") + @ApiModelProperty(value = "The type of the identification. Possible values: - `NATIONAL` - `CPF` - `CPNJ` - `CURP` - `SSN` - `DRIVER_LICENSE` This field is supported only on the following processors. **ComercioLatino**\\ Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing**\\ Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. ") public TypeEnum getType() { return type; } @@ -108,10 +116,10 @@ public Ptsv2paymentsBuyerInformationPersonalIdentification id(String id) { } /** - * Personal Identifier for the customer based on various type. This field is supported only on the processors listed in this description. **ComercioLatino** Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing** Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the personal_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * The value of the identification type. This field is supported only on the following processors. **ComercioLatino** Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing** Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the personal_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If type = PASSPORT, this is the cardholder's passport number. Recommended for Discover ProtectBuy. * @return id **/ - @ApiModelProperty(value = "Personal Identifier for the customer based on various type. This field is supported only on the processors listed in this description. **ComercioLatino** Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing** Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the personal_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "The value of the identification type. This field is supported only on the following processors. **ComercioLatino** Set this field to the Cadastro de Pessoas Fisicas (CPF). **CyberSource Latin American Processing** Supported for Redecard in Brazil. Set this field to the Cadastro de Pessoas Fisicas (CPF), which is required for AVS for Redecard in Brazil. **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. For processor-specific information, see the personal_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) If type = PASSPORT, this is the cardholder's passport number. Recommended for Discover ProtectBuy. ") public String getId() { return id; } @@ -126,10 +134,10 @@ public Ptsv2paymentsBuyerInformationPersonalIdentification issuedBy(String issue } /** - * If type = DRIVER_LICENSE, this is the State or province where the customer’s driver’s license was issued. Use the twocharacter State, Province, and Territory Codes for the United States and Canada. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used. + * If type = DRIVER_LICENSE, this is the State or province where the customer’s driver’s license was issued. Use the two-character State, Province, and Territory Codes for the United States and Canada. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used. If type = PASSPORT, this is the Issuing country for the cardholder’s passport. Recommended for Discover ProtectBuy. * @return issuedBy **/ - @ApiModelProperty(value = "If type = DRIVER_LICENSE, this is the State or province where the customer’s driver’s license was issued. Use the twocharacter State, Province, and Territory Codes for the United States and Canada. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used. ") + @ApiModelProperty(value = "If type = DRIVER_LICENSE, this is the State or province where the customer’s driver’s license was issued. Use the two-character State, Province, and Territory Codes for the United States and Canada. ** TeleCheck ** Contact your TeleCheck representative to find out whether this field is required or optional. ** All Other Processors ** Not used. If type = PASSPORT, this is the Issuing country for the cardholder’s passport. Recommended for Discover ProtectBuy. ") public String getIssuedBy() { return issuedBy; } diff --git a/src/main/java/Model/Ptsv2paymentsClientReferenceInformation.java b/src/main/java/Model/Ptsv2paymentsClientReferenceInformation.java index 7dffcda29..a70d70f03 100644 --- a/src/main/java/Model/Ptsv2paymentsClientReferenceInformation.java +++ b/src/main/java/Model/Ptsv2paymentsClientReferenceInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsClientReferenceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsClientReferenceInformation { @SerializedName("code") private String code = null; @@ -47,10 +47,10 @@ public Ptsv2paymentsClientReferenceInformation code(String code) { } /** - * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API. **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. + * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. * @return code **/ - @ApiModelProperty(value = "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API. **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ") + @ApiModelProperty(value = "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ") public String getCode() { return code; } @@ -65,10 +65,10 @@ public Ptsv2paymentsClientReferenceInformation transactionId(String transactionI } /** - * Identifier that you assign to the transaction. **Note** Use this field only if you want to support merchant-initiated reversal and void operations . See \"Merchant-Initiated Reversals and Voids,\" page 176. + * Identifier that you assign to the transaction. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. See page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf) * @return transactionId **/ - @ApiModelProperty(value = "Identifier that you assign to the transaction. **Note** Use this field only if you want to support merchant-initiated reversal and void operations . See \"Merchant-Initiated Reversals and Voids,\" page 176. ") + @ApiModelProperty(value = "Identifier that you assign to the transaction. **Note** Use this field only if you want to support merchant-initiated reversal and void operations. See page 250 on [Merchant-Initiated Reversals and Voids.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SO_API/Credit_Cards_SO_API.pdf) ") public String getTransactionId() { return transactionId; } diff --git a/src/main/java/Model/Ptsv2paymentsClientReferenceInformationPartner.java b/src/main/java/Model/Ptsv2paymentsClientReferenceInformationPartner.java index ac39f40d8..227c48aae 100644 --- a/src/main/java/Model/Ptsv2paymentsClientReferenceInformationPartner.java +++ b/src/main/java/Model/Ptsv2paymentsClientReferenceInformationPartner.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsClientReferenceInformationPartner */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsClientReferenceInformationPartner { @SerializedName("originalTransactionId") private String originalTransactionId = null; diff --git a/src/main/java/Model/Ptsv2paymentsConsumerAuthenticationInformation.java b/src/main/java/Model/Ptsv2paymentsConsumerAuthenticationInformation.java index 5f8335dbb..4ec5341fa 100644 --- a/src/main/java/Model/Ptsv2paymentsConsumerAuthenticationInformation.java +++ b/src/main/java/Model/Ptsv2paymentsConsumerAuthenticationInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsConsumerAuthenticationInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsConsumerAuthenticationInformation { @SerializedName("cavv") private String cavv = null; diff --git a/src/main/java/Model/Ptsv2paymentsDeviceInformation.java b/src/main/java/Model/Ptsv2paymentsDeviceInformation.java index ae456fa36..84ea41452 100644 --- a/src/main/java/Model/Ptsv2paymentsDeviceInformation.java +++ b/src/main/java/Model/Ptsv2paymentsDeviceInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsDeviceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsDeviceInformation { @SerializedName("hostName") private String hostName = null; @@ -43,10 +43,10 @@ public Ptsv2paymentsDeviceInformation hostName(String hostName) { } /** - * DNS resolved hostname from above _ipAddress_. + * Host name reported by the customer’s browser to your Web server identified via the HTTP header. * @return hostName **/ - @ApiModelProperty(value = "DNS resolved hostname from above _ipAddress_.") + @ApiModelProperty(value = "Host name reported by the customer’s browser to your Web server identified via the HTTP header.") public String getHostName() { return hostName; } @@ -61,10 +61,10 @@ public Ptsv2paymentsDeviceInformation ipAddress(String ipAddress) { } /** - * IP address of the customer. + * Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information. * @return ipAddress **/ - @ApiModelProperty(value = "IP address of the customer.") + @ApiModelProperty(value = "Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information. ") public String getIpAddress() { return ipAddress; } diff --git a/src/main/java/Model/Ptsv2paymentsInstallmentInformation.java b/src/main/java/Model/Ptsv2paymentsInstallmentInformation.java index 2761f7740..5cb796115 100644 --- a/src/main/java/Model/Ptsv2paymentsInstallmentInformation.java +++ b/src/main/java/Model/Ptsv2paymentsInstallmentInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsInstallmentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsInstallmentInformation { @SerializedName("amount") private String amount = null; diff --git a/src/main/java/Model/Ptsv2paymentsIssuerInformation.java b/src/main/java/Model/Ptsv2paymentsIssuerInformation.java index 50428038f..0fa493f60 100644 --- a/src/main/java/Model/Ptsv2paymentsIssuerInformation.java +++ b/src/main/java/Model/Ptsv2paymentsIssuerInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsIssuerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsIssuerInformation { @SerializedName("discretionaryData") private String discretionaryData = null; diff --git a/src/main/java/Model/Ptsv2paymentsMerchantDefinedInformation.java b/src/main/java/Model/Ptsv2paymentsMerchantDefinedInformation.java index 00f7bab0a..652d08539 100644 --- a/src/main/java/Model/Ptsv2paymentsMerchantDefinedInformation.java +++ b/src/main/java/Model/Ptsv2paymentsMerchantDefinedInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsMerchantDefinedInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsMerchantDefinedInformation { @SerializedName("key") private String key = null; diff --git a/src/main/java/Model/Ptsv2paymentsMerchantInformation.java b/src/main/java/Model/Ptsv2paymentsMerchantInformation.java index 6a377499c..95b81134e 100644 --- a/src/main/java/Model/Ptsv2paymentsMerchantInformation.java +++ b/src/main/java/Model/Ptsv2paymentsMerchantInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ /** * Ptsv2paymentsMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsMerchantInformation { @SerializedName("merchantDescriptor") private Ptsv2paymentsMerchantInformationMerchantDescriptor merchantDescriptor = null; diff --git a/src/main/java/Model/Ptsv2paymentsMerchantInformationMerchantDescriptor.java b/src/main/java/Model/Ptsv2paymentsMerchantInformationMerchantDescriptor.java index 662953b8b..1e1cb4f11 100644 --- a/src/main/java/Model/Ptsv2paymentsMerchantInformationMerchantDescriptor.java +++ b/src/main/java/Model/Ptsv2paymentsMerchantInformationMerchantDescriptor.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsMerchantInformationMerchantDescriptor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsMerchantInformationMerchantDescriptor { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor.java b/src/main/java/Model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor.java index cfe030332..a2f354006 100644 --- a/src/main/java/Model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor.java +++ b/src/main/java/Model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsMerchantInformationServiceFeeDescriptor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsMerchantInformationServiceFeeDescriptor { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformation.java b/src/main/java/Model/Ptsv2paymentsOrderInformation.java index 6c4ebba19..e21d6ce92 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformation.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -34,7 +34,7 @@ /** * Ptsv2paymentsOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsOrderInformation { @SerializedName("amountDetails") private Ptsv2paymentsOrderInformationAmountDetails amountDetails = null; diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetails.java b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetails.java index 899a50a45..34563e8f3 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetails.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -31,7 +31,7 @@ /** * Ptsv2paymentsOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsOrderInformationAmountDetails { @SerializedName("totalAmount") private String totalAmount = null; diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.java b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.java index b43c7c0fd..cdb0234dc 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge.java b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge.java index 4bd3f31aa..0b3d94d47 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsOrderInformationAmountDetailsSurcharge */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsOrderInformationAmountDetailsSurcharge { @SerializedName("amount") private String amount = null; diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.java b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.java index aff5532ce..02ca981fe 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsOrderInformationAmountDetailsTaxDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsOrderInformationAmountDetailsTaxDetails { /** * This is used to determine what type of tax related data should be inclued under _taxDetails_ object. Possible values: - alternate - local - national - vat diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationBillTo.java b/src/main/java/Model/Ptsv2paymentsOrderInformationBillTo.java index d94c3ffe5..8769efeaa 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationBillTo.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationBillTo.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsOrderInformationBillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsOrderInformationBillTo { @SerializedName("firstName") private String firstName = null; diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationBillToCompany.java b/src/main/java/Model/Ptsv2paymentsOrderInformationBillToCompany.java index b15477711..e07ecb840 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationBillToCompany.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationBillToCompany.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsOrderInformationBillToCompany */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsOrderInformationBillToCompany { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetails.java b/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetails.java index 03a73ce53..381fcd536 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetails.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * Ptsv2paymentsOrderInformationInvoiceDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsOrderInformationInvoiceDetails { @SerializedName("invoiceNumber") private String invoiceNumber = null; diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.java b/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.java index 948eafd41..6c5e1d9d8 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum { @SerializedName("data") private String data = null; diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationLineItems.java b/src/main/java/Model/Ptsv2paymentsOrderInformationLineItems.java index 8659d32fd..4e322ecf7 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationLineItems.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationLineItems.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * Ptsv2paymentsOrderInformationLineItems */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsOrderInformationLineItems { @SerializedName("productCode") private String productCode = null; @@ -116,10 +116,10 @@ public Ptsv2paymentsOrderInformationLineItems productCode(String productCode) { } /** - * Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. + * Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. * @return productCode **/ - @ApiModelProperty(value = "Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. ") + @ApiModelProperty(value = "Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. ") public String getProductCode() { return productCode; } @@ -134,10 +134,10 @@ public Ptsv2paymentsOrderInformationLineItems productName(String productName) { } /** - * For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false` respectively), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. + * For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. * @return productName **/ - @ApiModelProperty(value = "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false` respectively), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. ") + @ApiModelProperty(value = "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. ") public String getProductName() { return productName; } @@ -152,10 +152,10 @@ public Ptsv2paymentsOrderInformationLineItems productSku(String productSku) { } /** - * Identification code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. + * Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. * @return productSku **/ - @ApiModelProperty(value = "Identification code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. ") + @ApiModelProperty(value = "Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. ") public String getProductSku() { return productSku; } @@ -170,12 +170,12 @@ public Ptsv2paymentsOrderInformationLineItems quantity(BigDecimal quantity) { } /** - * For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. + * Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased. * minimum: 1 * maximum: 9999999999 * @return quantity **/ - @ApiModelProperty(value = "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. ") + @ApiModelProperty(value = "Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased. ") public BigDecimal getQuantity() { return quantity; } @@ -226,10 +226,10 @@ public Ptsv2paymentsOrderInformationLineItems totalAmount(String totalAmount) { } /** - * Total amount for the item. Normally calculated as the unit price x quantity. + * Total amount for the item. Normally calculated as the unit price x quantity. When orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD= 123 * @return totalAmount **/ - @ApiModelProperty(value = "Total amount for the item. Normally calculated as the unit price x quantity. ") + @ApiModelProperty(value = "Total amount for the item. Normally calculated as the unit price x quantity. When orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD= 123 ") public String getTotalAmount() { return totalAmount; } diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationShipTo.java b/src/main/java/Model/Ptsv2paymentsOrderInformationShipTo.java index a3b590251..f87ca48fe 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationShipTo.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationShipTo.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsOrderInformationShipTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsOrderInformationShipTo { @SerializedName("firstName") private String firstName = null; @@ -196,10 +196,10 @@ public Ptsv2paymentsOrderInformationShipTo country(String country) { } /** - * Country of the shipping address. Use the two character ISO Standard Country Codes. + * Country of the shipping address. Use the two-character ISO Standard Country Codes. * @return country **/ - @ApiModelProperty(value = "Country of the shipping address. Use the two character ISO Standard Country Codes.") + @ApiModelProperty(value = "Country of the shipping address. Use the two-character ISO Standard Country Codes.") public String getCountry() { return country; } @@ -250,10 +250,10 @@ public Ptsv2paymentsOrderInformationShipTo phoneNumber(String phoneNumber) { } /** - * Phone number for the shipping address. + * Phone number associated with the shipping address. * @return phoneNumber **/ - @ApiModelProperty(value = "Phone number for the shipping address.") + @ApiModelProperty(value = "Phone number associated with the shipping address.") public String getPhoneNumber() { return phoneNumber; } diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationShippingDetails.java b/src/main/java/Model/Ptsv2paymentsOrderInformationShippingDetails.java index 0bd19addd..2c2f8cd9f 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationShippingDetails.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationShippingDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,12 +24,13 @@ import java.io.IOException; /** - * Ptsv2paymentsOrderInformationShippingDetails + * Contains shipping information not related to address. */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@ApiModel(description = "Contains shipping information not related to address.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsOrderInformationShippingDetails { @SerializedName("giftWrap") - private Boolean giftWrap = null; + private String giftWrap = null; @SerializedName("shippingMethod") private String shippingMethod = null; @@ -37,21 +38,21 @@ public class Ptsv2paymentsOrderInformationShippingDetails { @SerializedName("shipFromPostalCode") private String shipFromPostalCode = null; - public Ptsv2paymentsOrderInformationShippingDetails giftWrap(Boolean giftWrap) { + public Ptsv2paymentsOrderInformationShippingDetails giftWrap(String giftWrap) { this.giftWrap = giftWrap; return this; } /** - * The description for this field is not available. + * Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - `yes`: The customer requested gift wrapping. - `no`: The customer did not request gift wrapping. * @return giftWrap **/ - @ApiModelProperty(value = "The description for this field is not available.") - public Boolean getGiftWrap() { + @ApiModelProperty(value = "Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - `yes`: The customer requested gift wrapping. - `no`: The customer did not request gift wrapping. ") + public String getGiftWrap() { return giftWrap; } - public void setGiftWrap(Boolean giftWrap) { + public void setGiftWrap(String giftWrap) { this.giftWrap = giftWrap; } diff --git a/src/main/java/Model/Ptsv2paymentsPaymentInformation.java b/src/main/java/Model/Ptsv2paymentsPaymentInformation.java index 5e8506e0e..e580cb32e 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformation.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -31,7 +31,7 @@ /** * Ptsv2paymentsPaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsPaymentInformation { @SerializedName("card") private Ptsv2paymentsPaymentInformationCard card = null; diff --git a/src/main/java/Model/Ptsv2paymentsPaymentInformationBank.java b/src/main/java/Model/Ptsv2paymentsPaymentInformationBank.java index 3cdfed2fa..198d35fa8 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformationBank.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformationBank.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsPaymentInformationBank */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsPaymentInformationBank { @SerializedName("account") private Ptsv2paymentsPaymentInformationBankAccount account = null; diff --git a/src/main/java/Model/Ptsv2paymentsPaymentInformationBankAccount.java b/src/main/java/Model/Ptsv2paymentsPaymentInformationBankAccount.java index b70df1abd..50e67ca7e 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformationBankAccount.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformationBankAccount.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsPaymentInformationBankAccount */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsPaymentInformationBankAccount { @SerializedName("type") private String type = null; diff --git a/src/main/java/Model/Ptsv2paymentsPaymentInformationCard.java b/src/main/java/Model/Ptsv2paymentsPaymentInformationCard.java index 49503cabd..4f1c5a47d 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformationCard.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformationCard.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsPaymentInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsPaymentInformationCard { @SerializedName("number") private String number = null; @@ -73,10 +73,10 @@ public Ptsv2paymentsPaymentInformationCard number(String number) { } /** - * Customer’s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field for the encoded account number. For processor-specific information, see the customer_cc_number field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return number **/ - @ApiModelProperty(value = "Customer’s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field for the encoded account number. For processor-specific information, see the customer_cc_number field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getNumber() { return number; } @@ -91,10 +91,10 @@ public Ptsv2paymentsPaymentInformationCard expirationMonth(String expirationMont } /** - * Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return expirationMonth **/ - @ApiModelProperty(value = "Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getExpirationMonth() { return expirationMonth; } @@ -109,10 +109,10 @@ public Ptsv2paymentsPaymentInformationCard expirationYear(String expirationYear) } /** - * Four-digit year in which the credit card expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return expirationYear **/ - @ApiModelProperty(value = "Four-digit year in which the credit card expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getExpirationYear() { return expirationYear; } @@ -127,10 +127,10 @@ public Ptsv2paymentsPaymentInformationCard type(String type) { } /** - * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover + * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) * @return type **/ - @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover ") + @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) ") public String getType() { return type; } diff --git a/src/main/java/Model/Ptsv2paymentsPaymentInformationCustomer.java b/src/main/java/Model/Ptsv2paymentsPaymentInformationCustomer.java index eea68c8a4..b2f815153 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformationCustomer.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformationCustomer.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsPaymentInformationCustomer */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsPaymentInformationCustomer { @SerializedName("customerId") private String customerId = null; diff --git a/src/main/java/Model/Ptsv2paymentsPaymentInformationFluidData.java b/src/main/java/Model/Ptsv2paymentsPaymentInformationFluidData.java index 469048c4b..f79b1461e 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformationFluidData.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformationFluidData.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsPaymentInformationFluidData */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsPaymentInformationFluidData { @SerializedName("key") private String key = null; diff --git a/src/main/java/Model/Ptsv2paymentsPaymentInformationTokenizedCard.java b/src/main/java/Model/Ptsv2paymentsPaymentInformationTokenizedCard.java index a2d9bfae8..b379a1afd 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformationTokenizedCard.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformationTokenizedCard.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsPaymentInformationTokenizedCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsPaymentInformationTokenizedCard { @SerializedName("number") private String number = null; @@ -118,10 +118,10 @@ public Ptsv2paymentsPaymentInformationTokenizedCard type(String type) { } /** - * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover + * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) * @return type **/ - @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover ") + @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) ") public String getType() { return type; } diff --git a/src/main/java/Model/Ptsv2paymentsPointOfSaleInformation.java b/src/main/java/Model/Ptsv2paymentsPointOfSaleInformation.java index 65cbe5454..6bf8edec8 100644 --- a/src/main/java/Model/Ptsv2paymentsPointOfSaleInformation.java +++ b/src/main/java/Model/Ptsv2paymentsPointOfSaleInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * Ptsv2paymentsPointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsPointOfSaleInformation { @SerializedName("terminalId") private String terminalId = null; diff --git a/src/main/java/Model/Ptsv2paymentsPointOfSaleInformationEmv.java b/src/main/java/Model/Ptsv2paymentsPointOfSaleInformationEmv.java index 6087eacf2..e4e55a967 100644 --- a/src/main/java/Model/Ptsv2paymentsPointOfSaleInformationEmv.java +++ b/src/main/java/Model/Ptsv2paymentsPointOfSaleInformationEmv.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsPointOfSaleInformationEmv */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsPointOfSaleInformationEmv { @SerializedName("tags") private String tags = null; diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformation.java b/src/main/java/Model/Ptsv2paymentsProcessingInformation.java index 72e264287..46eba5fa9 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformation.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * Ptsv2paymentsProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsProcessingInformation { @SerializedName("capture") private Boolean capture = false; diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.java b/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.java index c8755df01..33b57e682 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * Ptsv2paymentsProcessingInformationAuthorizationOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsProcessingInformationAuthorizationOptions { @SerializedName("authType") private String authType = null; diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.java b/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.java index ea0333cdc..72fe69eb0 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator { /** * This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction. Valid values: - **customer** - **merchant** diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java b/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java index 30ea7059b..9fe369ccf 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction { @SerializedName("reason") private String reason = null; diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.java b/src/main/java/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.java index 13e7a61c2..1a3c574cf 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsProcessingInformationBankTransferOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsProcessingInformationBankTransferOptions { @SerializedName("declineAvsFlags") private String declineAvsFlags = null; diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformationCaptureOptions.java b/src/main/java/Model/Ptsv2paymentsProcessingInformationCaptureOptions.java index 325460329..ad820a192 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformationCaptureOptions.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformationCaptureOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsProcessingInformationCaptureOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsProcessingInformationCaptureOptions { @SerializedName("captureSequenceNumber") private BigDecimal captureSequenceNumber = null; diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformationRecurringOptions.java b/src/main/java/Model/Ptsv2paymentsProcessingInformationRecurringOptions.java index df898975f..2ebc49884 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformationRecurringOptions.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformationRecurringOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsProcessingInformationRecurringOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsProcessingInformationRecurringOptions { @SerializedName("loanPayment") private Boolean loanPayment = false; diff --git a/src/main/java/Model/Ptsv2paymentsRecipientInformation.java b/src/main/java/Model/Ptsv2paymentsRecipientInformation.java index d852d45e8..8d47009a0 100644 --- a/src/main/java/Model/Ptsv2paymentsRecipientInformation.java +++ b/src/main/java/Model/Ptsv2paymentsRecipientInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsRecipientInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsRecipientInformation { @SerializedName("accountId") private String accountId = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformation.java b/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformation.java index c87f46b4a..ae7750753 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidcapturesAggregatorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesAggregatorInformation { @SerializedName("aggregatorId") private String aggregatorId = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.java b/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.java index 673e394de..47d72a883 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesAggregatorInformationSubMerchant */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesAggregatorInformationSubMerchant { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesBuyerInformation.java b/src/main/java/Model/Ptsv2paymentsidcapturesBuyerInformation.java index 3fc7c0eda..83930f9a8 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesBuyerInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesBuyerInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesBuyerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesBuyerInformation { @SerializedName("merchantCustomerId") private String merchantCustomerId = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesInstallmentInformation.java b/src/main/java/Model/Ptsv2paymentsidcapturesInstallmentInformation.java index a16a0d48a..82ee6206d 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesInstallmentInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesInstallmentInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesInstallmentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesInstallmentInformation { @SerializedName("firstInstallmentDate") private String firstInstallmentDate = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesMerchantInformation.java b/src/main/java/Model/Ptsv2paymentsidcapturesMerchantInformation.java index 5b9f13a45..b87e369e1 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesMerchantInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesMerchantInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ /** * Ptsv2paymentsidcapturesMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesMerchantInformation { @SerializedName("merchantDescriptor") private Ptsv2paymentsMerchantInformationMerchantDescriptor merchantDescriptor = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformation.java b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformation.java index 1f88839e6..886a084b1 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -34,7 +34,7 @@ /** * Ptsv2paymentsidcapturesOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesOrderInformation { @SerializedName("amountDetails") private Ptsv2paymentsidcapturesOrderInformationAmountDetails amountDetails = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.java b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.java index 94e22e0f2..9dd571680 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * Ptsv2paymentsidcapturesOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesOrderInformationAmountDetails { @SerializedName("totalAmount") private String totalAmount = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationBillTo.java b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationBillTo.java index 92c13709a..14808a5e8 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationBillTo.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationBillTo.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidcapturesOrderInformationBillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesOrderInformationBillTo { @SerializedName("firstName") private String firstName = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails.java b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails.java index 5ff826362..63b7fc2f4 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * Ptsv2paymentsidcapturesOrderInformationInvoiceDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesOrderInformationInvoiceDetails { @SerializedName("purchaseOrderNumber") private String purchaseOrderNumber = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShipTo.java b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShipTo.java index f4650fd1f..5aa96c90f 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShipTo.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShipTo.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesOrderInformationShipTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesOrderInformationShipTo { @SerializedName("administrativeArea") private String administrativeArea = null; @@ -61,10 +61,10 @@ public Ptsv2paymentsidcapturesOrderInformationShipTo country(String country) { } /** - * Country of the shipping address. Use the two character ISO Standard Country Codes. + * Country of the shipping address. Use the two-character ISO Standard Country Codes. * @return country **/ - @ApiModelProperty(value = "Country of the shipping address. Use the two character ISO Standard Country Codes.") + @ApiModelProperty(value = "Country of the shipping address. Use the two-character ISO Standard Country Codes.") public String getCountry() { return country; } diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShippingDetails.java b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShippingDetails.java index 07d41196a..a945d282c 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShippingDetails.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShippingDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesOrderInformationShippingDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesOrderInformationShippingDetails { @SerializedName("shipFromPostalCode") private String shipFromPostalCode = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesPaymentInformation.java b/src/main/java/Model/Ptsv2paymentsidcapturesPaymentInformation.java index b89f1608f..2a7a1d8c1 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesPaymentInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesPaymentInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidcapturesPaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesPaymentInformation { @SerializedName("customer") private Ptsv2paymentsPaymentInformationCustomer customer = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesPointOfSaleInformation.java b/src/main/java/Model/Ptsv2paymentsidcapturesPointOfSaleInformation.java index 7c4429685..1492b0bad 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesPointOfSaleInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesPointOfSaleInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidcapturesPointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesPointOfSaleInformation { @SerializedName("emv") private Ptsv2paymentsidcapturesPointOfSaleInformationEmv emv = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv.java b/src/main/java/Model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv.java index 5b895be71..edf57a811 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesPointOfSaleInformationEmv */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesPointOfSaleInformationEmv { @SerializedName("tags") private String tags = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformation.java b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformation.java index 5e3713511..cdb885346 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * Ptsv2paymentsidcapturesProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesProcessingInformation { @SerializedName("paymentSolution") private String paymentSolution = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.java b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.java index 1ca30a448..9bcb3a194 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions { @SerializedName("authType") private String authType = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.java b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.java index b5123ba3a..9a3e66a4c 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidcapturesProcessingInformationCaptureOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidcapturesProcessingInformationCaptureOptions { @SerializedName("captureSequenceNumber") private BigDecimal captureSequenceNumber = null; diff --git a/src/main/java/Model/Ptsv2paymentsidrefundsMerchantInformation.java b/src/main/java/Model/Ptsv2paymentsidrefundsMerchantInformation.java index e80ef4ffe..0e506d945 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsMerchantInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsMerchantInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidrefundsMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidrefundsMerchantInformation { @SerializedName("merchantDescriptor") private Ptsv2paymentsMerchantInformationMerchantDescriptor merchantDescriptor = null; diff --git a/src/main/java/Model/Ptsv2paymentsidrefundsOrderInformation.java b/src/main/java/Model/Ptsv2paymentsidrefundsOrderInformation.java index cbe498dc3..c984a33b4 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsOrderInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsOrderInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -34,7 +34,7 @@ /** * Ptsv2paymentsidrefundsOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidrefundsOrderInformation { @SerializedName("amountDetails") private Ptsv2paymentsidcapturesOrderInformationAmountDetails amountDetails = null; diff --git a/src/main/java/Model/Ptsv2paymentsidrefundsOrderInformationLineItems.java b/src/main/java/Model/Ptsv2paymentsidrefundsOrderInformationLineItems.java index cbd6b4b16..f3a18eab9 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsOrderInformationLineItems.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsOrderInformationLineItems.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * Ptsv2paymentsidrefundsOrderInformationLineItems */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidrefundsOrderInformationLineItems { @SerializedName("productCode") private String productCode = null; @@ -98,10 +98,10 @@ public Ptsv2paymentsidrefundsOrderInformationLineItems productCode(String produc } /** - * Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. + * Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. * @return productCode **/ - @ApiModelProperty(value = "Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. ") + @ApiModelProperty(value = "Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. ") public String getProductCode() { return productCode; } @@ -116,10 +116,10 @@ public Ptsv2paymentsidrefundsOrderInformationLineItems productName(String produc } /** - * For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false` respectively), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. + * For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. * @return productName **/ - @ApiModelProperty(value = "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false` respectively), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. ") + @ApiModelProperty(value = "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. ") public String getProductName() { return productName; } @@ -134,10 +134,10 @@ public Ptsv2paymentsidrefundsOrderInformationLineItems productSku(String product } /** - * Identification code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. + * Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. * @return productSku **/ - @ApiModelProperty(value = "Identification code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. ") + @ApiModelProperty(value = "Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. ") public String getProductSku() { return productSku; } @@ -152,12 +152,12 @@ public Ptsv2paymentsidrefundsOrderInformationLineItems quantity(BigDecimal quant } /** - * For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. + * Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased. * minimum: 1 * maximum: 9999999999 * @return quantity **/ - @ApiModelProperty(value = "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. ") + @ApiModelProperty(value = "Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased. ") public BigDecimal getQuantity() { return quantity; } @@ -208,10 +208,10 @@ public Ptsv2paymentsidrefundsOrderInformationLineItems totalAmount(String totalA } /** - * Total amount for the item. Normally calculated as the unit price x quantity. + * Total amount for the item. Normally calculated as the unit price x quantity. When orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD= 123 * @return totalAmount **/ - @ApiModelProperty(value = "Total amount for the item. Normally calculated as the unit price x quantity. ") + @ApiModelProperty(value = "Total amount for the item. Normally calculated as the unit price x quantity. When orderInformation.lineItems[].productCode is \"gift_card\", this is the purchase amount total for prepaid gift cards in major units. Example: 123.45 USD= 123 ") public String getTotalAmount() { return totalAmount; } diff --git a/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformation.java b/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformation.java index acafc525f..05edf07cc 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * Ptsv2paymentsidrefundsPaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidrefundsPaymentInformation { @SerializedName("card") private Ptsv2paymentsidrefundsPaymentInformationCard card = null; diff --git a/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformationCard.java b/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformationCard.java index f64ebcc36..795bc17f3 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformationCard.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformationCard.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidrefundsPaymentInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidrefundsPaymentInformationCard { @SerializedName("number") private String number = null; @@ -58,10 +58,10 @@ public Ptsv2paymentsidrefundsPaymentInformationCard number(String number) { } /** - * Customer’s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field for the encoded account number. For processor-specific information, see the customer_cc_number field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return number **/ - @ApiModelProperty(value = "Customer’s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field for the encoded account number. For processor-specific information, see the customer_cc_number field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getNumber() { return number; } @@ -76,10 +76,10 @@ public Ptsv2paymentsidrefundsPaymentInformationCard expirationMonth(String expir } /** - * Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return expirationMonth **/ - @ApiModelProperty(value = "Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getExpirationMonth() { return expirationMonth; } @@ -94,10 +94,10 @@ public Ptsv2paymentsidrefundsPaymentInformationCard expirationYear(String expira } /** - * Four-digit year in which the credit card expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return expirationYear **/ - @ApiModelProperty(value = "Four-digit year in which the credit card expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getExpirationYear() { return expirationYear; } @@ -112,10 +112,10 @@ public Ptsv2paymentsidrefundsPaymentInformationCard type(String type) { } /** - * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover + * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) * @return type **/ - @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover ") + @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) ") public String getType() { return type; } diff --git a/src/main/java/Model/Ptsv2paymentsidrefundsPointOfSaleInformation.java b/src/main/java/Model/Ptsv2paymentsidrefundsPointOfSaleInformation.java index 499565be3..6465610d2 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsPointOfSaleInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsPointOfSaleInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidrefundsPointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidrefundsPointOfSaleInformation { @SerializedName("emv") private Ptsv2paymentsidcapturesPointOfSaleInformationEmv emv = null; diff --git a/src/main/java/Model/Ptsv2paymentsidrefundsProcessingInformation.java b/src/main/java/Model/Ptsv2paymentsidrefundsProcessingInformation.java index b0e5dab4c..9f291761a 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsProcessingInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsProcessingInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidrefundsProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidrefundsProcessingInformation { @SerializedName("paymentSolution") private String paymentSolution = null; diff --git a/src/main/java/Model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions.java b/src/main/java/Model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions.java index 3974683b2..d7611b406 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidrefundsProcessingInformationRecurringOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidrefundsProcessingInformationRecurringOptions { @SerializedName("loanPayment") private Boolean loanPayment = false; diff --git a/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformation.java b/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformation.java index 1b25d5275..8a3b12335 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidreversalsClientReferenceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidreversalsClientReferenceInformation { @SerializedName("code") private String code = null; @@ -44,10 +44,10 @@ public Ptsv2paymentsidreversalsClientReferenceInformation code(String code) { } /** - * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API. **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. + * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. * @return code **/ - @ApiModelProperty(value = "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see Getting Started with CyberSource Advanced for the SCMP API. **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ") + @ApiModelProperty(value = "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ") public String getCode() { return code; } diff --git a/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformationPartner.java b/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformationPartner.java index 36cef7031..68d4df748 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformationPartner.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformationPartner.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidreversalsClientReferenceInformationPartner */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidreversalsClientReferenceInformationPartner { @SerializedName("developerId") private String developerId = null; diff --git a/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformation.java b/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformation.java index 42923dfcc..b9cf0aab7 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * Ptsv2paymentsidreversalsOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidreversalsOrderInformation { @SerializedName("amountDetails") private Ptsv2paymentsidreversalsOrderInformationAmountDetails amountDetails = null; diff --git a/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformationAmountDetails.java b/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformationAmountDetails.java index 8218561d0..beef95372 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformationAmountDetails.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformationAmountDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidreversalsOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidreversalsOrderInformationAmountDetails { @SerializedName("serviceFeeAmount") private String serviceFeeAmount = null; diff --git a/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformationLineItems.java b/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformationLineItems.java index 2a23d0c28..85f28cd2c 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformationLineItems.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformationLineItems.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidreversalsOrderInformationLineItems */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidreversalsOrderInformationLineItems { @SerializedName("quantity") private BigDecimal quantity = null; @@ -41,12 +41,12 @@ public Ptsv2paymentsidreversalsOrderInformationLineItems quantity(BigDecimal qua } /** - * For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. + * Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased. * minimum: 1 * maximum: 9999999999 * @return quantity **/ - @ApiModelProperty(value = "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. ") + @ApiModelProperty(value = "Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased. ") public BigDecimal getQuantity() { return quantity; } diff --git a/src/main/java/Model/Ptsv2paymentsidreversalsPointOfSaleInformation.java b/src/main/java/Model/Ptsv2paymentsidreversalsPointOfSaleInformation.java index 01897ab09..b98119097 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsPointOfSaleInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsPointOfSaleInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidreversalsPointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidreversalsPointOfSaleInformation { @SerializedName("emv") private PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv emv = null; diff --git a/src/main/java/Model/Ptsv2paymentsidreversalsProcessingInformation.java b/src/main/java/Model/Ptsv2paymentsidreversalsProcessingInformation.java index ed5dbcb38..e5615b785 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsProcessingInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsProcessingInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidreversalsProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidreversalsProcessingInformation { @SerializedName("paymentSolution") private String paymentSolution = null; diff --git a/src/main/java/Model/Ptsv2paymentsidreversalsReversalInformation.java b/src/main/java/Model/Ptsv2paymentsidreversalsReversalInformation.java index 47cad9130..d839c1b4c 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsReversalInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsReversalInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidreversalsReversalInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidreversalsReversalInformation { @SerializedName("amountDetails") private Ptsv2paymentsidreversalsReversalInformationAmountDetails amountDetails = null; diff --git a/src/main/java/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.java b/src/main/java/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.java index d68503969..856ebe1c8 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidreversalsReversalInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2paymentsidreversalsReversalInformationAmountDetails { @SerializedName("totalAmount") private String totalAmount = null; diff --git a/src/main/java/Model/Ptsv2payoutsClientReferenceInformation.java b/src/main/java/Model/Ptsv2payoutsClientReferenceInformation.java index 31996e35f..388be029c 100644 --- a/src/main/java/Model/Ptsv2payoutsClientReferenceInformation.java +++ b/src/main/java/Model/Ptsv2payoutsClientReferenceInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2payoutsClientReferenceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsClientReferenceInformation { @SerializedName("code") private String code = null; @@ -37,10 +37,10 @@ public Ptsv2payoutsClientReferenceInformation code(String code) { } /** - * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. + * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. * @return code **/ - @ApiModelProperty(value = "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. ") + @ApiModelProperty(value = "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ") public String getCode() { return code; } diff --git a/src/main/java/Model/Ptsv2payoutsMerchantInformation.java b/src/main/java/Model/Ptsv2payoutsMerchantInformation.java index 823638249..d392de663 100644 --- a/src/main/java/Model/Ptsv2payoutsMerchantInformation.java +++ b/src/main/java/Model/Ptsv2payoutsMerchantInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2payoutsMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsMerchantInformation { @SerializedName("categoryCode") private Integer categoryCode = null; @@ -47,11 +47,11 @@ public Ptsv2payoutsMerchantInformation categoryCode(Integer categoryCode) { } /** - * Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) See \"Aggregator Support,\" page 100. **CyberSource through VisaNet**\\ The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code * maximum: 9999 * @return categoryCode **/ - @ApiModelProperty(value = "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Four-digit number that the payment card industry uses to classify merchants into market segments. Visa assigned one or more of these values to your business when you started accepting Visa cards. If you do not include this field in your request, CyberSource uses the value in your CyberSource account. For processor-specific information, see the merchant_category_code field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) See \"Aggregator Support,\" page 100. **CyberSource through VisaNet**\\ The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR4 - Position: 150-153 - Field: Merchant Category Code ") public Integer getCategoryCode() { return categoryCode; } diff --git a/src/main/java/Model/Ptsv2payoutsMerchantInformationMerchantDescriptor.java b/src/main/java/Model/Ptsv2payoutsMerchantInformationMerchantDescriptor.java index b72f900b6..45e218111 100644 --- a/src/main/java/Model/Ptsv2payoutsMerchantInformationMerchantDescriptor.java +++ b/src/main/java/Model/Ptsv2payoutsMerchantInformationMerchantDescriptor.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2payoutsMerchantInformationMerchantDescriptor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsMerchantInformationMerchantDescriptor { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/Ptsv2payoutsOrderInformation.java b/src/main/java/Model/Ptsv2payoutsOrderInformation.java index 8e22b2a98..b9430058c 100644 --- a/src/main/java/Model/Ptsv2payoutsOrderInformation.java +++ b/src/main/java/Model/Ptsv2payoutsOrderInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ /** * Ptsv2payoutsOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsOrderInformation { @SerializedName("amountDetails") private Ptsv2payoutsOrderInformationAmountDetails amountDetails = null; diff --git a/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetails.java b/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetails.java index d3c9c52bb..f388cfaea 100644 --- a/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetails.java +++ b/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2payoutsOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsOrderInformationAmountDetails { @SerializedName("totalAmount") private String totalAmount = null; @@ -44,10 +44,10 @@ public Ptsv2payoutsOrderInformationAmountDetails totalAmount(String totalAmount) } /** - * Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:  Table 15, \"Authorization Information for Specific Processors,\" on page 43  Table 19, \"Capture Information for Specific Processors,\" on page 58  Table 23, \"Credit Information for Specific Processors,\" on page 75 If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247. **DCC with a Third-Party Provider**\\ Set this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used. * @return totalAmount **/ - @ApiModelProperty(value = "Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:  Table 15, \"Authorization Information for Specific Processors,\" on page 43  Table 19, \"Capture Information for Specific Processors,\" on page 58  Table 23, \"Credit Information for Specific Processors,\" on page 75 If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247. **DCC with a Third-Party Provider**\\ Set this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used. ") public String getTotalAmount() { return totalAmount; } @@ -62,10 +62,10 @@ public Ptsv2payoutsOrderInformationAmountDetails currency(String currency) { } /** - * Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. + * Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. * @return currency **/ - @ApiModelProperty(value = "Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. ") + @ApiModelProperty(value = "Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. ") public String getCurrency() { return currency; } diff --git a/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.java b/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.java index 7bf053427..15303f63b 100644 --- a/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.java +++ b/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2payoutsOrderInformationAmountDetailsSurcharge */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsOrderInformationAmountDetailsSurcharge { @SerializedName("amount") private String amount = null; @@ -37,10 +37,10 @@ public Ptsv2payoutsOrderInformationAmountDetailsSurcharge amount(String amount) } /** - * The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. - Applicable only for CTV for Payouts. - CTV (<= 08) For processor-specific information, see the surcharge_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. If the amount is positive, then it is a debit for the customer.\\ If the amount is negative, then it is a credit for the customer. **NOTE**: This field is supported only for CyberSource through VisaNet (CtV) for Payouts. For CtV, the maximum string length is 8. For processor-specific information, see the surcharge_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return amount **/ - @ApiModelProperty(value = "The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. - Applicable only for CTV for Payouts. - CTV (<= 08) For processor-specific information, see the surcharge_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "The surcharge amount is included in the total transaction amount but is passed in a separate field to the issuer and acquirer for tracking. The issuer can provide information about the surcharge amount to the customer. If the amount is positive, then it is a debit for the customer.\\ If the amount is negative, then it is a credit for the customer. **NOTE**: This field is supported only for CyberSource through VisaNet (CtV) for Payouts. For CtV, the maximum string length is 8. For processor-specific information, see the surcharge_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getAmount() { return amount; } diff --git a/src/main/java/Model/Ptsv2payoutsOrderInformationBillTo.java b/src/main/java/Model/Ptsv2payoutsOrderInformationBillTo.java index 5e3bec7a2..246d3acf6 100644 --- a/src/main/java/Model/Ptsv2payoutsOrderInformationBillTo.java +++ b/src/main/java/Model/Ptsv2payoutsOrderInformationBillTo.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2payoutsOrderInformationBillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsOrderInformationBillTo { @SerializedName("firstName") private String firstName = null; @@ -115,10 +115,10 @@ public Ptsv2payoutsOrderInformationBillTo firstName(String firstName) { } /** - * Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return firstName **/ - @ApiModelProperty(value = "Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getFirstName() { return firstName; } @@ -133,10 +133,10 @@ public Ptsv2payoutsOrderInformationBillTo lastName(String lastName) { } /** - * Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return lastName **/ - @ApiModelProperty(value = "Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getLastName() { return lastName; } @@ -151,10 +151,10 @@ public Ptsv2payoutsOrderInformationBillTo address1(String address1) { } /** - * First line of the billing street address as it appears on the credit card issuer’s records. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * First line of the billing street address as it appears on the credit card issuer’s records. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return address1 **/ - @ApiModelProperty(value = "First line of the billing street address as it appears on the credit card issuer’s records. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "First line of the billing street address as it appears on the credit card issuer’s records. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getAddress1() { return address1; } @@ -169,10 +169,10 @@ public Ptsv2payoutsOrderInformationBillTo address2(String address2) { } /** - * Additional address information. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Additional address information. For Payouts: This field may be sent only for FDC Compass. **Atos** This field must not contain colons (:). **Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions** This value is used for AVS. **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return address2 **/ - @ApiModelProperty(value = "Additional address information. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Additional address information. For Payouts: This field may be sent only for FDC Compass. **Atos** This field must not contain colons (:). **Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions** This value is used for AVS. **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getAddress2() { return address2; } @@ -187,10 +187,10 @@ public Ptsv2payoutsOrderInformationBillTo country(String country) { } /** - * Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return country **/ - @ApiModelProperty(value = "Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getCountry() { return country; } @@ -205,10 +205,10 @@ public Ptsv2payoutsOrderInformationBillTo locality(String locality) { } /** - * City of the billing address. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * City of the billing address. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return locality **/ - @ApiModelProperty(value = "City of the billing address. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "City of the billing address. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getLocality() { return locality; } @@ -223,10 +223,10 @@ public Ptsv2payoutsOrderInformationBillTo administrativeArea(String administrati } /** - * State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return administrativeArea **/ - @ApiModelProperty(value = "State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getAdministrativeArea() { return administrativeArea; } @@ -241,10 +241,10 @@ public Ptsv2payoutsOrderInformationBillTo postalCode(String postalCode) { } /** - * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For Payouts: This field may be sent only for FDC Compass. **American Express Direct** Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return postalCode **/ - @ApiModelProperty(value = "Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For Payouts: This field may be sent only for FDC Compass. **American Express Direct** Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getPostalCode() { return postalCode; } @@ -259,10 +259,10 @@ public Ptsv2payoutsOrderInformationBillTo phoneNumber(String phoneNumber) { } /** - * Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. * @return phoneNumber **/ - @ApiModelProperty(value = "Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ") public String getPhoneNumber() { return phoneNumber; } diff --git a/src/main/java/Model/Ptsv2payoutsPaymentInformation.java b/src/main/java/Model/Ptsv2payoutsPaymentInformation.java index d6855e0cd..edd03c61c 100644 --- a/src/main/java/Model/Ptsv2payoutsPaymentInformation.java +++ b/src/main/java/Model/Ptsv2payoutsPaymentInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,6 +14,7 @@ package Model; import java.util.Objects; +import Model.Ptsv2paymentsPaymentInformationCustomer; import Model.Ptsv2payoutsPaymentInformationCard; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; @@ -27,11 +28,14 @@ /** * Ptsv2payoutsPaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsPaymentInformation { @SerializedName("card") private Ptsv2payoutsPaymentInformationCard card = null; + @SerializedName("customer") + private Ptsv2paymentsPaymentInformationCustomer customer = null; + public Ptsv2payoutsPaymentInformation card(Ptsv2payoutsPaymentInformationCard card) { this.card = card; return this; @@ -50,6 +54,24 @@ public void setCard(Ptsv2payoutsPaymentInformationCard card) { this.card = card; } + public Ptsv2payoutsPaymentInformation customer(Ptsv2paymentsPaymentInformationCustomer customer) { + this.customer = customer; + return this; + } + + /** + * Get customer + * @return customer + **/ + @ApiModelProperty(value = "") + public Ptsv2paymentsPaymentInformationCustomer getCustomer() { + return customer; + } + + public void setCustomer(Ptsv2paymentsPaymentInformationCustomer customer) { + this.customer = customer; + } + @Override public boolean equals(java.lang.Object o) { @@ -60,12 +82,13 @@ public boolean equals(java.lang.Object o) { return false; } Ptsv2payoutsPaymentInformation ptsv2payoutsPaymentInformation = (Ptsv2payoutsPaymentInformation) o; - return Objects.equals(this.card, ptsv2payoutsPaymentInformation.card); + return Objects.equals(this.card, ptsv2payoutsPaymentInformation.card) && + Objects.equals(this.customer, ptsv2payoutsPaymentInformation.customer); } @Override public int hashCode() { - return Objects.hash(card); + return Objects.hash(card, customer); } @@ -75,6 +98,7 @@ public String toString() { sb.append("class Ptsv2payoutsPaymentInformation {\n"); sb.append(" card: ").append(toIndentedString(card)).append("\n"); + sb.append(" customer: ").append(toIndentedString(customer)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/Ptsv2payoutsPaymentInformationCard.java b/src/main/java/Model/Ptsv2payoutsPaymentInformationCard.java index e9dedf6c0..734cbab62 100644 --- a/src/main/java/Model/Ptsv2payoutsPaymentInformationCard.java +++ b/src/main/java/Model/Ptsv2payoutsPaymentInformationCard.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2payoutsPaymentInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsPaymentInformationCard { @SerializedName("type") private String type = null; @@ -49,10 +49,10 @@ public Ptsv2payoutsPaymentInformationCard type(String type) { } /** - * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover + * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) * @return type **/ - @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover ") + @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) ") public String getType() { return type; } @@ -67,10 +67,10 @@ public Ptsv2payoutsPaymentInformationCard number(String number) { } /** - * Customer’s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field for the encoded account number. For processor-specific information, see the customer_cc_number field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return number **/ - @ApiModelProperty(value = "Customer’s credit card number. Encoded Account Numbers when processing encoded account numbers, use this field for the encoded account number. For processor-specific information, see the customer_cc_number field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getNumber() { return number; } @@ -85,10 +85,10 @@ public Ptsv2payoutsPaymentInformationCard expirationMonth(String expirationMonth } /** - * Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return expirationMonth **/ - @ApiModelProperty(value = "Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getExpirationMonth() { return expirationMonth; } @@ -103,10 +103,10 @@ public Ptsv2payoutsPaymentInformationCard expirationYear(String expirationYear) } /** - * Four-digit year in which the credit card expires. `Format: YYYY`. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return expirationYear **/ - @ApiModelProperty(value = "Four-digit year in which the credit card expires. `Format: YYYY`. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getExpirationYear() { return expirationYear; } @@ -121,10 +121,10 @@ public Ptsv2payoutsPaymentInformationCard sourceAccountType(String sourceAccount } /** - * Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases. - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for CTV. **Note** Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - CHECKING: Checking account - CREDIT: Credit card account - SAVING: Saving account - LINE_OF_CREDIT: Line of credit - PREPAID: Prepaid card account - UNIVERSAL: Universal account + * Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for Visa Platform Connect (VPC). **Note**\\ Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - **CHECKING**: Checking account - **CREDIT**: Credit card account - **SAVING**: Saving account - **LINE_OF_CREDIT**: Line of credit or credit portion of combo card - **PREPAID**: Prepaid card account or prepaid portion of combo card - **UNIVERSAL**: Universal account * @return sourceAccountType **/ - @ApiModelProperty(value = "Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases. - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for CTV. **Note** Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - CHECKING: Checking account - CREDIT: Credit card account - SAVING: Saving account - LINE_OF_CREDIT: Line of credit - PREPAID: Prepaid card account - UNIVERSAL: Universal account ") + @ApiModelProperty(value = "Flag that specifies the type of account associated with the card. The cardholder provides this information during the payment process. This field is required in the following cases: - Debit transactions on Cielo and Comercio Latino. - Transactions with Brazilian-issued cards on CyberSource through VisaNet. - Applicable only for Visa Platform Connect (VPC). **Note**\\ Combo cards in Brazil contain credit and debit functionality in a single card. Visa systems use a credit bank identification number (BIN) for this type of card. Using the BIN to determine whether a card is debit or credit can cause transactions with these cards to be processed incorrectly. CyberSource strongly recommends that you include this field for combo card transactions. Possible values include the following. - **CHECKING**: Checking account - **CREDIT**: Credit card account - **SAVING**: Saving account - **LINE_OF_CREDIT**: Line of credit or credit portion of combo card - **PREPAID**: Prepaid card account or prepaid portion of combo card - **UNIVERSAL**: Universal account ") public String getSourceAccountType() { return sourceAccountType; } diff --git a/src/main/java/Model/Ptsv2payoutsProcessingInformation.java b/src/main/java/Model/Ptsv2payoutsProcessingInformation.java index 09a031ca9..c3a3ead87 100644 --- a/src/main/java/Model/Ptsv2payoutsProcessingInformation.java +++ b/src/main/java/Model/Ptsv2payoutsProcessingInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2payoutsProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsProcessingInformation { @SerializedName("businessApplicationId") private String businessApplicationId = null; @@ -86,10 +86,10 @@ public Ptsv2payoutsProcessingInformation commerceIndicator(String commerceIndica } /** - * Type of transaction. Possible value for Fast Payments transactions: - internet + * Type of transaction. Some payment card companies use this information when determining discount rates. When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value listed here. Possible value for Fast Payments transactions: - internet **Ingenico ePayments**\\ Ingenico ePayments was previously called _Global Collect_. **Payer Authentication Transactions**\\ For the possible values and requirements, see \"Payer Authentication,\" page 180. **Other Types of Transactions**\\ See Appendix G, \"Commerce Indicators,\" on page 353. * @return commerceIndicator **/ - @ApiModelProperty(value = "Type of transaction. Possible value for Fast Payments transactions: - internet ") + @ApiModelProperty(value = "Type of transaction. Some payment card companies use this information when determining discount rates. When you omit this field for Ingenico ePayments, the processor uses the default transaction type they have on file for you instead of the default value listed here. Possible value for Fast Payments transactions: - internet **Ingenico ePayments**\\ Ingenico ePayments was previously called _Global Collect_. **Payer Authentication Transactions**\\ For the possible values and requirements, see \"Payer Authentication,\" page 180. **Other Types of Transactions**\\ See Appendix G, \"Commerce Indicators,\" on page 353. ") public String getCommerceIndicator() { return commerceIndicator; } diff --git a/src/main/java/Model/Ptsv2payoutsProcessingInformationPayoutsOptions.java b/src/main/java/Model/Ptsv2payoutsProcessingInformationPayoutsOptions.java index a506decf6..3657af10a 100644 --- a/src/main/java/Model/Ptsv2payoutsProcessingInformationPayoutsOptions.java +++ b/src/main/java/Model/Ptsv2payoutsProcessingInformationPayoutsOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2payoutsProcessingInformationPayoutsOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsProcessingInformationPayoutsOptions { @SerializedName("acquirerMerchantId") private String acquirerMerchantId = null; diff --git a/src/main/java/Model/Ptsv2payoutsRecipientInformation.java b/src/main/java/Model/Ptsv2payoutsRecipientInformation.java index d172bde84..cb8c2a9d3 100644 --- a/src/main/java/Model/Ptsv2payoutsRecipientInformation.java +++ b/src/main/java/Model/Ptsv2payoutsRecipientInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2payoutsRecipientInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsRecipientInformation { @SerializedName("firstName") private String firstName = null; diff --git a/src/main/java/Model/Ptsv2payoutsSenderInformation.java b/src/main/java/Model/Ptsv2payoutsSenderInformation.java index dfef1e0f5..908fd2766 100644 --- a/src/main/java/Model/Ptsv2payoutsSenderInformation.java +++ b/src/main/java/Model/Ptsv2payoutsSenderInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * Ptsv2payoutsSenderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsSenderInformation { @SerializedName("referenceNumber") private String referenceNumber = null; diff --git a/src/main/java/Model/Ptsv2payoutsSenderInformationAccount.java b/src/main/java/Model/Ptsv2payoutsSenderInformationAccount.java index 0b9761470..30771017a 100644 --- a/src/main/java/Model/Ptsv2payoutsSenderInformationAccount.java +++ b/src/main/java/Model/Ptsv2payoutsSenderInformationAccount.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Ptsv2payoutsSenderInformationAccount */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Ptsv2payoutsSenderInformationAccount { @SerializedName("fundsSource") private String fundsSource = null; diff --git a/src/main/java/Model/RefundCaptureRequest.java b/src/main/java/Model/RefundCaptureRequest.java index e93016895..c87f963ac 100644 --- a/src/main/java/Model/RefundCaptureRequest.java +++ b/src/main/java/Model/RefundCaptureRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -38,7 +38,7 @@ /** * RefundCaptureRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class RefundCaptureRequest { @SerializedName("clientReferenceInformation") private Ptsv2paymentsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/main/java/Model/RefundPaymentRequest.java b/src/main/java/Model/RefundPaymentRequest.java index 0f929da3e..4f9b903b4 100644 --- a/src/main/java/Model/RefundPaymentRequest.java +++ b/src/main/java/Model/RefundPaymentRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -38,7 +38,7 @@ /** * RefundPaymentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class RefundPaymentRequest { @SerializedName("clientReferenceInformation") private Ptsv2paymentsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/main/java/Model/ReportingV3ConversionDetailsGet200Response.java b/src/main/java/Model/ReportingV3ConversionDetailsGet200Response.java index e7f6734f8..4a6d3f147 100644 --- a/src/main/java/Model/ReportingV3ConversionDetailsGet200Response.java +++ b/src/main/java/Model/ReportingV3ConversionDetailsGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * ReportingV3ConversionDetailsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3ConversionDetailsGet200Response { @SerializedName("organizationId") private String organizationId = null; diff --git a/src/main/java/Model/ReportingV3ConversionDetailsGet200ResponseConversionDetails.java b/src/main/java/Model/ReportingV3ConversionDetailsGet200ResponseConversionDetails.java index 3716c87f5..883081146 100644 --- a/src/main/java/Model/ReportingV3ConversionDetailsGet200ResponseConversionDetails.java +++ b/src/main/java/Model/ReportingV3ConversionDetailsGet200ResponseConversionDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * ReportingV3ConversionDetailsGet200ResponseConversionDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3ConversionDetailsGet200ResponseConversionDetails { @SerializedName("merchantReferenceNumber") private String merchantReferenceNumber = null; diff --git a/src/main/java/Model/ReportingV3ConversionDetailsGet200ResponseNotes.java b/src/main/java/Model/ReportingV3ConversionDetailsGet200ResponseNotes.java index 7495a1fa8..39b3347c6 100644 --- a/src/main/java/Model/ReportingV3ConversionDetailsGet200ResponseNotes.java +++ b/src/main/java/Model/ReportingV3ConversionDetailsGet200ResponseNotes.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * ReportingV3ConversionDetailsGet200ResponseNotes */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3ConversionDetailsGet200ResponseNotes { @SerializedName("time") private DateTime time = null; diff --git a/src/main/java/Model/ReportingV3NetFundingsGet200Response.java b/src/main/java/Model/ReportingV3NetFundingsGet200Response.java index eb4e95d58..da66eb4df 100644 --- a/src/main/java/Model/ReportingV3NetFundingsGet200Response.java +++ b/src/main/java/Model/ReportingV3NetFundingsGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -31,7 +31,7 @@ /** * ReportingV3NetFundingsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3NetFundingsGet200Response { @SerializedName("startTime") private DateTime startTime = null; diff --git a/src/main/java/Model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.java b/src/main/java/Model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.java index 3ceaf3c30..7c018768f 100644 --- a/src/main/java/Model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.java +++ b/src/main/java/Model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * ReportingV3NetFundingsGet200ResponseNetFundingSummaries */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3NetFundingsGet200ResponseNetFundingSummaries { /** * Gets or Sets type diff --git a/src/main/java/Model/ReportingV3NetFundingsGet200ResponseTotalPurchases.java b/src/main/java/Model/ReportingV3NetFundingsGet200ResponseTotalPurchases.java index a261aae22..3585f8d75 100644 --- a/src/main/java/Model/ReportingV3NetFundingsGet200ResponseTotalPurchases.java +++ b/src/main/java/Model/ReportingV3NetFundingsGet200ResponseTotalPurchases.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * ReportingV3NetFundingsGet200ResponseTotalPurchases */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3NetFundingsGet200ResponseTotalPurchases { @SerializedName("currency") private String currency = null; diff --git a/src/main/java/Model/ReportingV3NotificationofChangesGet200Response.java b/src/main/java/Model/ReportingV3NotificationofChangesGet200Response.java index ef2fa9dc3..5b4cfd1a5 100644 --- a/src/main/java/Model/ReportingV3NotificationofChangesGet200Response.java +++ b/src/main/java/Model/ReportingV3NotificationofChangesGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * ReportingV3NotificationofChangesGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3NotificationofChangesGet200Response { @SerializedName("notificationOfChanges") private List notificationOfChanges = null; diff --git a/src/main/java/Model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.java b/src/main/java/Model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.java index 74ac87916..4a95e0656 100644 --- a/src/main/java/Model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.java +++ b/src/main/java/Model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ * Notification Of Change */ @ApiModel(description = "Notification Of Change") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges { @SerializedName("merchantReferenceNumber") private String merchantReferenceNumber = null; diff --git a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200Response.java b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200Response.java index 5cc0dd5bd..fa52d5edf 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200Response.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -34,7 +34,7 @@ /** * ReportingV3PurchaseRefundDetailsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3PurchaseRefundDetailsGet200Response { @SerializedName("offset") private Integer offset = null; diff --git a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.java b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.java index c15ff0119..875ab2f19 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ * Authorization Info Values */ @ApiModel(description = "Authorization Info Values") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations { @SerializedName("requestId") private String requestId = null; diff --git a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.java b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.java index dcb664e6c..2b34e47c3 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ * Fee Funding Section */ @ApiModel(description = "Fee Funding Section") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails { @SerializedName("requestId") private String requestId = null; diff --git a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.java b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.java index 371704a44..c52bff986 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ * Other Merchant Details Values. */ @ApiModel(description = "Other Merchant Details Values.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3PurchaseRefundDetailsGet200ResponseOthers { @SerializedName("requestId") private String requestId = null; diff --git a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.java b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.java index 50d850023..e1c19b3ef 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ * Request Info Section */ @ApiModel(description = "Request Info Section") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails { @SerializedName("requestId") private String requestId = null; diff --git a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.java b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.java index 72d7f8b94..afe651b87 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ * Settlement Status Section Values. */ @ApiModel(description = "Settlement Status Section Values.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses { @SerializedName("requestId") private String requestId = null; diff --git a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.java b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.java index ba20e5136..37db6516d 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * ReportingV3PurchaseRefundDetailsGet200ResponseSettlements */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3PurchaseRefundDetailsGet200ResponseSettlements { @SerializedName("requestId") private String requestId = null; diff --git a/src/main/java/Model/ReportingV3ReportDefinitionsGet200Response.java b/src/main/java/Model/ReportingV3ReportDefinitionsGet200Response.java index b5436babe..3fc5db486 100644 --- a/src/main/java/Model/ReportingV3ReportDefinitionsGet200Response.java +++ b/src/main/java/Model/ReportingV3ReportDefinitionsGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * ReportingV3ReportDefinitionsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3ReportDefinitionsGet200Response { @SerializedName("reportDefinitions") private List reportDefinitions = null; diff --git a/src/main/java/Model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.java b/src/main/java/Model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.java index aadcdd370..4bbf1ca23 100644 --- a/src/main/java/Model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.java +++ b/src/main/java/Model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ /** * ReportingV3ReportDefinitionsGet200ResponseReportDefinitions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3ReportDefinitionsGet200ResponseReportDefinitions { @SerializedName("type") private String type = null; diff --git a/src/main/java/Model/ReportingV3ReportDefinitionsNameGet200Response.java b/src/main/java/Model/ReportingV3ReportDefinitionsNameGet200Response.java index e21402f42..2b19a7a49 100644 --- a/src/main/java/Model/ReportingV3ReportDefinitionsNameGet200Response.java +++ b/src/main/java/Model/ReportingV3ReportDefinitionsNameGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * ReportingV3ReportDefinitionsNameGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3ReportDefinitionsNameGet200Response { @SerializedName("type") private String type = null; diff --git a/src/main/java/Model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.java b/src/main/java/Model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.java index b13ed9c5c..4af68cda3 100644 --- a/src/main/java/Model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.java +++ b/src/main/java/Model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * ReportingV3ReportDefinitionsNameGet200ResponseAttributes */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3ReportDefinitionsNameGet200ResponseAttributes { @SerializedName("id") private String id = null; diff --git a/src/main/java/Model/ReportingV3ReportSubscriptionsGet200Response.java b/src/main/java/Model/ReportingV3ReportSubscriptionsGet200Response.java index b351ecc0f..41f11d5fa 100644 --- a/src/main/java/Model/ReportingV3ReportSubscriptionsGet200Response.java +++ b/src/main/java/Model/ReportingV3ReportSubscriptionsGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * ReportingV3ReportSubscriptionsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3ReportSubscriptionsGet200Response { @SerializedName("subscriptions") private List subscriptions = null; diff --git a/src/main/java/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.java b/src/main/java/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.java index cab679896..fbbffe254 100644 --- a/src/main/java/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.java +++ b/src/main/java/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.ReportingV3ReportsIdGet200ResponseReportPreferences; +import Model.Reportingv3reportsReportPreferences; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -33,7 +33,7 @@ * Subscription Details */ @ApiModel(description = "Subscription Details") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3ReportSubscriptionsGet200ResponseSubscriptions { @SerializedName("organizationId") private String organizationId = null; @@ -103,7 +103,9 @@ public enum ReportFrequencyEnum { WEEKLY("WEEKLY"), - MONTHLY("MONTHLY"); + MONTHLY("MONTHLY"), + + ADHOC("ADHOC"); private String value; @@ -165,7 +167,7 @@ public ReportFrequencyEnum read(final JsonReader jsonReader) throws IOException private Map> reportFilters = null; @SerializedName("reportPreferences") - private ReportingV3ReportsIdGet200ResponseReportPreferences reportPreferences = null; + private Reportingv3reportsReportPreferences reportPreferences = null; @SerializedName("groupId") private String groupId = null; @@ -384,7 +386,7 @@ public void setReportFilters(Map> reportFilters) { this.reportFilters = reportFilters; } - public ReportingV3ReportSubscriptionsGet200ResponseSubscriptions reportPreferences(ReportingV3ReportsIdGet200ResponseReportPreferences reportPreferences) { + public ReportingV3ReportSubscriptionsGet200ResponseSubscriptions reportPreferences(Reportingv3reportsReportPreferences reportPreferences) { this.reportPreferences = reportPreferences; return this; } @@ -394,11 +396,11 @@ public ReportingV3ReportSubscriptionsGet200ResponseSubscriptions reportPreferenc * @return reportPreferences **/ @ApiModelProperty(value = "") - public ReportingV3ReportsIdGet200ResponseReportPreferences getReportPreferences() { + public Reportingv3reportsReportPreferences getReportPreferences() { return reportPreferences; } - public void setReportPreferences(ReportingV3ReportsIdGet200ResponseReportPreferences reportPreferences) { + public void setReportPreferences(Reportingv3reportsReportPreferences reportPreferences) { this.reportPreferences = reportPreferences; } diff --git a/src/main/java/Model/ReportingV3ReportsGet200Response.java b/src/main/java/Model/ReportingV3ReportsGet200Response.java index ce5acc2c5..4833de01b 100644 --- a/src/main/java/Model/ReportingV3ReportsGet200Response.java +++ b/src/main/java/Model/ReportingV3ReportsGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * ReportingV3ReportsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3ReportsGet200Response { @SerializedName("reports") private List reports = null; diff --git a/src/main/java/Model/ReportingV3ReportsGet200ResponseReports.java b/src/main/java/Model/ReportingV3ReportsGet200ResponseReports.java index 67aebcc69..a317296d0 100644 --- a/src/main/java/Model/ReportingV3ReportsGet200ResponseReports.java +++ b/src/main/java/Model/ReportingV3ReportsGet200ResponseReports.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ * Report Search Result Bean */ @ApiModel(description = "Report Search Result Bean") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3ReportsGet200ResponseReports { @SerializedName("reportDefinitionId") private String reportDefinitionId = null; diff --git a/src/main/java/Model/ReportingV3ReportsIdGet200Response.java b/src/main/java/Model/ReportingV3ReportsIdGet200Response.java index 683c415fc..336e3326e 100644 --- a/src/main/java/Model/ReportingV3ReportsIdGet200Response.java +++ b/src/main/java/Model/ReportingV3ReportsIdGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.ReportingV3ReportsIdGet200ResponseReportPreferences; +import Model.Reportingv3reportsReportPreferences; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -33,7 +33,7 @@ * Report Log */ @ApiModel(description = "Report Log") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class ReportingV3ReportsIdGet200Response { @SerializedName("organizationId") private String organizationId = null; @@ -227,7 +227,7 @@ public ReportStatusEnum read(final JsonReader jsonReader) throws IOException { private Map> reportFilters = null; @SerializedName("reportPreferences") - private ReportingV3ReportsIdGet200ResponseReportPreferences reportPreferences = null; + private Reportingv3reportsReportPreferences reportPreferences = null; @SerializedName("groupId") private String groupId = null; @@ -464,7 +464,7 @@ public void setReportFilters(Map> reportFilters) { this.reportFilters = reportFilters; } - public ReportingV3ReportsIdGet200Response reportPreferences(ReportingV3ReportsIdGet200ResponseReportPreferences reportPreferences) { + public ReportingV3ReportsIdGet200Response reportPreferences(Reportingv3reportsReportPreferences reportPreferences) { this.reportPreferences = reportPreferences; return this; } @@ -474,11 +474,11 @@ public ReportingV3ReportsIdGet200Response reportPreferences(ReportingV3ReportsId * @return reportPreferences **/ @ApiModelProperty(value = "") - public ReportingV3ReportsIdGet200ResponseReportPreferences getReportPreferences() { + public Reportingv3reportsReportPreferences getReportPreferences() { return reportPreferences; } - public void setReportPreferences(ReportingV3ReportsIdGet200ResponseReportPreferences reportPreferences) { + public void setReportPreferences(Reportingv3reportsReportPreferences reportPreferences) { this.reportPreferences = reportPreferences; } diff --git a/src/main/java/Model/ReportingV3ReportsIdGet200ResponseReportPreferences.java b/src/main/java/Model/ReportingV3ReportsIdGet200ResponseReportPreferences.java deleted file mode 100644 index 6d80c743b..000000000 --- a/src/main/java/Model/ReportingV3ReportsIdGet200ResponseReportPreferences.java +++ /dev/null @@ -1,164 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Report Preferences - */ -@ApiModel(description = "Report Preferences") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class ReportingV3ReportsIdGet200ResponseReportPreferences { - @SerializedName("signedAmounts") - private Boolean signedAmounts = null; - - /** - * Specify the field naming convention to be followed in reports (applicable to only csv report formats - */ - @JsonAdapter(FieldNameConventionEnum.Adapter.class) - public enum FieldNameConventionEnum { - SOAPI("SOAPI"), - - SCMP("SCMP"); - - private String value; - - FieldNameConventionEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static FieldNameConventionEnum fromValue(String text) { - for (FieldNameConventionEnum b : FieldNameConventionEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final FieldNameConventionEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public FieldNameConventionEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return FieldNameConventionEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("fieldNameConvention") - private FieldNameConventionEnum fieldNameConvention = null; - - public ReportingV3ReportsIdGet200ResponseReportPreferences signedAmounts(Boolean signedAmounts) { - this.signedAmounts = signedAmounts; - return this; - } - - /** - * Indicator to determine whether negative sign infron of amount for all refunded transaction - * @return signedAmounts - **/ - @ApiModelProperty(value = "Indicator to determine whether negative sign infron of amount for all refunded transaction") - public Boolean getSignedAmounts() { - return signedAmounts; - } - - public void setSignedAmounts(Boolean signedAmounts) { - this.signedAmounts = signedAmounts; - } - - public ReportingV3ReportsIdGet200ResponseReportPreferences fieldNameConvention(FieldNameConventionEnum fieldNameConvention) { - this.fieldNameConvention = fieldNameConvention; - return this; - } - - /** - * Specify the field naming convention to be followed in reports (applicable to only csv report formats - * @return fieldNameConvention - **/ - @ApiModelProperty(value = "Specify the field naming convention to be followed in reports (applicable to only csv report formats") - public FieldNameConventionEnum getFieldNameConvention() { - return fieldNameConvention; - } - - public void setFieldNameConvention(FieldNameConventionEnum fieldNameConvention) { - this.fieldNameConvention = fieldNameConvention; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ReportingV3ReportsIdGet200ResponseReportPreferences reportingV3ReportsIdGet200ResponseReportPreferences = (ReportingV3ReportsIdGet200ResponseReportPreferences) o; - return Objects.equals(this.signedAmounts, reportingV3ReportsIdGet200ResponseReportPreferences.signedAmounts) && - Objects.equals(this.fieldNameConvention, reportingV3ReportsIdGet200ResponseReportPreferences.fieldNameConvention); - } - - @Override - public int hashCode() { - return Objects.hash(signedAmounts, fieldNameConvention); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ReportingV3ReportsIdGet200ResponseReportPreferences {\n"); - - sb.append(" signedAmounts: ").append(toIndentedString(signedAmounts)).append("\n"); - sb.append(" fieldNameConvention: ").append(toIndentedString(fieldNameConvention)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Reportingv3ReportDownloadsGet400Response.java b/src/main/java/Model/Reportingv3ReportDownloadsGet400Response.java index 974f68b6d..91ac28ae4 100644 --- a/src/main/java/Model/Reportingv3ReportDownloadsGet400Response.java +++ b/src/main/java/Model/Reportingv3ReportDownloadsGet400Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -25,15 +25,16 @@ import java.io.IOException; import java.util.ArrayList; import java.util.List; +import org.joda.time.DateTime; /** * HTTP status code for client application */ @ApiModel(description = "HTTP status code for client application") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Reportingv3ReportDownloadsGet400Response { @SerializedName("submitTimeUtc") - private String submitTimeUtc = null; + private DateTime submitTimeUtc = null; @SerializedName("reason") private String reason = null; @@ -44,21 +45,21 @@ public class Reportingv3ReportDownloadsGet400Response { @SerializedName("details") private List details = new ArrayList(); - public Reportingv3ReportDownloadsGet400Response submitTimeUtc(String submitTimeUtc) { + public Reportingv3ReportDownloadsGet400Response submitTimeUtc(DateTime submitTimeUtc) { this.submitTimeUtc = submitTimeUtc; return this; } /** - * Time of request in UTC + * Time of request in UTC. * @return submitTimeUtc **/ - @ApiModelProperty(example = "1549650141000", required = true, value = "Time of request in UTC ") - public String getSubmitTimeUtc() { + @ApiModelProperty(example = "2016-08-11T22:47:57Z", required = true, value = "Time of request in UTC. ") + public DateTime getSubmitTimeUtc() { return submitTimeUtc; } - public void setSubmitTimeUtc(String submitTimeUtc) { + public void setSubmitTimeUtc(DateTime submitTimeUtc) { this.submitTimeUtc = submitTimeUtc; } diff --git a/src/main/java/Model/Reportingv3ReportDownloadsGet400ResponseDetails.java b/src/main/java/Model/Reportingv3ReportDownloadsGet400ResponseDetails.java index 0548f3ce9..a4857b3e0 100644 --- a/src/main/java/Model/Reportingv3ReportDownloadsGet400ResponseDetails.java +++ b/src/main/java/Model/Reportingv3ReportDownloadsGet400ResponseDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ * Provides failed validation input field detail */ @ApiModel(description = "Provides failed validation input field detail ") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Reportingv3ReportDownloadsGet400ResponseDetails { @SerializedName("field") private String field = null; diff --git a/src/main/java/Model/Reportingv3reportsReportPreferences.java b/src/main/java/Model/Reportingv3reportsReportPreferences.java index 6482c0ddc..94282ca9b 100644 --- a/src/main/java/Model/Reportingv3reportsReportPreferences.java +++ b/src/main/java/Model/Reportingv3reportsReportPreferences.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ * Report Preferences */ @ApiModel(description = "Report Preferences") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Reportingv3reportsReportPreferences { @SerializedName("signedAmounts") private Boolean signedAmounts = null; diff --git a/src/main/java/Model/RequestBody.java b/src/main/java/Model/RequestBody.java index 004ba3792..582fe9cde 100644 --- a/src/main/java/Model/RequestBody.java +++ b/src/main/java/Model/RequestBody.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -32,7 +32,7 @@ /** * RequestBody */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class RequestBody { @SerializedName("organizationId") private String organizationId = null; diff --git a/src/main/java/Model/RequestBody1.java b/src/main/java/Model/RequestBody1.java index 7dcf285d2..aa27cd66b 100644 --- a/src/main/java/Model/RequestBody1.java +++ b/src/main/java/Model/RequestBody1.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.ReportingV3ReportsIdGet200ResponseReportPreferences; +import Model.Reportingv3reportsReportPreferences; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -31,7 +31,7 @@ /** * RequestBody1 */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class RequestBody1 { @SerializedName("organizationId") private String organizationId = null; @@ -101,7 +101,9 @@ public enum ReportFrequencyEnum { WEEKLY("WEEKLY"), - MONTHLY("MONTHLY"); + MONTHLY("MONTHLY"), + + ADHOC("ADHOC"); private String value; @@ -160,7 +162,7 @@ public ReportFrequencyEnum read(final JsonReader jsonReader) throws IOException private Map> reportFilters = null; @SerializedName("reportPreferences") - private ReportingV3ReportsIdGet200ResponseReportPreferences reportPreferences = null; + private Reportingv3reportsReportPreferences reportPreferences = null; @SerializedName("groupName") private String groupName = null; @@ -360,7 +362,7 @@ public void setReportFilters(Map> reportFilters) { this.reportFilters = reportFilters; } - public RequestBody1 reportPreferences(ReportingV3ReportsIdGet200ResponseReportPreferences reportPreferences) { + public RequestBody1 reportPreferences(Reportingv3reportsReportPreferences reportPreferences) { this.reportPreferences = reportPreferences; return this; } @@ -370,11 +372,11 @@ public RequestBody1 reportPreferences(ReportingV3ReportsIdGet200ResponseReportPr * @return reportPreferences **/ @ApiModelProperty(value = "") - public ReportingV3ReportsIdGet200ResponseReportPreferences getReportPreferences() { + public Reportingv3reportsReportPreferences getReportPreferences() { return reportPreferences; } - public void setReportPreferences(ReportingV3ReportsIdGet200ResponseReportPreferences reportPreferences) { + public void setReportPreferences(Reportingv3reportsReportPreferences reportPreferences) { this.reportPreferences = reportPreferences; } diff --git a/src/main/java/Model/ResponseStatus.java b/src/main/java/Model/ResponseStatus.java deleted file mode 100644 index 52655f294..000000000 --- a/src/main/java/Model/ResponseStatus.java +++ /dev/null @@ -1,197 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import Model.InlineResponseDefaultResponseStatusDetails; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; -import java.math.BigDecimal; -import java.util.ArrayList; -import java.util.List; - -/** - * ResponseStatus - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class ResponseStatus { - @SerializedName("status") - private BigDecimal status = null; - - @SerializedName("reason") - private String reason = null; - - @SerializedName("message") - private String message = null; - - @SerializedName("correlationId") - private String correlationId = null; - - @SerializedName("details") - private List details = null; - - public ResponseStatus status(BigDecimal status) { - this.status = status; - return this; - } - - /** - * HTTP Status code. - * @return status - **/ - @ApiModelProperty(value = "HTTP Status code.") - public BigDecimal getStatus() { - return status; - } - - public void setStatus(BigDecimal status) { - this.status = status; - } - - public ResponseStatus reason(String reason) { - this.reason = reason; - return this; - } - - /** - * Error Reason Code. - * @return reason - **/ - @ApiModelProperty(value = "Error Reason Code.") - public String getReason() { - return reason; - } - - public void setReason(String reason) { - this.reason = reason; - } - - public ResponseStatus message(String message) { - this.message = message; - return this; - } - - /** - * Error Message. - * @return message - **/ - @ApiModelProperty(value = "Error Message.") - public String getMessage() { - return message; - } - - public void setMessage(String message) { - this.message = message; - } - - public ResponseStatus correlationId(String correlationId) { - this.correlationId = correlationId; - return this; - } - - /** - * API correlation ID. - * @return correlationId - **/ - @ApiModelProperty(value = "API correlation ID.") - public String getCorrelationId() { - return correlationId; - } - - public void setCorrelationId(String correlationId) { - this.correlationId = correlationId; - } - - public ResponseStatus details(List details) { - this.details = details; - return this; - } - - public ResponseStatus addDetailsItem(InlineResponseDefaultResponseStatusDetails detailsItem) { - if (this.details == null) { - this.details = new ArrayList(); - } - this.details.add(detailsItem); - return this; - } - - /** - * Get details - * @return details - **/ - @ApiModelProperty(value = "") - public List getDetails() { - return details; - } - - public void setDetails(List details) { - this.details = details; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ResponseStatus responseStatus = (ResponseStatus) o; - return Objects.equals(this.status, responseStatus.status) && - Objects.equals(this.reason, responseStatus.reason) && - Objects.equals(this.message, responseStatus.message) && - Objects.equals(this.correlationId, responseStatus.correlationId) && - Objects.equals(this.details, responseStatus.details); - } - - @Override - public int hashCode() { - return Objects.hash(status, reason, message, correlationId, details); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ResponseStatus {\n"); - - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" reason: ").append(toIndentedString(reason)).append("\n"); - sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append(" correlationId: ").append(toIndentedString(correlationId)).append("\n"); - sb.append(" details: ").append(toIndentedString(details)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/ResponseStatusDetails.java b/src/main/java/Model/ResponseStatusDetails.java deleted file mode 100644 index 9441d378c..000000000 --- a/src/main/java/Model/ResponseStatusDetails.java +++ /dev/null @@ -1,116 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * ResponseStatusDetails - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class ResponseStatusDetails { - @SerializedName("location") - private String location = null; - - @SerializedName("message") - private String message = null; - - public ResponseStatusDetails location(String location) { - this.location = location; - return this; - } - - /** - * Field name referred to for validation issues. - * @return location - **/ - @ApiModelProperty(value = "Field name referred to for validation issues.") - public String getLocation() { - return location; - } - - public void setLocation(String location) { - this.location = location; - } - - public ResponseStatusDetails message(String message) { - this.message = message; - return this; - } - - /** - * Description or code of any error response. - * @return message - **/ - @ApiModelProperty(value = "Description or code of any error response.") - public String getMessage() { - return message; - } - - public void setMessage(String message) { - this.message = message; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - ResponseStatusDetails responseStatusDetails = (ResponseStatusDetails) o; - return Objects.equals(this.location, responseStatusDetails.location) && - Objects.equals(this.message, responseStatusDetails.message); - } - - @Override - public int hashCode() { - return Objects.hash(location, message); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class ResponseStatusDetails {\n"); - - sb.append(" location: ").append(toIndentedString(location)).append("\n"); - sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/RiskV1DecisionsPost201Response.java b/src/main/java/Model/RiskV1DecisionsPost201Response.java new file mode 100644 index 000000000..9c40ac97f --- /dev/null +++ b/src/main/java/Model/RiskV1DecisionsPost201Response.java @@ -0,0 +1,234 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.PtsV2PaymentsPost201ResponseErrorInformation; +import Model.PtsV2PaymentsPost201ResponseLinks; +import Model.RiskV1DecisionsPost201ResponseRiskInformation; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * RiskV1DecisionsPost201Response + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class RiskV1DecisionsPost201Response { + @SerializedName("_links") + private PtsV2PaymentsPost201ResponseLinks links = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("submitTimeUtc") + private String submitTimeUtc = null; + + @SerializedName("submitTimeLocal") + private String submitTimeLocal = null; + + @SerializedName("status") + private String status = null; + + @SerializedName("riskInformation") + private RiskV1DecisionsPost201ResponseRiskInformation riskInformation = null; + + @SerializedName("errorInformation") + private PtsV2PaymentsPost201ResponseErrorInformation errorInformation = null; + + public RiskV1DecisionsPost201Response links(PtsV2PaymentsPost201ResponseLinks links) { + this.links = links; + return this; + } + + /** + * Get links + * @return links + **/ + @ApiModelProperty(value = "") + public PtsV2PaymentsPost201ResponseLinks getLinks() { + return links; + } + + public void setLinks(PtsV2PaymentsPost201ResponseLinks links) { + this.links = links; + } + + public RiskV1DecisionsPost201Response id(String id) { + this.id = id; + return this; + } + + /** + * An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. + * @return id + **/ + @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public RiskV1DecisionsPost201Response submitTimeUtc(String submitTimeUtc) { + this.submitTimeUtc = submitTimeUtc; + return this; + } + + /** + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. + * @return submitTimeUtc + **/ + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") + public String getSubmitTimeUtc() { + return submitTimeUtc; + } + + public void setSubmitTimeUtc(String submitTimeUtc) { + this.submitTimeUtc = submitTimeUtc; + } + + public RiskV1DecisionsPost201Response submitTimeLocal(String submitTimeLocal) { + this.submitTimeLocal = submitTimeLocal; + return this; + } + + /** + * Time that the transaction was submitted in local time. + * @return submitTimeLocal + **/ + @ApiModelProperty(value = "Time that the transaction was submitted in local time.") + public String getSubmitTimeLocal() { + return submitTimeLocal; + } + + public void setSubmitTimeLocal(String submitTimeLocal) { + this.submitTimeLocal = submitTimeLocal; + } + + public RiskV1DecisionsPost201Response status(String status) { + this.status = status; + return this; + } + + /** + * The status of the submitted transaction. Possible values: - `ACCEPTED` - `REJECTED` - `PENDING_REVIEW` + * @return status + **/ + @ApiModelProperty(value = "The status of the submitted transaction. Possible values: - `ACCEPTED` - `REJECTED` - `PENDING_REVIEW` ") + public String getStatus() { + return status; + } + + public void setStatus(String status) { + this.status = status; + } + + public RiskV1DecisionsPost201Response riskInformation(RiskV1DecisionsPost201ResponseRiskInformation riskInformation) { + this.riskInformation = riskInformation; + return this; + } + + /** + * Get riskInformation + * @return riskInformation + **/ + @ApiModelProperty(value = "") + public RiskV1DecisionsPost201ResponseRiskInformation getRiskInformation() { + return riskInformation; + } + + public void setRiskInformation(RiskV1DecisionsPost201ResponseRiskInformation riskInformation) { + this.riskInformation = riskInformation; + } + + public RiskV1DecisionsPost201Response errorInformation(PtsV2PaymentsPost201ResponseErrorInformation errorInformation) { + this.errorInformation = errorInformation; + return this; + } + + /** + * Get errorInformation + * @return errorInformation + **/ + @ApiModelProperty(value = "") + public PtsV2PaymentsPost201ResponseErrorInformation getErrorInformation() { + return errorInformation; + } + + public void setErrorInformation(PtsV2PaymentsPost201ResponseErrorInformation errorInformation) { + this.errorInformation = errorInformation; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskV1DecisionsPost201Response riskV1DecisionsPost201Response = (RiskV1DecisionsPost201Response) o; + return Objects.equals(this.links, riskV1DecisionsPost201Response.links) && + Objects.equals(this.id, riskV1DecisionsPost201Response.id) && + Objects.equals(this.submitTimeUtc, riskV1DecisionsPost201Response.submitTimeUtc) && + Objects.equals(this.submitTimeLocal, riskV1DecisionsPost201Response.submitTimeLocal) && + Objects.equals(this.status, riskV1DecisionsPost201Response.status) && + Objects.equals(this.riskInformation, riskV1DecisionsPost201Response.riskInformation) && + Objects.equals(this.errorInformation, riskV1DecisionsPost201Response.errorInformation); + } + + @Override + public int hashCode() { + return Objects.hash(links, id, submitTimeUtc, submitTimeLocal, status, riskInformation, errorInformation); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RiskV1DecisionsPost201Response {\n"); + + sb.append(" links: ").append(toIndentedString(links)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" submitTimeUtc: ").append(toIndentedString(submitTimeUtc)).append("\n"); + sb.append(" submitTimeLocal: ").append(toIndentedString(submitTimeLocal)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append(" riskInformation: ").append(toIndentedString(riskInformation)).append("\n"); + sb.append(" errorInformation: ").append(toIndentedString(errorInformation)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformation.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformation.java new file mode 100644 index 000000000..63a2310aa --- /dev/null +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformation.java @@ -0,0 +1,319 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.RiskV1DecisionsPost201ResponseRiskInformationInfoCodes; +import Model.RiskV1DecisionsPost201ResponseRiskInformationIpAddress; +import Model.RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation; +import Model.RiskV1DecisionsPost201ResponseRiskInformationProfile; +import Model.RiskV1DecisionsPost201ResponseRiskInformationProviders; +import Model.RiskV1DecisionsPost201ResponseRiskInformationRules; +import Model.RiskV1DecisionsPost201ResponseRiskInformationScore; +import Model.RiskV1DecisionsPost201ResponseRiskInformationVelocity; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * Contains the result of risk assessment. + */ +@ApiModel(description = "Contains the result of risk assessment.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class RiskV1DecisionsPost201ResponseRiskInformation { + @SerializedName("profile") + private RiskV1DecisionsPost201ResponseRiskInformationProfile profile = null; + + @SerializedName("rules") + private List rules = null; + + @SerializedName("infoCodes") + private RiskV1DecisionsPost201ResponseRiskInformationInfoCodes infoCodes = null; + + @SerializedName("velocity") + private RiskV1DecisionsPost201ResponseRiskInformationVelocity velocity = null; + + @SerializedName("casePriority") + private Integer casePriority = null; + + @SerializedName("localTime") + private String localTime = null; + + @SerializedName("paymentInformation") + private RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation paymentInformation = null; + + @SerializedName("score") + private RiskV1DecisionsPost201ResponseRiskInformationScore score = null; + + @SerializedName("ipAddress") + private RiskV1DecisionsPost201ResponseRiskInformationIpAddress ipAddress = null; + + @SerializedName("providers") + private RiskV1DecisionsPost201ResponseRiskInformationProviders providers = null; + + public RiskV1DecisionsPost201ResponseRiskInformation profile(RiskV1DecisionsPost201ResponseRiskInformationProfile profile) { + this.profile = profile; + return this; + } + + /** + * Get profile + * @return profile + **/ + @ApiModelProperty(value = "") + public RiskV1DecisionsPost201ResponseRiskInformationProfile getProfile() { + return profile; + } + + public void setProfile(RiskV1DecisionsPost201ResponseRiskInformationProfile profile) { + this.profile = profile; + } + + public RiskV1DecisionsPost201ResponseRiskInformation rules(List rules) { + this.rules = rules; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformation addRulesItem(RiskV1DecisionsPost201ResponseRiskInformationRules rulesItem) { + if (this.rules == null) { + this.rules = new ArrayList(); + } + this.rules.add(rulesItem); + return this; + } + + /** + * Get rules + * @return rules + **/ + @ApiModelProperty(value = "") + public List getRules() { + return rules; + } + + public void setRules(List rules) { + this.rules = rules; + } + + public RiskV1DecisionsPost201ResponseRiskInformation infoCodes(RiskV1DecisionsPost201ResponseRiskInformationInfoCodes infoCodes) { + this.infoCodes = infoCodes; + return this; + } + + /** + * Get infoCodes + * @return infoCodes + **/ + @ApiModelProperty(value = "") + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes getInfoCodes() { + return infoCodes; + } + + public void setInfoCodes(RiskV1DecisionsPost201ResponseRiskInformationInfoCodes infoCodes) { + this.infoCodes = infoCodes; + } + + public RiskV1DecisionsPost201ResponseRiskInformation velocity(RiskV1DecisionsPost201ResponseRiskInformationVelocity velocity) { + this.velocity = velocity; + return this; + } + + /** + * Get velocity + * @return velocity + **/ + @ApiModelProperty(value = "") + public RiskV1DecisionsPost201ResponseRiskInformationVelocity getVelocity() { + return velocity; + } + + public void setVelocity(RiskV1DecisionsPost201ResponseRiskInformationVelocity velocity) { + this.velocity = velocity; + } + + public RiskV1DecisionsPost201ResponseRiskInformation casePriority(Integer casePriority) { + this.casePriority = casePriority; + return this; + } + + /** + * You receive this field only if you subscribe to the Enhanced Case Management service. For all possible values, Please refer to Simple Order API Developer Guide on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/) - Look for 'Reply Fields': \"decisionReply_casePriority\". + * @return casePriority + **/ + @ApiModelProperty(value = "You receive this field only if you subscribe to the Enhanced Case Management service. For all possible values, Please refer to Simple Order API Developer Guide on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/) - Look for 'Reply Fields': \"decisionReply_casePriority\". ") + public Integer getCasePriority() { + return casePriority; + } + + public void setCasePriority(Integer casePriority) { + this.casePriority = casePriority; + } + + public RiskV1DecisionsPost201ResponseRiskInformation localTime(String localTime) { + this.localTime = localTime; + return this; + } + + /** + * The customer's local time (hh:mm:ss), which is calculated from the transaction request time and the customer's billing address. + * @return localTime + **/ + @ApiModelProperty(value = "The customer's local time (hh:mm:ss), which is calculated from the transaction request time and the customer's billing address. ") + public String getLocalTime() { + return localTime; + } + + public void setLocalTime(String localTime) { + this.localTime = localTime; + } + + public RiskV1DecisionsPost201ResponseRiskInformation paymentInformation(RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation paymentInformation) { + this.paymentInformation = paymentInformation; + return this; + } + + /** + * Get paymentInformation + * @return paymentInformation + **/ + @ApiModelProperty(value = "") + public RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation getPaymentInformation() { + return paymentInformation; + } + + public void setPaymentInformation(RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation paymentInformation) { + this.paymentInformation = paymentInformation; + } + + public RiskV1DecisionsPost201ResponseRiskInformation score(RiskV1DecisionsPost201ResponseRiskInformationScore score) { + this.score = score; + return this; + } + + /** + * Get score + * @return score + **/ + @ApiModelProperty(value = "") + public RiskV1DecisionsPost201ResponseRiskInformationScore getScore() { + return score; + } + + public void setScore(RiskV1DecisionsPost201ResponseRiskInformationScore score) { + this.score = score; + } + + public RiskV1DecisionsPost201ResponseRiskInformation ipAddress(RiskV1DecisionsPost201ResponseRiskInformationIpAddress ipAddress) { + this.ipAddress = ipAddress; + return this; + } + + /** + * Get ipAddress + * @return ipAddress + **/ + @ApiModelProperty(value = "") + public RiskV1DecisionsPost201ResponseRiskInformationIpAddress getIpAddress() { + return ipAddress; + } + + public void setIpAddress(RiskV1DecisionsPost201ResponseRiskInformationIpAddress ipAddress) { + this.ipAddress = ipAddress; + } + + public RiskV1DecisionsPost201ResponseRiskInformation providers(RiskV1DecisionsPost201ResponseRiskInformationProviders providers) { + this.providers = providers; + return this; + } + + /** + * Get providers + * @return providers + **/ + @ApiModelProperty(value = "") + public RiskV1DecisionsPost201ResponseRiskInformationProviders getProviders() { + return providers; + } + + public void setProviders(RiskV1DecisionsPost201ResponseRiskInformationProviders providers) { + this.providers = providers; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskV1DecisionsPost201ResponseRiskInformation riskV1DecisionsPost201ResponseRiskInformation = (RiskV1DecisionsPost201ResponseRiskInformation) o; + return Objects.equals(this.profile, riskV1DecisionsPost201ResponseRiskInformation.profile) && + Objects.equals(this.rules, riskV1DecisionsPost201ResponseRiskInformation.rules) && + Objects.equals(this.infoCodes, riskV1DecisionsPost201ResponseRiskInformation.infoCodes) && + Objects.equals(this.velocity, riskV1DecisionsPost201ResponseRiskInformation.velocity) && + Objects.equals(this.casePriority, riskV1DecisionsPost201ResponseRiskInformation.casePriority) && + Objects.equals(this.localTime, riskV1DecisionsPost201ResponseRiskInformation.localTime) && + Objects.equals(this.paymentInformation, riskV1DecisionsPost201ResponseRiskInformation.paymentInformation) && + Objects.equals(this.score, riskV1DecisionsPost201ResponseRiskInformation.score) && + Objects.equals(this.ipAddress, riskV1DecisionsPost201ResponseRiskInformation.ipAddress) && + Objects.equals(this.providers, riskV1DecisionsPost201ResponseRiskInformation.providers); + } + + @Override + public int hashCode() { + return Objects.hash(profile, rules, infoCodes, velocity, casePriority, localTime, paymentInformation, score, ipAddress, providers); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RiskV1DecisionsPost201ResponseRiskInformation {\n"); + + sb.append(" profile: ").append(toIndentedString(profile)).append("\n"); + sb.append(" rules: ").append(toIndentedString(rules)).append("\n"); + sb.append(" infoCodes: ").append(toIndentedString(infoCodes)).append("\n"); + sb.append(" velocity: ").append(toIndentedString(velocity)).append("\n"); + sb.append(" casePriority: ").append(toIndentedString(casePriority)).append("\n"); + sb.append(" localTime: ").append(toIndentedString(localTime)).append("\n"); + sb.append(" paymentInformation: ").append(toIndentedString(paymentInformation)).append("\n"); + sb.append(" score: ").append(toIndentedString(score)).append("\n"); + sb.append(" ipAddress: ").append(toIndentedString(ipAddress)).append("\n"); + sb.append(" providers: ").append(toIndentedString(providers)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.java new file mode 100644 index 000000000..a793ee7f3 --- /dev/null +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.java @@ -0,0 +1,320 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * RiskV1DecisionsPost201ResponseRiskInformationInfoCodes + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class RiskV1DecisionsPost201ResponseRiskInformationInfoCodes { + @SerializedName("velocity") + private List velocity = null; + + @SerializedName("address") + private List address = null; + + @SerializedName("customerList") + private List customerList = null; + + @SerializedName("identityChange") + private List identityChange = null; + + @SerializedName("internet") + private List internet = null; + + @SerializedName("phone") + private List phone = null; + + @SerializedName("suspicious") + private List suspicious = null; + + @SerializedName("globalVelocity") + private List globalVelocity = null; + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes velocity(List velocity) { + this.velocity = velocity; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes addVelocityItem(String velocityItem) { + if (this.velocity == null) { + this.velocity = new ArrayList(); + } + this.velocity.add(velocityItem); + return this; + } + + /** + * List of information codes triggered by the order. These information codes were generated when you created the order and product velocity rules and are returned so that you can associate them with the rules. + * @return velocity + **/ + @ApiModelProperty(value = "List of information codes triggered by the order. These information codes were generated when you created the order and product velocity rules and are returned so that you can associate them with the rules. ") + public List getVelocity() { + return velocity; + } + + public void setVelocity(List velocity) { + this.velocity = velocity; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes address(List address) { + this.address = address; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes addAddressItem(String addressItem) { + if (this.address == null) { + this.address = new ArrayList(); + } + this.address.add(addressItem); + return this; + } + + /** + * Indicates a mismatch between the customer’s billing and shipping addresses. + * @return address + **/ + @ApiModelProperty(value = "Indicates a mismatch between the customer’s billing and shipping addresses.") + public List getAddress() { + return address; + } + + public void setAddress(List address) { + this.address = address; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes customerList(List customerList) { + this.customerList = customerList; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes addCustomerListItem(String customerListItem) { + if (this.customerList == null) { + this.customerList = new ArrayList(); + } + this.customerList.add(customerListItem); + return this; + } + + /** + * Indicates that customer information is associated with transactions that are either on the negative or the positive list. + * @return customerList + **/ + @ApiModelProperty(value = "Indicates that customer information is associated with transactions that are either on the negative or the positive list. ") + public List getCustomerList() { + return customerList; + } + + public void setCustomerList(List customerList) { + this.customerList = customerList; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes identityChange(List identityChange) { + this.identityChange = identityChange; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes addIdentityChangeItem(String identityChangeItem) { + if (this.identityChange == null) { + this.identityChange = new ArrayList(); + } + this.identityChange.add(identityChangeItem); + return this; + } + + /** + * Indicates excessive identity changes. The threshold is variable depending on the identity elements being compared. This field can contain one or more information codes, separated by carets (^). + * @return identityChange + **/ + @ApiModelProperty(value = "Indicates excessive identity changes. The threshold is variable depending on the identity elements being compared. This field can contain one or more information codes, separated by carets (^). ") + public List getIdentityChange() { + return identityChange; + } + + public void setIdentityChange(List identityChange) { + this.identityChange = identityChange; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes internet(List internet) { + this.internet = internet; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes addInternetItem(String internetItem) { + if (this.internet == null) { + this.internet = new ArrayList(); + } + this.internet.add(internetItem); + return this; + } + + /** + * Indicates a problem with the customer’s email address, IP address, or billing address. + * @return internet + **/ + @ApiModelProperty(value = "Indicates a problem with the customer’s email address, IP address, or billing address.") + public List getInternet() { + return internet; + } + + public void setInternet(List internet) { + this.internet = internet; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes phone(List phone) { + this.phone = phone; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes addPhoneItem(String phoneItem) { + if (this.phone == null) { + this.phone = new ArrayList(); + } + this.phone.add(phoneItem); + return this; + } + + /** + * Indicates a problem with the customer’s phone number. + * @return phone + **/ + @ApiModelProperty(value = "Indicates a problem with the customer’s phone number.") + public List getPhone() { + return phone; + } + + public void setPhone(List phone) { + this.phone = phone; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes suspicious(List suspicious) { + this.suspicious = suspicious; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes addSuspiciousItem(String suspiciousItem) { + if (this.suspicious == null) { + this.suspicious = new ArrayList(); + } + this.suspicious.add(suspiciousItem); + return this; + } + + /** + * Indicates that the customer provided potentially suspicious information. + * @return suspicious + **/ + @ApiModelProperty(value = "Indicates that the customer provided potentially suspicious information.") + public List getSuspicious() { + return suspicious; + } + + public void setSuspicious(List suspicious) { + this.suspicious = suspicious; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes globalVelocity(List globalVelocity) { + this.globalVelocity = globalVelocity; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationInfoCodes addGlobalVelocityItem(String globalVelocityItem) { + if (this.globalVelocity == null) { + this.globalVelocity = new ArrayList(); + } + this.globalVelocity.add(globalVelocityItem); + return this; + } + + /** + * Indicates that the customer has a high purchase frequency. + * @return globalVelocity + **/ + @ApiModelProperty(value = "Indicates that the customer has a high purchase frequency.") + public List getGlobalVelocity() { + return globalVelocity; + } + + public void setGlobalVelocity(List globalVelocity) { + this.globalVelocity = globalVelocity; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskV1DecisionsPost201ResponseRiskInformationInfoCodes riskV1DecisionsPost201ResponseRiskInformationInfoCodes = (RiskV1DecisionsPost201ResponseRiskInformationInfoCodes) o; + return Objects.equals(this.velocity, riskV1DecisionsPost201ResponseRiskInformationInfoCodes.velocity) && + Objects.equals(this.address, riskV1DecisionsPost201ResponseRiskInformationInfoCodes.address) && + Objects.equals(this.customerList, riskV1DecisionsPost201ResponseRiskInformationInfoCodes.customerList) && + Objects.equals(this.identityChange, riskV1DecisionsPost201ResponseRiskInformationInfoCodes.identityChange) && + Objects.equals(this.internet, riskV1DecisionsPost201ResponseRiskInformationInfoCodes.internet) && + Objects.equals(this.phone, riskV1DecisionsPost201ResponseRiskInformationInfoCodes.phone) && + Objects.equals(this.suspicious, riskV1DecisionsPost201ResponseRiskInformationInfoCodes.suspicious) && + Objects.equals(this.globalVelocity, riskV1DecisionsPost201ResponseRiskInformationInfoCodes.globalVelocity); + } + + @Override + public int hashCode() { + return Objects.hash(velocity, address, customerList, identityChange, internet, phone, suspicious, globalVelocity); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RiskV1DecisionsPost201ResponseRiskInformationInfoCodes {\n"); + + sb.append(" velocity: ").append(toIndentedString(velocity)).append("\n"); + sb.append(" address: ").append(toIndentedString(address)).append("\n"); + sb.append(" customerList: ").append(toIndentedString(customerList)).append("\n"); + sb.append(" identityChange: ").append(toIndentedString(identityChange)).append("\n"); + sb.append(" internet: ").append(toIndentedString(internet)).append("\n"); + sb.append(" phone: ").append(toIndentedString(phone)).append("\n"); + sb.append(" suspicious: ").append(toIndentedString(suspicious)).append("\n"); + sb.append(" globalVelocity: ").append(toIndentedString(globalVelocity)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationIpAddress.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationIpAddress.java new file mode 100644 index 000000000..3e6fab2e7 --- /dev/null +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationIpAddress.java @@ -0,0 +1,186 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Contains detailed response information about the customer's IP address. + */ +@ApiModel(description = "Contains detailed response information about the customer's IP address.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class RiskV1DecisionsPost201ResponseRiskInformationIpAddress { + @SerializedName("anonymizerStatus") + private String anonymizerStatus = null; + + @SerializedName("city") + private String city = null; + + @SerializedName("country") + private String country = null; + + @SerializedName("state") + private String state = null; + + @SerializedName("routingMethod") + private String routingMethod = null; + + public RiskV1DecisionsPost201ResponseRiskInformationIpAddress anonymizerStatus(String anonymizerStatus) { + this.anonymizerStatus = anonymizerStatus; + return this; + } + + /** + * Indicates whether the transaction IP address is associated with a known anonymous proxy. For all possible values, Please refer to Simple Order API Developer Guide on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/)- Look for 'Reply Fields': \"afsReply_ipAnonymizerStatus\". + * @return anonymizerStatus + **/ + @ApiModelProperty(value = "Indicates whether the transaction IP address is associated with a known anonymous proxy. For all possible values, Please refer to Simple Order API Developer Guide on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/)- Look for 'Reply Fields': \"afsReply_ipAnonymizerStatus\". ") + public String getAnonymizerStatus() { + return anonymizerStatus; + } + + public void setAnonymizerStatus(String anonymizerStatus) { + this.anonymizerStatus = anonymizerStatus; + } + + public RiskV1DecisionsPost201ResponseRiskInformationIpAddress city(String city) { + this.city = city; + return this; + } + + /** + * Name of the city decoded from the IP address used directly or indirectly by the customer to send the order. + * @return city + **/ + @ApiModelProperty(value = "Name of the city decoded from the IP address used directly or indirectly by the customer to send the order. ") + public String getCity() { + return city; + } + + public void setCity(String city) { + this.city = city; + } + + public RiskV1DecisionsPost201ResponseRiskInformationIpAddress country(String country) { + this.country = country; + return this; + } + + /** + * Name of the country decoded from the IP address used directly or indirectly by the customer to send the order. + * @return country + **/ + @ApiModelProperty(value = "Name of the country decoded from the IP address used directly or indirectly by the customer to send the order. ") + public String getCountry() { + return country; + } + + public void setCountry(String country) { + this.country = country; + } + + public RiskV1DecisionsPost201ResponseRiskInformationIpAddress state(String state) { + this.state = state; + return this; + } + + /** + * Name of the state decoded from the IP address used directly or indirectly by the customer to send the order. + * @return state + **/ + @ApiModelProperty(value = "Name of the state decoded from the IP address used directly or indirectly by the customer to send the order. ") + public String getState() { + return state; + } + + public void setState(String state) { + this.state = state; + } + + public RiskV1DecisionsPost201ResponseRiskInformationIpAddress routingMethod(String routingMethod) { + this.routingMethod = routingMethod; + return this; + } + + /** + * Routing method decoded from the IP address used directly or indirectly by the customer to send the order. For all possible values, Please refer to Simple Order API Developer Guide on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/)- Look for 'Reply Fields': \"afsService_ipRoutingMethod \". + * @return routingMethod + **/ + @ApiModelProperty(value = "Routing method decoded from the IP address used directly or indirectly by the customer to send the order. For all possible values, Please refer to Simple Order API Developer Guide on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/)- Look for 'Reply Fields': \"afsService_ipRoutingMethod \". ") + public String getRoutingMethod() { + return routingMethod; + } + + public void setRoutingMethod(String routingMethod) { + this.routingMethod = routingMethod; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskV1DecisionsPost201ResponseRiskInformationIpAddress riskV1DecisionsPost201ResponseRiskInformationIpAddress = (RiskV1DecisionsPost201ResponseRiskInformationIpAddress) o; + return Objects.equals(this.anonymizerStatus, riskV1DecisionsPost201ResponseRiskInformationIpAddress.anonymizerStatus) && + Objects.equals(this.city, riskV1DecisionsPost201ResponseRiskInformationIpAddress.city) && + Objects.equals(this.country, riskV1DecisionsPost201ResponseRiskInformationIpAddress.country) && + Objects.equals(this.state, riskV1DecisionsPost201ResponseRiskInformationIpAddress.state) && + Objects.equals(this.routingMethod, riskV1DecisionsPost201ResponseRiskInformationIpAddress.routingMethod); + } + + @Override + public int hashCode() { + return Objects.hash(anonymizerStatus, city, country, state, routingMethod); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RiskV1DecisionsPost201ResponseRiskInformationIpAddress {\n"); + + sb.append(" anonymizerStatus: ").append(toIndentedString(anonymizerStatus)).append("\n"); + sb.append(" city: ").append(toIndentedString(city)).append("\n"); + sb.append(" country: ").append(toIndentedString(country)).append("\n"); + sb.append(" state: ").append(toIndentedString(state)).append("\n"); + sb.append(" routingMethod: ").append(toIndentedString(routingMethod)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation.java new file mode 100644 index 000000000..9c88d54b6 --- /dev/null +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation.java @@ -0,0 +1,186 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Contains response information about the payment. + */ +@ApiModel(description = "Contains response information about the payment.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation { + @SerializedName("binCountry") + private String binCountry = null; + + @SerializedName("accountType") + private String accountType = null; + + @SerializedName("issuer") + private String issuer = null; + + @SerializedName("scheme") + private String scheme = null; + + @SerializedName("bin") + private String bin = null; + + public RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation binCountry(String binCountry) { + this.binCountry = binCountry; + return this; + } + + /** + * Country (two-digit country code) associated with the BIN of the customer’s card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the Business Center. + * @return binCountry + **/ + @ApiModelProperty(value = "Country (two-digit country code) associated with the BIN of the customer’s card used for the payment. Returned if the information is available. Use this field for additional information when reviewing orders. This information is also displayed in the details page of the Business Center. ") + public String getBinCountry() { + return binCountry; + } + + public void setBinCountry(String binCountry) { + this.binCountry = binCountry; + } + + public RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation accountType(String accountType) { + this.accountType = accountType; + return this; + } + + /** + * Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. + * @return accountType + **/ + @ApiModelProperty(value = "Type of payment card account. This field can refer to a credit card, debit card, or prepaid card account type. ") + public String getAccountType() { + return accountType; + } + + public void setAccountType(String accountType) { + this.accountType = accountType; + } + + public RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation issuer(String issuer) { + this.issuer = issuer; + return this; + } + + /** + * Name of the bank or entity that issued the card account. + * @return issuer + **/ + @ApiModelProperty(value = "Name of the bank or entity that issued the card account.") + public String getIssuer() { + return issuer; + } + + public void setIssuer(String issuer) { + this.issuer = issuer; + } + + public RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation scheme(String scheme) { + this.scheme = scheme; + return this; + } + + /** + * Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron *Note:* Additional values may be present. + * @return scheme + **/ + @ApiModelProperty(value = "Subtype of card account. This field can contain one of the following values: - Maestro International - Maestro UK Domestic - MasterCard Credit - MasterCard Debit - Visa Credit - Visa Debit - Visa Electron *Note:* Additional values may be present. ") + public String getScheme() { + return scheme; + } + + public void setScheme(String scheme) { + this.scheme = scheme; + } + + public RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation bin(String bin) { + this.bin = bin; + return this; + } + + /** + * Credit card BIN (the first six digits of the credit card).Derived either from the `bin` request field or from the first six characters of the `number` field. + * @return bin + **/ + @ApiModelProperty(value = "Credit card BIN (the first six digits of the credit card).Derived either from the `bin` request field or from the first six characters of the `number` field. ") + public String getBin() { + return bin; + } + + public void setBin(String bin) { + this.bin = bin; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation riskV1DecisionsPost201ResponseRiskInformationPaymentInformation = (RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation) o; + return Objects.equals(this.binCountry, riskV1DecisionsPost201ResponseRiskInformationPaymentInformation.binCountry) && + Objects.equals(this.accountType, riskV1DecisionsPost201ResponseRiskInformationPaymentInformation.accountType) && + Objects.equals(this.issuer, riskV1DecisionsPost201ResponseRiskInformationPaymentInformation.issuer) && + Objects.equals(this.scheme, riskV1DecisionsPost201ResponseRiskInformationPaymentInformation.scheme) && + Objects.equals(this.bin, riskV1DecisionsPost201ResponseRiskInformationPaymentInformation.bin); + } + + @Override + public int hashCode() { + return Objects.hash(binCountry, accountType, issuer, scheme, bin); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RiskV1DecisionsPost201ResponseRiskInformationPaymentInformation {\n"); + + sb.append(" binCountry: ").append(toIndentedString(binCountry)).append("\n"); + sb.append(" accountType: ").append(toIndentedString(accountType)).append("\n"); + sb.append(" issuer: ").append(toIndentedString(issuer)).append("\n"); + sb.append(" scheme: ").append(toIndentedString(scheme)).append("\n"); + sb.append(" bin: ").append(toIndentedString(bin)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProfile.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProfile.java new file mode 100644 index 000000000..22e073de1 --- /dev/null +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProfile.java @@ -0,0 +1,139 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * RiskV1DecisionsPost201ResponseRiskInformationProfile + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class RiskV1DecisionsPost201ResponseRiskInformationProfile { + @SerializedName("name") + private String name = null; + + @SerializedName("desinationQueue") + private String desinationQueue = null; + + @SerializedName("selectorRule") + private String selectorRule = null; + + public RiskV1DecisionsPost201ResponseRiskInformationProfile name(String name) { + this.name = name; + return this; + } + + /** + * Name of the active profile chosen by the profile selector. If no profile selector exists, the default active profile is chosen. + * @return name + **/ + @ApiModelProperty(value = "Name of the active profile chosen by the profile selector. If no profile selector exists, the default active profile is chosen. ") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public RiskV1DecisionsPost201ResponseRiskInformationProfile desinationQueue(String desinationQueue) { + this.desinationQueue = desinationQueue; + return this; + } + + /** + * Name of the queue where orders that are not automatically accepted are sent. + * @return desinationQueue + **/ + @ApiModelProperty(value = "Name of the queue where orders that are not automatically accepted are sent. ") + public String getDesinationQueue() { + return desinationQueue; + } + + public void setDesinationQueue(String desinationQueue) { + this.desinationQueue = desinationQueue; + } + + public RiskV1DecisionsPost201ResponseRiskInformationProfile selectorRule(String selectorRule) { + this.selectorRule = selectorRule; + return this; + } + + /** + * Name of the profile selector rule that chooses the profile to use for the transaction. If no profile selector exists, the value is Default Active Profile. + * @return selectorRule + **/ + @ApiModelProperty(value = "Name of the profile selector rule that chooses the profile to use for the transaction. If no profile selector exists, the value is Default Active Profile. ") + public String getSelectorRule() { + return selectorRule; + } + + public void setSelectorRule(String selectorRule) { + this.selectorRule = selectorRule; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskV1DecisionsPost201ResponseRiskInformationProfile riskV1DecisionsPost201ResponseRiskInformationProfile = (RiskV1DecisionsPost201ResponseRiskInformationProfile) o; + return Objects.equals(this.name, riskV1DecisionsPost201ResponseRiskInformationProfile.name) && + Objects.equals(this.desinationQueue, riskV1DecisionsPost201ResponseRiskInformationProfile.desinationQueue) && + Objects.equals(this.selectorRule, riskV1DecisionsPost201ResponseRiskInformationProfile.selectorRule); + } + + @Override + public int hashCode() { + return Objects.hash(name, desinationQueue, selectorRule); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RiskV1DecisionsPost201ResponseRiskInformationProfile {\n"); + + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" desinationQueue: ").append(toIndentedString(desinationQueue)).append("\n"); + sb.append(" selectorRule: ").append(toIndentedString(selectorRule)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProviders.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProviders.java new file mode 100644 index 000000000..119e5a790 --- /dev/null +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProviders.java @@ -0,0 +1,104 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * RiskV1DecisionsPost201ResponseRiskInformationProviders + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class RiskV1DecisionsPost201ResponseRiskInformationProviders { + @SerializedName("providerName") + private List providerName = null; + + public RiskV1DecisionsPost201ResponseRiskInformationProviders providerName(List providerName) { + this.providerName = providerName; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationProviders addProviderNameItem(RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName providerNameItem) { + if (this.providerName == null) { + this.providerName = new ArrayList(); + } + this.providerName.add(providerNameItem); + return this; + } + + /** + * Get providerName + * @return providerName + **/ + @ApiModelProperty(value = "") + public List getProviderName() { + return providerName; + } + + public void setProviderName(List providerName) { + this.providerName = providerName; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskV1DecisionsPost201ResponseRiskInformationProviders riskV1DecisionsPost201ResponseRiskInformationProviders = (RiskV1DecisionsPost201ResponseRiskInformationProviders) o; + return Objects.equals(this.providerName, riskV1DecisionsPost201ResponseRiskInformationProviders.providerName); + } + + @Override + public int hashCode() { + return Objects.hash(providerName); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RiskV1DecisionsPost201ResponseRiskInformationProviders {\n"); + + sb.append(" providerName: ").append(toIndentedString(providerName)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.java new file mode 100644 index 000000000..2e8c8b379 --- /dev/null +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.java @@ -0,0 +1,135 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * Name of the 3rd party provider, for example, Emailage. + */ +@ApiModel(description = "Name of the 3rd party provider, for example, Emailage.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName { + @SerializedName("fieldName") + private List fieldName = null; + + @SerializedName("fieldValue") + private List fieldValue = null; + + public RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName fieldName(List fieldName) { + this.fieldName = fieldName; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName addFieldNameItem(String fieldNameItem) { + if (this.fieldName == null) { + this.fieldName = new ArrayList(); + } + this.fieldName.add(fieldNameItem); + return this; + } + + /** + * Get fieldName + * @return fieldName + **/ + @ApiModelProperty(value = "") + public List getFieldName() { + return fieldName; + } + + public void setFieldName(List fieldName) { + this.fieldName = fieldName; + } + + public RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName fieldValue(List fieldValue) { + this.fieldValue = fieldValue; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName addFieldValueItem(String fieldValueItem) { + if (this.fieldValue == null) { + this.fieldValue = new ArrayList(); + } + this.fieldValue.add(fieldValueItem); + return this; + } + + /** + * Get fieldValue + * @return fieldValue + **/ + @ApiModelProperty(value = "") + public List getFieldValue() { + return fieldValue; + } + + public void setFieldValue(List fieldValue) { + this.fieldValue = fieldValue; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName riskV1DecisionsPost201ResponseRiskInformationProvidersProviderName = (RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName) o; + return Objects.equals(this.fieldName, riskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.fieldName) && + Objects.equals(this.fieldValue, riskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.fieldValue); + } + + @Override + public int hashCode() { + return Objects.hash(fieldName, fieldValue); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName {\n"); + + sb.append(" fieldName: ").append(toIndentedString(fieldName)).append("\n"); + sb.append(" fieldValue: ").append(toIndentedString(fieldValue)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationRules.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationRules.java new file mode 100644 index 000000000..98eb70b43 --- /dev/null +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationRules.java @@ -0,0 +1,116 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * RiskV1DecisionsPost201ResponseRiskInformationRules + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class RiskV1DecisionsPost201ResponseRiskInformationRules { + @SerializedName("name") + private String name = null; + + @SerializedName("decision") + private String decision = null; + + public RiskV1DecisionsPost201ResponseRiskInformationRules name(String name) { + this.name = name; + return this; + } + + /** + * Description of the rule as it appears in the Profile Editor. + * @return name + **/ + @ApiModelProperty(value = "Description of the rule as it appears in the Profile Editor.") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public RiskV1DecisionsPost201ResponseRiskInformationRules decision(String decision) { + this.decision = decision; + return this; + } + + /** + * Summarizes the result for the rule according to the setting that you chose in the Profile Editor. This field can contain one of the following values: - `IGNORE` - `REVIEW` - `REJECT` - `ACCEPT` + * @return decision + **/ + @ApiModelProperty(value = "Summarizes the result for the rule according to the setting that you chose in the Profile Editor. This field can contain one of the following values: - `IGNORE` - `REVIEW` - `REJECT` - `ACCEPT` ") + public String getDecision() { + return decision; + } + + public void setDecision(String decision) { + this.decision = decision; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskV1DecisionsPost201ResponseRiskInformationRules riskV1DecisionsPost201ResponseRiskInformationRules = (RiskV1DecisionsPost201ResponseRiskInformationRules) o; + return Objects.equals(this.name, riskV1DecisionsPost201ResponseRiskInformationRules.name) && + Objects.equals(this.decision, riskV1DecisionsPost201ResponseRiskInformationRules.decision); + } + + @Override + public int hashCode() { + return Objects.hash(name, decision); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RiskV1DecisionsPost201ResponseRiskInformationRules {\n"); + + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" decision: ").append(toIndentedString(decision)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationScore.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationScore.java new file mode 100644 index 000000000..b010245e8 --- /dev/null +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationScore.java @@ -0,0 +1,149 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * RiskV1DecisionsPost201ResponseRiskInformationScore + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class RiskV1DecisionsPost201ResponseRiskInformationScore { + @SerializedName("factorCodes") + private List factorCodes = null; + + @SerializedName("modelUsed") + private String modelUsed = null; + + @SerializedName("result") + private String result = null; + + public RiskV1DecisionsPost201ResponseRiskInformationScore factorCodes(List factorCodes) { + this.factorCodes = factorCodes; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationScore addFactorCodesItem(String factorCodesItem) { + if (this.factorCodes == null) { + this.factorCodes = new ArrayList(); + } + this.factorCodes.add(factorCodesItem); + return this; + } + + /** + * Get factorCodes + * @return factorCodes + **/ + @ApiModelProperty(value = "") + public List getFactorCodes() { + return factorCodes; + } + + public void setFactorCodes(List factorCodes) { + this.factorCodes = factorCodes; + } + + public RiskV1DecisionsPost201ResponseRiskInformationScore modelUsed(String modelUsed) { + this.modelUsed = modelUsed; + return this; + } + + /** + * Name of the score model used for the transaction. If you did not include a custom model in your request, this field contains the name of CyberSource’s default model. + * @return modelUsed + **/ + @ApiModelProperty(value = "Name of the score model used for the transaction. If you did not include a custom model in your request, this field contains the name of CyberSource’s default model. ") + public String getModelUsed() { + return modelUsed; + } + + public void setModelUsed(String modelUsed) { + this.modelUsed = modelUsed; + } + + public RiskV1DecisionsPost201ResponseRiskInformationScore result(String result) { + this.result = result; + return this; + } + + /** + * Total score calculated for this order. The value cannot be negative. + * @return result + **/ + @ApiModelProperty(value = "Total score calculated for this order. The value cannot be negative. ") + public String getResult() { + return result; + } + + public void setResult(String result) { + this.result = result; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskV1DecisionsPost201ResponseRiskInformationScore riskV1DecisionsPost201ResponseRiskInformationScore = (RiskV1DecisionsPost201ResponseRiskInformationScore) o; + return Objects.equals(this.factorCodes, riskV1DecisionsPost201ResponseRiskInformationScore.factorCodes) && + Objects.equals(this.modelUsed, riskV1DecisionsPost201ResponseRiskInformationScore.modelUsed) && + Objects.equals(this.result, riskV1DecisionsPost201ResponseRiskInformationScore.result); + } + + @Override + public int hashCode() { + return Objects.hash(factorCodes, modelUsed, result); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RiskV1DecisionsPost201ResponseRiskInformationScore {\n"); + + sb.append(" factorCodes: ").append(toIndentedString(factorCodes)).append("\n"); + sb.append(" modelUsed: ").append(toIndentedString(modelUsed)).append("\n"); + sb.append(" result: ").append(toIndentedString(result)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocity.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocity.java new file mode 100644 index 000000000..6ca641c4b --- /dev/null +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocity.java @@ -0,0 +1,135 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * RiskV1DecisionsPost201ResponseRiskInformationVelocity + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class RiskV1DecisionsPost201ResponseRiskInformationVelocity { + @SerializedName("morphing") + private List morphing = null; + + @SerializedName("address") + private List address = null; + + public RiskV1DecisionsPost201ResponseRiskInformationVelocity morphing(List morphing) { + this.morphing = morphing; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationVelocity addMorphingItem(RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing morphingItem) { + if (this.morphing == null) { + this.morphing = new ArrayList(); + } + this.morphing.add(morphingItem); + return this; + } + + /** + * Get morphing + * @return morphing + **/ + @ApiModelProperty(value = "") + public List getMorphing() { + return morphing; + } + + public void setMorphing(List morphing) { + this.morphing = morphing; + } + + public RiskV1DecisionsPost201ResponseRiskInformationVelocity address(List address) { + this.address = address; + return this; + } + + public RiskV1DecisionsPost201ResponseRiskInformationVelocity addAddressItem(String addressItem) { + if (this.address == null) { + this.address = new ArrayList(); + } + this.address.add(addressItem); + return this; + } + + /** + * Get address + * @return address + **/ + @ApiModelProperty(value = "") + public List getAddress() { + return address; + } + + public void setAddress(List address) { + this.address = address; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskV1DecisionsPost201ResponseRiskInformationVelocity riskV1DecisionsPost201ResponseRiskInformationVelocity = (RiskV1DecisionsPost201ResponseRiskInformationVelocity) o; + return Objects.equals(this.morphing, riskV1DecisionsPost201ResponseRiskInformationVelocity.morphing) && + Objects.equals(this.address, riskV1DecisionsPost201ResponseRiskInformationVelocity.address); + } + + @Override + public int hashCode() { + return Objects.hash(morphing, address); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RiskV1DecisionsPost201ResponseRiskInformationVelocity {\n"); + + sb.append(" morphing: ").append(toIndentedString(morphing)).append("\n"); + sb.append(" address: ").append(toIndentedString(address)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.java new file mode 100644 index 000000000..fbb91038b --- /dev/null +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.java @@ -0,0 +1,139 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing { + @SerializedName("count") + private Integer count = null; + + @SerializedName("fieldName") + private String fieldName = null; + + @SerializedName("informationCode") + private String informationCode = null; + + public RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing count(Integer count) { + this.count = count; + return this; + } + + /** + * Morphing count. Note The count is not returned for the initial transaction. + * @return count + **/ + @ApiModelProperty(value = "Morphing count. Note The count is not returned for the initial transaction.") + public Integer getCount() { + return count; + } + + public void setCount(Integer count) { + this.count = count; + } + + public RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing fieldName(String fieldName) { + this.fieldName = fieldName; + return this; + } + + /** + * Field name of the morphing element. specified by the setting that you chose in the Velocity Editor. For all possible values, Please refer to Simple Order API Developer Guide on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/) - Look for 'Reply Fields': \"decisionReply_morphingElement_#_fieldName\". + * @return fieldName + **/ + @ApiModelProperty(value = "Field name of the morphing element. specified by the setting that you chose in the Velocity Editor. For all possible values, Please refer to Simple Order API Developer Guide on [CyberSource Business Center](https://ebc2.cybersource.com/ebc2/) - Look for 'Reply Fields': \"decisionReply_morphingElement_#_fieldName\". ") + public String getFieldName() { + return fieldName; + } + + public void setFieldName(String fieldName) { + this.fieldName = fieldName; + } + + public RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing informationCode(String informationCode) { + this.informationCode = informationCode; + return this; + } + + /** + * Identifier that CYBS assigned to the velocity rule specified by the number. + * @return informationCode + **/ + @ApiModelProperty(value = "Identifier that CYBS assigned to the velocity rule specified by the number.") + public String getInformationCode() { + return informationCode; + } + + public void setInformationCode(String informationCode) { + this.informationCode = informationCode; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing riskV1DecisionsPost201ResponseRiskInformationVelocityMorphing = (RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing) o; + return Objects.equals(this.count, riskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.count) && + Objects.equals(this.fieldName, riskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.fieldName) && + Objects.equals(this.informationCode, riskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.informationCode); + } + + @Override + public int hashCode() { + return Objects.hash(count, fieldName, informationCode); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing {\n"); + + sb.append(" count: ").append(toIndentedString(count)).append("\n"); + sb.append(" fieldName: ").append(toIndentedString(fieldName)).append("\n"); + sb.append(" informationCode: ").append(toIndentedString(informationCode)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/UmsV1UsersGet400Response.java b/src/main/java/Model/RiskV1DecisionsPost400Response.java similarity index 54% rename from src/main/java/Model/UmsV1UsersGet400Response.java rename to src/main/java/Model/RiskV1DecisionsPost400Response.java index 6e7125b55..e40f00056 100644 --- a/src/main/java/Model/UmsV1UsersGet400Response.java +++ b/src/main/java/Model/RiskV1DecisionsPost400Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.PtsV2PayoutsPost201ResponseErrorInformationDetails; +import Model.PtsV2PaymentsPost201ResponseErrorInformationDetails; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -27,15 +27,15 @@ import java.util.List; /** - * UmsV1UsersGet400Response + * RiskV1DecisionsPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class UmsV1UsersGet400Response { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class RiskV1DecisionsPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; /** - * The status of the submitted transaction. + * The status of the submitted transaction. Possible values: - INVALID_REQUEST */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { @@ -82,82 +82,25 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { @SerializedName("status") private StatusEnum status = null; - /** - * The reason of the status. - */ - @JsonAdapter(ReasonEnum.Adapter.class) - public enum ReasonEnum { - MISSING_FIELD("MISSING_FIELD"), - - INVALID_DATA("INVALID_DATA"), - - DUPLICATE_REQUEST("DUPLICATE_REQUEST"), - - INVALID_CARD("INVALID_CARD"), - - INVALID_MERCHANT_CONFIGURATION("INVALID_MERCHANT_CONFIGURATION"), - - CAPTURE_ALREADY_VOIDED("CAPTURE_ALREADY_VOIDED"), - - ACCOUNT_NOT_ALLOWED_CREDIT("ACCOUNT_NOT_ALLOWED_CREDIT"); - - private String value; - - ReasonEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static ReasonEnum fromValue(String text) { - for (ReasonEnum b : ReasonEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final ReasonEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public ReasonEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return ReasonEnum.fromValue(String.valueOf(value)); - } - } - } - @SerializedName("reason") - private ReasonEnum reason = null; + private String reason = null; @SerializedName("message") private String message = null; @SerializedName("details") - private List details = null; + private List details = null; - public UmsV1UsersGet400Response submitTimeUtc(String submitTimeUtc) { + public RiskV1DecisionsPost400Response submitTimeUtc(String submitTimeUtc) { this.submitTimeUtc = submitTimeUtc; return this; } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } @@ -166,16 +109,16 @@ public void setSubmitTimeUtc(String submitTimeUtc) { this.submitTimeUtc = submitTimeUtc; } - public UmsV1UsersGet400Response status(StatusEnum status) { + public RiskV1DecisionsPost400Response status(StatusEnum status) { this.status = status; return this; } /** - * The status of the submitted transaction. + * The status of the submitted transaction. Possible values: - INVALID_REQUEST * @return status **/ - @ApiModelProperty(value = "The status of the submitted transaction.") + @ApiModelProperty(value = "The status of the submitted transaction. Possible values: - INVALID_REQUEST ") public StatusEnum getStatus() { return status; } @@ -184,25 +127,25 @@ public void setStatus(StatusEnum status) { this.status = status; } - public UmsV1UsersGet400Response reason(ReasonEnum reason) { + public RiskV1DecisionsPost400Response reason(String reason) { this.reason = reason; return this; } /** - * The reason of the status. + * The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_MERCHANT_CONFIGURATION - PROCESSOR_UNAVAILABLE * @return reason **/ - @ApiModelProperty(value = "The reason of the status. ") - public ReasonEnum getReason() { + @ApiModelProperty(value = "The reason of the status. Possible values: - MISSING_FIELD - INVALID_DATA - DUPLICATE_REQUEST - INVALID_MERCHANT_CONFIGURATION - PROCESSOR_UNAVAILABLE ") + public String getReason() { return reason; } - public void setReason(ReasonEnum reason) { + public void setReason(String reason) { this.reason = reason; } - public UmsV1UsersGet400Response message(String message) { + public RiskV1DecisionsPost400Response message(String message) { this.message = message; return this; } @@ -220,14 +163,14 @@ public void setMessage(String message) { this.message = message; } - public UmsV1UsersGet400Response details(List details) { + public RiskV1DecisionsPost400Response details(List details) { this.details = details; return this; } - public UmsV1UsersGet400Response addDetailsItem(PtsV2PayoutsPost201ResponseErrorInformationDetails detailsItem) { + public RiskV1DecisionsPost400Response addDetailsItem(PtsV2PaymentsPost201ResponseErrorInformationDetails detailsItem) { if (this.details == null) { - this.details = new ArrayList(); + this.details = new ArrayList(); } this.details.add(detailsItem); return this; @@ -238,11 +181,11 @@ public UmsV1UsersGet400Response addDetailsItem(PtsV2PayoutsPost201ResponseErrorI * @return details **/ @ApiModelProperty(value = "") - public List getDetails() { + public List getDetails() { return details; } - public void setDetails(List details) { + public void setDetails(List details) { this.details = details; } @@ -255,12 +198,12 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - UmsV1UsersGet400Response umsV1UsersGet400Response = (UmsV1UsersGet400Response) o; - return Objects.equals(this.submitTimeUtc, umsV1UsersGet400Response.submitTimeUtc) && - Objects.equals(this.status, umsV1UsersGet400Response.status) && - Objects.equals(this.reason, umsV1UsersGet400Response.reason) && - Objects.equals(this.message, umsV1UsersGet400Response.message) && - Objects.equals(this.details, umsV1UsersGet400Response.details); + RiskV1DecisionsPost400Response riskV1DecisionsPost400Response = (RiskV1DecisionsPost400Response) o; + return Objects.equals(this.submitTimeUtc, riskV1DecisionsPost400Response.submitTimeUtc) && + Objects.equals(this.status, riskV1DecisionsPost400Response.status) && + Objects.equals(this.reason, riskV1DecisionsPost400Response.reason) && + Objects.equals(this.message, riskV1DecisionsPost400Response.message) && + Objects.equals(this.details, riskV1DecisionsPost400Response.details); } @Override @@ -272,7 +215,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class UmsV1UsersGet400Response {\n"); + sb.append("class RiskV1DecisionsPost400Response {\n"); sb.append(" submitTimeUtc: ").append(toIndentedString(submitTimeUtc)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); diff --git a/src/main/java/Model/Riskv1decisionsBuyerInformation.java b/src/main/java/Model/Riskv1decisionsBuyerInformation.java new file mode 100644 index 000000000..aef2878b0 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsBuyerInformation.java @@ -0,0 +1,151 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.Ptsv2paymentsBuyerInformationPersonalIdentification; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * Contains information about the buyer. + */ +@ApiModel(description = "Contains information about the buyer.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsBuyerInformation { + @SerializedName("hashedPassword") + private String hashedPassword = null; + + @SerializedName("dateOfBirth") + private String dateOfBirth = null; + + @SerializedName("personalIdentification") + private List personalIdentification = null; + + public Riskv1decisionsBuyerInformation hashedPassword(String hashedPassword) { + this.hashedPassword = hashedPassword; + return this; + } + + /** + * The description for this field is not available. + * @return hashedPassword + **/ + @ApiModelProperty(value = "The description for this field is not available. ") + public String getHashedPassword() { + return hashedPassword; + } + + public void setHashedPassword(String hashedPassword) { + this.hashedPassword = hashedPassword; + } + + public Riskv1decisionsBuyerInformation dateOfBirth(String dateOfBirth) { + this.dateOfBirth = dateOfBirth; + return this; + } + + /** + * Recipient’s date of birth. **Format**: `YYYYMMDD`. This field is a pass-through, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see \"Recipients,\" page 224. + * @return dateOfBirth + **/ + @ApiModelProperty(value = "Recipient’s date of birth. **Format**: `YYYYMMDD`. This field is a pass-through, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. For more details, see \"Recipients,\" page 224. ") + public String getDateOfBirth() { + return dateOfBirth; + } + + public void setDateOfBirth(String dateOfBirth) { + this.dateOfBirth = dateOfBirth; + } + + public Riskv1decisionsBuyerInformation personalIdentification(List personalIdentification) { + this.personalIdentification = personalIdentification; + return this; + } + + public Riskv1decisionsBuyerInformation addPersonalIdentificationItem(Ptsv2paymentsBuyerInformationPersonalIdentification personalIdentificationItem) { + if (this.personalIdentification == null) { + this.personalIdentification = new ArrayList(); + } + this.personalIdentification.add(personalIdentificationItem); + return this; + } + + /** + * Get personalIdentification + * @return personalIdentification + **/ + @ApiModelProperty(value = "") + public List getPersonalIdentification() { + return personalIdentification; + } + + public void setPersonalIdentification(List personalIdentification) { + this.personalIdentification = personalIdentification; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsBuyerInformation riskv1decisionsBuyerInformation = (Riskv1decisionsBuyerInformation) o; + return Objects.equals(this.hashedPassword, riskv1decisionsBuyerInformation.hashedPassword) && + Objects.equals(this.dateOfBirth, riskv1decisionsBuyerInformation.dateOfBirth) && + Objects.equals(this.personalIdentification, riskv1decisionsBuyerInformation.personalIdentification); + } + + @Override + public int hashCode() { + return Objects.hash(hashedPassword, dateOfBirth, personalIdentification); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsBuyerInformation {\n"); + + sb.append(" hashedPassword: ").append(toIndentedString(hashedPassword)).append("\n"); + sb.append(" dateOfBirth: ").append(toIndentedString(dateOfBirth)).append("\n"); + sb.append(" personalIdentification: ").append(toIndentedString(personalIdentification)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsCardVerification.java b/src/main/java/Model/Riskv1decisionsCardVerification.java new file mode 100644 index 000000000..ea01e16a6 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsCardVerification.java @@ -0,0 +1,93 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Riskv1decisionsCardVerification + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsCardVerification { + @SerializedName("resultCode") + private String resultCode = null; + + public Riskv1decisionsCardVerification resultCode(String resultCode) { + this.resultCode = resultCode; + return this; + } + + /** + * Result of card verification. Returned by the authorization service in the `processorInformation.cardVerification.resultCode` reply field. If ics_auth and ics_score are requested at the same time, the value is automatically passed from ics_auth to ics_score. For more information on using this field, see \"\"Sending the Results of Address and Card Verification Tests,\"\" page 16. The field contains one of the following values: - `I`: Card verification number failed processor's data validation check. - `M`: Card verification number matched. - `N`: Card verification number not matched. - `P`: Card verification number not processed. - `S`: Card verification number is on the card but was not included in the request. - `U`: Card verification is not supported by the issuing bank. - `X`: Card verification is not supported by the payment card company. - Space Character: Deprecated. Ignore this value. - `1`: CyberSource does not support card verification for this processor or card type. - `2`: Processor returned value unrecognized for card verification response. - `3`: Processor did not return card verification result code. + * @return resultCode + **/ + @ApiModelProperty(value = "Result of card verification. Returned by the authorization service in the `processorInformation.cardVerification.resultCode` reply field. If ics_auth and ics_score are requested at the same time, the value is automatically passed from ics_auth to ics_score. For more information on using this field, see \"\"Sending the Results of Address and Card Verification Tests,\"\" page 16. The field contains one of the following values: - `I`: Card verification number failed processor's data validation check. - `M`: Card verification number matched. - `N`: Card verification number not matched. - `P`: Card verification number not processed. - `S`: Card verification number is on the card but was not included in the request. - `U`: Card verification is not supported by the issuing bank. - `X`: Card verification is not supported by the payment card company. - Space Character: Deprecated. Ignore this value. - `1`: CyberSource does not support card verification for this processor or card type. - `2`: Processor returned value unrecognized for card verification response. - `3`: Processor did not return card verification result code. ") + public String getResultCode() { + return resultCode; + } + + public void setResultCode(String resultCode) { + this.resultCode = resultCode; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsCardVerification riskv1decisionsCardVerification = (Riskv1decisionsCardVerification) o; + return Objects.equals(this.resultCode, riskv1decisionsCardVerification.resultCode); + } + + @Override + public int hashCode() { + return Objects.hash(resultCode); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsCardVerification {\n"); + + sb.append(" resultCode: ").append(toIndentedString(resultCode)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsClientReferenceInformation.java b/src/main/java/Model/Riskv1decisionsClientReferenceInformation.java new file mode 100644 index 000000000..5a84a3461 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsClientReferenceInformation.java @@ -0,0 +1,116 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Riskv1decisionsClientReferenceInformation + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsClientReferenceInformation { + @SerializedName("code") + private String code = null; + + @SerializedName("comments") + private String comments = null; + + public Riskv1decisionsClientReferenceInformation code(String code) { + this.code = code; + return this; + } + + /** + * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. + * @return code + **/ + @ApiModelProperty(value = "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ") + public String getCode() { + return code; + } + + public void setCode(String code) { + this.code = code; + } + + public Riskv1decisionsClientReferenceInformation comments(String comments) { + this.comments = comments; + return this; + } + + /** + * Brief description of the order or any comment you wish to add to the order. + * @return comments + **/ + @ApiModelProperty(value = "Brief description of the order or any comment you wish to add to the order.") + public String getComments() { + return comments; + } + + public void setComments(String comments) { + this.comments = comments; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsClientReferenceInformation riskv1decisionsClientReferenceInformation = (Riskv1decisionsClientReferenceInformation) o; + return Objects.equals(this.code, riskv1decisionsClientReferenceInformation.code) && + Objects.equals(this.comments, riskv1decisionsClientReferenceInformation.comments); + } + + @Override + public int hashCode() { + return Objects.hash(code, comments); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsClientReferenceInformation {\n"); + + sb.append(" code: ").append(toIndentedString(code)).append("\n"); + sb.append(" comments: ").append(toIndentedString(comments)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsDeviceInformation.java b/src/main/java/Model/Riskv1decisionsDeviceInformation.java new file mode 100644 index 000000000..b20b54e17 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsDeviceInformation.java @@ -0,0 +1,208 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Riskv1decisionsDeviceInformation + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsDeviceInformation { + @SerializedName("cookiesAccepted") + private String cookiesAccepted = null; + + @SerializedName("ipAddress") + private String ipAddress = null; + + @SerializedName("hostName") + private String hostName = null; + + @SerializedName("fingerprintSessionId") + private String fingerprintSessionId = null; + + @SerializedName("httpBrowserEmail") + private String httpBrowserEmail = null; + + @SerializedName("userAgent") + private String userAgent = null; + + public Riskv1decisionsDeviceInformation cookiesAccepted(String cookiesAccepted) { + this.cookiesAccepted = cookiesAccepted; + return this; + } + + /** + * Boolean that indicates whether the customer’s browser accepts cookies. This field can contain one of the following values: - `yes`: The customer’s browser accepts cookies. - `no`: The customer’s browser does not accept cookies. + * @return cookiesAccepted + **/ + @ApiModelProperty(value = "Boolean that indicates whether the customer’s browser accepts cookies. This field can contain one of the following values: - `yes`: The customer’s browser accepts cookies. - `no`: The customer’s browser does not accept cookies. ") + public String getCookiesAccepted() { + return cookiesAccepted; + } + + public void setCookiesAccepted(String cookiesAccepted) { + this.cookiesAccepted = cookiesAccepted; + } + + public Riskv1decisionsDeviceInformation ipAddress(String ipAddress) { + this.ipAddress = ipAddress; + return this; + } + + /** + * Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information. + * @return ipAddress + **/ + @ApiModelProperty(value = "Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information. ") + public String getIpAddress() { + return ipAddress; + } + + public void setIpAddress(String ipAddress) { + this.ipAddress = ipAddress; + } + + public Riskv1decisionsDeviceInformation hostName(String hostName) { + this.hostName = hostName; + return this; + } + + /** + * Host name reported by the customer’s browser to your Web server identified via the HTTP header. + * @return hostName + **/ + @ApiModelProperty(value = "Host name reported by the customer’s browser to your Web server identified via the HTTP header.") + public String getHostName() { + return hostName; + } + + public void setHostName(String hostName) { + this.hostName = hostName; + } + + public Riskv1decisionsDeviceInformation fingerprintSessionId(String fingerprintSessionId) { + this.fingerprintSessionId = fingerprintSessionId; + return this; + } + + /** + * Contains the session ID that you send to Decision Manager to obtain the device fingerprint information. The string can contain uppercase and lowercase letters, digits, hyphen (-), and underscore (_). However, do not use the same uppercase and lowercase letters to indicate different session IDs. The session ID must be unique for each merchant ID. You can use any string that you are already generating, such as an order number or web session ID.The session ID must be unique for each page load, regardless of an individual’s web session ID. If the same user navigates to a profiled page and is assigned a web session, navigates away from the profiled page, then navigates back to the profiled page, the generated session ID should be different and unique. An example of an ideal session ID would be a web session ID plus the timestamp. This measure ensures that a unique ID is generated every time the page is loaded, even if it is the same user reloading the page. + * @return fingerprintSessionId + **/ + @ApiModelProperty(value = "Contains the session ID that you send to Decision Manager to obtain the device fingerprint information. The string can contain uppercase and lowercase letters, digits, hyphen (-), and underscore (_). However, do not use the same uppercase and lowercase letters to indicate different session IDs. The session ID must be unique for each merchant ID. You can use any string that you are already generating, such as an order number or web session ID.The session ID must be unique for each page load, regardless of an individual’s web session ID. If the same user navigates to a profiled page and is assigned a web session, navigates away from the profiled page, then navigates back to the profiled page, the generated session ID should be different and unique. An example of an ideal session ID would be a web session ID plus the timestamp. This measure ensures that a unique ID is generated every time the page is loaded, even if it is the same user reloading the page. ") + public String getFingerprintSessionId() { + return fingerprintSessionId; + } + + public void setFingerprintSessionId(String fingerprintSessionId) { + this.fingerprintSessionId = fingerprintSessionId; + } + + public Riskv1decisionsDeviceInformation httpBrowserEmail(String httpBrowserEmail) { + this.httpBrowserEmail = httpBrowserEmail; + return this; + } + + /** + * Email address set in the customer’s browser, which may differ from customer email. + * @return httpBrowserEmail + **/ + @ApiModelProperty(value = "Email address set in the customer’s browser, which may differ from customer email. ") + public String getHttpBrowserEmail() { + return httpBrowserEmail; + } + + public void setHttpBrowserEmail(String httpBrowserEmail) { + this.httpBrowserEmail = httpBrowserEmail; + } + + public Riskv1decisionsDeviceInformation userAgent(String userAgent) { + this.userAgent = userAgent; + return this; + } + + /** + * Customer’s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies the Netscape browser. + * @return userAgent + **/ + @ApiModelProperty(value = "Customer’s browser as identified from the HTTP header data. For example, Mozilla is the value that identifies the Netscape browser. ") + public String getUserAgent() { + return userAgent; + } + + public void setUserAgent(String userAgent) { + this.userAgent = userAgent; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsDeviceInformation riskv1decisionsDeviceInformation = (Riskv1decisionsDeviceInformation) o; + return Objects.equals(this.cookiesAccepted, riskv1decisionsDeviceInformation.cookiesAccepted) && + Objects.equals(this.ipAddress, riskv1decisionsDeviceInformation.ipAddress) && + Objects.equals(this.hostName, riskv1decisionsDeviceInformation.hostName) && + Objects.equals(this.fingerprintSessionId, riskv1decisionsDeviceInformation.fingerprintSessionId) && + Objects.equals(this.httpBrowserEmail, riskv1decisionsDeviceInformation.httpBrowserEmail) && + Objects.equals(this.userAgent, riskv1decisionsDeviceInformation.userAgent); + } + + @Override + public int hashCode() { + return Objects.hash(cookiesAccepted, ipAddress, hostName, fingerprintSessionId, httpBrowserEmail, userAgent); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsDeviceInformation {\n"); + + sb.append(" cookiesAccepted: ").append(toIndentedString(cookiesAccepted)).append("\n"); + sb.append(" ipAddress: ").append(toIndentedString(ipAddress)).append("\n"); + sb.append(" hostName: ").append(toIndentedString(hostName)).append("\n"); + sb.append(" fingerprintSessionId: ").append(toIndentedString(fingerprintSessionId)).append("\n"); + sb.append(" httpBrowserEmail: ").append(toIndentedString(httpBrowserEmail)).append("\n"); + sb.append(" userAgent: ").append(toIndentedString(userAgent)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsMerchantDefinedInformation.java b/src/main/java/Model/Riskv1decisionsMerchantDefinedInformation.java new file mode 100644 index 000000000..f0a382508 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsMerchantDefinedInformation.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Contains merchant-defined key-value pairs. + */ +@ApiModel(description = "Contains merchant-defined key-value pairs.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsMerchantDefinedInformation { + @SerializedName("key") + private String key = null; + + @SerializedName("value") + private String value = null; + + public Riskv1decisionsMerchantDefinedInformation key(String key) { + this.key = key; + return this; + } + + /** + * Fields that you can use to store information. The value appears in the Case Management Details window in the Business Center. The first four fields are the same fields that are used by the Secure Data services. See request code examples. Warning Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. + * @return key + **/ + @ApiModelProperty(value = "Fields that you can use to store information. The value appears in the Case Management Details window in the Business Center. The first four fields are the same fields that are used by the Secure Data services. See request code examples. Warning Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not limited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV, CVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension. ") + public String getKey() { + return key; + } + + public void setKey(String key) { + this.key = key; + } + + public Riskv1decisionsMerchantDefinedInformation value(String value) { + this.value = value; + return this; + } + + /** + * String value for the key + * @return value + **/ + @ApiModelProperty(value = "String value for the key") + public String getValue() { + return value; + } + + public void setValue(String value) { + this.value = value; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsMerchantDefinedInformation riskv1decisionsMerchantDefinedInformation = (Riskv1decisionsMerchantDefinedInformation) o; + return Objects.equals(this.key, riskv1decisionsMerchantDefinedInformation.key) && + Objects.equals(this.value, riskv1decisionsMerchantDefinedInformation.value); + } + + @Override + public int hashCode() { + return Objects.hash(key, value); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsMerchantDefinedInformation {\n"); + + sb.append(" key: ").append(toIndentedString(key)).append("\n"); + sb.append(" value: ").append(toIndentedString(value)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsOrderInformation.java b/src/main/java/Model/Riskv1decisionsOrderInformation.java new file mode 100644 index 000000000..44a51221f --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsOrderInformation.java @@ -0,0 +1,224 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.Riskv1decisionsOrderInformationAmountDetails; +import Model.Riskv1decisionsOrderInformationBillTo; +import Model.Riskv1decisionsOrderInformationLineItems; +import Model.Riskv1decisionsOrderInformationShipTo; +import Model.Riskv1decisionsOrderInformationShippingDetails; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * Contains detailed order-level information. + */ +@ApiModel(description = "Contains detailed order-level information.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsOrderInformation { + @SerializedName("amountDetails") + private Riskv1decisionsOrderInformationAmountDetails amountDetails = null; + + @SerializedName("shippingDetails") + private Riskv1decisionsOrderInformationShippingDetails shippingDetails = null; + + @SerializedName("shipTo") + private Riskv1decisionsOrderInformationShipTo shipTo = null; + + @SerializedName("returnsAccepted") + private String returnsAccepted = null; + + @SerializedName("lineItems") + private List lineItems = null; + + @SerializedName("billTo") + private Riskv1decisionsOrderInformationBillTo billTo = null; + + public Riskv1decisionsOrderInformation amountDetails(Riskv1decisionsOrderInformationAmountDetails amountDetails) { + this.amountDetails = amountDetails; + return this; + } + + /** + * Get amountDetails + * @return amountDetails + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsOrderInformationAmountDetails getAmountDetails() { + return amountDetails; + } + + public void setAmountDetails(Riskv1decisionsOrderInformationAmountDetails amountDetails) { + this.amountDetails = amountDetails; + } + + public Riskv1decisionsOrderInformation shippingDetails(Riskv1decisionsOrderInformationShippingDetails shippingDetails) { + this.shippingDetails = shippingDetails; + return this; + } + + /** + * Get shippingDetails + * @return shippingDetails + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsOrderInformationShippingDetails getShippingDetails() { + return shippingDetails; + } + + public void setShippingDetails(Riskv1decisionsOrderInformationShippingDetails shippingDetails) { + this.shippingDetails = shippingDetails; + } + + public Riskv1decisionsOrderInformation shipTo(Riskv1decisionsOrderInformationShipTo shipTo) { + this.shipTo = shipTo; + return this; + } + + /** + * Get shipTo + * @return shipTo + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsOrderInformationShipTo getShipTo() { + return shipTo; + } + + public void setShipTo(Riskv1decisionsOrderInformationShipTo shipTo) { + this.shipTo = shipTo; + } + + public Riskv1decisionsOrderInformation returnsAccepted(String returnsAccepted) { + this.returnsAccepted = returnsAccepted; + return this; + } + + /** + * Boolean that indicates whether returns are accepted for this order. This field can contain one of the following values: - `yes`: Returns are accepted for this order. - `no`: Returns are not accepted for this order. + * @return returnsAccepted + **/ + @ApiModelProperty(value = "Boolean that indicates whether returns are accepted for this order. This field can contain one of the following values: - `yes`: Returns are accepted for this order. - `no`: Returns are not accepted for this order. ") + public String getReturnsAccepted() { + return returnsAccepted; + } + + public void setReturnsAccepted(String returnsAccepted) { + this.returnsAccepted = returnsAccepted; + } + + public Riskv1decisionsOrderInformation lineItems(List lineItems) { + this.lineItems = lineItems; + return this; + } + + public Riskv1decisionsOrderInformation addLineItemsItem(Riskv1decisionsOrderInformationLineItems lineItemsItem) { + if (this.lineItems == null) { + this.lineItems = new ArrayList(); + } + this.lineItems.add(lineItemsItem); + return this; + } + + /** + * This array contains detailed information about individual products in the order. + * @return lineItems + **/ + @ApiModelProperty(value = "This array contains detailed information about individual products in the order.") + public List getLineItems() { + return lineItems; + } + + public void setLineItems(List lineItems) { + this.lineItems = lineItems; + } + + public Riskv1decisionsOrderInformation billTo(Riskv1decisionsOrderInformationBillTo billTo) { + this.billTo = billTo; + return this; + } + + /** + * Get billTo + * @return billTo + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsOrderInformationBillTo getBillTo() { + return billTo; + } + + public void setBillTo(Riskv1decisionsOrderInformationBillTo billTo) { + this.billTo = billTo; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsOrderInformation riskv1decisionsOrderInformation = (Riskv1decisionsOrderInformation) o; + return Objects.equals(this.amountDetails, riskv1decisionsOrderInformation.amountDetails) && + Objects.equals(this.shippingDetails, riskv1decisionsOrderInformation.shippingDetails) && + Objects.equals(this.shipTo, riskv1decisionsOrderInformation.shipTo) && + Objects.equals(this.returnsAccepted, riskv1decisionsOrderInformation.returnsAccepted) && + Objects.equals(this.lineItems, riskv1decisionsOrderInformation.lineItems) && + Objects.equals(this.billTo, riskv1decisionsOrderInformation.billTo); + } + + @Override + public int hashCode() { + return Objects.hash(amountDetails, shippingDetails, shipTo, returnsAccepted, lineItems, billTo); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsOrderInformation {\n"); + + sb.append(" amountDetails: ").append(toIndentedString(amountDetails)).append("\n"); + sb.append(" shippingDetails: ").append(toIndentedString(shippingDetails)).append("\n"); + sb.append(" shipTo: ").append(toIndentedString(shipTo)).append("\n"); + sb.append(" returnsAccepted: ").append(toIndentedString(returnsAccepted)).append("\n"); + sb.append(" lineItems: ").append(toIndentedString(lineItems)).append("\n"); + sb.append(" billTo: ").append(toIndentedString(billTo)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsOrderInformationAmountDetails.java b/src/main/java/Model/Riskv1decisionsOrderInformationAmountDetails.java new file mode 100644 index 000000000..14ad45253 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsOrderInformationAmountDetails.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Contains `currency` and `totalAmount` for this order. + */ +@ApiModel(description = "Contains `currency` and `totalAmount` for this order.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsOrderInformationAmountDetails { + @SerializedName("currency") + private String currency = null; + + @SerializedName("totalAmount") + private String totalAmount = null; + + public Riskv1decisionsOrderInformationAmountDetails currency(String currency) { + this.currency = currency; + return this; + } + + /** + * Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. + * @return currency + **/ + @ApiModelProperty(required = true, value = "Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. ") + public String getCurrency() { + return currency; + } + + public void setCurrency(String currency) { + this.currency = currency; + } + + public Riskv1decisionsOrderInformationAmountDetails totalAmount(String totalAmount) { + this.totalAmount = totalAmount; + return this; + } + + /** + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:  Table 15, \"Authorization Information for Specific Processors,\" on page 43  Table 19, \"Capture Information for Specific Processors,\" on page 58  Table 23, \"Credit Information for Specific Processors,\" on page 75 If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247. **DCC with a Third-Party Provider**\\ Set this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used. + * @return totalAmount + **/ + @ApiModelProperty(value = "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:  Table 15, \"Authorization Information for Specific Processors,\" on page 43  Table 19, \"Capture Information for Specific Processors,\" on page 58  Table 23, \"Credit Information for Specific Processors,\" on page 75 If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247. **DCC with a Third-Party Provider**\\ Set this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used. ") + public String getTotalAmount() { + return totalAmount; + } + + public void setTotalAmount(String totalAmount) { + this.totalAmount = totalAmount; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsOrderInformationAmountDetails riskv1decisionsOrderInformationAmountDetails = (Riskv1decisionsOrderInformationAmountDetails) o; + return Objects.equals(this.currency, riskv1decisionsOrderInformationAmountDetails.currency) && + Objects.equals(this.totalAmount, riskv1decisionsOrderInformationAmountDetails.totalAmount); + } + + @Override + public int hashCode() { + return Objects.hash(currency, totalAmount); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsOrderInformationAmountDetails {\n"); + + sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); + sb.append(" totalAmount: ").append(toIndentedString(totalAmount)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsOrderInformationBillTo.java b/src/main/java/Model/Riskv1decisionsOrderInformationBillTo.java new file mode 100644 index 000000000..28ddbad06 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsOrderInformationBillTo.java @@ -0,0 +1,300 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Riskv1decisionsOrderInformationBillTo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsOrderInformationBillTo { + @SerializedName("address1") + private String address1 = null; + + @SerializedName("address2") + private String address2 = null; + + @SerializedName("administrativeArea") + private String administrativeArea = null; + + @SerializedName("country") + private String country = null; + + @SerializedName("locality") + private String locality = null; + + @SerializedName("firstName") + private String firstName = null; + + @SerializedName("lastName") + private String lastName = null; + + @SerializedName("phoneNumber") + private String phoneNumber = null; + + @SerializedName("email") + private String email = null; + + @SerializedName("postalCode") + private String postalCode = null; + + public Riskv1decisionsOrderInformationBillTo address1(String address1) { + this.address1 = address1; + return this; + } + + /** + * First line of the billing street address as it appears on the credit card issuer’s records. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return address1 + **/ + @ApiModelProperty(value = "First line of the billing street address as it appears on the credit card issuer’s records. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getAddress1() { + return address1; + } + + public void setAddress1(String address1) { + this.address1 = address1; + } + + public Riskv1decisionsOrderInformationBillTo address2(String address2) { + this.address2 = address2; + return this; + } + + /** + * Additional address information. For Payouts: This field may be sent only for FDC Compass. **Atos** This field must not contain colons (:). **Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions** This value is used for AVS. **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return address2 + **/ + @ApiModelProperty(value = "Additional address information. For Payouts: This field may be sent only for FDC Compass. **Atos** This field must not contain colons (:). **Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions** This value is used for AVS. **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getAddress2() { + return address2; + } + + public void setAddress2(String address2) { + this.address2 = address2; + } + + public Riskv1decisionsOrderInformationBillTo administrativeArea(String administrativeArea) { + this.administrativeArea = administrativeArea; + return this; + } + + /** + * State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return administrativeArea + **/ + @ApiModelProperty(value = "State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getAdministrativeArea() { + return administrativeArea; + } + + public void setAdministrativeArea(String administrativeArea) { + this.administrativeArea = administrativeArea; + } + + public Riskv1decisionsOrderInformationBillTo country(String country) { + this.country = country; + return this; + } + + /** + * Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return country + **/ + @ApiModelProperty(value = "Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getCountry() { + return country; + } + + public void setCountry(String country) { + this.country = country; + } + + public Riskv1decisionsOrderInformationBillTo locality(String locality) { + this.locality = locality; + return this; + } + + /** + * City of the billing address. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return locality + **/ + @ApiModelProperty(value = "City of the billing address. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getLocality() { + return locality; + } + + public void setLocality(String locality) { + this.locality = locality; + } + + public Riskv1decisionsOrderInformationBillTo firstName(String firstName) { + this.firstName = firstName; + return this; + } + + /** + * Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return firstName + **/ + @ApiModelProperty(value = "Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getFirstName() { + return firstName; + } + + public void setFirstName(String firstName) { + this.firstName = firstName; + } + + public Riskv1decisionsOrderInformationBillTo lastName(String lastName) { + this.lastName = lastName; + return this; + } + + /** + * Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return lastName + **/ + @ApiModelProperty(value = "Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getLastName() { + return lastName; + } + + public void setLastName(String lastName) { + this.lastName = lastName; + } + + public Riskv1decisionsOrderInformationBillTo phoneNumber(String phoneNumber) { + this.phoneNumber = phoneNumber; + return this; + } + + /** + * Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. + * @return phoneNumber + **/ + @ApiModelProperty(value = "Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ") + public String getPhoneNumber() { + return phoneNumber; + } + + public void setPhoneNumber(String phoneNumber) { + this.phoneNumber = phoneNumber; + } + + public Riskv1decisionsOrderInformationBillTo email(String email) { + this.email = email; + return this; + } + + /** + * Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return email + **/ + @ApiModelProperty(value = "Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + public Riskv1decisionsOrderInformationBillTo postalCode(String postalCode) { + this.postalCode = postalCode; + return this; + } + + /** + * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For Payouts: This field may be sent only for FDC Compass. **American Express Direct** Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return postalCode + **/ + @ApiModelProperty(value = "Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For Payouts: This field may be sent only for FDC Compass. **American Express Direct** Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getPostalCode() { + return postalCode; + } + + public void setPostalCode(String postalCode) { + this.postalCode = postalCode; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsOrderInformationBillTo riskv1decisionsOrderInformationBillTo = (Riskv1decisionsOrderInformationBillTo) o; + return Objects.equals(this.address1, riskv1decisionsOrderInformationBillTo.address1) && + Objects.equals(this.address2, riskv1decisionsOrderInformationBillTo.address2) && + Objects.equals(this.administrativeArea, riskv1decisionsOrderInformationBillTo.administrativeArea) && + Objects.equals(this.country, riskv1decisionsOrderInformationBillTo.country) && + Objects.equals(this.locality, riskv1decisionsOrderInformationBillTo.locality) && + Objects.equals(this.firstName, riskv1decisionsOrderInformationBillTo.firstName) && + Objects.equals(this.lastName, riskv1decisionsOrderInformationBillTo.lastName) && + Objects.equals(this.phoneNumber, riskv1decisionsOrderInformationBillTo.phoneNumber) && + Objects.equals(this.email, riskv1decisionsOrderInformationBillTo.email) && + Objects.equals(this.postalCode, riskv1decisionsOrderInformationBillTo.postalCode); + } + + @Override + public int hashCode() { + return Objects.hash(address1, address2, administrativeArea, country, locality, firstName, lastName, phoneNumber, email, postalCode); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsOrderInformationBillTo {\n"); + + sb.append(" address1: ").append(toIndentedString(address1)).append("\n"); + sb.append(" address2: ").append(toIndentedString(address2)).append("\n"); + sb.append(" administrativeArea: ").append(toIndentedString(administrativeArea)).append("\n"); + sb.append(" country: ").append(toIndentedString(country)).append("\n"); + sb.append(" locality: ").append(toIndentedString(locality)).append("\n"); + sb.append(" firstName: ").append(toIndentedString(firstName)).append("\n"); + sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n"); + sb.append(" phoneNumber: ").append(toIndentedString(phoneNumber)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append(" postalCode: ").append(toIndentedString(postalCode)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsOrderInformationLineItems.java b/src/main/java/Model/Riskv1decisionsOrderInformationLineItems.java new file mode 100644 index 000000000..390495917 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsOrderInformationLineItems.java @@ -0,0 +1,281 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.Riskv1decisionsOrderInformationPassenger; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.math.BigDecimal; + +/** + * Riskv1decisionsOrderInformationLineItems + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsOrderInformationLineItems { + @SerializedName("unitPrice") + private String unitPrice = null; + + @SerializedName("quantity") + private BigDecimal quantity = null; + + @SerializedName("productSKU") + private String productSKU = null; + + @SerializedName("productRisk") + private String productRisk = null; + + @SerializedName("productName") + private String productName = null; + + @SerializedName("productCode") + private String productCode = null; + + @SerializedName("gift") + private String gift = "no"; + + @SerializedName("distributorProductSku") + private String distributorProductSku = null; + + @SerializedName("passenger") + private Riskv1decisionsOrderInformationPassenger passenger = null; + + public Riskv1decisionsOrderInformationLineItems unitPrice(String unitPrice) { + this.unitPrice = unitPrice; + return this; + } + + /** + * Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in: - Table 12, \"Authorization Information for Specific Processors,\" on page 36 - Table 16, \"Capture Information for Specific Processors,\" on page 51 - Table 20, \"Credit Information for Specific Processors,\" on page 65 **DCC for First Data**\\ This value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36. **Zero Amount Authorizations**\\ If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220. + * @return unitPrice + **/ + @ApiModelProperty(value = "Per-item price of the product. This value cannot be negative. You can include a decimal point (.), but you cannot include any other special characters. CyberSource truncates the amount to the correct number of decimal places. For processor-specific information, see the amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in: - Table 12, \"Authorization Information for Specific Processors,\" on page 36 - Table 16, \"Capture Information for Specific Processors,\" on page 51 - Table 20, \"Credit Information for Specific Processors,\" on page 65 **DCC for First Data**\\ This value is the original amount in your local currency. You must include this field. You cannot use grand_total_amount. See \"Dynamic Currency Conversion for First Data,\" page 113. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 12, \"Authorization Information for Specific Processors,\" on page 36. **Zero Amount Authorizations**\\ If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 220. ") + public String getUnitPrice() { + return unitPrice; + } + + public void setUnitPrice(String unitPrice) { + this.unitPrice = unitPrice; + } + + public Riskv1decisionsOrderInformationLineItems quantity(BigDecimal quantity) { + this.quantity = quantity; + return this; + } + + /** + * Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased. + * minimum: 1 + * maximum: 9999999999 + * @return quantity + **/ + @ApiModelProperty(value = "Number of units for this order. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. When `orderInformation.lineItems[].productCode` is `gift_card`, this is the total count of individual prepaid gift cards purchased. ") + public BigDecimal getQuantity() { + return quantity; + } + + public void setQuantity(BigDecimal quantity) { + this.quantity = quantity; + } + + public Riskv1decisionsOrderInformationLineItems productSKU(String productSKU) { + this.productSKU = productSKU; + return this; + } + + /** + * Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. + * @return productSKU + **/ + @ApiModelProperty(value = "Stock Keeping Unit (SKU) code for the product. For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when _orderInformation.lineItems[].productCode_ is not set to **default** or one of the other values that are related to shipping and/or handling. ") + public String getProductSKU() { + return productSKU; + } + + public void setProductSKU(String productSKU) { + this.productSKU = productSKU; + } + + public Riskv1decisionsOrderInformationLineItems productRisk(String productRisk) { + this.productRisk = productRisk; + return this; + } + + /** + * Indicates the level of risk for the product. This field can contain one of the following values: - `low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks. + * @return productRisk + **/ + @ApiModelProperty(value = "Indicates the level of risk for the product. This field can contain one of the following values: - `low`: The product is associated with few chargebacks. - `normal`: The product is associated with a normal number of chargebacks. - `high`: The product is associated with many chargebacks. ") + public String getProductRisk() { + return productRisk; + } + + public void setProductRisk(String productRisk) { + this.productRisk = productRisk; + } + + public Riskv1decisionsOrderInformationLineItems productName(String productName) { + this.productName = productName; + return this; + } + + /** + * For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. + * @return productName + **/ + @ApiModelProperty(value = "For an authorization or capture transaction (`processingOptions.capture` is set to `true` or `false`), this field is required when `orderInformation.lineItems[].productCode` is not set to `default` or one of the other values that are related to shipping and/or handling. ") + public String getProductName() { + return productName; + } + + public void setProductName(String productName) { + this.productName = productName; + } + + public Riskv1decisionsOrderInformationLineItems productCode(String productCode) { + this.productCode = productCode; + return this; + } + + /** + * Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. + * @return productCode + **/ + @ApiModelProperty(value = "Type of product. This value is used to determine the category that the product is in: electronic, handling, physical, service, or shipping. The default value is **default**. If you are performing an authorization transaction (`processingOptions.capture` is set to `false`), and you set this field to a value other than default or any of the values related to shipping and handling, then the fields `quantity`, `productName`, and `productSku` are required. It can also have a value of \"gift_card\". See Appendix O, \"Product Codes,\" on page 373 for a list of valid values. For a payment, when you set this field to a value other than default or any of the values related to shipping and handling, below fields _quantity_, _productName_, and _productSKU_ are required. ") + public String getProductCode() { + return productCode; + } + + public void setProductCode(String productCode) { + this.productCode = productCode; + } + + public Riskv1decisionsOrderInformationLineItems gift(String gift) { + this.gift = gift; + return this; + } + + /** + * Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - `yes`: Orders are assigned only slight additional risk if billing and shipping addresses are different. - `no` (default): Orders are assigned higher additional risk if billing and shipping addresses are different. - `off`: Differences between billing and shipping addresses do not affect the score. + * @return gift + **/ + @ApiModelProperty(value = "Determines whether to assign risk to the order if the billing and shipping addresses specify different cities, states, or countries. This field can contain one of the following values: - `yes`: Orders are assigned only slight additional risk if billing and shipping addresses are different. - `no` (default): Orders are assigned higher additional risk if billing and shipping addresses are different. - `off`: Differences between billing and shipping addresses do not affect the score. ") + public String getGift() { + return gift; + } + + public void setGift(String gift) { + this.gift = gift; + } + + public Riskv1decisionsOrderInformationLineItems distributorProductSku(String distributorProductSku) { + this.distributorProductSku = distributorProductSku; + return this; + } + + /** + * Product’s identifier code. This field is inserted into the outgoing message without being parsed or formatted. This field is included as Distributor product SKU (Offer) in the list of API fields with which you can create custom rules. + * @return distributorProductSku + **/ + @ApiModelProperty(value = "Product’s identifier code. This field is inserted into the outgoing message without being parsed or formatted. This field is included as Distributor product SKU (Offer) in the list of API fields with which you can create custom rules. ") + public String getDistributorProductSku() { + return distributorProductSku; + } + + public void setDistributorProductSku(String distributorProductSku) { + this.distributorProductSku = distributorProductSku; + } + + public Riskv1decisionsOrderInformationLineItems passenger(Riskv1decisionsOrderInformationPassenger passenger) { + this.passenger = passenger; + return this; + } + + /** + * Get passenger + * @return passenger + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsOrderInformationPassenger getPassenger() { + return passenger; + } + + public void setPassenger(Riskv1decisionsOrderInformationPassenger passenger) { + this.passenger = passenger; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsOrderInformationLineItems riskv1decisionsOrderInformationLineItems = (Riskv1decisionsOrderInformationLineItems) o; + return Objects.equals(this.unitPrice, riskv1decisionsOrderInformationLineItems.unitPrice) && + Objects.equals(this.quantity, riskv1decisionsOrderInformationLineItems.quantity) && + Objects.equals(this.productSKU, riskv1decisionsOrderInformationLineItems.productSKU) && + Objects.equals(this.productRisk, riskv1decisionsOrderInformationLineItems.productRisk) && + Objects.equals(this.productName, riskv1decisionsOrderInformationLineItems.productName) && + Objects.equals(this.productCode, riskv1decisionsOrderInformationLineItems.productCode) && + Objects.equals(this.gift, riskv1decisionsOrderInformationLineItems.gift) && + Objects.equals(this.distributorProductSku, riskv1decisionsOrderInformationLineItems.distributorProductSku) && + Objects.equals(this.passenger, riskv1decisionsOrderInformationLineItems.passenger); + } + + @Override + public int hashCode() { + return Objects.hash(unitPrice, quantity, productSKU, productRisk, productName, productCode, gift, distributorProductSku, passenger); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsOrderInformationLineItems {\n"); + + sb.append(" unitPrice: ").append(toIndentedString(unitPrice)).append("\n"); + sb.append(" quantity: ").append(toIndentedString(quantity)).append("\n"); + sb.append(" productSKU: ").append(toIndentedString(productSKU)).append("\n"); + sb.append(" productRisk: ").append(toIndentedString(productRisk)).append("\n"); + sb.append(" productName: ").append(toIndentedString(productName)).append("\n"); + sb.append(" productCode: ").append(toIndentedString(productCode)).append("\n"); + sb.append(" gift: ").append(toIndentedString(gift)).append("\n"); + sb.append(" distributorProductSku: ").append(toIndentedString(distributorProductSku)).append("\n"); + sb.append(" passenger: ").append(toIndentedString(passenger)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsOrderInformationPassenger.java b/src/main/java/Model/Riskv1decisionsOrderInformationPassenger.java new file mode 100644 index 000000000..9b98da355 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsOrderInformationPassenger.java @@ -0,0 +1,232 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Contains travel-related passenger details. + */ +@ApiModel(description = "Contains travel-related passenger details.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsOrderInformationPassenger { + @SerializedName("type") + private String type = null; + + @SerializedName("status") + private String status = null; + + @SerializedName("phone") + private String phone = null; + + @SerializedName("firstName") + private String firstName = null; + + @SerializedName("lastName") + private String lastName = null; + + @SerializedName("id") + private String id = null; + + @SerializedName("email") + private String email = null; + + public Riskv1decisionsOrderInformationPassenger type(String type) { + this.type = type; + return this; + } + + /** + * Passenger classification associated with the price of the ticket. You can use one of the following values: - `ADT`: Adult - `CNN`: Child - `INF`: Infant - `YTH`: Youth - `STU`: Student - `SCR`: Senior Citizen - `MIL`: Military + * @return type + **/ + @ApiModelProperty(value = "Passenger classification associated with the price of the ticket. You can use one of the following values: - `ADT`: Adult - `CNN`: Child - `INF`: Infant - `YTH`: Youth - `STU`: Student - `SCR`: Senior Citizen - `MIL`: Military ") + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public Riskv1decisionsOrderInformationPassenger status(String status) { + this.status = status; + return this; + } + + /** + * Your company's passenger classification, such as with a frequent flyer program. In this case, you might use values such as `standard`, `gold`, or `platinum`. + * @return status + **/ + @ApiModelProperty(value = "Your company's passenger classification, such as with a frequent flyer program. In this case, you might use values such as `standard`, `gold`, or `platinum`. ") + public String getStatus() { + return status; + } + + public void setStatus(String status) { + this.status = status; + } + + public Riskv1decisionsOrderInformationPassenger phone(String phone) { + this.phone = phone; + return this; + } + + /** + * Passenger's phone number. If the order is from outside the U.S., CyberSource recommends that you include the country code. + * @return phone + **/ + @ApiModelProperty(value = "Passenger's phone number. If the order is from outside the U.S., CyberSource recommends that you include the country code. ") + public String getPhone() { + return phone; + } + + public void setPhone(String phone) { + this.phone = phone; + } + + public Riskv1decisionsOrderInformationPassenger firstName(String firstName) { + this.firstName = firstName; + return this; + } + + /** + * Passenger's first name. + * @return firstName + **/ + @ApiModelProperty(value = "Passenger's first name.") + public String getFirstName() { + return firstName; + } + + public void setFirstName(String firstName) { + this.firstName = firstName; + } + + public Riskv1decisionsOrderInformationPassenger lastName(String lastName) { + this.lastName = lastName; + return this; + } + + /** + * Passenger's last name. + * @return lastName + **/ + @ApiModelProperty(value = "Passenger's last name.") + public String getLastName() { + return lastName; + } + + public void setLastName(String lastName) { + this.lastName = lastName; + } + + public Riskv1decisionsOrderInformationPassenger id(String id) { + this.id = id; + return this; + } + + /** + * ID of the passenger to whom the ticket was issued. For example, you can use this field for the frequent flyer number. + * @return id + **/ + @ApiModelProperty(value = "ID of the passenger to whom the ticket was issued. For example, you can use this field for the frequent flyer number. ") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public Riskv1decisionsOrderInformationPassenger email(String email) { + this.email = email; + return this; + } + + /** + * Passenger's email address, including the full domain name, such as jdoe@example.com. + * @return email + **/ + @ApiModelProperty(value = "Passenger's email address, including the full domain name, such as jdoe@example.com.") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsOrderInformationPassenger riskv1decisionsOrderInformationPassenger = (Riskv1decisionsOrderInformationPassenger) o; + return Objects.equals(this.type, riskv1decisionsOrderInformationPassenger.type) && + Objects.equals(this.status, riskv1decisionsOrderInformationPassenger.status) && + Objects.equals(this.phone, riskv1decisionsOrderInformationPassenger.phone) && + Objects.equals(this.firstName, riskv1decisionsOrderInformationPassenger.firstName) && + Objects.equals(this.lastName, riskv1decisionsOrderInformationPassenger.lastName) && + Objects.equals(this.id, riskv1decisionsOrderInformationPassenger.id) && + Objects.equals(this.email, riskv1decisionsOrderInformationPassenger.email); + } + + @Override + public int hashCode() { + return Objects.hash(type, status, phone, firstName, lastName, id, email); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsOrderInformationPassenger {\n"); + + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" status: ").append(toIndentedString(status)).append("\n"); + sb.append(" phone: ").append(toIndentedString(phone)).append("\n"); + sb.append(" firstName: ").append(toIndentedString(firstName)).append("\n"); + sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsOrderInformationShipTo.java b/src/main/java/Model/Riskv1decisionsOrderInformationShipTo.java new file mode 100644 index 000000000..12079e4d9 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsOrderInformationShipTo.java @@ -0,0 +1,278 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Contains recipient shipping information. + */ +@ApiModel(description = "Contains recipient shipping information.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsOrderInformationShipTo { + @SerializedName("address1") + private String address1 = null; + + @SerializedName("address2") + private String address2 = null; + + @SerializedName("administrativeArea") + private String administrativeArea = null; + + @SerializedName("country") + private String country = null; + + @SerializedName("locality") + private String locality = null; + + @SerializedName("firstName") + private String firstName = null; + + @SerializedName("lastName") + private String lastName = null; + + @SerializedName("phoneNumber") + private String phoneNumber = null; + + @SerializedName("postalCode") + private String postalCode = null; + + public Riskv1decisionsOrderInformationShipTo address1(String address1) { + this.address1 = address1; + return this; + } + + /** + * First line of the shipping address. + * @return address1 + **/ + @ApiModelProperty(value = "First line of the shipping address.") + public String getAddress1() { + return address1; + } + + public void setAddress1(String address1) { + this.address1 = address1; + } + + public Riskv1decisionsOrderInformationShipTo address2(String address2) { + this.address2 = address2; + return this; + } + + /** + * Second line of the shipping address. + * @return address2 + **/ + @ApiModelProperty(value = "Second line of the shipping address.") + public String getAddress2() { + return address2; + } + + public void setAddress2(String address2) { + this.address2 = address2; + } + + public Riskv1decisionsOrderInformationShipTo administrativeArea(String administrativeArea) { + this.administrativeArea = administrativeArea; + return this; + } + + /** + * State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. + * @return administrativeArea + **/ + @ApiModelProperty(value = "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. ") + public String getAdministrativeArea() { + return administrativeArea; + } + + public void setAdministrativeArea(String administrativeArea) { + this.administrativeArea = administrativeArea; + } + + public Riskv1decisionsOrderInformationShipTo country(String country) { + this.country = country; + return this; + } + + /** + * Country of the shipping address. Use the two-character ISO Standard Country Codes. + * @return country + **/ + @ApiModelProperty(value = "Country of the shipping address. Use the two-character ISO Standard Country Codes.") + public String getCountry() { + return country; + } + + public void setCountry(String country) { + this.country = country; + } + + public Riskv1decisionsOrderInformationShipTo locality(String locality) { + this.locality = locality; + return this; + } + + /** + * City of the shipping address. + * @return locality + **/ + @ApiModelProperty(value = "City of the shipping address.") + public String getLocality() { + return locality; + } + + public void setLocality(String locality) { + this.locality = locality; + } + + public Riskv1decisionsOrderInformationShipTo firstName(String firstName) { + this.firstName = firstName; + return this; + } + + /** + * First name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 + * @return firstName + **/ + @ApiModelProperty(value = "First name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 ") + public String getFirstName() { + return firstName; + } + + public void setFirstName(String firstName) { + this.firstName = firstName; + } + + public Riskv1decisionsOrderInformationShipTo lastName(String lastName) { + this.lastName = lastName; + return this; + } + + /** + * Last name of the recipient. **Processor-specific maximum length** - Litle: 25 - All other processors: 60 + * @return lastName + **/ + @ApiModelProperty(value = "Last name of the recipient. **Processor-specific maximum length** - Litle: 25 - All other processors: 60 ") + public String getLastName() { + return lastName; + } + + public void setLastName(String lastName) { + this.lastName = lastName; + } + + public Riskv1decisionsOrderInformationShipTo phoneNumber(String phoneNumber) { + this.phoneNumber = phoneNumber; + return this; + } + + /** + * Phone number associated with the shipping address. + * @return phoneNumber + **/ + @ApiModelProperty(value = "Phone number associated with the shipping address.") + public String getPhoneNumber() { + return phoneNumber; + } + + public void setPhoneNumber(String phoneNumber) { + this.phoneNumber = phoneNumber; + } + + public Riskv1decisionsOrderInformationShipTo postalCode(String postalCode) { + this.postalCode = postalCode; + return this; + } + + /** + * Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 **American Express Direct**\\ Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. + * @return postalCode + **/ + @ApiModelProperty(value = "Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 **American Express Direct**\\ Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. ") + public String getPostalCode() { + return postalCode; + } + + public void setPostalCode(String postalCode) { + this.postalCode = postalCode; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsOrderInformationShipTo riskv1decisionsOrderInformationShipTo = (Riskv1decisionsOrderInformationShipTo) o; + return Objects.equals(this.address1, riskv1decisionsOrderInformationShipTo.address1) && + Objects.equals(this.address2, riskv1decisionsOrderInformationShipTo.address2) && + Objects.equals(this.administrativeArea, riskv1decisionsOrderInformationShipTo.administrativeArea) && + Objects.equals(this.country, riskv1decisionsOrderInformationShipTo.country) && + Objects.equals(this.locality, riskv1decisionsOrderInformationShipTo.locality) && + Objects.equals(this.firstName, riskv1decisionsOrderInformationShipTo.firstName) && + Objects.equals(this.lastName, riskv1decisionsOrderInformationShipTo.lastName) && + Objects.equals(this.phoneNumber, riskv1decisionsOrderInformationShipTo.phoneNumber) && + Objects.equals(this.postalCode, riskv1decisionsOrderInformationShipTo.postalCode); + } + + @Override + public int hashCode() { + return Objects.hash(address1, address2, administrativeArea, country, locality, firstName, lastName, phoneNumber, postalCode); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsOrderInformationShipTo {\n"); + + sb.append(" address1: ").append(toIndentedString(address1)).append("\n"); + sb.append(" address2: ").append(toIndentedString(address2)).append("\n"); + sb.append(" administrativeArea: ").append(toIndentedString(administrativeArea)).append("\n"); + sb.append(" country: ").append(toIndentedString(country)).append("\n"); + sb.append(" locality: ").append(toIndentedString(locality)).append("\n"); + sb.append(" firstName: ").append(toIndentedString(firstName)).append("\n"); + sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n"); + sb.append(" phoneNumber: ").append(toIndentedString(phoneNumber)).append("\n"); + sb.append(" postalCode: ").append(toIndentedString(postalCode)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsOrderInformationShippingDetails.java b/src/main/java/Model/Riskv1decisionsOrderInformationShippingDetails.java new file mode 100644 index 000000000..444a9b736 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsOrderInformationShippingDetails.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Contains shipping information not related to address. + */ +@ApiModel(description = "Contains shipping information not related to address.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsOrderInformationShippingDetails { + @SerializedName("giftWrap") + private String giftWrap = null; + + @SerializedName("shippingMethod") + private String shippingMethod = null; + + public Riskv1decisionsOrderInformationShippingDetails giftWrap(String giftWrap) { + this.giftWrap = giftWrap; + return this; + } + + /** + * Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - `yes`: The customer requested gift wrapping. - `no`: The customer did not request gift wrapping. + * @return giftWrap + **/ + @ApiModelProperty(value = "Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - `yes`: The customer requested gift wrapping. - `no`: The customer did not request gift wrapping. ") + public String getGiftWrap() { + return giftWrap; + } + + public void setGiftWrap(String giftWrap) { + this.giftWrap = giftWrap; + } + + public Riskv1decisionsOrderInformationShippingDetails shippingMethod(String shippingMethod) { + this.shippingMethod = shippingMethod; + return this; + } + + /** + * Shipping method for the product. Possible values: - `lowcost`: Lowest-cost service - `sameday`: Courier or same-day service - `oneday`: Next-day or overnight service - `twoday`: Two-day service - `threeday`: Three-day service - `pickup`: Store pick-up - `other`: Other shipping method - `none`: No shipping method because product is a service or subscription + * @return shippingMethod + **/ + @ApiModelProperty(value = "Shipping method for the product. Possible values: - `lowcost`: Lowest-cost service - `sameday`: Courier or same-day service - `oneday`: Next-day or overnight service - `twoday`: Two-day service - `threeday`: Three-day service - `pickup`: Store pick-up - `other`: Other shipping method - `none`: No shipping method because product is a service or subscription ") + public String getShippingMethod() { + return shippingMethod; + } + + public void setShippingMethod(String shippingMethod) { + this.shippingMethod = shippingMethod; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsOrderInformationShippingDetails riskv1decisionsOrderInformationShippingDetails = (Riskv1decisionsOrderInformationShippingDetails) o; + return Objects.equals(this.giftWrap, riskv1decisionsOrderInformationShippingDetails.giftWrap) && + Objects.equals(this.shippingMethod, riskv1decisionsOrderInformationShippingDetails.shippingMethod); + } + + @Override + public int hashCode() { + return Objects.hash(giftWrap, shippingMethod); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsOrderInformationShippingDetails {\n"); + + sb.append(" giftWrap: ").append(toIndentedString(giftWrap)).append("\n"); + sb.append(" shippingMethod: ").append(toIndentedString(shippingMethod)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsPaymentInformation.java b/src/main/java/Model/Riskv1decisionsPaymentInformation.java new file mode 100644 index 000000000..01281719b --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsPaymentInformation.java @@ -0,0 +1,119 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.Riskv1decisionsPaymentInformationCard; +import Model.Riskv1decisionsPaymentInformationTokenizedCard; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Contains the payment data for this transaction. + */ +@ApiModel(description = "Contains the payment data for this transaction.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsPaymentInformation { + @SerializedName("card") + private Riskv1decisionsPaymentInformationCard card = null; + + @SerializedName("tokenizedCard") + private Riskv1decisionsPaymentInformationTokenizedCard tokenizedCard = null; + + public Riskv1decisionsPaymentInformation card(Riskv1decisionsPaymentInformationCard card) { + this.card = card; + return this; + } + + /** + * Get card + * @return card + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsPaymentInformationCard getCard() { + return card; + } + + public void setCard(Riskv1decisionsPaymentInformationCard card) { + this.card = card; + } + + public Riskv1decisionsPaymentInformation tokenizedCard(Riskv1decisionsPaymentInformationTokenizedCard tokenizedCard) { + this.tokenizedCard = tokenizedCard; + return this; + } + + /** + * Get tokenizedCard + * @return tokenizedCard + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsPaymentInformationTokenizedCard getTokenizedCard() { + return tokenizedCard; + } + + public void setTokenizedCard(Riskv1decisionsPaymentInformationTokenizedCard tokenizedCard) { + this.tokenizedCard = tokenizedCard; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsPaymentInformation riskv1decisionsPaymentInformation = (Riskv1decisionsPaymentInformation) o; + return Objects.equals(this.card, riskv1decisionsPaymentInformation.card) && + Objects.equals(this.tokenizedCard, riskv1decisionsPaymentInformation.tokenizedCard); + } + + @Override + public int hashCode() { + return Objects.hash(card, tokenizedCard); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsPaymentInformation {\n"); + + sb.append(" card: ").append(toIndentedString(card)).append("\n"); + sb.append(" tokenizedCard: ").append(toIndentedString(tokenizedCard)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsPaymentInformationCard.java b/src/main/java/Model/Riskv1decisionsPaymentInformationCard.java new file mode 100644 index 000000000..f30dc6b49 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsPaymentInformationCard.java @@ -0,0 +1,186 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Use this for a non-tokenized payment card. + */ +@ApiModel(description = "Use this for a non-tokenized payment card.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsPaymentInformationCard { + @SerializedName("number") + private String number = null; + + @SerializedName("type") + private String type = null; + + @SerializedName("bin") + private String bin = null; + + @SerializedName("expirationMonth") + private String expirationMonth = null; + + @SerializedName("expirationYear") + private String expirationYear = null; + + public Riskv1decisionsPaymentInformationCard number(String number) { + this.number = number; + return this; + } + + /** + * The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return number + **/ + @ApiModelProperty(value = "The customer’s payment card number, also knows as the Primary Account Nunmber (PAN). You can also use this field for encoded account numbers. For processor-specific information, see the `customer_cc_number` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getNumber() { + return number; + } + + public void setNumber(String number) { + this.number = number; + } + + public Riskv1decisionsPaymentInformationCard type(String type) { + this.type = type; + return this; + } + + /** + * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) + * @return type + **/ + @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) ") + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public Riskv1decisionsPaymentInformationCard bin(String bin) { + this.bin = bin; + return this; + } + + /** + * description: The BIN is the first six digits of the card's Primary Account Number (PAN). + * @return bin + **/ + @ApiModelProperty(value = "description: The BIN is the first six digits of the card's Primary Account Number (PAN). ") + public String getBin() { + return bin; + } + + public void setBin(String bin) { + this.bin = bin; + } + + public Riskv1decisionsPaymentInformationCard expirationMonth(String expirationMonth) { + this.expirationMonth = expirationMonth; + return this; + } + + /** + * Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return expirationMonth + **/ + @ApiModelProperty(value = "Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getExpirationMonth() { + return expirationMonth; + } + + public void setExpirationMonth(String expirationMonth) { + this.expirationMonth = expirationMonth; + } + + public Riskv1decisionsPaymentInformationCard expirationYear(String expirationYear) { + this.expirationYear = expirationYear; + return this; + } + + /** + * Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return expirationYear + **/ + @ApiModelProperty(value = "Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getExpirationYear() { + return expirationYear; + } + + public void setExpirationYear(String expirationYear) { + this.expirationYear = expirationYear; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsPaymentInformationCard riskv1decisionsPaymentInformationCard = (Riskv1decisionsPaymentInformationCard) o; + return Objects.equals(this.number, riskv1decisionsPaymentInformationCard.number) && + Objects.equals(this.type, riskv1decisionsPaymentInformationCard.type) && + Objects.equals(this.bin, riskv1decisionsPaymentInformationCard.bin) && + Objects.equals(this.expirationMonth, riskv1decisionsPaymentInformationCard.expirationMonth) && + Objects.equals(this.expirationYear, riskv1decisionsPaymentInformationCard.expirationYear); + } + + @Override + public int hashCode() { + return Objects.hash(number, type, bin, expirationMonth, expirationYear); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsPaymentInformationCard {\n"); + + sb.append(" number: ").append(toIndentedString(number)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" bin: ").append(toIndentedString(bin)).append("\n"); + sb.append(" expirationMonth: ").append(toIndentedString(expirationMonth)).append("\n"); + sb.append(" expirationYear: ").append(toIndentedString(expirationYear)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsPaymentInformationTokenizedCard.java b/src/main/java/Model/Riskv1decisionsPaymentInformationTokenizedCard.java new file mode 100644 index 000000000..d3ccb7da6 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsPaymentInformationTokenizedCard.java @@ -0,0 +1,163 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Use this object to submit a payment network token instead of card-based values. + */ +@ApiModel(description = "Use this object to submit a payment network token instead of card-based values.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsPaymentInformationTokenizedCard { + @SerializedName("type") + private String type = null; + + @SerializedName("number") + private String number = null; + + @SerializedName("expirationMonth") + private String expirationMonth = null; + + @SerializedName("expirationYear") + private String expirationYear = null; + + public Riskv1decisionsPaymentInformationTokenizedCard type(String type) { + this.type = type; + return this; + } + + /** + * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) + * @return type + **/ + @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) ") + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public Riskv1decisionsPaymentInformationTokenizedCard number(String number) { + this.number = number; + return this; + } + + /** + * Customer’s payment network token value. + * @return number + **/ + @ApiModelProperty(value = "Customer’s payment network token value. ") + public String getNumber() { + return number; + } + + public void setNumber(String number) { + this.number = number; + } + + public Riskv1decisionsPaymentInformationTokenizedCard expirationMonth(String expirationMonth) { + this.expirationMonth = expirationMonth; + return this; + } + + /** + * Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return expirationMonth + **/ + @ApiModelProperty(value = "Two-digit month in which the payment network token expires. `Format: MM`. Possible values: 01 through 12. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (01 through 12) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getExpirationMonth() { + return expirationMonth; + } + + public void setExpirationMonth(String expirationMonth) { + this.expirationMonth = expirationMonth; + } + + public Riskv1decisionsPaymentInformationTokenizedCard expirationYear(String expirationYear) { + this.expirationYear = expirationYear; + return this; + } + + /** + * Four-digit year in which the payment network token expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * @return expirationYear + **/ + @ApiModelProperty(value = "Four-digit year in which the payment network token expires. `Format: YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (1900 through 3000) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (card_type=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + public String getExpirationYear() { + return expirationYear; + } + + public void setExpirationYear(String expirationYear) { + this.expirationYear = expirationYear; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsPaymentInformationTokenizedCard riskv1decisionsPaymentInformationTokenizedCard = (Riskv1decisionsPaymentInformationTokenizedCard) o; + return Objects.equals(this.type, riskv1decisionsPaymentInformationTokenizedCard.type) && + Objects.equals(this.number, riskv1decisionsPaymentInformationTokenizedCard.number) && + Objects.equals(this.expirationMonth, riskv1decisionsPaymentInformationTokenizedCard.expirationMonth) && + Objects.equals(this.expirationYear, riskv1decisionsPaymentInformationTokenizedCard.expirationYear); + } + + @Override + public int hashCode() { + return Objects.hash(type, number, expirationMonth, expirationYear); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsPaymentInformationTokenizedCard {\n"); + + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" number: ").append(toIndentedString(number)).append("\n"); + sb.append(" expirationMonth: ").append(toIndentedString(expirationMonth)).append("\n"); + sb.append(" expirationYear: ").append(toIndentedString(expirationYear)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsProcessorInformation.java b/src/main/java/Model/Riskv1decisionsProcessorInformation.java new file mode 100644 index 000000000..cd4561400 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsProcessorInformation.java @@ -0,0 +1,95 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.Riskv1decisionsProcessorInformationAvs; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Contains information related to the payment processor. + */ +@ApiModel(description = "Contains information related to the payment processor.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsProcessorInformation { + @SerializedName("avs") + private Riskv1decisionsProcessorInformationAvs avs = null; + + public Riskv1decisionsProcessorInformation avs(Riskv1decisionsProcessorInformationAvs avs) { + this.avs = avs; + return this; + } + + /** + * Get avs + * @return avs + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsProcessorInformationAvs getAvs() { + return avs; + } + + public void setAvs(Riskv1decisionsProcessorInformationAvs avs) { + this.avs = avs; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsProcessorInformation riskv1decisionsProcessorInformation = (Riskv1decisionsProcessorInformation) o; + return Objects.equals(this.avs, riskv1decisionsProcessorInformation.avs); + } + + @Override + public int hashCode() { + return Objects.hash(avs); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsProcessorInformation {\n"); + + sb.append(" avs: ").append(toIndentedString(avs)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv1paymentinstrumentsBankAccount.java b/src/main/java/Model/Riskv1decisionsProcessorInformationAvs.java similarity index 53% rename from src/main/java/Model/Tmsv1paymentinstrumentsBankAccount.java rename to src/main/java/Model/Riskv1decisionsProcessorInformationAvs.java index d1d0e9c17..77b4cf0ba 100644 --- a/src/main/java/Model/Tmsv1paymentinstrumentsBankAccount.java +++ b/src/main/java/Model/Riskv1decisionsProcessorInformationAvs.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,29 +24,30 @@ import java.io.IOException; /** - * Tmsv1paymentinstrumentsBankAccount + * Address Verification Service */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1paymentinstrumentsBankAccount { - @SerializedName("type") - private String type = null; +@ApiModel(description = "Address Verification Service") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsProcessorInformationAvs { + @SerializedName("code") + private String code = null; - public Tmsv1paymentinstrumentsBankAccount type(String type) { - this.type = type; + public Riskv1decisionsProcessorInformationAvs code(String code) { + this.code = code; return this; } /** - * Type of Bank Account. - * @return type + * Value returned for address verification from the Payments Authorization response. + * @return code **/ - @ApiModelProperty(example = "savings", value = "Type of Bank Account.") - public String getType() { - return type; + @ApiModelProperty(value = "Value returned for address verification from the Payments Authorization response.") + public String getCode() { + return code; } - public void setType(String type) { - this.type = type; + public void setCode(String code) { + this.code = code; } @@ -58,22 +59,22 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv1paymentinstrumentsBankAccount tmsv1paymentinstrumentsBankAccount = (Tmsv1paymentinstrumentsBankAccount) o; - return Objects.equals(this.type, tmsv1paymentinstrumentsBankAccount.type); + Riskv1decisionsProcessorInformationAvs riskv1decisionsProcessorInformationAvs = (Riskv1decisionsProcessorInformationAvs) o; + return Objects.equals(this.code, riskv1decisionsProcessorInformationAvs.code); } @Override public int hashCode() { - return Objects.hash(type); + return Objects.hash(code); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1paymentinstrumentsBankAccount {\n"); + sb.append("class Riskv1decisionsProcessorInformationAvs {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" code: ").append(toIndentedString(code)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/Riskv1decisionsRiskInformation.java b/src/main/java/Model/Riskv1decisionsRiskInformation.java new file mode 100644 index 000000000..57f01bacc --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsRiskInformation.java @@ -0,0 +1,94 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.Riskv1decisionsRiskInformationProfile; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Riskv1decisionsRiskInformation + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsRiskInformation { + @SerializedName("profile") + private Riskv1decisionsRiskInformationProfile profile = null; + + public Riskv1decisionsRiskInformation profile(Riskv1decisionsRiskInformationProfile profile) { + this.profile = profile; + return this; + } + + /** + * Get profile + * @return profile + **/ + @ApiModelProperty(value = "") + public Riskv1decisionsRiskInformationProfile getProfile() { + return profile; + } + + public void setProfile(Riskv1decisionsRiskInformationProfile profile) { + this.profile = profile; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsRiskInformation riskv1decisionsRiskInformation = (Riskv1decisionsRiskInformation) o; + return Objects.equals(this.profile, riskv1decisionsRiskInformation.profile); + } + + @Override + public int hashCode() { + return Objects.hash(profile); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsRiskInformation {\n"); + + sb.append(" profile: ").append(toIndentedString(profile)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod.java b/src/main/java/Model/Riskv1decisionsRiskInformationProfile.java similarity index 51% rename from src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod.java rename to src/main/java/Model/Riskv1decisionsRiskInformationProfile.java index ee42caead..8e960b4bf 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod.java +++ b/src/main/java/Model/Riskv1decisionsRiskInformationProfile.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,29 +24,30 @@ import java.io.IOException; /** - * TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod + * Identifies a risk profile. */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod { - @SerializedName("type") - private String type = null; +@ApiModel(description = "Identifies a risk profile.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsRiskInformationProfile { + @SerializedName("name") + private String name = null; - public TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod type(String type) { - this.type = type; + public Riskv1decisionsRiskInformationProfile name(String name) { + this.name = name; return this; } /** - * The description for this field is not available. - * @return type + * Name of the active profile chosen by the profile selector. If no profile selector exists, the default active profile is chosen. + * @return name **/ - @ApiModelProperty(value = "The description for this field is not available.") - public String getType() { - return type; + @ApiModelProperty(value = "Name of the active profile chosen by the profile selector. If no profile selector exists, the default active profile is chosen. ") + public String getName() { + return name; } - public void setType(String type) { - this.type = type; + public void setName(String name) { + this.name = name; } @@ -58,22 +59,22 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod tssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod = (TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod) o; - return Objects.equals(this.type, tssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod.type); + Riskv1decisionsRiskInformationProfile riskv1decisionsRiskInformationProfile = (Riskv1decisionsRiskInformationProfile) o; + return Objects.equals(this.name, riskv1decisionsRiskInformationProfile.name); } @Override public int hashCode() { - return Objects.hash(type); + return Objects.hash(name); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod {\n"); + sb.append("class Riskv1decisionsRiskInformationProfile {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/Riskv1decisionsTravelInformation.java b/src/main/java/Model/Riskv1decisionsTravelInformation.java new file mode 100644 index 000000000..0a70c2507 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsTravelInformation.java @@ -0,0 +1,173 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.Riskv1decisionsTravelInformationLegs; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * Riskv1decisionsTravelInformation + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsTravelInformation { + @SerializedName("completeRoute") + private String completeRoute = null; + + @SerializedName("departureTime") + private String departureTime = null; + + @SerializedName("journeyType") + private String journeyType = null; + + @SerializedName("legs") + private List legs = null; + + public Riskv1decisionsTravelInformation completeRoute(String completeRoute) { + this.completeRoute = completeRoute; + return this; + } + + /** + * Concatenation of individual travel legs in the format ORIG1-DEST1[:ORIG2-DEST2...:ORIGn-DESTn], for example, SFO-JFK:JFK-LHR:LHR-CDG. For airport codes, see the IATA Airline and Airport Code Search. Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the value of _complete_route takes precedence over that of the _leg# fields. + * @return completeRoute + **/ + @ApiModelProperty(value = "Concatenation of individual travel legs in the format ORIG1-DEST1[:ORIG2-DEST2...:ORIGn-DESTn], for example, SFO-JFK:JFK-LHR:LHR-CDG. For airport codes, see the IATA Airline and Airport Code Search. Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the value of _complete_route takes precedence over that of the _leg# fields. ") + public String getCompleteRoute() { + return completeRoute; + } + + public void setCompleteRoute(String completeRoute) { + this.completeRoute = completeRoute; + } + + public Riskv1decisionsTravelInformation departureTime(String departureTime) { + this.departureTime = departureTime; + return this; + } + + /** + * Departure date and time of the first leg of the trip. Use one of the following formats: - yyyy-MM-dd HH:mm z - yyyy-MM-dd hh:mm a z - yyyy-MM-dd hh:mma z HH = hour in 24-hour format hh = hour in 12-hour format a = am or pm (case insensitive) z = time zone of the departing flight, for example: If the airline is based in city A, but the flight departs from city B, z is the time zone of city B at the time of departure. Important For travel information, use GMT instead of UTC, or use the local time zone. Examples 2011-03-20 11:30 PM PDT 2011-03-20 11:30pm GMT 2011-03-20 11:30pm GMT-05:00 Eastern Standard Time: GMT-05:00 or EST Note When specifying an offset from GMT, the format must be exactly as specified in the example. Insert no spaces between the time zone and the offset. + * @return departureTime + **/ + @ApiModelProperty(value = "Departure date and time of the first leg of the trip. Use one of the following formats: - yyyy-MM-dd HH:mm z - yyyy-MM-dd hh:mm a z - yyyy-MM-dd hh:mma z HH = hour in 24-hour format hh = hour in 12-hour format a = am or pm (case insensitive) z = time zone of the departing flight, for example: If the airline is based in city A, but the flight departs from city B, z is the time zone of city B at the time of departure. Important For travel information, use GMT instead of UTC, or use the local time zone. Examples 2011-03-20 11:30 PM PDT 2011-03-20 11:30pm GMT 2011-03-20 11:30pm GMT-05:00 Eastern Standard Time: GMT-05:00 or EST Note When specifying an offset from GMT, the format must be exactly as specified in the example. Insert no spaces between the time zone and the offset. ") + public String getDepartureTime() { + return departureTime; + } + + public void setDepartureTime(String departureTime) { + this.departureTime = departureTime; + } + + public Riskv1decisionsTravelInformation journeyType(String journeyType) { + this.journeyType = journeyType; + return this; + } + + /** + * Type of travel, for example one way or round trip. + * @return journeyType + **/ + @ApiModelProperty(value = "Type of travel, for example one way or round trip.") + public String getJourneyType() { + return journeyType; + } + + public void setJourneyType(String journeyType) { + this.journeyType = journeyType; + } + + public Riskv1decisionsTravelInformation legs(List legs) { + this.legs = legs; + return this; + } + + public Riskv1decisionsTravelInformation addLegsItem(Riskv1decisionsTravelInformationLegs legsItem) { + if (this.legs == null) { + this.legs = new ArrayList(); + } + this.legs.add(legsItem); + return this; + } + + /** + * Get legs + * @return legs + **/ + @ApiModelProperty(value = "") + public List getLegs() { + return legs; + } + + public void setLegs(List legs) { + this.legs = legs; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsTravelInformation riskv1decisionsTravelInformation = (Riskv1decisionsTravelInformation) o; + return Objects.equals(this.completeRoute, riskv1decisionsTravelInformation.completeRoute) && + Objects.equals(this.departureTime, riskv1decisionsTravelInformation.departureTime) && + Objects.equals(this.journeyType, riskv1decisionsTravelInformation.journeyType) && + Objects.equals(this.legs, riskv1decisionsTravelInformation.legs); + } + + @Override + public int hashCode() { + return Objects.hash(completeRoute, departureTime, journeyType, legs); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsTravelInformation {\n"); + + sb.append(" completeRoute: ").append(toIndentedString(completeRoute)).append("\n"); + sb.append(" departureTime: ").append(toIndentedString(departureTime)).append("\n"); + sb.append(" journeyType: ").append(toIndentedString(journeyType)).append("\n"); + sb.append(" legs: ").append(toIndentedString(legs)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Riskv1decisionsTravelInformationLegs.java b/src/main/java/Model/Riskv1decisionsTravelInformationLegs.java new file mode 100644 index 000000000..183ad44c6 --- /dev/null +++ b/src/main/java/Model/Riskv1decisionsTravelInformationLegs.java @@ -0,0 +1,116 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Riskv1decisionsTravelInformationLegs + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Riskv1decisionsTravelInformationLegs { + @SerializedName("origination") + private String origination = null; + + @SerializedName("destination") + private String destination = null; + + public Riskv1decisionsTravelInformationLegs origination(String origination) { + this.origination = origination; + return this; + } + + /** + * Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a positive integer from 0 to N. For example: decision_manager_travel_leg0_orig=SFO decision_manager_travel_leg1_orig=SFO Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the complete route takes precedence over the individual legs. + * @return origination + **/ + @ApiModelProperty(value = "Use to specify the airport code for the origin of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a positive integer from 0 to N. For example: decision_manager_travel_leg0_orig=SFO decision_manager_travel_leg1_orig=SFO Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the complete route takes precedence over the individual legs. ") + public String getOrigination() { + return origination; + } + + public void setOrigination(String origination) { + this.origination = origination; + } + + public Riskv1decisionsTravelInformationLegs destination(String destination) { + this.destination = destination; + return this; + } + + /** + * Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a positive integer from 0 to N. For example: decision_manager_travel_leg0_dest=SFO decision_manager_travel_leg1_dest=SFO Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the complete route takes precedence over the individual legs. + * @return destination + **/ + @ApiModelProperty(value = "Use to specify the airport code for the destination of the leg of the trip, which is designated by the pound (#) symbol in the field name. This code is usually three digits long, for example: SFO = San Francisco. Do not use the colon (:) or the dash (-). For airport codes, see the IATA Airline and Airport Code Search. The leg number can be a positive integer from 0 to N. For example: decision_manager_travel_leg0_dest=SFO decision_manager_travel_leg1_dest=SFO Note In your request, send either the complete route or the individual legs (_leg#_orig and _leg#_dest). If you send all the fields, the complete route takes precedence over the individual legs. ") + public String getDestination() { + return destination; + } + + public void setDestination(String destination) { + this.destination = destination; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Riskv1decisionsTravelInformationLegs riskv1decisionsTravelInformationLegs = (Riskv1decisionsTravelInformationLegs) o; + return Objects.equals(this.origination, riskv1decisionsTravelInformationLegs.origination) && + Objects.equals(this.destination, riskv1decisionsTravelInformationLegs.destination); + } + + @Override + public int hashCode() { + return Objects.hash(origination, destination); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Riskv1decisionsTravelInformationLegs {\n"); + + sb.append(" origination: ").append(toIndentedString(origination)).append("\n"); + sb.append(" destination: ").append(toIndentedString(destination)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TmsV1InstrumentidentifiersDelete409Response.java b/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409Response.java similarity index 64% rename from src/main/java/Model/TmsV1InstrumentidentifiersDelete409Response.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersDelete409Response.java index c70eb133d..4b8c41c6b 100644 --- a/src/main/java/Model/TmsV1InstrumentidentifiersDelete409Response.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.TmsV1InstrumentidentifiersDelete409ResponseLinks; +import Model.TmsV1InstrumentIdentifiersDelete409ResponseLinks; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -25,14 +25,14 @@ import java.io.IOException; /** - * TmsV1InstrumentidentifiersDelete409Response + * TmsV1InstrumentIdentifiersDelete409Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1InstrumentidentifiersDelete409Response { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersDelete409Response { @SerializedName("_links") - private TmsV1InstrumentidentifiersDelete409ResponseLinks links = null; + private TmsV1InstrumentIdentifiersDelete409ResponseLinks links = null; - public TmsV1InstrumentidentifiersDelete409Response links(TmsV1InstrumentidentifiersDelete409ResponseLinks links) { + public TmsV1InstrumentIdentifiersDelete409Response links(TmsV1InstrumentIdentifiersDelete409ResponseLinks links) { this.links = links; return this; } @@ -42,11 +42,11 @@ public TmsV1InstrumentidentifiersDelete409Response links(TmsV1Instrumentidentifi * @return links **/ @ApiModelProperty(value = "") - public TmsV1InstrumentidentifiersDelete409ResponseLinks getLinks() { + public TmsV1InstrumentIdentifiersDelete409ResponseLinks getLinks() { return links; } - public void setLinks(TmsV1InstrumentidentifiersDelete409ResponseLinks links) { + public void setLinks(TmsV1InstrumentIdentifiersDelete409ResponseLinks links) { this.links = links; } @@ -59,8 +59,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TmsV1InstrumentidentifiersDelete409Response tmsV1InstrumentidentifiersDelete409Response = (TmsV1InstrumentidentifiersDelete409Response) o; - return Objects.equals(this.links, tmsV1InstrumentidentifiersDelete409Response.links); + TmsV1InstrumentIdentifiersDelete409Response tmsV1InstrumentIdentifiersDelete409Response = (TmsV1InstrumentIdentifiersDelete409Response) o; + return Objects.equals(this.links, tmsV1InstrumentIdentifiersDelete409Response.links); } @Override @@ -72,7 +72,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1InstrumentidentifiersDelete409Response {\n"); + sb.append("class TmsV1InstrumentIdentifiersDelete409Response {\n"); sb.append(" links: ").append(toIndentedString(links)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/TmsV1InstrumentidentifiersDelete409ResponseLinks.java b/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinks.java similarity index 68% rename from src/main/java/Model/TmsV1InstrumentidentifiersDelete409ResponseLinks.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinks.java index b51a69079..34bd9cc2b 100644 --- a/src/main/java/Model/TmsV1InstrumentidentifiersDelete409ResponseLinks.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinks.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments; +import Model.TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -25,14 +25,14 @@ import java.io.IOException; /** - * TmsV1InstrumentidentifiersDelete409ResponseLinks + * TmsV1InstrumentIdentifiersDelete409ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1InstrumentidentifiersDelete409ResponseLinks { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersDelete409ResponseLinks { @SerializedName("paymentInstruments") - private TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments paymentInstruments = null; + private TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments paymentInstruments = null; - public TmsV1InstrumentidentifiersDelete409ResponseLinks paymentInstruments(TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments paymentInstruments) { + public TmsV1InstrumentIdentifiersDelete409ResponseLinks paymentInstruments(TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments paymentInstruments) { this.paymentInstruments = paymentInstruments; return this; } @@ -42,11 +42,11 @@ public TmsV1InstrumentidentifiersDelete409ResponseLinks paymentInstruments(TmsV1 * @return paymentInstruments **/ @ApiModelProperty(value = "") - public TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments getPaymentInstruments() { + public TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments getPaymentInstruments() { return paymentInstruments; } - public void setPaymentInstruments(TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments paymentInstruments) { + public void setPaymentInstruments(TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments paymentInstruments) { this.paymentInstruments = paymentInstruments; } @@ -59,8 +59,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TmsV1InstrumentidentifiersDelete409ResponseLinks tmsV1InstrumentidentifiersDelete409ResponseLinks = (TmsV1InstrumentidentifiersDelete409ResponseLinks) o; - return Objects.equals(this.paymentInstruments, tmsV1InstrumentidentifiersDelete409ResponseLinks.paymentInstruments); + TmsV1InstrumentIdentifiersDelete409ResponseLinks tmsV1InstrumentIdentifiersDelete409ResponseLinks = (TmsV1InstrumentIdentifiersDelete409ResponseLinks) o; + return Objects.equals(this.paymentInstruments, tmsV1InstrumentIdentifiersDelete409ResponseLinks.paymentInstruments); } @Override @@ -72,7 +72,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1InstrumentidentifiersDelete409ResponseLinks {\n"); + sb.append("class TmsV1InstrumentIdentifiersDelete409ResponseLinks {\n"); sb.append(" paymentInstruments: ").append(toIndentedString(paymentInstruments)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments.java b/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments.java similarity index 72% rename from src/main/java/Model/TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments.java index b74ba6d94..aa3123252 100644 --- a/src/main/java/Model/TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,14 +24,14 @@ import java.io.IOException; /** - * TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments + * TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments { @SerializedName("href") private String href = null; - public TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments href(String href) { + public TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments href(String href) { this.href = href; return this; } @@ -58,8 +58,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments tmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments = (TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments) o; - return Objects.equals(this.href, tmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments.href); + TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments tmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments = (TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments) o; + return Objects.equals(this.href, tmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments.href); } @Override @@ -71,7 +71,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1InstrumentidentifiersDelete409ResponseLinksPaymentInstruments {\n"); + sb.append("class TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments {\n"); sb.append(" href: ").append(toIndentedString(href)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.java similarity index 69% rename from src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.java index 75605eb18..a841cf544 100644 --- a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,8 @@ package Model; import java.util.Objects; -import Model.TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -25,12 +26,12 @@ import java.io.IOException; /** - * TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response { @SerializedName("_links") - private TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks links = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks links = null; /** * Shows the response is a collection of objects. @@ -93,9 +94,9 @@ public ObjectEnum read(final JsonReader jsonReader) throws IOException { private String total = null; @SerializedName("_embedded") - private Object embedded = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded embedded = null; - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response links(TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks links) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response links(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks links) { this.links = links; return this; } @@ -105,11 +106,11 @@ public TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response links(TmsV1Ins * @return links **/ @ApiModelProperty(value = "") - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks getLinks() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks getLinks() { return links; } - public void setLinks(TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks links) { + public void setLinks(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks links) { this.links = links; } @@ -158,21 +159,21 @@ public String getTotal() { return total; } - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response embedded(Object embedded) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response embedded(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded embedded) { this.embedded = embedded; return this; } /** - * Array of Payment Instruments returned for the supplied Instrument Identifier. + * Get embedded * @return embedded **/ - @ApiModelProperty(value = "Array of Payment Instruments returned for the supplied Instrument Identifier.") - public Object getEmbedded() { + @ApiModelProperty(value = "") + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded getEmbedded() { return embedded; } - public void setEmbedded(Object embedded) { + public void setEmbedded(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded embedded) { this.embedded = embedded; } @@ -185,14 +186,14 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response tmsV1InstrumentidentifiersPaymentinstrumentsGet200Response = (TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response) o; - return Objects.equals(this.links, tmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.links) && - Objects.equals(this.object, tmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.object) && - Objects.equals(this.offset, tmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.offset) && - Objects.equals(this.limit, tmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.limit) && - Objects.equals(this.count, tmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.count) && - Objects.equals(this.total, tmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.total) && - Objects.equals(this.embedded, tmsV1InstrumentidentifiersPaymentinstrumentsGet200Response.embedded); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response tmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response) o; + return Objects.equals(this.links, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.links) && + Objects.equals(this.object, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.object) && + Objects.equals(this.offset, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.offset) && + Objects.equals(this.limit, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.limit) && + Objects.equals(this.count, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.count) && + Objects.equals(this.total, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.total) && + Objects.equals(this.embedded, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.embedded); } @Override @@ -204,7 +205,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response {\n"); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response {\n"); sb.append(" links: ").append(toIndentedString(links)).append("\n"); sb.append(" object: ").append(toIndentedString(object)).append("\n"); diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded.java new file mode 100644 index 000000000..71ff5f700 --- /dev/null +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded.java @@ -0,0 +1,104 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded { + @SerializedName("paymentInstruments") + private List paymentInstruments = null; + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded paymentInstruments(List paymentInstruments) { + this.paymentInstruments = paymentInstruments; + return this; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded addPaymentInstrumentsItem(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments paymentInstrumentsItem) { + if (this.paymentInstruments == null) { + this.paymentInstruments = new ArrayList(); + } + this.paymentInstruments.add(paymentInstrumentsItem); + return this; + } + + /** + * Array of Payment Instruments returned for the supplied Instrument Identifier. + * @return paymentInstruments + **/ + @ApiModelProperty(value = "Array of Payment Instruments returned for the supplied Instrument Identifier.") + public List getPaymentInstruments() { + return paymentInstruments; + } + + public void setPaymentInstruments(List paymentInstruments) { + this.paymentInstruments = paymentInstruments; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded) o; + return Objects.equals(this.paymentInstruments, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded.paymentInstruments); + } + + @Override + public int hashCode() { + return Objects.hash(paymentInstruments); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded {\n"); + + sb.append(" paymentInstruments: ").append(toIndentedString(paymentInstruments)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.java new file mode 100644 index 000000000..ee58044d7 --- /dev/null +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.java @@ -0,0 +1,144 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount { + /** + * Checking account type. Possible values: * C: checking * S: savings (USD only) * X: corporate checking (USD only) * G: general ledger + */ + @JsonAdapter(TypeEnum.Adapter.class) + public enum TypeEnum { + CHECKING("checking"), + + SAVINGS("savings"), + + CORPORATE_CHECKING("corporate checking"), + + GENERAL_LEDGER("general ledger"); + + private String value; + + TypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static TypeEnum fromValue(String text) { + for (TypeEnum b : TypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public TypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("type") + private TypeEnum type = null; + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount type(TypeEnum type) { + this.type = type; + return this; + } + + /** + * Checking account type. Possible values: * C: checking * S: savings (USD only) * X: corporate checking (USD only) * G: general ledger + * @return type + **/ + @ApiModelProperty(example = "savings", value = "Checking account type. Possible values: * C: checking * S: savings (USD only) * X: corporate checking (USD only) * G: general ledger ") + public TypeEnum getType() { + return type; + } + + public void setType(TypeEnum type) { + this.type = type; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount) o; + return Objects.equals(this.type, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.type); + } + + @Override + public int hashCode() { + return Objects.hash(type); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount {\n"); + + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.java new file mode 100644 index 000000000..5cb44fa3e --- /dev/null +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.java @@ -0,0 +1,323 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo { + @SerializedName("firstName") + private String firstName = null; + + @SerializedName("lastName") + private String lastName = null; + + @SerializedName("company") + private String company = null; + + @SerializedName("address1") + private String address1 = null; + + @SerializedName("address2") + private String address2 = null; + + @SerializedName("locality") + private String locality = null; + + @SerializedName("administrativeArea") + private String administrativeArea = null; + + @SerializedName("postalCode") + private String postalCode = null; + + @SerializedName("country") + private String country = null; + + @SerializedName("email") + private String email = null; + + @SerializedName("phoneNumber") + private String phoneNumber = null; + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo firstName(String firstName) { + this.firstName = firstName; + return this; + } + + /** + * Customer’s first name. For a credit card transaction, this name must match the name on the card. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. + * @return firstName + **/ + @ApiModelProperty(example = "John", value = "Customer’s first name. For a credit card transaction, this name must match the name on the card. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. ") + public String getFirstName() { + return firstName; + } + + public void setFirstName(String firstName) { + this.firstName = firstName; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo lastName(String lastName) { + this.lastName = lastName; + return this; + } + + /** + * Customer’s last name. For a credit card transaction, this name must match the name on the card. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. + * @return lastName + **/ + @ApiModelProperty(example = "Smith", value = "Customer’s last name. For a credit card transaction, this name must match the name on the card. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. ") + public String getLastName() { + return lastName; + } + + public void setLastName(String lastName) { + this.lastName = lastName; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo company(String company) { + this.company = company; + return this; + } + + /** + * Name of the customer’s company. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. + * @return company + **/ + @ApiModelProperty(example = "CyberSource", value = "Name of the customer’s company. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. ") + public String getCompany() { + return company; + } + + public void setCompany(String company) { + this.company = company; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo address1(String address1) { + this.address1 = address1; + return this; + } + + /** + * First line of the billing street address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. + * @return address1 + **/ + @ApiModelProperty(example = "12 Main Street", value = "First line of the billing street address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. ") + public String getAddress1() { + return address1; + } + + public void setAddress1(String address1) { + this.address1 = address1; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo address2(String address2) { + this.address2 = address2; + return this; + } + + /** + * Additional address information. + * @return address2 + **/ + @ApiModelProperty(example = "20 My Street", value = "Additional address information.") + public String getAddress2() { + return address2; + } + + public void setAddress2(String address2) { + this.address2 = address2; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo locality(String locality) { + this.locality = locality; + return this; + } + + /** + * City of the billing address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. + * @return locality + **/ + @ApiModelProperty(example = "Foster City", value = "City of the billing address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. ") + public String getLocality() { + return locality; + } + + public void setLocality(String locality) { + this.locality = locality; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo administrativeArea(String administrativeArea) { + this.administrativeArea = administrativeArea; + return this; + } + + /** + * State or province of the billing address. For an address in the U.S. or Canada, use the State, Province, and Territory Codes for the United States and Canada. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. + * @return administrativeArea + **/ + @ApiModelProperty(example = "CA", value = "State or province of the billing address. For an address in the U.S. or Canada, use the State, Province, and Territory Codes for the United States and Canada. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. ") + public String getAdministrativeArea() { + return administrativeArea; + } + + public void setAdministrativeArea(String administrativeArea) { + this.administrativeArea = administrativeArea; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo postalCode(String postalCode) { + this.postalCode = postalCode; + return this; + } + + /** + * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example A1B 2C3 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. + * @return postalCode + **/ + @ApiModelProperty(example = "90200", value = "Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] **Example** 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space] [numeric][alpha][numeric] Example A1B 2C3 This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important**: It is your responsibility to determine whether a field is required for the transaction you are requesting. ") + public String getPostalCode() { + return postalCode; + } + + public void setPostalCode(String postalCode) { + this.postalCode = postalCode; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo country(String country) { + this.country = country; + return this; + } + + /** + * Country of the billing address. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. + * @return country + **/ + @ApiModelProperty(example = "US", value = "Country of the billing address. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. ") + public String getCountry() { + return country; + } + + public void setCountry(String country) { + this.country = country; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo email(String email) { + this.email = email; + return this; + } + + /** + * Customer’s email address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. + * @return email + **/ + @ApiModelProperty(example = "john.smith@example.com", value = "Customer’s email address. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See the TMS REST Developer Guide for more information about relaxed address requirements. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. ") + public String getEmail() { + return email; + } + + public void setEmail(String email) { + this.email = email; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo phoneNumber(String phoneNumber) { + this.phoneNumber = phoneNumber; + return this; + } + + /** + * Customer phone number. When you create a customer profile, the requirements depend on the payment method: * Credit cards — optional. * Electronic checks — contact your payment processor representative to find out if this field is required or optional. * PINless debits — optional. + * @return phoneNumber + **/ + @ApiModelProperty(example = "555123456", value = "Customer phone number. When you create a customer profile, the requirements depend on the payment method: * Credit cards — optional. * Electronic checks — contact your payment processor representative to find out if this field is required or optional. * PINless debits — optional. ") + public String getPhoneNumber() { + return phoneNumber; + } + + public void setPhoneNumber(String phoneNumber) { + this.phoneNumber = phoneNumber; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo) o; + return Objects.equals(this.firstName, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.firstName) && + Objects.equals(this.lastName, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.lastName) && + Objects.equals(this.company, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.company) && + Objects.equals(this.address1, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.address1) && + Objects.equals(this.address2, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.address2) && + Objects.equals(this.locality, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.locality) && + Objects.equals(this.administrativeArea, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.administrativeArea) && + Objects.equals(this.postalCode, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.postalCode) && + Objects.equals(this.country, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.country) && + Objects.equals(this.email, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.email) && + Objects.equals(this.phoneNumber, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.phoneNumber); + } + + @Override + public int hashCode() { + return Objects.hash(firstName, lastName, company, address1, address2, locality, administrativeArea, postalCode, country, email, phoneNumber); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo {\n"); + + sb.append(" firstName: ").append(toIndentedString(firstName)).append("\n"); + sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n"); + sb.append(" company: ").append(toIndentedString(company)).append("\n"); + sb.append(" address1: ").append(toIndentedString(address1)).append("\n"); + sb.append(" address2: ").append(toIndentedString(address2)).append("\n"); + sb.append(" locality: ").append(toIndentedString(locality)).append("\n"); + sb.append(" administrativeArea: ").append(toIndentedString(administrativeArea)).append("\n"); + sb.append(" postalCode: ").append(toIndentedString(postalCode)).append("\n"); + sb.append(" country: ").append(toIndentedString(country)).append("\n"); + sb.append(" email: ").append(toIndentedString(email)).append("\n"); + sb.append(" phoneNumber: ").append(toIndentedString(phoneNumber)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.java new file mode 100644 index 000000000..8c9c964d7 --- /dev/null +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.java @@ -0,0 +1,173 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation { + @SerializedName("companyTaxID") + private String companyTaxID = null; + + @SerializedName("currency") + private String currency = null; + + @SerializedName("dateOBirth") + private String dateOBirth = null; + + @SerializedName("personalIdentification") + private List personalIdentification = null; + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation companyTaxID(String companyTaxID) { + this.companyTaxID = companyTaxID; + return this; + } + + /** + * Tax identifier for the customer’s company. **Important**: Contact your TeleCheck representative to find out whether this field is required or optional. + * @return companyTaxID + **/ + @ApiModelProperty(example = "1234567890123456800", value = "Tax identifier for the customer’s company. **Important**: Contact your TeleCheck representative to find out whether this field is required or optional. ") + public String getCompanyTaxID() { + return companyTaxID; + } + + public void setCompanyTaxID(String companyTaxID) { + this.companyTaxID = companyTaxID; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation currency(String currency) { + this.currency = currency; + return this; + } + + /** + * Currency used by the customer. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha. + * @return currency + **/ + @ApiModelProperty(example = "USD", value = "Currency used by the customer. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha.") + public String getCurrency() { + return currency; + } + + public void setCurrency(String currency) { + this.currency = currency; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation dateOBirth(String dateOBirth) { + this.dateOBirth = dateOBirth; + return this; + } + + /** + * Date of birth of the customer. Format: `YYYY-MM-DD` or `YYYYMMDD` + * @return dateOBirth + **/ + @ApiModelProperty(example = "1960-12-30", value = "Date of birth of the customer. Format: `YYYY-MM-DD` or `YYYYMMDD` ") + public String getDateOBirth() { + return dateOBirth; + } + + public void setDateOBirth(String dateOBirth) { + this.dateOBirth = dateOBirth; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation personalIdentification(List personalIdentification) { + this.personalIdentification = personalIdentification; + return this; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation addPersonalIdentificationItem(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification personalIdentificationItem) { + if (this.personalIdentification == null) { + this.personalIdentification = new ArrayList(); + } + this.personalIdentification.add(personalIdentificationItem); + return this; + } + + /** + * Get personalIdentification + * @return personalIdentification + **/ + @ApiModelProperty(value = "") + public List getPersonalIdentification() { + return personalIdentification; + } + + public void setPersonalIdentification(List personalIdentification) { + this.personalIdentification = personalIdentification; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation) o; + return Objects.equals(this.companyTaxID, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.companyTaxID) && + Objects.equals(this.currency, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.currency) && + Objects.equals(this.dateOBirth, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.dateOBirth) && + Objects.equals(this.personalIdentification, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.personalIdentification); + } + + @Override + public int hashCode() { + return Objects.hash(companyTaxID, currency, dateOBirth, personalIdentification); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation {\n"); + + sb.append(" companyTaxID: ").append(toIndentedString(companyTaxID)).append("\n"); + sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); + sb.append(" dateOBirth: ").append(toIndentedString(dateOBirth)).append("\n"); + sb.append(" personalIdentification: ").append(toIndentedString(personalIdentification)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv1paymentinstrumentsBuyerInformationIssuedBy.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy.java similarity index 52% rename from src/main/java/Model/Tmsv1paymentinstrumentsBuyerInformationIssuedBy.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy.java index 66a360109..18d9f19c3 100644 --- a/src/main/java/Model/Tmsv1paymentinstrumentsBuyerInformationIssuedBy.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,23 +24,23 @@ import java.io.IOException; /** - * Tmsv1paymentinstrumentsBuyerInformationIssuedBy + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1paymentinstrumentsBuyerInformationIssuedBy { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy { @SerializedName("administrativeArea") private String administrativeArea = null; - public Tmsv1paymentinstrumentsBuyerInformationIssuedBy administrativeArea(String administrativeArea) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy administrativeArea(String administrativeArea) { this.administrativeArea = administrativeArea; return this; } /** - * State or province where the identification was issued. + * State or province in which the customer’s driver’s license was issued. Use the State, Province, and Territory Codes for the United States and Canada. **Important**: Contact your TeleCheck representative to learn whether this field is required or optional. * @return administrativeArea **/ - @ApiModelProperty(example = "CA", value = "State or province where the identification was issued.") + @ApiModelProperty(example = "CA", value = "State or province in which the customer’s driver’s license was issued. Use the State, Province, and Territory Codes for the United States and Canada. **Important**: Contact your TeleCheck representative to learn whether this field is required or optional. ") public String getAdministrativeArea() { return administrativeArea; } @@ -58,8 +58,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv1paymentinstrumentsBuyerInformationIssuedBy tmsv1paymentinstrumentsBuyerInformationIssuedBy = (Tmsv1paymentinstrumentsBuyerInformationIssuedBy) o; - return Objects.equals(this.administrativeArea, tmsv1paymentinstrumentsBuyerInformationIssuedBy.administrativeArea); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy) o; + return Objects.equals(this.administrativeArea, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy.administrativeArea); } @Override @@ -71,7 +71,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1paymentinstrumentsBuyerInformationIssuedBy {\n"); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy {\n"); sb.append(" administrativeArea: ").append(toIndentedString(administrativeArea)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.java new file mode 100644 index 000000000..c489901db --- /dev/null +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.java @@ -0,0 +1,185 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification { + @SerializedName("id") + private String id = null; + + /** + * Type of personal identification. **Important**: Contact your TeleCheck representative to learn whether this field is required or optional. + */ + @JsonAdapter(TypeEnum.Adapter.class) + public enum TypeEnum { + LICENSE("driver license"); + + private String value; + + TypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static TypeEnum fromValue(String text) { + for (TypeEnum b : TypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public TypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("type") + private TypeEnum type = null; + + @SerializedName("issuedBy") + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy issuedBy = null; + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification id(String id) { + this.id = id; + return this; + } + + /** + * Customer's identification number. **Important**: Contact your TeleCheck representative to learn whether this field is required or optional. + * @return id + **/ + @ApiModelProperty(example = "1234567890", value = "Customer's identification number. **Important**: Contact your TeleCheck representative to learn whether this field is required or optional. ") + public String getId() { + return id; + } + + public void setId(String id) { + this.id = id; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification type(TypeEnum type) { + this.type = type; + return this; + } + + /** + * Type of personal identification. **Important**: Contact your TeleCheck representative to learn whether this field is required or optional. + * @return type + **/ + @ApiModelProperty(example = "driver license", value = "Type of personal identification. **Important**: Contact your TeleCheck representative to learn whether this field is required or optional. ") + public TypeEnum getType() { + return type; + } + + public void setType(TypeEnum type) { + this.type = type; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification issuedBy(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy issuedBy) { + this.issuedBy = issuedBy; + return this; + } + + /** + * Get issuedBy + * @return issuedBy + **/ + @ApiModelProperty(value = "") + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy getIssuedBy() { + return issuedBy; + } + + public void setIssuedBy(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy issuedBy) { + this.issuedBy = issuedBy; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification) o; + return Objects.equals(this.id, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.id) && + Objects.equals(this.type, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.type) && + Objects.equals(this.issuedBy, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.issuedBy); + } + + @Override + public int hashCode() { + return Objects.hash(id, type, issuedBy); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification {\n"); + + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" issuedBy: ").append(toIndentedString(issuedBy)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.java new file mode 100644 index 000000000..ea7f22538 --- /dev/null +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.java @@ -0,0 +1,388 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard { + @SerializedName("expirationMonth") + private String expirationMonth = null; + + @SerializedName("expirationYear") + private String expirationYear = null; + + /** + * Type of credit card. Possible values: * Visa (001) * Mastercard (002) - Eurocard—European regional brand of Mastercard * American Express (003) * Discover (004) * Diners Club (005) * Carte Blanche (006) * JCB (007) * Optima (008) * Twinpay Credit (011) * Twinpay Debit (012) * Walmart (013) * EnRoute (014) * Lowes consumer (015) * Home Depot consumer (016) * MBNA (017) * Dicks Sportswear (018) * Casual Corner (019) * Sears (020) * JAL (021) * Disney (023) * Maestro (024) - UK Domestic * Sams Club consumer (025) * Sams Club business (026) * Nicos (027) * Bill me later (028) * Bebe (029) * Restoration Hardware (030) * Delta (031) — use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types. * Solo (032) * Visa Electron (033) * Dankort (034) * Laser (035) * Carte Bleue (036) — formerly Cartes Bancaires * Cartes Bancaires (036) * Carta Si (037) * pinless debit (038) * encoded account (039) * UATP (040) * Household (041) * Maestro (042) - International * GE Money UK (043) * Korean cards (044) * Style (045) * JCrew (046) * PayEase China processing eWallet (047) * PayEase China processing bank transfer (048) * Meijer Private Label (049) * Hipercard (050) — supported only by the Comercio Latino processor. * Aura (051) — supported only by the Comercio Latino processor. * Redecard (052) * ORICO (053) * Elo (054) — supported only by the Comercio Latino processor. * Capital One Private Label (055) * Synchrony Private Label (056) * Costco Private Label (057) * mada (060) * China Union Pay (062) * Falabella private label (063) + */ + @JsonAdapter(TypeEnum.Adapter.class) + public enum TypeEnum { + VISA("visa"), + + MASTERCARD("mastercard"), + + AMERICAN_EXPRESS("american express"), + + DISCOVER("discover"), + + DINERS_CLUB("diners club"), + + CARTE_BLANCHE("carte blanche"), + + JCB("jcb"), + + OPTIMA("optima"), + + TWINPAY_CREDIT("twinpay credit"), + + TWINPAY_DEBIT("twinpay debit"), + + WALMART("walmart"), + + ENROUTE("enroute"), + + LOWES_CONSUMER("lowes consumer"), + + HOME_DEPOT_CONSUMER("home depot consumer"), + + MBNA("mbna"), + + DICKS_SPORTSWEAR("dicks sportswear"), + + CASUAL_CORNER("casual corner"), + + SEARS("sears"), + + JAL("jal"), + + DISNEY("disney"), + + MAESTRO_UK_DOMESTIC("maestro uk domestic"), + + SAMS_CLUB_CONSUMER("sams club consumer"), + + SAMS_CLUB_BUSINESS("sams club business"), + + NICOS("nicos"), + + BILL_ME_LATER("bill me later"), + + BEBE("bebe"), + + RESTORATION_HARDWARE("restoration hardware"), + + DELTA_ONLINE("delta online"), + + SOLO("solo"), + + VISA_ELECTRON("visa electron"), + + DANKORT("dankort"), + + LASER("laser"), + + CARTE_BLEUE("carte bleue"), + + CARTA_SI("carta si"), + + PINLESS_DEBIT("pinless debit"), + + ENCODED_ACCOUNT("encoded account"), + + UATP("uatp"), + + HOUSEHOLD("household"), + + MAESTRO_INTERNATIONAL("maestro international"), + + GE_MONEY_UK("ge money uk"), + + KOREAN_CARDS("korean cards"), + + STYLE("style"), + + JCREW("jcrew"), + + PAYEASE_CHINA_PROCESSING_EWALLET("payease china processing ewallet"), + + PAYEASE_CHINA_PROCESSING_BANK_TRANSFER("payease china processing bank transfer"), + + MEIJER_PRIVATE_LABEL("meijer private label"), + + HIPERCARD("hipercard"), + + AURA("aura"), + + REDECARD("redecard"), + + ORICO("orico"), + + ELO("elo"), + + CAPITAL_ONE_PRIVATE_LABEL("capital one private label"), + + SYNCHRONY_PRIVATE_LABEL("synchrony private label"), + + CHINA_UNION_PAY("china union pay"), + + COSTCO_PRIVATE_LABEL("costco private label"), + + MADA("mada"), + + FALABELLA_PRIVATE_LABEL("falabella private label"); + + private String value; + + TypeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static TypeEnum fromValue(String text) { + for (TypeEnum b : TypeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public TypeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return TypeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("type") + private TypeEnum type = null; + + @SerializedName("issueNumber") + private String issueNumber = null; + + @SerializedName("startMonth") + private String startMonth = null; + + @SerializedName("startYear") + private String startYear = null; + + @SerializedName("useAs") + private String useAs = null; + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard expirationMonth(String expirationMonth) { + this.expirationMonth = expirationMonth; + return this; + } + + /** + * Two-digit month in which the credit card expires. Format: `MM` Possible values: `01` through `12` This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. For more information about relaxed requirements, see the TMS REST API Developer Guide. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting. + * @return expirationMonth + **/ + @ApiModelProperty(example = "12", value = "Two-digit month in which the credit card expires. Format: `MM` Possible values: `01` through `12` This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. For more information about relaxed requirements, see the TMS REST API Developer Guide. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting. ") + public String getExpirationMonth() { + return expirationMonth; + } + + public void setExpirationMonth(String expirationMonth) { + this.expirationMonth = expirationMonth; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard expirationYear(String expirationYear) { + this.expirationYear = expirationYear; + return this; + } + + /** + * Four-digit year in which the credit card expires. Format: `YYYY`. Possible values: `1900` through `2099`. **FDC Nashville Global and FDMS South** You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See Relaxed Requirements for Address Data and Expiration Date page. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.' + * @return expirationYear + **/ + @ApiModelProperty(example = "2022", value = "Four-digit year in which the credit card expires. Format: `YYYY`. Possible values: `1900` through `2099`. **FDC Nashville Global and FDMS South** You can send in 2 digits or 4 digits. When you send in 2 digits, they must be the last 2 digits of the year. This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See Relaxed Requirements for Address Data and Expiration Date page. Important: It is your responsibility to determine whether a field is required for the transaction you are requesting.' ") + public String getExpirationYear() { + return expirationYear; + } + + public void setExpirationYear(String expirationYear) { + this.expirationYear = expirationYear; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard type(TypeEnum type) { + this.type = type; + return this; + } + + /** + * Type of credit card. Possible values: * Visa (001) * Mastercard (002) - Eurocard—European regional brand of Mastercard * American Express (003) * Discover (004) * Diners Club (005) * Carte Blanche (006) * JCB (007) * Optima (008) * Twinpay Credit (011) * Twinpay Debit (012) * Walmart (013) * EnRoute (014) * Lowes consumer (015) * Home Depot consumer (016) * MBNA (017) * Dicks Sportswear (018) * Casual Corner (019) * Sears (020) * JAL (021) * Disney (023) * Maestro (024) - UK Domestic * Sams Club consumer (025) * Sams Club business (026) * Nicos (027) * Bill me later (028) * Bebe (029) * Restoration Hardware (030) * Delta (031) — use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types. * Solo (032) * Visa Electron (033) * Dankort (034) * Laser (035) * Carte Bleue (036) — formerly Cartes Bancaires * Cartes Bancaires (036) * Carta Si (037) * pinless debit (038) * encoded account (039) * UATP (040) * Household (041) * Maestro (042) - International * GE Money UK (043) * Korean cards (044) * Style (045) * JCrew (046) * PayEase China processing eWallet (047) * PayEase China processing bank transfer (048) * Meijer Private Label (049) * Hipercard (050) — supported only by the Comercio Latino processor. * Aura (051) — supported only by the Comercio Latino processor. * Redecard (052) * ORICO (053) * Elo (054) — supported only by the Comercio Latino processor. * Capital One Private Label (055) * Synchrony Private Label (056) * Costco Private Label (057) * mada (060) * China Union Pay (062) * Falabella private label (063) + * @return type + **/ + @ApiModelProperty(required = true, value = "Type of credit card. Possible values: * Visa (001) * Mastercard (002) - Eurocard—European regional brand of Mastercard * American Express (003) * Discover (004) * Diners Club (005) * Carte Blanche (006) * JCB (007) * Optima (008) * Twinpay Credit (011) * Twinpay Debit (012) * Walmart (013) * EnRoute (014) * Lowes consumer (015) * Home Depot consumer (016) * MBNA (017) * Dicks Sportswear (018) * Casual Corner (019) * Sears (020) * JAL (021) * Disney (023) * Maestro (024) - UK Domestic * Sams Club consumer (025) * Sams Club business (026) * Nicos (027) * Bill me later (028) * Bebe (029) * Restoration Hardware (030) * Delta (031) — use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types. * Solo (032) * Visa Electron (033) * Dankort (034) * Laser (035) * Carte Bleue (036) — formerly Cartes Bancaires * Cartes Bancaires (036) * Carta Si (037) * pinless debit (038) * encoded account (039) * UATP (040) * Household (041) * Maestro (042) - International * GE Money UK (043) * Korean cards (044) * Style (045) * JCrew (046) * PayEase China processing eWallet (047) * PayEase China processing bank transfer (048) * Meijer Private Label (049) * Hipercard (050) — supported only by the Comercio Latino processor. * Aura (051) — supported only by the Comercio Latino processor. * Redecard (052) * ORICO (053) * Elo (054) — supported only by the Comercio Latino processor. * Capital One Private Label (055) * Synchrony Private Label (056) * Costco Private Label (057) * mada (060) * China Union Pay (062) * Falabella private label (063) ") + public TypeEnum getType() { + return type; + } + + public void setType(TypeEnum type) { + this.type = type; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard issueNumber(String issueNumber) { + this.issueNumber = issueNumber; + return this; + } + + /** + * Number of times a Maestro (UK Domestic) card has been issued to the account holder. + * @return issueNumber + **/ + @ApiModelProperty(example = "01", value = "Number of times a Maestro (UK Domestic) card has been issued to the account holder.") + public String getIssueNumber() { + return issueNumber; + } + + public void setIssueNumber(String issueNumber) { + this.issueNumber = issueNumber; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard startMonth(String startMonth) { + this.startMonth = startMonth; + return this; + } + + /** + * Month of the start of the Maestro (UK Domestic) card validity period. Format: `MM`. Possible values: `01` through `12`. + * @return startMonth + **/ + @ApiModelProperty(example = "12", value = "Month of the start of the Maestro (UK Domestic) card validity period. Format: `MM`. Possible values: `01` through `12`. ") + public String getStartMonth() { + return startMonth; + } + + public void setStartMonth(String startMonth) { + this.startMonth = startMonth; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard startYear(String startYear) { + this.startYear = startYear; + return this; + } + + /** + * Year of the start of the Maestro (UK Domestic) card validity period. Format: `YYYY`. Possible values: `1900` through `2099`. + * @return startYear + **/ + @ApiModelProperty(example = "2022", value = "Year of the start of the Maestro (UK Domestic) card validity period. Format: `YYYY`. Possible values: `1900` through `2099`. ") + public String getStartYear() { + return startYear; + } + + public void setStartYear(String startYear) { + this.startYear = startYear; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard useAs(String useAs) { + this.useAs = useAs; + return this; + } + + /** + * Card Use As Field. Supported value of `pinless debit` only. Only for use with Pinless Debit tokens. + * @return useAs + **/ + @ApiModelProperty(example = "pinless debit", value = "Card Use As Field. Supported value of `pinless debit` only. Only for use with Pinless Debit tokens.") + public String getUseAs() { + return useAs; + } + + public void setUseAs(String useAs) { + this.useAs = useAs; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard) o; + return Objects.equals(this.expirationMonth, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.expirationMonth) && + Objects.equals(this.expirationYear, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.expirationYear) && + Objects.equals(this.type, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.type) && + Objects.equals(this.issueNumber, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.issueNumber) && + Objects.equals(this.startMonth, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.startMonth) && + Objects.equals(this.startYear, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.startYear) && + Objects.equals(this.useAs, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.useAs); + } + + @Override + public int hashCode() { + return Objects.hash(expirationMonth, expirationYear, type, issueNumber, startMonth, startYear, useAs); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard {\n"); + + sb.append(" expirationMonth: ").append(toIndentedString(expirationMonth)).append("\n"); + sb.append(" expirationYear: ").append(toIndentedString(expirationYear)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" issueNumber: ").append(toIndentedString(issueNumber)).append("\n"); + sb.append(" startMonth: ").append(toIndentedString(startMonth)).append("\n"); + sb.append(" startYear: ").append(toIndentedString(startYear)).append("\n"); + sb.append(" useAs: ").append(toIndentedString(useAs)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv1paymentinstrumentsInstrumentIdentifier.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.java similarity index 57% rename from src/main/java/Model/Tmsv1paymentinstrumentsInstrumentIdentifier.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.java index d007be4b7..6de609ed1 100644 --- a/src/main/java/Model/Tmsv1paymentinstrumentsInstrumentIdentifier.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,11 +14,11 @@ package Model; import java.util.Objects; -import Model.Tmsv1instrumentidentifiersBankAccount; -import Model.Tmsv1instrumentidentifiersCard; -import Model.Tmsv1instrumentidentifiersLinks; -import Model.Tmsv1instrumentidentifiersMetadata; -import Model.Tmsv1instrumentidentifiersProcessingInformation; +import Model.TmsV1InstrumentIdentifiersPost200ResponseBankAccount; +import Model.TmsV1InstrumentIdentifiersPost200ResponseCard; +import Model.TmsV1InstrumentIdentifiersPost200ResponseLinks; +import Model.TmsV1InstrumentIdentifiersPost200ResponseMetadata; +import Model.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -29,15 +29,15 @@ import java.io.IOException; /** - * Tmsv1paymentinstrumentsInstrumentIdentifier + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1paymentinstrumentsInstrumentIdentifier { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier { @SerializedName("_links") - private Tmsv1instrumentidentifiersLinks links = null; + private TmsV1InstrumentIdentifiersPost200ResponseLinks links = null; /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. + * Describes type of token. */ @JsonAdapter(ObjectEnum.Adapter.class) public enum ObjectEnum { @@ -138,18 +138,18 @@ public StateEnum read(final JsonReader jsonReader) throws IOException { private String id = null; @SerializedName("card") - private Tmsv1instrumentidentifiersCard card = null; + private TmsV1InstrumentIdentifiersPost200ResponseCard card = null; @SerializedName("bankAccount") - private Tmsv1instrumentidentifiersBankAccount bankAccount = null; + private TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount = null; @SerializedName("processingInformation") - private Tmsv1instrumentidentifiersProcessingInformation processingInformation = null; + private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation = null; @SerializedName("metadata") - private Tmsv1instrumentidentifiersMetadata metadata = null; + private TmsV1InstrumentIdentifiersPost200ResponseMetadata metadata = null; - public Tmsv1paymentinstrumentsInstrumentIdentifier links(Tmsv1instrumentidentifiersLinks links) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier links(TmsV1InstrumentIdentifiersPost200ResponseLinks links) { this.links = links; return this; } @@ -159,19 +159,19 @@ public Tmsv1paymentinstrumentsInstrumentIdentifier links(Tmsv1instrumentidentifi * @return links **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersLinks getLinks() { + public TmsV1InstrumentIdentifiersPost200ResponseLinks getLinks() { return links; } - public void setLinks(Tmsv1instrumentidentifiersLinks links) { + public void setLinks(TmsV1InstrumentIdentifiersPost200ResponseLinks links) { this.links = links; } /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. + * Describes type of token. * @return object **/ - @ApiModelProperty(example = "instrumentIdentifier", value = "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.") + @ApiModelProperty(example = "instrumentIdentifier", value = "Describes type of token.") public ObjectEnum getObject() { return object; } @@ -185,16 +185,16 @@ public StateEnum getState() { return state; } - public Tmsv1paymentinstrumentsInstrumentIdentifier id(String id) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier id(String id) { this.id = id; return this; } /** - * The id of the existing instrument identifier to be linked to the newly created payment instrument. + * The ID of the existing instrument identifier to be linked to the newly created payment instrument. * @return id **/ - @ApiModelProperty(example = "1234567890123456789", value = "The id of the existing instrument identifier to be linked to the newly created payment instrument.") + @ApiModelProperty(example = "1234567890123456789", value = "The ID of the existing instrument identifier to be linked to the newly created payment instrument.") public String getId() { return id; } @@ -203,7 +203,7 @@ public void setId(String id) { this.id = id; } - public Tmsv1paymentinstrumentsInstrumentIdentifier card(Tmsv1instrumentidentifiersCard card) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier card(TmsV1InstrumentIdentifiersPost200ResponseCard card) { this.card = card; return this; } @@ -213,15 +213,15 @@ public Tmsv1paymentinstrumentsInstrumentIdentifier card(Tmsv1instrumentidentifie * @return card **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersCard getCard() { + public TmsV1InstrumentIdentifiersPost200ResponseCard getCard() { return card; } - public void setCard(Tmsv1instrumentidentifiersCard card) { + public void setCard(TmsV1InstrumentIdentifiersPost200ResponseCard card) { this.card = card; } - public Tmsv1paymentinstrumentsInstrumentIdentifier bankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier bankAccount(TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount) { this.bankAccount = bankAccount; return this; } @@ -231,15 +231,15 @@ public Tmsv1paymentinstrumentsInstrumentIdentifier bankAccount(Tmsv1instrumentid * @return bankAccount **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersBankAccount getBankAccount() { + public TmsV1InstrumentIdentifiersPost200ResponseBankAccount getBankAccount() { return bankAccount; } - public void setBankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { + public void setBankAccount(TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount) { this.bankAccount = bankAccount; } - public Tmsv1paymentinstrumentsInstrumentIdentifier processingInformation(Tmsv1instrumentidentifiersProcessingInformation processingInformation) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier processingInformation(TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation) { this.processingInformation = processingInformation; return this; } @@ -249,15 +249,15 @@ public Tmsv1paymentinstrumentsInstrumentIdentifier processingInformation(Tmsv1in * @return processingInformation **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersProcessingInformation getProcessingInformation() { + public TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation getProcessingInformation() { return processingInformation; } - public void setProcessingInformation(Tmsv1instrumentidentifiersProcessingInformation processingInformation) { + public void setProcessingInformation(TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation) { this.processingInformation = processingInformation; } - public Tmsv1paymentinstrumentsInstrumentIdentifier metadata(Tmsv1instrumentidentifiersMetadata metadata) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier metadata(TmsV1InstrumentIdentifiersPost200ResponseMetadata metadata) { this.metadata = metadata; return this; } @@ -267,11 +267,11 @@ public Tmsv1paymentinstrumentsInstrumentIdentifier metadata(Tmsv1instrumentident * @return metadata **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersMetadata getMetadata() { + public TmsV1InstrumentIdentifiersPost200ResponseMetadata getMetadata() { return metadata; } - public void setMetadata(Tmsv1instrumentidentifiersMetadata metadata) { + public void setMetadata(TmsV1InstrumentIdentifiersPost200ResponseMetadata metadata) { this.metadata = metadata; } @@ -284,15 +284,15 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv1paymentinstrumentsInstrumentIdentifier tmsv1paymentinstrumentsInstrumentIdentifier = (Tmsv1paymentinstrumentsInstrumentIdentifier) o; - return Objects.equals(this.links, tmsv1paymentinstrumentsInstrumentIdentifier.links) && - Objects.equals(this.object, tmsv1paymentinstrumentsInstrumentIdentifier.object) && - Objects.equals(this.state, tmsv1paymentinstrumentsInstrumentIdentifier.state) && - Objects.equals(this.id, tmsv1paymentinstrumentsInstrumentIdentifier.id) && - Objects.equals(this.card, tmsv1paymentinstrumentsInstrumentIdentifier.card) && - Objects.equals(this.bankAccount, tmsv1paymentinstrumentsInstrumentIdentifier.bankAccount) && - Objects.equals(this.processingInformation, tmsv1paymentinstrumentsInstrumentIdentifier.processingInformation) && - Objects.equals(this.metadata, tmsv1paymentinstrumentsInstrumentIdentifier.metadata); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier) o; + return Objects.equals(this.links, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.links) && + Objects.equals(this.object, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.object) && + Objects.equals(this.state, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.state) && + Objects.equals(this.id, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.id) && + Objects.equals(this.card, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.card) && + Objects.equals(this.bankAccount, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.bankAccount) && + Objects.equals(this.processingInformation, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.processingInformation) && + Objects.equals(this.metadata, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.metadata); } @Override @@ -304,7 +304,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1paymentinstrumentsInstrumentIdentifier {\n"); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier {\n"); sb.append(" links: ").append(toIndentedString(links)).append("\n"); sb.append(" object: ").append(toIndentedString(object)).append("\n"); diff --git a/src/main/java/Model/Tmsv1paymentinstrumentsMerchantInformation.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.java similarity index 50% rename from src/main/java/Model/Tmsv1paymentinstrumentsMerchantInformation.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.java index 33c780532..6fc1d2684 100644 --- a/src/main/java/Model/Tmsv1paymentinstrumentsMerchantInformation.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -25,14 +25,14 @@ import java.io.IOException; /** - * Tmsv1paymentinstrumentsMerchantInformation + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1paymentinstrumentsMerchantInformation { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation { @SerializedName("merchantDescriptor") - private Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor merchantDescriptor = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor merchantDescriptor = null; - public Tmsv1paymentinstrumentsMerchantInformation merchantDescriptor(Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor merchantDescriptor) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation merchantDescriptor(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor merchantDescriptor) { this.merchantDescriptor = merchantDescriptor; return this; } @@ -42,11 +42,11 @@ public Tmsv1paymentinstrumentsMerchantInformation merchantDescriptor(Tmsv1paymen * @return merchantDescriptor **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor getMerchantDescriptor() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor getMerchantDescriptor() { return merchantDescriptor; } - public void setMerchantDescriptor(Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor merchantDescriptor) { + public void setMerchantDescriptor(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor merchantDescriptor) { this.merchantDescriptor = merchantDescriptor; } @@ -59,8 +59,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv1paymentinstrumentsMerchantInformation tmsv1paymentinstrumentsMerchantInformation = (Tmsv1paymentinstrumentsMerchantInformation) o; - return Objects.equals(this.merchantDescriptor, tmsv1paymentinstrumentsMerchantInformation.merchantDescriptor); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation) o; + return Objects.equals(this.merchantDescriptor, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.merchantDescriptor); } @Override @@ -72,7 +72,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1paymentinstrumentsMerchantInformation {\n"); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation {\n"); sb.append(" merchantDescriptor: ").append(toIndentedString(merchantDescriptor)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor.java similarity index 63% rename from src/main/java/Model/Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor.java index d806ac610..078046881 100644 --- a/src/main/java/Model/Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,14 +24,14 @@ import java.io.IOException; /** - * Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor { @SerializedName("alternateName") private String alternateName = null; - public Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor alternateName(String alternateName) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor alternateName(String alternateName) { this.alternateName = alternateName; return this; } @@ -58,8 +58,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor = (Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor) o; - return Objects.equals(this.alternateName, tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor.alternateName); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor) o; + return Objects.equals(this.alternateName, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor.alternateName); } @Override @@ -71,7 +71,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1paymentinstrumentsMerchantInformationMerchantDescriptor {\n"); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor {\n"); sb.append(" alternateName: ").append(toIndentedString(alternateName)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.java new file mode 100644 index 000000000..33afbbec6 --- /dev/null +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.java @@ -0,0 +1,420 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation; +import Model.TmsV1InstrumentIdentifiersPost200ResponseLinks; +import Model.TmsV1InstrumentIdentifiersPost200ResponseMetadata; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments { + @SerializedName("_links") + private TmsV1InstrumentIdentifiersPost200ResponseLinks links = null; + + @SerializedName("id") + private String id = null; + + /** + * Describes type of token. + */ + @JsonAdapter(ObjectEnum.Adapter.class) + public enum ObjectEnum { + PAYMENTINSTRUMENT("paymentInstrument"); + + private String value; + + ObjectEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static ObjectEnum fromValue(String text) { + for (ObjectEnum b : ObjectEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final ObjectEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public ObjectEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return ObjectEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("object") + private ObjectEnum object = null; + + /** + * Current state of the token. + */ + @JsonAdapter(StateEnum.Adapter.class) + public enum StateEnum { + ACTIVE("ACTIVE"), + + CLOSED("CLOSED"); + + private String value; + + StateEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static StateEnum fromValue(String text) { + for (StateEnum b : StateEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public StateEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return StateEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("state") + private StateEnum state = null; + + @SerializedName("bankAccount") + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount bankAccount = null; + + @SerializedName("card") + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard card = null; + + @SerializedName("buyerInformation") + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation buyerInformation = null; + + @SerializedName("billTo") + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo billTo = null; + + @SerializedName("processingInformation") + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation processingInformation = null; + + @SerializedName("merchantInformation") + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation merchantInformation = null; + + @SerializedName("metaData") + private TmsV1InstrumentIdentifiersPost200ResponseMetadata metaData = null; + + @SerializedName("instrumentIdentifier") + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier instrumentIdentifier = null; + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments links(TmsV1InstrumentIdentifiersPost200ResponseLinks links) { + this.links = links; + return this; + } + + /** + * Get links + * @return links + **/ + @ApiModelProperty(value = "") + public TmsV1InstrumentIdentifiersPost200ResponseLinks getLinks() { + return links; + } + + public void setLinks(TmsV1InstrumentIdentifiersPost200ResponseLinks links) { + this.links = links; + } + + /** + * Unique identification number assigned by CyberSource to the submitted request. + * @return id + **/ + @ApiModelProperty(example = "1234567890123456800", value = "Unique identification number assigned by CyberSource to the submitted request.") + public String getId() { + return id; + } + + /** + * Describes type of token. + * @return object + **/ + @ApiModelProperty(example = "instrumentIdentifier", value = "Describes type of token.") + public ObjectEnum getObject() { + return object; + } + + /** + * Current state of the token. + * @return state + **/ + @ApiModelProperty(example = "ACTIVE", value = "Current state of the token.") + public StateEnum getState() { + return state; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments bankAccount(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount bankAccount) { + this.bankAccount = bankAccount; + return this; + } + + /** + * Get bankAccount + * @return bankAccount + **/ + @ApiModelProperty(value = "") + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount getBankAccount() { + return bankAccount; + } + + public void setBankAccount(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount bankAccount) { + this.bankAccount = bankAccount; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments card(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard card) { + this.card = card; + return this; + } + + /** + * Get card + * @return card + **/ + @ApiModelProperty(value = "") + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard getCard() { + return card; + } + + public void setCard(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard card) { + this.card = card; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments buyerInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation buyerInformation) { + this.buyerInformation = buyerInformation; + return this; + } + + /** + * Get buyerInformation + * @return buyerInformation + **/ + @ApiModelProperty(value = "") + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation getBuyerInformation() { + return buyerInformation; + } + + public void setBuyerInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation buyerInformation) { + this.buyerInformation = buyerInformation; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments billTo(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo billTo) { + this.billTo = billTo; + return this; + } + + /** + * Get billTo + * @return billTo + **/ + @ApiModelProperty(value = "") + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo getBillTo() { + return billTo; + } + + public void setBillTo(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo billTo) { + this.billTo = billTo; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments processingInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation processingInformation) { + this.processingInformation = processingInformation; + return this; + } + + /** + * Get processingInformation + * @return processingInformation + **/ + @ApiModelProperty(value = "") + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation getProcessingInformation() { + return processingInformation; + } + + public void setProcessingInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation processingInformation) { + this.processingInformation = processingInformation; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments merchantInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation merchantInformation) { + this.merchantInformation = merchantInformation; + return this; + } + + /** + * Get merchantInformation + * @return merchantInformation + **/ + @ApiModelProperty(value = "") + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation getMerchantInformation() { + return merchantInformation; + } + + public void setMerchantInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation merchantInformation) { + this.merchantInformation = merchantInformation; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments metaData(TmsV1InstrumentIdentifiersPost200ResponseMetadata metaData) { + this.metaData = metaData; + return this; + } + + /** + * Get metaData + * @return metaData + **/ + @ApiModelProperty(value = "") + public TmsV1InstrumentIdentifiersPost200ResponseMetadata getMetaData() { + return metaData; + } + + public void setMetaData(TmsV1InstrumentIdentifiersPost200ResponseMetadata metaData) { + this.metaData = metaData; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments instrumentIdentifier(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier instrumentIdentifier) { + this.instrumentIdentifier = instrumentIdentifier; + return this; + } + + /** + * Get instrumentIdentifier + * @return instrumentIdentifier + **/ + @ApiModelProperty(value = "") + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier getInstrumentIdentifier() { + return instrumentIdentifier; + } + + public void setInstrumentIdentifier(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier instrumentIdentifier) { + this.instrumentIdentifier = instrumentIdentifier; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments) o; + return Objects.equals(this.links, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.links) && + Objects.equals(this.id, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.id) && + Objects.equals(this.object, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.object) && + Objects.equals(this.state, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.state) && + Objects.equals(this.bankAccount, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.bankAccount) && + Objects.equals(this.card, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.card) && + Objects.equals(this.buyerInformation, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.buyerInformation) && + Objects.equals(this.billTo, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.billTo) && + Objects.equals(this.processingInformation, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.processingInformation) && + Objects.equals(this.merchantInformation, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.merchantInformation) && + Objects.equals(this.metaData, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.metaData) && + Objects.equals(this.instrumentIdentifier, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.instrumentIdentifier); + } + + @Override + public int hashCode() { + return Objects.hash(links, id, object, state, bankAccount, card, buyerInformation, billTo, processingInformation, merchantInformation, metaData, instrumentIdentifier); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments {\n"); + + sb.append(" links: ").append(toIndentedString(links)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" object: ").append(toIndentedString(object)).append("\n"); + sb.append(" state: ").append(toIndentedString(state)).append("\n"); + sb.append(" bankAccount: ").append(toIndentedString(bankAccount)).append("\n"); + sb.append(" card: ").append(toIndentedString(card)).append("\n"); + sb.append(" buyerInformation: ").append(toIndentedString(buyerInformation)).append("\n"); + sb.append(" billTo: ").append(toIndentedString(billTo)).append("\n"); + sb.append(" processingInformation: ").append(toIndentedString(processingInformation)).append("\n"); + sb.append(" merchantInformation: ").append(toIndentedString(merchantInformation)).append("\n"); + sb.append(" metaData: ").append(toIndentedString(metaData)).append("\n"); + sb.append(" instrumentIdentifier: ").append(toIndentedString(instrumentIdentifier)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.java new file mode 100644 index 000000000..2a5a46924 --- /dev/null +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation { + @SerializedName("billPaymentProgramEnabled") + private Boolean billPaymentProgramEnabled = false; + + @SerializedName("bankTransferOptions") + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions bankTransferOptions = null; + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation billPaymentProgramEnabled(Boolean billPaymentProgramEnabled) { + this.billPaymentProgramEnabled = billPaymentProgramEnabled; + return this; + } + + /** + * Indicates that the payments for this customer profile are for the Bill Payment program. Possible values: * false: Not a Visa Bill Payment. * true: Visa Bill Payment. + * @return billPaymentProgramEnabled + **/ + @ApiModelProperty(example = "true", value = "Indicates that the payments for this customer profile are for the Bill Payment program. Possible values: * false: Not a Visa Bill Payment. * true: Visa Bill Payment. ") + public Boolean getBillPaymentProgramEnabled() { + return billPaymentProgramEnabled; + } + + public void setBillPaymentProgramEnabled(Boolean billPaymentProgramEnabled) { + this.billPaymentProgramEnabled = billPaymentProgramEnabled; + } + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation bankTransferOptions(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions bankTransferOptions) { + this.bankTransferOptions = bankTransferOptions; + return this; + } + + /** + * Get bankTransferOptions + * @return bankTransferOptions + **/ + @ApiModelProperty(value = "") + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions getBankTransferOptions() { + return bankTransferOptions; + } + + public void setBankTransferOptions(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions bankTransferOptions) { + this.bankTransferOptions = bankTransferOptions; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation) o; + return Objects.equals(this.billPaymentProgramEnabled, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.billPaymentProgramEnabled) && + Objects.equals(this.bankTransferOptions, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.bankTransferOptions); + } + + @Override + public int hashCode() { + return Objects.hash(billPaymentProgramEnabled, bankTransferOptions); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation {\n"); + + sb.append(" billPaymentProgramEnabled: ").append(toIndentedString(billPaymentProgramEnabled)).append("\n"); + sb.append(" bankTransferOptions: ").append(toIndentedString(bankTransferOptions)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions.java new file mode 100644 index 000000000..3e7d6e665 --- /dev/null +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions.java @@ -0,0 +1,144 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions { + /** + * **Important** This field is required if your processor is TeleCheck. Code that specifies the authorization method for the transaction. Possible values: - **CCD**: corporate cash disbursement. Charge or credit against a business checking account. You can use one-time or recurring CCD transactions to transfer funds to or from a corporate entity. A standing authorization is required for recurring transactions. - **PPD**: prearranged payment and deposit entry. Charge or credit against a personal checking or savings account. You can originate a PPD entry only when the payment and deposit terms between you and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions. - **TEL**: telephone-initiated entry. One-time charge against a personal checking or savings account. You can originate a TEL entry only when there is a business relationship between you and the customer or when the customer initiates a telephone call to you. For a TEL entry, you must obtain a payment authorization from the customer over the telephone. There is no recurring billing option for TEL. - **WEB**: internet-initiated entry—charge against a personal checking or savings account. You can originate a one-time or recurring WEB entry when the customer initiates the transaction over the Internet. For a WEB entry, you must obtain payment authorization from the customer over the Internet. + */ + @JsonAdapter(SeCCodeEnum.Adapter.class) + public enum SeCCodeEnum { + CCD("CCD"), + + PPD("PPD"), + + TEL("TEL"), + + WEB("WEB"); + + private String value; + + SeCCodeEnum(String value) { + this.value = value; + } + + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + public static SeCCodeEnum fromValue(String text) { + for (SeCCodeEnum b : SeCCodeEnum.values()) { + if (String.valueOf(b.value).equals(text)) { + return b; + } + } + return null; + } + + public static class Adapter extends TypeAdapter { + @Override + public void write(final JsonWriter jsonWriter, final SeCCodeEnum enumeration) throws IOException { + jsonWriter.value(enumeration.getValue()); + } + + @Override + public SeCCodeEnum read(final JsonReader jsonReader) throws IOException { + String value = jsonReader.nextString(); + return SeCCodeEnum.fromValue(String.valueOf(value)); + } + } + } + + @SerializedName("SECCode") + private SeCCodeEnum seCCode = null; + + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions seCCode(SeCCodeEnum seCCode) { + this.seCCode = seCCode; + return this; + } + + /** + * **Important** This field is required if your processor is TeleCheck. Code that specifies the authorization method for the transaction. Possible values: - **CCD**: corporate cash disbursement. Charge or credit against a business checking account. You can use one-time or recurring CCD transactions to transfer funds to or from a corporate entity. A standing authorization is required for recurring transactions. - **PPD**: prearranged payment and deposit entry. Charge or credit against a personal checking or savings account. You can originate a PPD entry only when the payment and deposit terms between you and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions. - **TEL**: telephone-initiated entry. One-time charge against a personal checking or savings account. You can originate a TEL entry only when there is a business relationship between you and the customer or when the customer initiates a telephone call to you. For a TEL entry, you must obtain a payment authorization from the customer over the telephone. There is no recurring billing option for TEL. - **WEB**: internet-initiated entry—charge against a personal checking or savings account. You can originate a one-time or recurring WEB entry when the customer initiates the transaction over the Internet. For a WEB entry, you must obtain payment authorization from the customer over the Internet. + * @return seCCode + **/ + @ApiModelProperty(example = "WEB", value = "**Important** This field is required if your processor is TeleCheck. Code that specifies the authorization method for the transaction. Possible values: - **CCD**: corporate cash disbursement. Charge or credit against a business checking account. You can use one-time or recurring CCD transactions to transfer funds to or from a corporate entity. A standing authorization is required for recurring transactions. - **PPD**: prearranged payment and deposit entry. Charge or credit against a personal checking or savings account. You can originate a PPD entry only when the payment and deposit terms between you and the customer are prearranged. A written authorization from the customer is required for one-time transactions and a written standing authorization is required for recurring transactions. - **TEL**: telephone-initiated entry. One-time charge against a personal checking or savings account. You can originate a TEL entry only when there is a business relationship between you and the customer or when the customer initiates a telephone call to you. For a TEL entry, you must obtain a payment authorization from the customer over the telephone. There is no recurring billing option for TEL. - **WEB**: internet-initiated entry—charge against a personal checking or savings account. You can originate a one-time or recurring WEB entry when the customer initiates the transaction over the Internet. For a WEB entry, you must obtain payment authorization from the customer over the Internet. ") + public SeCCodeEnum getSeCCode() { + return seCCode; + } + + public void setSeCCode(SeCCodeEnum seCCode) { + this.seCCode = seCCode; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions) o; + return Objects.equals(this.seCCode, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions.seCCode); + } + + @Override + public int hashCode() { + return Objects.hash(seCCode); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions {\n"); + + sb.append(" seCCode: ").append(toIndentedString(seCCode)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.java similarity index 52% rename from src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.java index dcd121fcd..212f9bab1 100644 --- a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,11 +14,11 @@ package Model; import java.util.Objects; -import Model.TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst; -import Model.TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast; -import Model.TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext; -import Model.TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev; -import Model.TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -29,26 +29,26 @@ import java.io.IOException; /** - * TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks { @SerializedName("self") - private TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf self = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf self = null; @SerializedName("first") - private TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst first = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst first = null; @SerializedName("prev") - private TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev prev = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev prev = null; @SerializedName("next") - private TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext next = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext next = null; @SerializedName("last") - private TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast last = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast last = null; - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks self(TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf self) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks self(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf self) { this.self = self; return this; } @@ -58,15 +58,15 @@ public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks self(TmsV * @return self **/ @ApiModelProperty(value = "") - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf getSelf() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf getSelf() { return self; } - public void setSelf(TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf self) { + public void setSelf(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf self) { this.self = self; } - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks first(TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst first) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks first(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst first) { this.first = first; return this; } @@ -76,15 +76,15 @@ public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks first(Tms * @return first **/ @ApiModelProperty(value = "") - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst getFirst() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst getFirst() { return first; } - public void setFirst(TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst first) { + public void setFirst(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst first) { this.first = first; } - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks prev(TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev prev) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks prev(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev prev) { this.prev = prev; return this; } @@ -94,15 +94,15 @@ public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks prev(TmsV * @return prev **/ @ApiModelProperty(value = "") - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev getPrev() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev getPrev() { return prev; } - public void setPrev(TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev prev) { + public void setPrev(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev prev) { this.prev = prev; } - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks next(TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext next) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks next(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext next) { this.next = next; return this; } @@ -112,15 +112,15 @@ public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks next(TmsV * @return next **/ @ApiModelProperty(value = "") - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext getNext() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext getNext() { return next; } - public void setNext(TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext next) { + public void setNext(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext next) { this.next = next; } - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks last(TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast last) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks last(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast last) { this.last = last; return this; } @@ -130,11 +130,11 @@ public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks last(TmsV * @return last **/ @ApiModelProperty(value = "") - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast getLast() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast getLast() { return last; } - public void setLast(TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast last) { + public void setLast(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast last) { this.last = last; } @@ -147,12 +147,12 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks = (TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks) o; - return Objects.equals(this.self, tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks.self) && - Objects.equals(this.first, tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks.first) && - Objects.equals(this.prev, tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks.prev) && - Objects.equals(this.next, tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks.next) && - Objects.equals(this.last, tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks.last); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks) o; + return Objects.equals(this.self, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.self) && + Objects.equals(this.first, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.first) && + Objects.equals(this.prev, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.prev) && + Objects.equals(this.next, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.next) && + Objects.equals(this.last, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.last); } @Override @@ -164,7 +164,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinks {\n"); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks {\n"); sb.append(" self: ").append(toIndentedString(self)).append("\n"); sb.append(" first: ").append(toIndentedString(first)).append("\n"); diff --git a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst.java similarity index 72% rename from src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst.java index dfeabda4b..a2cb81f1d 100644 --- a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,14 +24,14 @@ import java.io.IOException; /** - * TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst { @SerializedName("href") private String href = null; - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst href(String href) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst href(String href) { this.href = href; return this; } @@ -58,8 +58,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst = (TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst) o; - return Objects.equals(this.href, tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst.href); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst) o; + return Objects.equals(this.href, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst.href); } @Override @@ -71,7 +71,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksFirst {\n"); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst {\n"); sb.append(" href: ").append(toIndentedString(href)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast.java similarity index 72% rename from src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast.java index 0dccd8bdd..791495bc4 100644 --- a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,14 +24,14 @@ import java.io.IOException; /** - * TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast { @SerializedName("href") private String href = null; - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast href(String href) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast href(String href) { this.href = href; return this; } @@ -58,8 +58,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast = (TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast) o; - return Objects.equals(this.href, tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast.href); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast) o; + return Objects.equals(this.href, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast.href); } @Override @@ -71,7 +71,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksLast {\n"); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast {\n"); sb.append(" href: ").append(toIndentedString(href)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext.java similarity index 73% rename from src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext.java index bcaf701db..c63083bea 100644 --- a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,14 +24,14 @@ import java.io.IOException; /** - * TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext { @SerializedName("href") private String href = null; - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext href(String href) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext href(String href) { this.href = href; return this; } @@ -58,8 +58,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext = (TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext) o; - return Objects.equals(this.href, tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext.href); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext) o; + return Objects.equals(this.href, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext.href); } @Override @@ -71,7 +71,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksNext {\n"); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext {\n"); sb.append(" href: ").append(toIndentedString(href)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev.java similarity index 75% rename from src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev.java index 6a55283c7..c656c3897 100644 --- a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,12 +27,12 @@ * A link to the previous collection starting at the supplied offset minus the supplied limit. */ @ApiModel(description = "A link to the previous collection starting at the supplied offset minus the supplied limit.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev { @SerializedName("href") private String href = null; - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev href(String href) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev href(String href) { this.href = href; return this; } @@ -59,8 +59,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev = (TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev) o; - return Objects.equals(this.href, tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev.href); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev) o; + return Objects.equals(this.href, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev.href); } @Override @@ -72,7 +72,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksPrev {\n"); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev {\n"); sb.append(" href: ").append(toIndentedString(href)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf.java similarity index 72% rename from src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf.java index 18aa19e83..37e9643da 100644 --- a/src/main/java/Model/TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,14 +24,14 @@ import java.io.IOException; /** - * TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf + * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf { @SerializedName("href") private String href = null; - public TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf href(String href) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf href(String href) { this.href = href; return this; } @@ -58,8 +58,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf = (TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf) o; - return Objects.equals(this.href, tmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf.href); + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf = (TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf) o; + return Objects.equals(this.href, tmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf.href); } @Override @@ -71,7 +71,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1InstrumentidentifiersPaymentinstrumentsGet200ResponseLinksSelf {\n"); + sb.append("class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf {\n"); sb.append(" href: ").append(toIndentedString(href)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/TmsV1InstrumentidentifiersPost200Response.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200Response.java similarity index 66% rename from src/main/java/Model/TmsV1InstrumentidentifiersPost200Response.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPost200Response.java index fb0f681b6..fbef80913 100644 --- a/src/main/java/Model/TmsV1InstrumentidentifiersPost200Response.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,11 +14,11 @@ package Model; import java.util.Objects; -import Model.Tmsv1instrumentidentifiersBankAccount; -import Model.Tmsv1instrumentidentifiersCard; -import Model.Tmsv1instrumentidentifiersLinks; -import Model.Tmsv1instrumentidentifiersMetadata; -import Model.Tmsv1instrumentidentifiersProcessingInformation; +import Model.TmsV1InstrumentIdentifiersPost200ResponseBankAccount; +import Model.TmsV1InstrumentIdentifiersPost200ResponseCard; +import Model.TmsV1InstrumentIdentifiersPost200ResponseLinks; +import Model.TmsV1InstrumentIdentifiersPost200ResponseMetadata; +import Model.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -29,18 +29,18 @@ import java.io.IOException; /** - * TmsV1InstrumentidentifiersPost200Response + * TmsV1InstrumentIdentifiersPost200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1InstrumentidentifiersPost200Response { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPost200Response { @SerializedName("_links") - private Tmsv1instrumentidentifiersLinks links = null; + private TmsV1InstrumentIdentifiersPost200ResponseLinks links = null; @SerializedName("id") private String id = null; /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. + * Describes type of token. */ @JsonAdapter(ObjectEnum.Adapter.class) public enum ObjectEnum { @@ -138,18 +138,18 @@ public StateEnum read(final JsonReader jsonReader) throws IOException { private StateEnum state = null; @SerializedName("card") - private Tmsv1instrumentidentifiersCard card = null; + private TmsV1InstrumentIdentifiersPost200ResponseCard card = null; @SerializedName("bankAccount") - private Tmsv1instrumentidentifiersBankAccount bankAccount = null; + private TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount = null; @SerializedName("processingInformation") - private Tmsv1instrumentidentifiersProcessingInformation processingInformation = null; + private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation = null; @SerializedName("metadata") - private Tmsv1instrumentidentifiersMetadata metadata = null; + private TmsV1InstrumentIdentifiersPost200ResponseMetadata metadata = null; - public TmsV1InstrumentidentifiersPost200Response links(Tmsv1instrumentidentifiersLinks links) { + public TmsV1InstrumentIdentifiersPost200Response links(TmsV1InstrumentIdentifiersPost200ResponseLinks links) { this.links = links; return this; } @@ -159,11 +159,11 @@ public TmsV1InstrumentidentifiersPost200Response links(Tmsv1instrumentidentifier * @return links **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersLinks getLinks() { + public TmsV1InstrumentIdentifiersPost200ResponseLinks getLinks() { return links; } - public void setLinks(Tmsv1instrumentidentifiersLinks links) { + public void setLinks(TmsV1InstrumentIdentifiersPost200ResponseLinks links) { this.links = links; } @@ -177,10 +177,10 @@ public String getId() { } /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. + * Describes type of token. * @return object **/ - @ApiModelProperty(example = "instrumentIdentifier", value = "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.") + @ApiModelProperty(example = "instrumentIdentifier", value = "Describes type of token.") public ObjectEnum getObject() { return object; } @@ -194,7 +194,7 @@ public StateEnum getState() { return state; } - public TmsV1InstrumentidentifiersPost200Response card(Tmsv1instrumentidentifiersCard card) { + public TmsV1InstrumentIdentifiersPost200Response card(TmsV1InstrumentIdentifiersPost200ResponseCard card) { this.card = card; return this; } @@ -204,15 +204,15 @@ public TmsV1InstrumentidentifiersPost200Response card(Tmsv1instrumentidentifiers * @return card **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersCard getCard() { + public TmsV1InstrumentIdentifiersPost200ResponseCard getCard() { return card; } - public void setCard(Tmsv1instrumentidentifiersCard card) { + public void setCard(TmsV1InstrumentIdentifiersPost200ResponseCard card) { this.card = card; } - public TmsV1InstrumentidentifiersPost200Response bankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { + public TmsV1InstrumentIdentifiersPost200Response bankAccount(TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount) { this.bankAccount = bankAccount; return this; } @@ -222,15 +222,15 @@ public TmsV1InstrumentidentifiersPost200Response bankAccount(Tmsv1instrumentiden * @return bankAccount **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersBankAccount getBankAccount() { + public TmsV1InstrumentIdentifiersPost200ResponseBankAccount getBankAccount() { return bankAccount; } - public void setBankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { + public void setBankAccount(TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount) { this.bankAccount = bankAccount; } - public TmsV1InstrumentidentifiersPost200Response processingInformation(Tmsv1instrumentidentifiersProcessingInformation processingInformation) { + public TmsV1InstrumentIdentifiersPost200Response processingInformation(TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation) { this.processingInformation = processingInformation; return this; } @@ -240,15 +240,15 @@ public TmsV1InstrumentidentifiersPost200Response processingInformation(Tmsv1inst * @return processingInformation **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersProcessingInformation getProcessingInformation() { + public TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation getProcessingInformation() { return processingInformation; } - public void setProcessingInformation(Tmsv1instrumentidentifiersProcessingInformation processingInformation) { + public void setProcessingInformation(TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation) { this.processingInformation = processingInformation; } - public TmsV1InstrumentidentifiersPost200Response metadata(Tmsv1instrumentidentifiersMetadata metadata) { + public TmsV1InstrumentIdentifiersPost200Response metadata(TmsV1InstrumentIdentifiersPost200ResponseMetadata metadata) { this.metadata = metadata; return this; } @@ -258,11 +258,11 @@ public TmsV1InstrumentidentifiersPost200Response metadata(Tmsv1instrumentidentif * @return metadata **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersMetadata getMetadata() { + public TmsV1InstrumentIdentifiersPost200ResponseMetadata getMetadata() { return metadata; } - public void setMetadata(Tmsv1instrumentidentifiersMetadata metadata) { + public void setMetadata(TmsV1InstrumentIdentifiersPost200ResponseMetadata metadata) { this.metadata = metadata; } @@ -275,15 +275,15 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - TmsV1InstrumentidentifiersPost200Response tmsV1InstrumentidentifiersPost200Response = (TmsV1InstrumentidentifiersPost200Response) o; - return Objects.equals(this.links, tmsV1InstrumentidentifiersPost200Response.links) && - Objects.equals(this.id, tmsV1InstrumentidentifiersPost200Response.id) && - Objects.equals(this.object, tmsV1InstrumentidentifiersPost200Response.object) && - Objects.equals(this.state, tmsV1InstrumentidentifiersPost200Response.state) && - Objects.equals(this.card, tmsV1InstrumentidentifiersPost200Response.card) && - Objects.equals(this.bankAccount, tmsV1InstrumentidentifiersPost200Response.bankAccount) && - Objects.equals(this.processingInformation, tmsV1InstrumentidentifiersPost200Response.processingInformation) && - Objects.equals(this.metadata, tmsV1InstrumentidentifiersPost200Response.metadata); + TmsV1InstrumentIdentifiersPost200Response tmsV1InstrumentIdentifiersPost200Response = (TmsV1InstrumentIdentifiersPost200Response) o; + return Objects.equals(this.links, tmsV1InstrumentIdentifiersPost200Response.links) && + Objects.equals(this.id, tmsV1InstrumentIdentifiersPost200Response.id) && + Objects.equals(this.object, tmsV1InstrumentIdentifiersPost200Response.object) && + Objects.equals(this.state, tmsV1InstrumentIdentifiersPost200Response.state) && + Objects.equals(this.card, tmsV1InstrumentIdentifiersPost200Response.card) && + Objects.equals(this.bankAccount, tmsV1InstrumentIdentifiersPost200Response.bankAccount) && + Objects.equals(this.processingInformation, tmsV1InstrumentIdentifiersPost200Response.processingInformation) && + Objects.equals(this.metadata, tmsV1InstrumentIdentifiersPost200Response.metadata); } @Override @@ -295,7 +295,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1InstrumentidentifiersPost200Response {\n"); + sb.append("class TmsV1InstrumentIdentifiersPost200Response {\n"); sb.append(" links: ").append(toIndentedString(links)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersBankAccount.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount.java similarity index 66% rename from src/main/java/Model/Tmsv1instrumentidentifiersBankAccount.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount.java index 8a356a7c4..72f8e2c77 100644 --- a/src/main/java/Model/Tmsv1instrumentidentifiersBankAccount.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,26 +24,26 @@ import java.io.IOException; /** - * Tmsv1instrumentidentifiersBankAccount + * TmsV1InstrumentIdentifiersPost200ResponseBankAccount */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1instrumentidentifiersBankAccount { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPost200ResponseBankAccount { @SerializedName("number") private String number = null; @SerializedName("routingNumber") private String routingNumber = null; - public Tmsv1instrumentidentifiersBankAccount number(String number) { + public TmsV1InstrumentIdentifiersPost200ResponseBankAccount number(String number) { this.number = number; return this; } /** - * Bank account number. + * Checking account number. * @return number **/ - @ApiModelProperty(example = "1234567890123456800", value = "Bank account number.") + @ApiModelProperty(example = "1234567890123456800", value = "Checking account number.") public String getNumber() { return number; } @@ -52,7 +52,7 @@ public void setNumber(String number) { this.number = number; } - public Tmsv1instrumentidentifiersBankAccount routingNumber(String routingNumber) { + public TmsV1InstrumentIdentifiersPost200ResponseBankAccount routingNumber(String routingNumber) { this.routingNumber = routingNumber; return this; } @@ -79,9 +79,9 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv1instrumentidentifiersBankAccount tmsv1instrumentidentifiersBankAccount = (Tmsv1instrumentidentifiersBankAccount) o; - return Objects.equals(this.number, tmsv1instrumentidentifiersBankAccount.number) && - Objects.equals(this.routingNumber, tmsv1instrumentidentifiersBankAccount.routingNumber); + TmsV1InstrumentIdentifiersPost200ResponseBankAccount tmsV1InstrumentIdentifiersPost200ResponseBankAccount = (TmsV1InstrumentIdentifiersPost200ResponseBankAccount) o; + return Objects.equals(this.number, tmsV1InstrumentIdentifiersPost200ResponseBankAccount.number) && + Objects.equals(this.routingNumber, tmsV1InstrumentIdentifiersPost200ResponseBankAccount.routingNumber); } @Override @@ -93,7 +93,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1instrumentidentifiersBankAccount {\n"); + sb.append("class TmsV1InstrumentIdentifiersPost200ResponseBankAccount {\n"); sb.append(" number: ").append(toIndentedString(number)).append("\n"); sb.append(" routingNumber: ").append(toIndentedString(routingNumber)).append("\n"); diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseCard.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseCard.java new file mode 100644 index 000000000..026d4380e --- /dev/null +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseCard.java @@ -0,0 +1,93 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * TmsV1InstrumentIdentifiersPost200ResponseCard + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPost200ResponseCard { + @SerializedName("number") + private String number = null; + + public TmsV1InstrumentIdentifiersPost200ResponseCard number(String number) { + this.number = number; + return this; + } + + /** + * Customer’s credit card number. + * @return number + **/ + @ApiModelProperty(example = "1234567890987654", value = "Customer’s credit card number.") + public String getNumber() { + return number; + } + + public void setNumber(String number) { + this.number = number; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TmsV1InstrumentIdentifiersPost200ResponseCard tmsV1InstrumentIdentifiersPost200ResponseCard = (TmsV1InstrumentIdentifiersPost200ResponseCard) o; + return Objects.equals(this.number, tmsV1InstrumentIdentifiersPost200ResponseCard.number); + } + + @Override + public int hashCode() { + return Objects.hash(number); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TmsV1InstrumentIdentifiersPost200ResponseCard {\n"); + + sb.append(" number: ").append(toIndentedString(number)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersLinks.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinks.java similarity index 53% rename from src/main/java/Model/Tmsv1instrumentidentifiersLinks.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinks.java index 60534bdfd..d9ae55c2e 100644 --- a/src/main/java/Model/Tmsv1instrumentidentifiersLinks.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinks.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.Tmsv1instrumentidentifiersLinksSelf; +import Model.TmsV1InstrumentIdentifiersPost200ResponseLinksSelf; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -25,20 +25,20 @@ import java.io.IOException; /** - * Tmsv1instrumentidentifiersLinks + * TmsV1InstrumentIdentifiersPost200ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1instrumentidentifiersLinks { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPost200ResponseLinks { @SerializedName("self") - private Tmsv1instrumentidentifiersLinksSelf self = null; + private TmsV1InstrumentIdentifiersPost200ResponseLinksSelf self = null; @SerializedName("ancestor") - private Tmsv1instrumentidentifiersLinksSelf ancestor = null; + private TmsV1InstrumentIdentifiersPost200ResponseLinksSelf ancestor = null; @SerializedName("successor") - private Tmsv1instrumentidentifiersLinksSelf successor = null; + private TmsV1InstrumentIdentifiersPost200ResponseLinksSelf successor = null; - public Tmsv1instrumentidentifiersLinks self(Tmsv1instrumentidentifiersLinksSelf self) { + public TmsV1InstrumentIdentifiersPost200ResponseLinks self(TmsV1InstrumentIdentifiersPost200ResponseLinksSelf self) { this.self = self; return this; } @@ -48,15 +48,15 @@ public Tmsv1instrumentidentifiersLinks self(Tmsv1instrumentidentifiersLinksSelf * @return self **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersLinksSelf getSelf() { + public TmsV1InstrumentIdentifiersPost200ResponseLinksSelf getSelf() { return self; } - public void setSelf(Tmsv1instrumentidentifiersLinksSelf self) { + public void setSelf(TmsV1InstrumentIdentifiersPost200ResponseLinksSelf self) { this.self = self; } - public Tmsv1instrumentidentifiersLinks ancestor(Tmsv1instrumentidentifiersLinksSelf ancestor) { + public TmsV1InstrumentIdentifiersPost200ResponseLinks ancestor(TmsV1InstrumentIdentifiersPost200ResponseLinksSelf ancestor) { this.ancestor = ancestor; return this; } @@ -66,15 +66,15 @@ public Tmsv1instrumentidentifiersLinks ancestor(Tmsv1instrumentidentifiersLinksS * @return ancestor **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersLinksSelf getAncestor() { + public TmsV1InstrumentIdentifiersPost200ResponseLinksSelf getAncestor() { return ancestor; } - public void setAncestor(Tmsv1instrumentidentifiersLinksSelf ancestor) { + public void setAncestor(TmsV1InstrumentIdentifiersPost200ResponseLinksSelf ancestor) { this.ancestor = ancestor; } - public Tmsv1instrumentidentifiersLinks successor(Tmsv1instrumentidentifiersLinksSelf successor) { + public TmsV1InstrumentIdentifiersPost200ResponseLinks successor(TmsV1InstrumentIdentifiersPost200ResponseLinksSelf successor) { this.successor = successor; return this; } @@ -84,11 +84,11 @@ public Tmsv1instrumentidentifiersLinks successor(Tmsv1instrumentidentifiersLinks * @return successor **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersLinksSelf getSuccessor() { + public TmsV1InstrumentIdentifiersPost200ResponseLinksSelf getSuccessor() { return successor; } - public void setSuccessor(Tmsv1instrumentidentifiersLinksSelf successor) { + public void setSuccessor(TmsV1InstrumentIdentifiersPost200ResponseLinksSelf successor) { this.successor = successor; } @@ -101,10 +101,10 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv1instrumentidentifiersLinks tmsv1instrumentidentifiersLinks = (Tmsv1instrumentidentifiersLinks) o; - return Objects.equals(this.self, tmsv1instrumentidentifiersLinks.self) && - Objects.equals(this.ancestor, tmsv1instrumentidentifiersLinks.ancestor) && - Objects.equals(this.successor, tmsv1instrumentidentifiersLinks.successor); + TmsV1InstrumentIdentifiersPost200ResponseLinks tmsV1InstrumentIdentifiersPost200ResponseLinks = (TmsV1InstrumentIdentifiersPost200ResponseLinks) o; + return Objects.equals(this.self, tmsV1InstrumentIdentifiersPost200ResponseLinks.self) && + Objects.equals(this.ancestor, tmsV1InstrumentIdentifiersPost200ResponseLinks.ancestor) && + Objects.equals(this.successor, tmsV1InstrumentIdentifiersPost200ResponseLinks.successor); } @Override @@ -116,7 +116,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1instrumentidentifiersLinks {\n"); + sb.append("class TmsV1InstrumentIdentifiersPost200ResponseLinks {\n"); sb.append(" self: ").append(toIndentedString(self)).append("\n"); sb.append(" ancestor: ").append(toIndentedString(ancestor)).append("\n"); diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersLinksSelf.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.java similarity index 70% rename from src/main/java/Model/Tmsv1instrumentidentifiersLinksSelf.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.java index 2ac192888..85ea52c86 100644 --- a/src/main/java/Model/Tmsv1instrumentidentifiersLinksSelf.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,14 +24,14 @@ import java.io.IOException; /** - * Tmsv1instrumentidentifiersLinksSelf + * TmsV1InstrumentIdentifiersPost200ResponseLinksSelf */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1instrumentidentifiersLinksSelf { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPost200ResponseLinksSelf { @SerializedName("href") private String href = null; - public Tmsv1instrumentidentifiersLinksSelf href(String href) { + public TmsV1InstrumentIdentifiersPost200ResponseLinksSelf href(String href) { this.href = href; return this; } @@ -58,8 +58,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv1instrumentidentifiersLinksSelf tmsv1instrumentidentifiersLinksSelf = (Tmsv1instrumentidentifiersLinksSelf) o; - return Objects.equals(this.href, tmsv1instrumentidentifiersLinksSelf.href); + TmsV1InstrumentIdentifiersPost200ResponseLinksSelf tmsV1InstrumentIdentifiersPost200ResponseLinksSelf = (TmsV1InstrumentIdentifiersPost200ResponseLinksSelf) o; + return Objects.equals(this.href, tmsV1InstrumentIdentifiersPost200ResponseLinksSelf.href); } @Override @@ -71,7 +71,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1instrumentidentifiersLinksSelf {\n"); + sb.append("class TmsV1InstrumentIdentifiersPost200ResponseLinksSelf {\n"); sb.append(" href: ").append(toIndentedString(href)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersMetadata.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseMetadata.java similarity index 70% rename from src/main/java/Model/Tmsv1instrumentidentifiersMetadata.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseMetadata.java index 4d4709193..8a29727c8 100644 --- a/src/main/java/Model/Tmsv1instrumentidentifiersMetadata.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseMetadata.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,14 +24,14 @@ import java.io.IOException; /** - * Tmsv1instrumentidentifiersMetadata + * TmsV1InstrumentIdentifiersPost200ResponseMetadata */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1instrumentidentifiersMetadata { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPost200ResponseMetadata { @SerializedName("creator") private String creator = null; - public Tmsv1instrumentidentifiersMetadata creator(String creator) { + public TmsV1InstrumentIdentifiersPost200ResponseMetadata creator(String creator) { this.creator = creator; return this; } @@ -58,8 +58,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv1instrumentidentifiersMetadata tmsv1instrumentidentifiersMetadata = (Tmsv1instrumentidentifiersMetadata) o; - return Objects.equals(this.creator, tmsv1instrumentidentifiersMetadata.creator); + TmsV1InstrumentIdentifiersPost200ResponseMetadata tmsV1InstrumentIdentifiersPost200ResponseMetadata = (TmsV1InstrumentIdentifiersPost200ResponseMetadata) o; + return Objects.equals(this.creator, tmsV1InstrumentIdentifiersPost200ResponseMetadata.creator); } @Override @@ -71,7 +71,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1instrumentidentifiersMetadata {\n"); + sb.append("class TmsV1InstrumentIdentifiersPost200ResponseMetadata {\n"); sb.append(" creator: ").append(toIndentedString(creator)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersProcessingInformation.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.java similarity index 54% rename from src/main/java/Model/Tmsv1instrumentidentifiersProcessingInformation.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.java index 2336b2e38..84e4a99ac 100644 --- a/src/main/java/Model/Tmsv1instrumentidentifiersProcessingInformation.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions; +import Model.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -25,14 +25,14 @@ import java.io.IOException; /** - * Tmsv1instrumentidentifiersProcessingInformation + * TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1instrumentidentifiersProcessingInformation { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation { @SerializedName("authorizationOptions") - private Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions authorizationOptions = null; + private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions authorizationOptions = null; - public Tmsv1instrumentidentifiersProcessingInformation authorizationOptions(Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions authorizationOptions) { + public TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation authorizationOptions(TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions authorizationOptions) { this.authorizationOptions = authorizationOptions; return this; } @@ -42,11 +42,11 @@ public Tmsv1instrumentidentifiersProcessingInformation authorizationOptions(Tmsv * @return authorizationOptions **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions getAuthorizationOptions() { + public TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions getAuthorizationOptions() { return authorizationOptions; } - public void setAuthorizationOptions(Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions authorizationOptions) { + public void setAuthorizationOptions(TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions authorizationOptions) { this.authorizationOptions = authorizationOptions; } @@ -59,8 +59,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv1instrumentidentifiersProcessingInformation tmsv1instrumentidentifiersProcessingInformation = (Tmsv1instrumentidentifiersProcessingInformation) o; - return Objects.equals(this.authorizationOptions, tmsv1instrumentidentifiersProcessingInformation.authorizationOptions); + TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation tmsV1InstrumentIdentifiersPost200ResponseProcessingInformation = (TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation) o; + return Objects.equals(this.authorizationOptions, tmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.authorizationOptions); } @Override @@ -72,7 +72,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1instrumentidentifiersProcessingInformation {\n"); + sb.append("class TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation {\n"); sb.append(" authorizationOptions: ").append(toIndentedString(authorizationOptions)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions.java similarity index 51% rename from src/main/java/Model/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions.java index afae8a586..ac1b11843 100644 --- a/src/main/java/Model/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator; +import Model.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -25,14 +25,14 @@ import java.io.IOException; /** - * Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions + * TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions { @SerializedName("initiator") - private Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator initiator = null; + private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator initiator = null; - public Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions initiator(Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator initiator) { + public TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions initiator(TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator initiator) { this.initiator = initiator; return this; } @@ -42,11 +42,11 @@ public Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions initi * @return initiator **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator getInitiator() { + public TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator getInitiator() { return initiator; } - public void setInitiator(Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator initiator) { + public void setInitiator(TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator initiator) { this.initiator = initiator; } @@ -59,8 +59,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions = (Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions) o; - return Objects.equals(this.initiator, tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions.initiator); + TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions tmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions = (TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions) o; + return Objects.equals(this.initiator, tmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions.initiator); } @Override @@ -72,7 +72,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptions {\n"); + sb.append("class TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions {\n"); sb.append(" initiator: ").append(toIndentedString(initiator)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.java similarity index 50% rename from src/main/java/Model/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.java index 2fe13d72c..2411f10eb 100644 --- a/src/main/java/Model/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction; +import Model.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -25,14 +25,14 @@ import java.io.IOException; /** - * Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator + * TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator { @SerializedName("merchantInitiatedTransaction") - private Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction merchantInitiatedTransaction = null; + private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction merchantInitiatedTransaction = null; - public Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator merchantInitiatedTransaction(Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction merchantInitiatedTransaction) { + public TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator merchantInitiatedTransaction(TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction merchantInitiatedTransaction) { this.merchantInitiatedTransaction = merchantInitiatedTransaction; return this; } @@ -42,11 +42,11 @@ public Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitia * @return merchantInitiatedTransaction **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction getMerchantInitiatedTransaction() { + public TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction getMerchantInitiatedTransaction() { return merchantInitiatedTransaction; } - public void setMerchantInitiatedTransaction(Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction merchantInitiatedTransaction) { + public void setMerchantInitiatedTransaction(TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction merchantInitiatedTransaction) { this.merchantInitiatedTransaction = merchantInitiatedTransaction; } @@ -59,8 +59,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator = (Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator) o; - return Objects.equals(this.merchantInitiatedTransaction, tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator.merchantInitiatedTransaction); + TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator tmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator = (TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator) o; + return Objects.equals(this.merchantInitiatedTransaction, tmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.merchantInitiatedTransaction); } @Override @@ -72,7 +72,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiator {\n"); + sb.append("class TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator {\n"); sb.append(" merchantInitiatedTransaction: ").append(toIndentedString(merchantInitiatedTransaction)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java similarity index 59% rename from src/main/java/Model/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java rename to src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java index e2f5ef763..e6671fccd 100644 --- a/src/main/java/Model/Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -24,14 +24,14 @@ import java.io.IOException; /** - * Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction + * TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction { @SerializedName("previousTransactionId") private String previousTransactionId = null; - public Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction previousTransactionId(String previousTransactionId) { + public TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction previousTransactionId(String previousTransactionId) { this.previousTransactionId = previousTransactionId; return this; } @@ -58,8 +58,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction = (Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction) o; - return Objects.equals(this.previousTransactionId, tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.previousTransactionId); + TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction tmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction = (TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction) o; + return Objects.equals(this.previousTransactionId, tmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.previousTransactionId); } @Override @@ -71,7 +71,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1instrumentidentifiersProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction {\n"); + sb.append("class TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction {\n"); sb.append(" previousTransactionId: ").append(toIndentedString(previousTransactionId)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/TmsV1PaymentinstrumentsPost201Response.java b/src/main/java/Model/TmsV1PaymentinstrumentsPost201Response.java deleted file mode 100644 index 7f71d66df..000000000 --- a/src/main/java/Model/TmsV1PaymentinstrumentsPost201Response.java +++ /dev/null @@ -1,420 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import Model.TmsV1PaymentinstrumentsPost201ResponseCard; -import Model.Tmsv1instrumentidentifiersLinks; -import Model.Tmsv1instrumentidentifiersMetadata; -import Model.Tmsv1paymentinstrumentsBankAccount; -import Model.Tmsv1paymentinstrumentsBillTo; -import Model.Tmsv1paymentinstrumentsBuyerInformation; -import Model.Tmsv1paymentinstrumentsInstrumentIdentifier; -import Model.Tmsv1paymentinstrumentsMerchantInformation; -import Model.Tmsv1paymentinstrumentsProcessingInformation; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * TmsV1PaymentinstrumentsPost201Response - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1PaymentinstrumentsPost201Response { - @SerializedName("_links") - private Tmsv1instrumentidentifiersLinks links = null; - - @SerializedName("id") - private String id = null; - - /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. - */ - @JsonAdapter(ObjectEnum.Adapter.class) - public enum ObjectEnum { - PAYMENTINSTRUMENT("paymentInstrument"); - - private String value; - - ObjectEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static ObjectEnum fromValue(String text) { - for (ObjectEnum b : ObjectEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final ObjectEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public ObjectEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return ObjectEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("object") - private ObjectEnum object = null; - - /** - * Current state of the token. - */ - @JsonAdapter(StateEnum.Adapter.class) - public enum StateEnum { - ACTIVE("ACTIVE"), - - CLOSED("CLOSED"); - - private String value; - - StateEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static StateEnum fromValue(String text) { - for (StateEnum b : StateEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public StateEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return StateEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("state") - private StateEnum state = null; - - @SerializedName("bankAccount") - private Tmsv1paymentinstrumentsBankAccount bankAccount = null; - - @SerializedName("card") - private TmsV1PaymentinstrumentsPost201ResponseCard card = null; - - @SerializedName("buyerInformation") - private Tmsv1paymentinstrumentsBuyerInformation buyerInformation = null; - - @SerializedName("billTo") - private Tmsv1paymentinstrumentsBillTo billTo = null; - - @SerializedName("processingInformation") - private Tmsv1paymentinstrumentsProcessingInformation processingInformation = null; - - @SerializedName("merchantInformation") - private Tmsv1paymentinstrumentsMerchantInformation merchantInformation = null; - - @SerializedName("metaData") - private Tmsv1instrumentidentifiersMetadata metaData = null; - - @SerializedName("instrumentIdentifier") - private Tmsv1paymentinstrumentsInstrumentIdentifier instrumentIdentifier = null; - - public TmsV1PaymentinstrumentsPost201Response links(Tmsv1instrumentidentifiersLinks links) { - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersLinks getLinks() { - return links; - } - - public void setLinks(Tmsv1instrumentidentifiersLinks links) { - this.links = links; - } - - /** - * Unique identification number assigned by CyberSource to the submitted request. - * @return id - **/ - @ApiModelProperty(example = "1234567890123456800", value = "Unique identification number assigned by CyberSource to the submitted request.") - public String getId() { - return id; - } - - /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. - * @return object - **/ - @ApiModelProperty(example = "instrumentIdentifier", value = "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.") - public ObjectEnum getObject() { - return object; - } - - /** - * Current state of the token. - * @return state - **/ - @ApiModelProperty(example = "ACTIVE", value = "Current state of the token.") - public StateEnum getState() { - return state; - } - - public TmsV1PaymentinstrumentsPost201Response bankAccount(Tmsv1paymentinstrumentsBankAccount bankAccount) { - this.bankAccount = bankAccount; - return this; - } - - /** - * Get bankAccount - * @return bankAccount - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsBankAccount getBankAccount() { - return bankAccount; - } - - public void setBankAccount(Tmsv1paymentinstrumentsBankAccount bankAccount) { - this.bankAccount = bankAccount; - } - - public TmsV1PaymentinstrumentsPost201Response card(TmsV1PaymentinstrumentsPost201ResponseCard card) { - this.card = card; - return this; - } - - /** - * Get card - * @return card - **/ - @ApiModelProperty(value = "") - public TmsV1PaymentinstrumentsPost201ResponseCard getCard() { - return card; - } - - public void setCard(TmsV1PaymentinstrumentsPost201ResponseCard card) { - this.card = card; - } - - public TmsV1PaymentinstrumentsPost201Response buyerInformation(Tmsv1paymentinstrumentsBuyerInformation buyerInformation) { - this.buyerInformation = buyerInformation; - return this; - } - - /** - * Get buyerInformation - * @return buyerInformation - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsBuyerInformation getBuyerInformation() { - return buyerInformation; - } - - public void setBuyerInformation(Tmsv1paymentinstrumentsBuyerInformation buyerInformation) { - this.buyerInformation = buyerInformation; - } - - public TmsV1PaymentinstrumentsPost201Response billTo(Tmsv1paymentinstrumentsBillTo billTo) { - this.billTo = billTo; - return this; - } - - /** - * Get billTo - * @return billTo - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsBillTo getBillTo() { - return billTo; - } - - public void setBillTo(Tmsv1paymentinstrumentsBillTo billTo) { - this.billTo = billTo; - } - - public TmsV1PaymentinstrumentsPost201Response processingInformation(Tmsv1paymentinstrumentsProcessingInformation processingInformation) { - this.processingInformation = processingInformation; - return this; - } - - /** - * Get processingInformation - * @return processingInformation - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsProcessingInformation getProcessingInformation() { - return processingInformation; - } - - public void setProcessingInformation(Tmsv1paymentinstrumentsProcessingInformation processingInformation) { - this.processingInformation = processingInformation; - } - - public TmsV1PaymentinstrumentsPost201Response merchantInformation(Tmsv1paymentinstrumentsMerchantInformation merchantInformation) { - this.merchantInformation = merchantInformation; - return this; - } - - /** - * Get merchantInformation - * @return merchantInformation - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsMerchantInformation getMerchantInformation() { - return merchantInformation; - } - - public void setMerchantInformation(Tmsv1paymentinstrumentsMerchantInformation merchantInformation) { - this.merchantInformation = merchantInformation; - } - - public TmsV1PaymentinstrumentsPost201Response metaData(Tmsv1instrumentidentifiersMetadata metaData) { - this.metaData = metaData; - return this; - } - - /** - * Get metaData - * @return metaData - **/ - @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersMetadata getMetaData() { - return metaData; - } - - public void setMetaData(Tmsv1instrumentidentifiersMetadata metaData) { - this.metaData = metaData; - } - - public TmsV1PaymentinstrumentsPost201Response instrumentIdentifier(Tmsv1paymentinstrumentsInstrumentIdentifier instrumentIdentifier) { - this.instrumentIdentifier = instrumentIdentifier; - return this; - } - - /** - * Get instrumentIdentifier - * @return instrumentIdentifier - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsInstrumentIdentifier getInstrumentIdentifier() { - return instrumentIdentifier; - } - - public void setInstrumentIdentifier(Tmsv1paymentinstrumentsInstrumentIdentifier instrumentIdentifier) { - this.instrumentIdentifier = instrumentIdentifier; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TmsV1PaymentinstrumentsPost201Response tmsV1PaymentinstrumentsPost201Response = (TmsV1PaymentinstrumentsPost201Response) o; - return Objects.equals(this.links, tmsV1PaymentinstrumentsPost201Response.links) && - Objects.equals(this.id, tmsV1PaymentinstrumentsPost201Response.id) && - Objects.equals(this.object, tmsV1PaymentinstrumentsPost201Response.object) && - Objects.equals(this.state, tmsV1PaymentinstrumentsPost201Response.state) && - Objects.equals(this.bankAccount, tmsV1PaymentinstrumentsPost201Response.bankAccount) && - Objects.equals(this.card, tmsV1PaymentinstrumentsPost201Response.card) && - Objects.equals(this.buyerInformation, tmsV1PaymentinstrumentsPost201Response.buyerInformation) && - Objects.equals(this.billTo, tmsV1PaymentinstrumentsPost201Response.billTo) && - Objects.equals(this.processingInformation, tmsV1PaymentinstrumentsPost201Response.processingInformation) && - Objects.equals(this.merchantInformation, tmsV1PaymentinstrumentsPost201Response.merchantInformation) && - Objects.equals(this.metaData, tmsV1PaymentinstrumentsPost201Response.metaData) && - Objects.equals(this.instrumentIdentifier, tmsV1PaymentinstrumentsPost201Response.instrumentIdentifier); - } - - @Override - public int hashCode() { - return Objects.hash(links, id, object, state, bankAccount, card, buyerInformation, billTo, processingInformation, merchantInformation, metaData, instrumentIdentifier); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1PaymentinstrumentsPost201Response {\n"); - - sb.append(" links: ").append(toIndentedString(links)).append("\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" object: ").append(toIndentedString(object)).append("\n"); - sb.append(" state: ").append(toIndentedString(state)).append("\n"); - sb.append(" bankAccount: ").append(toIndentedString(bankAccount)).append("\n"); - sb.append(" card: ").append(toIndentedString(card)).append("\n"); - sb.append(" buyerInformation: ").append(toIndentedString(buyerInformation)).append("\n"); - sb.append(" billTo: ").append(toIndentedString(billTo)).append("\n"); - sb.append(" processingInformation: ").append(toIndentedString(processingInformation)).append("\n"); - sb.append(" merchantInformation: ").append(toIndentedString(merchantInformation)).append("\n"); - sb.append(" metaData: ").append(toIndentedString(metaData)).append("\n"); - sb.append(" instrumentIdentifier: ").append(toIndentedString(instrumentIdentifier)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/TmsV1PaymentinstrumentsPost201ResponseCard.java b/src/main/java/Model/TmsV1PaymentinstrumentsPost201ResponseCard.java deleted file mode 100644 index f9aa2d76c..000000000 --- a/src/main/java/Model/TmsV1PaymentinstrumentsPost201ResponseCard.java +++ /dev/null @@ -1,382 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * TmsV1PaymentinstrumentsPost201ResponseCard - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TmsV1PaymentinstrumentsPost201ResponseCard { - @SerializedName("expirationMonth") - private String expirationMonth = null; - - @SerializedName("expirationYear") - private String expirationYear = null; - - /** - * Credit card brand. - */ - @JsonAdapter(TypeEnum.Adapter.class) - public enum TypeEnum { - VISA("visa"), - - MASTERCARD("mastercard"), - - AMERICAN_EXPRESS("american express"), - - DISCOVER("discover"), - - DINERS_CLUB("diners club"), - - CARTE_BLANCHE("carte blanche"), - - JCB("jcb"), - - OPTIMA("optima"), - - TWINPAY_CREDIT("twinpay credit"), - - TWINPAY_DEBIT("twinpay debit"), - - WALMART("walmart"), - - ENROUTE("enroute"), - - LOWES_CONSUMER("lowes consumer"), - - HOME_DEPOT_CONSUMER("home depot consumer"), - - MBNA("mbna"), - - DICKS_SPORTSWEAR("dicks sportswear"), - - CASUAL_CORNER("casual corner"), - - SEARS("sears"), - - JAL("jal"), - - DISNEY("disney"), - - MAESTRO_UK_DOMESTIC("maestro uk domestic"), - - SAMS_CLUB_CONSUMER("sams club consumer"), - - SAMS_CLUB_BUSINESS("sams club business"), - - NICOS("nicos"), - - BILL_ME_LATER("bill me later"), - - BEBE("bebe"), - - RESTORATION_HARDWARE("restoration hardware"), - - DELTA_ONLINE("delta online"), - - SOLO("solo"), - - VISA_ELECTRON("visa electron"), - - DANKORT("dankort"), - - LASER("laser"), - - CARTE_BLEUE("carte bleue"), - - CARTA_SI("carta si"), - - PINLESS_DEBIT("pinless debit"), - - ENCODED_ACCOUNT("encoded account"), - - UATP("uatp"), - - HOUSEHOLD("household"), - - MAESTRO_INTERNATIONAL("maestro international"), - - GE_MONEY_UK("ge money uk"), - - KOREAN_CARDS("korean cards"), - - STYLE("style"), - - JCREW("jcrew"), - - PAYEASE_CHINA_PROCESSING_EWALLET("payease china processing ewallet"), - - PAYEASE_CHINA_PROCESSING_BANK_TRANSFER("payease china processing bank transfer"), - - MEIJER_PRIVATE_LABEL("meijer private label"), - - HIPERCARD("hipercard"), - - AURA("aura"), - - REDECARD("redecard"), - - ORICO("orico"), - - ELO("elo"), - - CAPITAL_ONE_PRIVATE_LABEL("capital one private label"), - - SYNCHRONY_PRIVATE_LABEL("synchrony private label"), - - CHINA_UNION_PAY("china union pay"); - - private String value; - - TypeEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static TypeEnum fromValue(String text) { - for (TypeEnum b : TypeEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public TypeEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return TypeEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("type") - private TypeEnum type = null; - - @SerializedName("issueNumber") - private String issueNumber = null; - - @SerializedName("startMonth") - private String startMonth = null; - - @SerializedName("startYear") - private String startYear = null; - - @SerializedName("useAs") - private String useAs = null; - - public TmsV1PaymentinstrumentsPost201ResponseCard expirationMonth(String expirationMonth) { - this.expirationMonth = expirationMonth; - return this; - } - - /** - * Credit card expiration month. - * @return expirationMonth - **/ - @ApiModelProperty(example = "12", value = "Credit card expiration month.") - public String getExpirationMonth() { - return expirationMonth; - } - - public void setExpirationMonth(String expirationMonth) { - this.expirationMonth = expirationMonth; - } - - public TmsV1PaymentinstrumentsPost201ResponseCard expirationYear(String expirationYear) { - this.expirationYear = expirationYear; - return this; - } - - /** - * Credit card expiration year. - * @return expirationYear - **/ - @ApiModelProperty(example = "2022", value = "Credit card expiration year.") - public String getExpirationYear() { - return expirationYear; - } - - public void setExpirationYear(String expirationYear) { - this.expirationYear = expirationYear; - } - - public TmsV1PaymentinstrumentsPost201ResponseCard type(TypeEnum type) { - this.type = type; - return this; - } - - /** - * Credit card brand. - * @return type - **/ - @ApiModelProperty(example = "visa", value = "Credit card brand.") - public TypeEnum getType() { - return type; - } - - public void setType(TypeEnum type) { - this.type = type; - } - - public TmsV1PaymentinstrumentsPost201ResponseCard issueNumber(String issueNumber) { - this.issueNumber = issueNumber; - return this; - } - - /** - * Credit card issue number. - * @return issueNumber - **/ - @ApiModelProperty(example = "01", value = "Credit card issue number.") - public String getIssueNumber() { - return issueNumber; - } - - public void setIssueNumber(String issueNumber) { - this.issueNumber = issueNumber; - } - - public TmsV1PaymentinstrumentsPost201ResponseCard startMonth(String startMonth) { - this.startMonth = startMonth; - return this; - } - - /** - * Credit card start month. - * @return startMonth - **/ - @ApiModelProperty(example = "12", value = "Credit card start month.") - public String getStartMonth() { - return startMonth; - } - - public void setStartMonth(String startMonth) { - this.startMonth = startMonth; - } - - public TmsV1PaymentinstrumentsPost201ResponseCard startYear(String startYear) { - this.startYear = startYear; - return this; - } - - /** - * Credit card start year. - * @return startYear - **/ - @ApiModelProperty(example = "12", value = "Credit card start year.") - public String getStartYear() { - return startYear; - } - - public void setStartYear(String startYear) { - this.startYear = startYear; - } - - public TmsV1PaymentinstrumentsPost201ResponseCard useAs(String useAs) { - this.useAs = useAs; - return this; - } - - /** - * Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens. - * @return useAs - **/ - @ApiModelProperty(example = "pinless debit", value = "Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens.") - public String getUseAs() { - return useAs; - } - - public void setUseAs(String useAs) { - this.useAs = useAs; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TmsV1PaymentinstrumentsPost201ResponseCard tmsV1PaymentinstrumentsPost201ResponseCard = (TmsV1PaymentinstrumentsPost201ResponseCard) o; - return Objects.equals(this.expirationMonth, tmsV1PaymentinstrumentsPost201ResponseCard.expirationMonth) && - Objects.equals(this.expirationYear, tmsV1PaymentinstrumentsPost201ResponseCard.expirationYear) && - Objects.equals(this.type, tmsV1PaymentinstrumentsPost201ResponseCard.type) && - Objects.equals(this.issueNumber, tmsV1PaymentinstrumentsPost201ResponseCard.issueNumber) && - Objects.equals(this.startMonth, tmsV1PaymentinstrumentsPost201ResponseCard.startMonth) && - Objects.equals(this.startYear, tmsV1PaymentinstrumentsPost201ResponseCard.startYear) && - Objects.equals(this.useAs, tmsV1PaymentinstrumentsPost201ResponseCard.useAs); - } - - @Override - public int hashCode() { - return Objects.hash(expirationMonth, expirationYear, type, issueNumber, startMonth, startYear, useAs); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1PaymentinstrumentsPost201ResponseCard {\n"); - - sb.append(" expirationMonth: ").append(toIndentedString(expirationMonth)).append("\n"); - sb.append(" expirationYear: ").append(toIndentedString(expirationYear)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); - sb.append(" issueNumber: ").append(toIndentedString(issueNumber)).append("\n"); - sb.append(" startMonth: ").append(toIndentedString(startMonth)).append("\n"); - sb.append(" startYear: ").append(toIndentedString(startYear)).append("\n"); - sb.append(" useAs: ").append(toIndentedString(useAs)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersBillTo.java b/src/main/java/Model/Tmsv1instrumentidentifiersBillTo.java new file mode 100644 index 000000000..b823a07f5 --- /dev/null +++ b/src/main/java/Model/Tmsv1instrumentidentifiersBillTo.java @@ -0,0 +1,208 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Tmsv1instrumentidentifiersBillTo + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class Tmsv1instrumentidentifiersBillTo { + @SerializedName("address1") + private String address1 = null; + + @SerializedName("address2") + private String address2 = null; + + @SerializedName("locality") + private String locality = null; + + @SerializedName("administrativeArea") + private String administrativeArea = null; + + @SerializedName("postalCode") + private String postalCode = null; + + @SerializedName("country") + private String country = null; + + public Tmsv1instrumentidentifiersBillTo address1(String address1) { + this.address1 = address1; + return this; + } + + /** + * First address line registered with card. + * @return address1 + **/ + @ApiModelProperty(example = "8310 Capital of Texas Highway North", value = "First address line registered with card.") + public String getAddress1() { + return address1; + } + + public void setAddress1(String address1) { + this.address1 = address1; + } + + public Tmsv1instrumentidentifiersBillTo address2(String address2) { + this.address2 = address2; + return this; + } + + /** + * Second address line registered with card. + * @return address2 + **/ + @ApiModelProperty(example = "Bluffstone Drive", value = "Second address line registered with card.") + public String getAddress2() { + return address2; + } + + public void setAddress2(String address2) { + this.address2 = address2; + } + + public Tmsv1instrumentidentifiersBillTo locality(String locality) { + this.locality = locality; + return this; + } + + /** + * Locality registered with card. + * @return locality + **/ + @ApiModelProperty(example = "Austin", value = "Locality registered with card.") + public String getLocality() { + return locality; + } + + public void setLocality(String locality) { + this.locality = locality; + } + + public Tmsv1instrumentidentifiersBillTo administrativeArea(String administrativeArea) { + this.administrativeArea = administrativeArea; + return this; + } + + /** + * Administrative area registered with card. + * @return administrativeArea + **/ + @ApiModelProperty(example = "TX", value = "Administrative area registered with card.") + public String getAdministrativeArea() { + return administrativeArea; + } + + public void setAdministrativeArea(String administrativeArea) { + this.administrativeArea = administrativeArea; + } + + public Tmsv1instrumentidentifiersBillTo postalCode(String postalCode) { + this.postalCode = postalCode; + return this; + } + + /** + * Postal code registered with card. + * @return postalCode + **/ + @ApiModelProperty(example = "78731", value = "Postal code registered with card.") + public String getPostalCode() { + return postalCode; + } + + public void setPostalCode(String postalCode) { + this.postalCode = postalCode; + } + + public Tmsv1instrumentidentifiersBillTo country(String country) { + this.country = country; + return this; + } + + /** + * Country registered with card. + * @return country + **/ + @ApiModelProperty(example = "US", value = "Country registered with card.") + public String getCountry() { + return country; + } + + public void setCountry(String country) { + this.country = country; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Tmsv1instrumentidentifiersBillTo tmsv1instrumentidentifiersBillTo = (Tmsv1instrumentidentifiersBillTo) o; + return Objects.equals(this.address1, tmsv1instrumentidentifiersBillTo.address1) && + Objects.equals(this.address2, tmsv1instrumentidentifiersBillTo.address2) && + Objects.equals(this.locality, tmsv1instrumentidentifiersBillTo.locality) && + Objects.equals(this.administrativeArea, tmsv1instrumentidentifiersBillTo.administrativeArea) && + Objects.equals(this.postalCode, tmsv1instrumentidentifiersBillTo.postalCode) && + Objects.equals(this.country, tmsv1instrumentidentifiersBillTo.country); + } + + @Override + public int hashCode() { + return Objects.hash(address1, address2, locality, administrativeArea, postalCode, country); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Tmsv1instrumentidentifiersBillTo {\n"); + + sb.append(" address1: ").append(toIndentedString(address1)).append("\n"); + sb.append(" address2: ").append(toIndentedString(address2)).append("\n"); + sb.append(" locality: ").append(toIndentedString(locality)).append("\n"); + sb.append(" administrativeArea: ").append(toIndentedString(administrativeArea)).append("\n"); + sb.append(" postalCode: ").append(toIndentedString(postalCode)).append("\n"); + sb.append(" country: ").append(toIndentedString(country)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersCard.java b/src/main/java/Model/Tmsv1instrumentidentifiersCard.java index 409b8f036..dcae5b0b5 100644 --- a/src/main/java/Model/Tmsv1instrumentidentifiersCard.java +++ b/src/main/java/Model/Tmsv1instrumentidentifiersCard.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,11 +26,20 @@ /** * Tmsv1instrumentidentifiersCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Tmsv1instrumentidentifiersCard { @SerializedName("number") private String number = null; + @SerializedName("expirationMonth") + private String expirationMonth = null; + + @SerializedName("expirationYear") + private String expirationYear = null; + + @SerializedName("securityCode") + private String securityCode = null; + public Tmsv1instrumentidentifiersCard number(String number) { this.number = number; return this; @@ -40,7 +49,7 @@ public Tmsv1instrumentidentifiersCard number(String number) { * Credit card number (PAN). * @return number **/ - @ApiModelProperty(example = "1234567890987654", value = "Credit card number (PAN).") + @ApiModelProperty(example = "4622943127013705", value = "Credit card number (PAN).") public String getNumber() { return number; } @@ -49,6 +58,60 @@ public void setNumber(String number) { this.number = number; } + public Tmsv1instrumentidentifiersCard expirationMonth(String expirationMonth) { + this.expirationMonth = expirationMonth; + return this; + } + + /** + * Card expiration month. Format: `MM`. Possible values: `01` through `12`. + * @return expirationMonth + **/ + @ApiModelProperty(example = "12", value = "Card expiration month. Format: `MM`. Possible values: `01` through `12`. ") + public String getExpirationMonth() { + return expirationMonth; + } + + public void setExpirationMonth(String expirationMonth) { + this.expirationMonth = expirationMonth; + } + + public Tmsv1instrumentidentifiersCard expirationYear(String expirationYear) { + this.expirationYear = expirationYear; + return this; + } + + /** + * Card expiration year. Format: `YYYY`. Possible values: `1900` through `2099`. + * @return expirationYear + **/ + @ApiModelProperty(example = "2022", value = "Card expiration year. Format: `YYYY`. Possible values: `1900` through `2099`. ") + public String getExpirationYear() { + return expirationYear; + } + + public void setExpirationYear(String expirationYear) { + this.expirationYear = expirationYear; + } + + public Tmsv1instrumentidentifiersCard securityCode(String securityCode) { + this.securityCode = securityCode; + return this; + } + + /** + * Card security code. + * @return securityCode + **/ + @ApiModelProperty(example = "838", value = "Card security code.") + public String getSecurityCode() { + return securityCode; + } + + public void setSecurityCode(String securityCode) { + this.securityCode = securityCode; + } + @Override public boolean equals(java.lang.Object o) { @@ -59,12 +122,15 @@ public boolean equals(java.lang.Object o) { return false; } Tmsv1instrumentidentifiersCard tmsv1instrumentidentifiersCard = (Tmsv1instrumentidentifiersCard) o; - return Objects.equals(this.number, tmsv1instrumentidentifiersCard.number); + return Objects.equals(this.number, tmsv1instrumentidentifiersCard.number) && + Objects.equals(this.expirationMonth, tmsv1instrumentidentifiersCard.expirationMonth) && + Objects.equals(this.expirationYear, tmsv1instrumentidentifiersCard.expirationYear) && + Objects.equals(this.securityCode, tmsv1instrumentidentifiersCard.securityCode); } @Override public int hashCode() { - return Objects.hash(number); + return Objects.hash(number, expirationMonth, expirationYear, securityCode); } @@ -74,6 +140,9 @@ public String toString() { sb.append("class Tmsv1instrumentidentifiersCard {\n"); sb.append(" number: ").append(toIndentedString(number)).append("\n"); + sb.append(" expirationMonth: ").append(toIndentedString(expirationMonth)).append("\n"); + sb.append(" expirationYear: ").append(toIndentedString(expirationYear)).append("\n"); + sb.append(" securityCode: ").append(toIndentedString(securityCode)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersDetails.java b/src/main/java/Model/Tmsv1instrumentidentifiersDetails.java index 8bdf371f5..e0a5d9328 100644 --- a/src/main/java/Model/Tmsv1instrumentidentifiersDetails.java +++ b/src/main/java/Model/Tmsv1instrumentidentifiersDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * Tmsv1instrumentidentifiersDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class Tmsv1instrumentidentifiersDetails { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/Tmsv1paymentinstrumentsBillTo.java b/src/main/java/Model/Tmsv1paymentinstrumentsBillTo.java deleted file mode 100644 index 206e9092f..000000000 --- a/src/main/java/Model/Tmsv1paymentinstrumentsBillTo.java +++ /dev/null @@ -1,323 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Tmsv1paymentinstrumentsBillTo - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1paymentinstrumentsBillTo { - @SerializedName("firstName") - private String firstName = null; - - @SerializedName("lastName") - private String lastName = null; - - @SerializedName("company") - private String company = null; - - @SerializedName("address1") - private String address1 = null; - - @SerializedName("address2") - private String address2 = null; - - @SerializedName("locality") - private String locality = null; - - @SerializedName("administrativeArea") - private String administrativeArea = null; - - @SerializedName("postalCode") - private String postalCode = null; - - @SerializedName("country") - private String country = null; - - @SerializedName("email") - private String email = null; - - @SerializedName("phoneNumber") - private String phoneNumber = null; - - public Tmsv1paymentinstrumentsBillTo firstName(String firstName) { - this.firstName = firstName; - return this; - } - - /** - * Bill to First Name. - * @return firstName - **/ - @ApiModelProperty(example = "John", value = "Bill to First Name.") - public String getFirstName() { - return firstName; - } - - public void setFirstName(String firstName) { - this.firstName = firstName; - } - - public Tmsv1paymentinstrumentsBillTo lastName(String lastName) { - this.lastName = lastName; - return this; - } - - /** - * Bill to Last Name. - * @return lastName - **/ - @ApiModelProperty(example = "Smith", value = "Bill to Last Name.") - public String getLastName() { - return lastName; - } - - public void setLastName(String lastName) { - this.lastName = lastName; - } - - public Tmsv1paymentinstrumentsBillTo company(String company) { - this.company = company; - return this; - } - - /** - * Bill to Company. - * @return company - **/ - @ApiModelProperty(example = "CyberSource", value = "Bill to Company.") - public String getCompany() { - return company; - } - - public void setCompany(String company) { - this.company = company; - } - - public Tmsv1paymentinstrumentsBillTo address1(String address1) { - this.address1 = address1; - return this; - } - - /** - * Bill to Address Line 1. - * @return address1 - **/ - @ApiModelProperty(example = "12 Main Street", value = "Bill to Address Line 1.") - public String getAddress1() { - return address1; - } - - public void setAddress1(String address1) { - this.address1 = address1; - } - - public Tmsv1paymentinstrumentsBillTo address2(String address2) { - this.address2 = address2; - return this; - } - - /** - * Bill to Address Line 2. - * @return address2 - **/ - @ApiModelProperty(example = "20 My Street", value = "Bill to Address Line 2.") - public String getAddress2() { - return address2; - } - - public void setAddress2(String address2) { - this.address2 = address2; - } - - public Tmsv1paymentinstrumentsBillTo locality(String locality) { - this.locality = locality; - return this; - } - - /** - * Bill to City. - * @return locality - **/ - @ApiModelProperty(example = "Foster City", value = "Bill to City.") - public String getLocality() { - return locality; - } - - public void setLocality(String locality) { - this.locality = locality; - } - - public Tmsv1paymentinstrumentsBillTo administrativeArea(String administrativeArea) { - this.administrativeArea = administrativeArea; - return this; - } - - /** - * Bill to State. - * @return administrativeArea - **/ - @ApiModelProperty(example = "CA", value = "Bill to State.") - public String getAdministrativeArea() { - return administrativeArea; - } - - public void setAdministrativeArea(String administrativeArea) { - this.administrativeArea = administrativeArea; - } - - public Tmsv1paymentinstrumentsBillTo postalCode(String postalCode) { - this.postalCode = postalCode; - return this; - } - - /** - * Bill to Postal Code. - * @return postalCode - **/ - @ApiModelProperty(example = "90200", value = "Bill to Postal Code.") - public String getPostalCode() { - return postalCode; - } - - public void setPostalCode(String postalCode) { - this.postalCode = postalCode; - } - - public Tmsv1paymentinstrumentsBillTo country(String country) { - this.country = country; - return this; - } - - /** - * Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2 - * @return country - **/ - @ApiModelProperty(example = "US", value = "Bill to Country. Accepts input in the ISO 3166-1 standard, stores as ISO 3166-1-Alpha-2") - public String getCountry() { - return country; - } - - public void setCountry(String country) { - this.country = country; - } - - public Tmsv1paymentinstrumentsBillTo email(String email) { - this.email = email; - return this; - } - - /** - * Valid Bill to Email. - * @return email - **/ - @ApiModelProperty(example = "john.smith@example.com", value = "Valid Bill to Email.") - public String getEmail() { - return email; - } - - public void setEmail(String email) { - this.email = email; - } - - public Tmsv1paymentinstrumentsBillTo phoneNumber(String phoneNumber) { - this.phoneNumber = phoneNumber; - return this; - } - - /** - * Bill to Phone Number. - * @return phoneNumber - **/ - @ApiModelProperty(example = "555123456", value = "Bill to Phone Number.") - public String getPhoneNumber() { - return phoneNumber; - } - - public void setPhoneNumber(String phoneNumber) { - this.phoneNumber = phoneNumber; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Tmsv1paymentinstrumentsBillTo tmsv1paymentinstrumentsBillTo = (Tmsv1paymentinstrumentsBillTo) o; - return Objects.equals(this.firstName, tmsv1paymentinstrumentsBillTo.firstName) && - Objects.equals(this.lastName, tmsv1paymentinstrumentsBillTo.lastName) && - Objects.equals(this.company, tmsv1paymentinstrumentsBillTo.company) && - Objects.equals(this.address1, tmsv1paymentinstrumentsBillTo.address1) && - Objects.equals(this.address2, tmsv1paymentinstrumentsBillTo.address2) && - Objects.equals(this.locality, tmsv1paymentinstrumentsBillTo.locality) && - Objects.equals(this.administrativeArea, tmsv1paymentinstrumentsBillTo.administrativeArea) && - Objects.equals(this.postalCode, tmsv1paymentinstrumentsBillTo.postalCode) && - Objects.equals(this.country, tmsv1paymentinstrumentsBillTo.country) && - Objects.equals(this.email, tmsv1paymentinstrumentsBillTo.email) && - Objects.equals(this.phoneNumber, tmsv1paymentinstrumentsBillTo.phoneNumber); - } - - @Override - public int hashCode() { - return Objects.hash(firstName, lastName, company, address1, address2, locality, administrativeArea, postalCode, country, email, phoneNumber); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1paymentinstrumentsBillTo {\n"); - - sb.append(" firstName: ").append(toIndentedString(firstName)).append("\n"); - sb.append(" lastName: ").append(toIndentedString(lastName)).append("\n"); - sb.append(" company: ").append(toIndentedString(company)).append("\n"); - sb.append(" address1: ").append(toIndentedString(address1)).append("\n"); - sb.append(" address2: ").append(toIndentedString(address2)).append("\n"); - sb.append(" locality: ").append(toIndentedString(locality)).append("\n"); - sb.append(" administrativeArea: ").append(toIndentedString(administrativeArea)).append("\n"); - sb.append(" postalCode: ").append(toIndentedString(postalCode)).append("\n"); - sb.append(" country: ").append(toIndentedString(country)).append("\n"); - sb.append(" email: ").append(toIndentedString(email)).append("\n"); - sb.append(" phoneNumber: ").append(toIndentedString(phoneNumber)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Tmsv1paymentinstrumentsBuyerInformation.java b/src/main/java/Model/Tmsv1paymentinstrumentsBuyerInformation.java deleted file mode 100644 index 55c3fe89a..000000000 --- a/src/main/java/Model/Tmsv1paymentinstrumentsBuyerInformation.java +++ /dev/null @@ -1,173 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import Model.Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; -import java.util.ArrayList; -import java.util.List; - -/** - * Tmsv1paymentinstrumentsBuyerInformation - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1paymentinstrumentsBuyerInformation { - @SerializedName("companyTaxID") - private String companyTaxID = null; - - @SerializedName("currency") - private String currency = null; - - @SerializedName("dateOBirth") - private String dateOBirth = null; - - @SerializedName("personalIdentification") - private List personalIdentification = null; - - public Tmsv1paymentinstrumentsBuyerInformation companyTaxID(String companyTaxID) { - this.companyTaxID = companyTaxID; - return this; - } - - /** - * Company Tax ID. - * @return companyTaxID - **/ - @ApiModelProperty(example = "1234567890123456800", value = "Company Tax ID.") - public String getCompanyTaxID() { - return companyTaxID; - } - - public void setCompanyTaxID(String companyTaxID) { - this.companyTaxID = companyTaxID; - } - - public Tmsv1paymentinstrumentsBuyerInformation currency(String currency) { - this.currency = currency; - return this; - } - - /** - * Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha - * @return currency - **/ - @ApiModelProperty(example = "USD", value = "Currency. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha") - public String getCurrency() { - return currency; - } - - public void setCurrency(String currency) { - this.currency = currency; - } - - public Tmsv1paymentinstrumentsBuyerInformation dateOBirth(String dateOBirth) { - this.dateOBirth = dateOBirth; - return this; - } - - /** - * Date of birth YYYY-MM-DD. - * @return dateOBirth - **/ - @ApiModelProperty(example = "1960-12-30", value = "Date of birth YYYY-MM-DD.") - public String getDateOBirth() { - return dateOBirth; - } - - public void setDateOBirth(String dateOBirth) { - this.dateOBirth = dateOBirth; - } - - public Tmsv1paymentinstrumentsBuyerInformation personalIdentification(List personalIdentification) { - this.personalIdentification = personalIdentification; - return this; - } - - public Tmsv1paymentinstrumentsBuyerInformation addPersonalIdentificationItem(Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification personalIdentificationItem) { - if (this.personalIdentification == null) { - this.personalIdentification = new ArrayList(); - } - this.personalIdentification.add(personalIdentificationItem); - return this; - } - - /** - * Get personalIdentification - * @return personalIdentification - **/ - @ApiModelProperty(value = "") - public List getPersonalIdentification() { - return personalIdentification; - } - - public void setPersonalIdentification(List personalIdentification) { - this.personalIdentification = personalIdentification; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Tmsv1paymentinstrumentsBuyerInformation tmsv1paymentinstrumentsBuyerInformation = (Tmsv1paymentinstrumentsBuyerInformation) o; - return Objects.equals(this.companyTaxID, tmsv1paymentinstrumentsBuyerInformation.companyTaxID) && - Objects.equals(this.currency, tmsv1paymentinstrumentsBuyerInformation.currency) && - Objects.equals(this.dateOBirth, tmsv1paymentinstrumentsBuyerInformation.dateOBirth) && - Objects.equals(this.personalIdentification, tmsv1paymentinstrumentsBuyerInformation.personalIdentification); - } - - @Override - public int hashCode() { - return Objects.hash(companyTaxID, currency, dateOBirth, personalIdentification); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1paymentinstrumentsBuyerInformation {\n"); - - sb.append(" companyTaxID: ").append(toIndentedString(companyTaxID)).append("\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append(" dateOBirth: ").append(toIndentedString(dateOBirth)).append("\n"); - sb.append(" personalIdentification: ").append(toIndentedString(personalIdentification)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification.java b/src/main/java/Model/Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification.java deleted file mode 100644 index fa4fd6a1f..000000000 --- a/src/main/java/Model/Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification.java +++ /dev/null @@ -1,140 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import Model.Tmsv1paymentinstrumentsBuyerInformationIssuedBy; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification { - @SerializedName("id") - private String id = null; - - @SerializedName("type") - private String type = null; - - @SerializedName("issuedBy") - private Tmsv1paymentinstrumentsBuyerInformationIssuedBy issuedBy = null; - - public Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification id(String id) { - this.id = id; - return this; - } - - /** - * Identification Number. - * @return id - **/ - @ApiModelProperty(example = "1234567890", value = "Identification Number.") - public String getId() { - return id; - } - - public void setId(String id) { - this.id = id; - } - - public Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification type(String type) { - this.type = type; - return this; - } - - /** - * Type of personal identification. - * @return type - **/ - @ApiModelProperty(example = "driver license", value = "Type of personal identification.") - public String getType() { - return type; - } - - public void setType(String type) { - this.type = type; - } - - public Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification issuedBy(Tmsv1paymentinstrumentsBuyerInformationIssuedBy issuedBy) { - this.issuedBy = issuedBy; - return this; - } - - /** - * Get issuedBy - * @return issuedBy - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsBuyerInformationIssuedBy getIssuedBy() { - return issuedBy; - } - - public void setIssuedBy(Tmsv1paymentinstrumentsBuyerInformationIssuedBy issuedBy) { - this.issuedBy = issuedBy; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification tmsv1paymentinstrumentsBuyerInformationPersonalIdentification = (Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification) o; - return Objects.equals(this.id, tmsv1paymentinstrumentsBuyerInformationPersonalIdentification.id) && - Objects.equals(this.type, tmsv1paymentinstrumentsBuyerInformationPersonalIdentification.type) && - Objects.equals(this.issuedBy, tmsv1paymentinstrumentsBuyerInformationPersonalIdentification.issuedBy); - } - - @Override - public int hashCode() { - return Objects.hash(id, type, issuedBy); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1paymentinstrumentsBuyerInformationPersonalIdentification {\n"); - - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); - sb.append(" issuedBy: ").append(toIndentedString(issuedBy)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Tmsv1paymentinstrumentsCard.java b/src/main/java/Model/Tmsv1paymentinstrumentsCard.java deleted file mode 100644 index acf171edd..000000000 --- a/src/main/java/Model/Tmsv1paymentinstrumentsCard.java +++ /dev/null @@ -1,382 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Tmsv1paymentinstrumentsCard - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1paymentinstrumentsCard { - @SerializedName("expirationMonth") - private String expirationMonth = null; - - @SerializedName("expirationYear") - private String expirationYear = null; - - /** - * Credit card brand. - */ - @JsonAdapter(TypeEnum.Adapter.class) - public enum TypeEnum { - VISA("visa"), - - MASTERCARD("mastercard"), - - AMERICAN_EXPRESS("american express"), - - DISCOVER("discover"), - - DINERS_CLUB("diners club"), - - CARTE_BLANCHE("carte blanche"), - - JCB("jcb"), - - OPTIMA("optima"), - - TWINPAY_CREDIT("twinpay credit"), - - TWINPAY_DEBIT("twinpay debit"), - - WALMART("walmart"), - - ENROUTE("enroute"), - - LOWES_CONSUMER("lowes consumer"), - - HOME_DEPOT_CONSUMER("home depot consumer"), - - MBNA("mbna"), - - DICKS_SPORTSWEAR("dicks sportswear"), - - CASUAL_CORNER("casual corner"), - - SEARS("sears"), - - JAL("jal"), - - DISNEY("disney"), - - MAESTRO_UK_DOMESTIC("maestro uk domestic"), - - SAMS_CLUB_CONSUMER("sams club consumer"), - - SAMS_CLUB_BUSINESS("sams club business"), - - NICOS("nicos"), - - BILL_ME_LATER("bill me later"), - - BEBE("bebe"), - - RESTORATION_HARDWARE("restoration hardware"), - - DELTA_ONLINE("delta online"), - - SOLO("solo"), - - VISA_ELECTRON("visa electron"), - - DANKORT("dankort"), - - LASER("laser"), - - CARTE_BLEUE("carte bleue"), - - CARTA_SI("carta si"), - - PINLESS_DEBIT("pinless debit"), - - ENCODED_ACCOUNT("encoded account"), - - UATP("uatp"), - - HOUSEHOLD("household"), - - MAESTRO_INTERNATIONAL("maestro international"), - - GE_MONEY_UK("ge money uk"), - - KOREAN_CARDS("korean cards"), - - STYLE("style"), - - JCREW("jcrew"), - - PAYEASE_CHINA_PROCESSING_EWALLET("payease china processing ewallet"), - - PAYEASE_CHINA_PROCESSING_BANK_TRANSFER("payease china processing bank transfer"), - - MEIJER_PRIVATE_LABEL("meijer private label"), - - HIPERCARD("hipercard"), - - AURA("aura"), - - REDECARD("redecard"), - - ORICO("orico"), - - ELO("elo"), - - CAPITAL_ONE_PRIVATE_LABEL("capital one private label"), - - SYNCHRONY_PRIVATE_LABEL("synchrony private label"), - - CHINA_UNION_PAY("china union pay"); - - private String value; - - TypeEnum(String value) { - this.value = value; - } - - public String getValue() { - return value; - } - - @Override - public String toString() { - return String.valueOf(value); - } - - public static TypeEnum fromValue(String text) { - for (TypeEnum b : TypeEnum.values()) { - if (String.valueOf(b.value).equals(text)) { - return b; - } - } - return null; - } - - public static class Adapter extends TypeAdapter { - @Override - public void write(final JsonWriter jsonWriter, final TypeEnum enumeration) throws IOException { - jsonWriter.value(enumeration.getValue()); - } - - @Override - public TypeEnum read(final JsonReader jsonReader) throws IOException { - String value = jsonReader.nextString(); - return TypeEnum.fromValue(String.valueOf(value)); - } - } - } - - @SerializedName("type") - private TypeEnum type = null; - - @SerializedName("issueNumber") - private String issueNumber = null; - - @SerializedName("startMonth") - private String startMonth = null; - - @SerializedName("startYear") - private String startYear = null; - - @SerializedName("useAs") - private String useAs = null; - - public Tmsv1paymentinstrumentsCard expirationMonth(String expirationMonth) { - this.expirationMonth = expirationMonth; - return this; - } - - /** - * Credit card expiration month. - * @return expirationMonth - **/ - @ApiModelProperty(example = "12", value = "Credit card expiration month.") - public String getExpirationMonth() { - return expirationMonth; - } - - public void setExpirationMonth(String expirationMonth) { - this.expirationMonth = expirationMonth; - } - - public Tmsv1paymentinstrumentsCard expirationYear(String expirationYear) { - this.expirationYear = expirationYear; - return this; - } - - /** - * Credit card expiration year. - * @return expirationYear - **/ - @ApiModelProperty(example = "2022", value = "Credit card expiration year.") - public String getExpirationYear() { - return expirationYear; - } - - public void setExpirationYear(String expirationYear) { - this.expirationYear = expirationYear; - } - - public Tmsv1paymentinstrumentsCard type(TypeEnum type) { - this.type = type; - return this; - } - - /** - * Credit card brand. - * @return type - **/ - @ApiModelProperty(example = "visa", value = "Credit card brand.") - public TypeEnum getType() { - return type; - } - - public void setType(TypeEnum type) { - this.type = type; - } - - public Tmsv1paymentinstrumentsCard issueNumber(String issueNumber) { - this.issueNumber = issueNumber; - return this; - } - - /** - * Credit card issue number. - * @return issueNumber - **/ - @ApiModelProperty(example = "01", value = "Credit card issue number.") - public String getIssueNumber() { - return issueNumber; - } - - public void setIssueNumber(String issueNumber) { - this.issueNumber = issueNumber; - } - - public Tmsv1paymentinstrumentsCard startMonth(String startMonth) { - this.startMonth = startMonth; - return this; - } - - /** - * Credit card start month. - * @return startMonth - **/ - @ApiModelProperty(example = "12", value = "Credit card start month.") - public String getStartMonth() { - return startMonth; - } - - public void setStartMonth(String startMonth) { - this.startMonth = startMonth; - } - - public Tmsv1paymentinstrumentsCard startYear(String startYear) { - this.startYear = startYear; - return this; - } - - /** - * Credit card start year. - * @return startYear - **/ - @ApiModelProperty(example = "12", value = "Credit card start year.") - public String getStartYear() { - return startYear; - } - - public void setStartYear(String startYear) { - this.startYear = startYear; - } - - public Tmsv1paymentinstrumentsCard useAs(String useAs) { - this.useAs = useAs; - return this; - } - - /** - * Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens. - * @return useAs - **/ - @ApiModelProperty(example = "pinless debit", value = "Card Use As Field. Supported value of \"pinless debit\" only. Only for use with Pinless Debit tokens.") - public String getUseAs() { - return useAs; - } - - public void setUseAs(String useAs) { - this.useAs = useAs; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Tmsv1paymentinstrumentsCard tmsv1paymentinstrumentsCard = (Tmsv1paymentinstrumentsCard) o; - return Objects.equals(this.expirationMonth, tmsv1paymentinstrumentsCard.expirationMonth) && - Objects.equals(this.expirationYear, tmsv1paymentinstrumentsCard.expirationYear) && - Objects.equals(this.type, tmsv1paymentinstrumentsCard.type) && - Objects.equals(this.issueNumber, tmsv1paymentinstrumentsCard.issueNumber) && - Objects.equals(this.startMonth, tmsv1paymentinstrumentsCard.startMonth) && - Objects.equals(this.startYear, tmsv1paymentinstrumentsCard.startYear) && - Objects.equals(this.useAs, tmsv1paymentinstrumentsCard.useAs); - } - - @Override - public int hashCode() { - return Objects.hash(expirationMonth, expirationYear, type, issueNumber, startMonth, startYear, useAs); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1paymentinstrumentsCard {\n"); - - sb.append(" expirationMonth: ").append(toIndentedString(expirationMonth)).append("\n"); - sb.append(" expirationYear: ").append(toIndentedString(expirationYear)).append("\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); - sb.append(" issueNumber: ").append(toIndentedString(issueNumber)).append("\n"); - sb.append(" startMonth: ").append(toIndentedString(startMonth)).append("\n"); - sb.append(" startYear: ").append(toIndentedString(startYear)).append("\n"); - sb.append(" useAs: ").append(toIndentedString(useAs)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Tmsv1paymentinstrumentsProcessingInformation.java b/src/main/java/Model/Tmsv1paymentinstrumentsProcessingInformation.java deleted file mode 100644 index 45c3baf11..000000000 --- a/src/main/java/Model/Tmsv1paymentinstrumentsProcessingInformation.java +++ /dev/null @@ -1,117 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import Model.Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Tmsv1paymentinstrumentsProcessingInformation - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1paymentinstrumentsProcessingInformation { - @SerializedName("billPaymentProgramEnabled") - private Boolean billPaymentProgramEnabled = null; - - @SerializedName("bankTransferOptions") - private Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions bankTransferOptions = null; - - public Tmsv1paymentinstrumentsProcessingInformation billPaymentProgramEnabled(Boolean billPaymentProgramEnabled) { - this.billPaymentProgramEnabled = billPaymentProgramEnabled; - return this; - } - - /** - * Bill Payment Program Enabled. - * @return billPaymentProgramEnabled - **/ - @ApiModelProperty(example = "true", value = "Bill Payment Program Enabled.") - public Boolean getBillPaymentProgramEnabled() { - return billPaymentProgramEnabled; - } - - public void setBillPaymentProgramEnabled(Boolean billPaymentProgramEnabled) { - this.billPaymentProgramEnabled = billPaymentProgramEnabled; - } - - public Tmsv1paymentinstrumentsProcessingInformation bankTransferOptions(Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions bankTransferOptions) { - this.bankTransferOptions = bankTransferOptions; - return this; - } - - /** - * Get bankTransferOptions - * @return bankTransferOptions - **/ - @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions getBankTransferOptions() { - return bankTransferOptions; - } - - public void setBankTransferOptions(Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions bankTransferOptions) { - this.bankTransferOptions = bankTransferOptions; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Tmsv1paymentinstrumentsProcessingInformation tmsv1paymentinstrumentsProcessingInformation = (Tmsv1paymentinstrumentsProcessingInformation) o; - return Objects.equals(this.billPaymentProgramEnabled, tmsv1paymentinstrumentsProcessingInformation.billPaymentProgramEnabled) && - Objects.equals(this.bankTransferOptions, tmsv1paymentinstrumentsProcessingInformation.bankTransferOptions); - } - - @Override - public int hashCode() { - return Objects.hash(billPaymentProgramEnabled, bankTransferOptions); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1paymentinstrumentsProcessingInformation {\n"); - - sb.append(" billPaymentProgramEnabled: ").append(toIndentedString(billPaymentProgramEnabled)).append("\n"); - sb.append(" bankTransferOptions: ").append(toIndentedString(bankTransferOptions)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions.java b/src/main/java/Model/Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions.java deleted file mode 100644 index d1d60eb0d..000000000 --- a/src/main/java/Model/Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions.java +++ /dev/null @@ -1,93 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions { - @SerializedName("SECCode") - private String seCCode = null; - - public Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions seCCode(String seCCode) { - this.seCCode = seCCode; - return this; - } - - /** - * Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB). - * @return seCCode - **/ - @ApiModelProperty(example = "WEB", value = "Authorization method used for the transaction.(acceptable values are CCD, PPD, TEL, WEB).") - public String getSeCCode() { - return seCCode; - } - - public void setSeCCode(String seCCode) { - this.seCCode = seCCode; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions tmsv1paymentinstrumentsProcessingInformationBankTransferOptions = (Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions) o; - return Objects.equals(this.seCCode, tmsv1paymentinstrumentsProcessingInformationBankTransferOptions.seCCode); - } - - @Override - public int hashCode() { - return Objects.hash(seCCode); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class Tmsv1paymentinstrumentsProcessingInformationBankTransferOptions {\n"); - - sb.append(" seCCode: ").append(toIndentedString(seCCode)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/TokenizeParameters.java b/src/main/java/Model/TokenizeParameters.java deleted file mode 100644 index 18753facf..000000000 --- a/src/main/java/Model/TokenizeParameters.java +++ /dev/null @@ -1,117 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import Model.Flexv1tokensCardInfo; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * TokenizeParameters - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TokenizeParameters { - @SerializedName("keyId") - private String keyId = null; - - @SerializedName("cardInfo") - private Flexv1tokensCardInfo cardInfo = null; - - public TokenizeParameters keyId(String keyId) { - this.keyId = keyId; - return this; - } - - /** - * Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key. - * @return keyId - **/ - @ApiModelProperty(value = "Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key.") - public String getKeyId() { - return keyId; - } - - public void setKeyId(String keyId) { - this.keyId = keyId; - } - - public TokenizeParameters cardInfo(Flexv1tokensCardInfo cardInfo) { - this.cardInfo = cardInfo; - return this; - } - - /** - * Get cardInfo - * @return cardInfo - **/ - @ApiModelProperty(value = "") - public Flexv1tokensCardInfo getCardInfo() { - return cardInfo; - } - - public void setCardInfo(Flexv1tokensCardInfo cardInfo) { - this.cardInfo = cardInfo; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TokenizeParameters tokenizeParameters = (TokenizeParameters) o; - return Objects.equals(this.keyId, tokenizeParameters.keyId) && - Objects.equals(this.cardInfo, tokenizeParameters.cardInfo); - } - - @Override - public int hashCode() { - return Objects.hash(keyId, cardInfo); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TokenizeParameters {\n"); - - sb.append(" keyId: ").append(toIndentedString(keyId)).append("\n"); - sb.append(" cardInfo: ").append(toIndentedString(cardInfo)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/TokenizeRequest.java b/src/main/java/Model/TokenizeRequest.java index 55898bbc5..b3ef60c5a 100644 --- a/src/main/java/Model/TokenizeRequest.java +++ b/src/main/java/Model/TokenizeRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * TokenizeRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TokenizeRequest { @SerializedName("keyId") private String keyId = null; @@ -44,7 +44,7 @@ public TokenizeRequest keyId(String keyId) { * Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key. * @return keyId **/ - @ApiModelProperty(value = "Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key.") + @ApiModelProperty(required = true, value = "Unique identifier for the generated token. This is obtained from the Generate Key request. See the [Java Script and Java examples] (http://apps.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Flex/Key/html) on how to import the key and encrypt using the imported key.") public String getKeyId() { return keyId; } diff --git a/src/main/java/Model/TokenizeResult.java b/src/main/java/Model/TokenizeResult.java deleted file mode 100644 index b10fc8e62..000000000 --- a/src/main/java/Model/TokenizeResult.java +++ /dev/null @@ -1,265 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * TokenizeResult - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TokenizeResult { - @SerializedName("keyId") - private String keyId = null; - - @SerializedName("token") - private String token = null; - - @SerializedName("maskedPan") - private String maskedPan = null; - - @SerializedName("cardType") - private String cardType = null; - - @SerializedName("timestamp") - private Long timestamp = null; - - @SerializedName("signedFields") - private String signedFields = null; - - @SerializedName("signature") - private String signature = null; - - @SerializedName("discoverableServices") - private Map discoverableServices = null; - - public TokenizeResult keyId(String keyId) { - this.keyId = keyId; - return this; - } - - /** - * The Key ID. - * @return keyId - **/ - @ApiModelProperty(value = "The Key ID.") - public String getKeyId() { - return keyId; - } - - public void setKeyId(String keyId) { - this.keyId = keyId; - } - - public TokenizeResult token(String token) { - this.token = token; - return this; - } - - /** - * The generated token. The token replaces card data and is used as the Subscription ID in the CyberSource Simple Order API or SCMP API. - * @return token - **/ - @ApiModelProperty(value = "The generated token. The token replaces card data and is used as the Subscription ID in the CyberSource Simple Order API or SCMP API.") - public String getToken() { - return token; - } - - public void setToken(String token) { - this.token = token; - } - - public TokenizeResult maskedPan(String maskedPan) { - this.maskedPan = maskedPan; - return this; - } - - /** - * The masked card number displaying the first 6 digits and the last 4 digits. - * @return maskedPan - **/ - @ApiModelProperty(value = "The masked card number displaying the first 6 digits and the last 4 digits.") - public String getMaskedPan() { - return maskedPan; - } - - public void setMaskedPan(String maskedPan) { - this.maskedPan = maskedPan; - } - - public TokenizeResult cardType(String cardType) { - this.cardType = cardType; - return this; - } - - /** - * The card type. - * @return cardType - **/ - @ApiModelProperty(value = "The card type.") - public String getCardType() { - return cardType; - } - - public void setCardType(String cardType) { - this.cardType = cardType; - } - - public TokenizeResult timestamp(Long timestamp) { - this.timestamp = timestamp; - return this; - } - - /** - * The UTC date and time in milliseconds at which the signature was generated. - * @return timestamp - **/ - @ApiModelProperty(value = "The UTC date and time in milliseconds at which the signature was generated.") - public Long getTimestamp() { - return timestamp; - } - - public void setTimestamp(Long timestamp) { - this.timestamp = timestamp; - } - - public TokenizeResult signedFields(String signedFields) { - this.signedFields = signedFields; - return this; - } - - /** - * Indicates which fields from the response make up the data that is used when verifying the response signature. See the [sample code] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/java/com/cybersource/flex/application/CheckoutController.java) on how to verify the signature. - * @return signedFields - **/ - @ApiModelProperty(value = "Indicates which fields from the response make up the data that is used when verifying the response signature. See the [sample code] (https://github.com/CyberSource/cybersource-flex-samples/blob/master/java/spring-boot/src/main/java/com/cybersource/flex/application/CheckoutController.java) on how to verify the signature.") - public String getSignedFields() { - return signedFields; - } - - public void setSignedFields(String signedFields) { - this.signedFields = signedFields; - } - - public TokenizeResult signature(String signature) { - this.signature = signature; - return this; - } - - /** - * Flex-generated digital signature. To ensure the values have not been tampered with while passing through the client, verify this server-side using the public key generated from the /keys resource. - * @return signature - **/ - @ApiModelProperty(value = "Flex-generated digital signature. To ensure the values have not been tampered with while passing through the client, verify this server-side using the public key generated from the /keys resource.") - public String getSignature() { - return signature; - } - - public void setSignature(String signature) { - this.signature = signature; - } - - public TokenizeResult discoverableServices(Map discoverableServices) { - this.discoverableServices = discoverableServices; - return this; - } - - public TokenizeResult putDiscoverableServicesItem(String key, Object discoverableServicesItem) { - if (this.discoverableServices == null) { - this.discoverableServices = new HashMap(); - } - this.discoverableServices.put(key, discoverableServicesItem); - return this; - } - - /** - * Get discoverableServices - * @return discoverableServices - **/ - @ApiModelProperty(value = "") - public Map getDiscoverableServices() { - return discoverableServices; - } - - public void setDiscoverableServices(Map discoverableServices) { - this.discoverableServices = discoverableServices; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TokenizeResult tokenizeResult = (TokenizeResult) o; - return Objects.equals(this.keyId, tokenizeResult.keyId) && - Objects.equals(this.token, tokenizeResult.token) && - Objects.equals(this.maskedPan, tokenizeResult.maskedPan) && - Objects.equals(this.cardType, tokenizeResult.cardType) && - Objects.equals(this.timestamp, tokenizeResult.timestamp) && - Objects.equals(this.signedFields, tokenizeResult.signedFields) && - Objects.equals(this.signature, tokenizeResult.signature) && - Objects.equals(this.discoverableServices, tokenizeResult.discoverableServices); - } - - @Override - public int hashCode() { - return Objects.hash(keyId, token, maskedPan, cardType, timestamp, signedFields, signature, discoverableServices); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TokenizeResult {\n"); - - sb.append(" keyId: ").append(toIndentedString(keyId)).append("\n"); - sb.append(" token: ").append(toIndentedString(token)).append("\n"); - sb.append(" maskedPan: ").append(toIndentedString(maskedPan)).append("\n"); - sb.append(" cardType: ").append(toIndentedString(cardType)).append("\n"); - sb.append(" timestamp: ").append(toIndentedString(timestamp)).append("\n"); - sb.append(" signedFields: ").append(toIndentedString(signedFields)).append("\n"); - sb.append(" signature: ").append(toIndentedString(signature)).append("\n"); - sb.append(" discoverableServices: ").append(toIndentedString(discoverableServices)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/TssV2TransactionsGet200Response.java b/src/main/java/Model/TssV2TransactionsGet200Response.java index bd5ea3902..f85efd946 100644 --- a/src/main/java/Model/TssV2TransactionsGet200Response.java +++ b/src/main/java/Model/TssV2TransactionsGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.PtsV2PaymentsReversalsPost201ResponseLinks; +import Model.Ptsv2paymentsMerchantDefinedInformation; import Model.TssV2TransactionsGet200ResponseApplicationInformation; import Model.TssV2TransactionsGet200ResponseBuyerInformation; import Model.TssV2TransactionsGet200ResponseClientReferenceInformation; @@ -23,7 +23,7 @@ import Model.TssV2TransactionsGet200ResponseErrorInformation; import Model.TssV2TransactionsGet200ResponseFraudMarkingInformation; import Model.TssV2TransactionsGet200ResponseInstallmentInformation; -import Model.TssV2TransactionsGet200ResponseMerchantDefinedInformation; +import Model.TssV2TransactionsGet200ResponseLinks; import Model.TssV2TransactionsGet200ResponseMerchantInformation; import Model.TssV2TransactionsGet200ResponseOrderInformation; import Model.TssV2TransactionsGet200ResponsePaymentInformation; @@ -46,7 +46,7 @@ /** * TssV2TransactionsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200Response { @SerializedName("id") private String id = null; @@ -63,8 +63,8 @@ public class TssV2TransactionsGet200Response { @SerializedName("status") private String status = null; - @SerializedName("submitTimeUtc") - private String submitTimeUtc = null; + @SerializedName("submitTimeUTC") + private String submitTimeUTC = null; @SerializedName("applicationInformation") private TssV2TransactionsGet200ResponseApplicationInformation applicationInformation = null; @@ -91,7 +91,7 @@ public class TssV2TransactionsGet200Response { private TssV2TransactionsGet200ResponseFraudMarkingInformation fraudMarkingInformation = null; @SerializedName("merchantDefinedInformation") - private List merchantDefinedInformation = null; + private List merchantDefinedInformation = null; @SerializedName("merchantInformation") private TssV2TransactionsGet200ResponseMerchantInformation merchantInformation = null; @@ -118,7 +118,7 @@ public class TssV2TransactionsGet200Response { private TssV2TransactionsGet200ResponseSenderInformation senderInformation = null; @SerializedName("_links") - private PtsV2PaymentsReversalsPost201ResponseLinks links = null; + private TssV2TransactionsGet200ResponseLinks links = null; public TssV2TransactionsGet200Response id(String id) { this.id = id; @@ -126,10 +126,10 @@ public TssV2TransactionsGet200Response id(String id) { } /** - * An unique identification number assigned by CyberSource to identify the submitted request. + * An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. * @return id **/ - @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request.") + @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.") public String getId() { return id; } @@ -210,22 +210,22 @@ public void setStatus(String status) { this.status = status; } - public TssV2TransactionsGet200Response submitTimeUtc(String submitTimeUtc) { - this.submitTimeUtc = submitTimeUtc; + public TssV2TransactionsGet200Response submitTimeUTC(String submitTimeUTC) { + this.submitTimeUTC = submitTimeUTC; return this; } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. - * @return submitTimeUtc + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. + * @return submitTimeUTC **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") - public String getSubmitTimeUtc() { - return submitTimeUtc; + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") + public String getSubmitTimeUTC() { + return submitTimeUTC; } - public void setSubmitTimeUtc(String submitTimeUtc) { - this.submitTimeUtc = submitTimeUtc; + public void setSubmitTimeUTC(String submitTimeUTC) { + this.submitTimeUTC = submitTimeUTC; } public TssV2TransactionsGet200Response applicationInformation(TssV2TransactionsGet200ResponseApplicationInformation applicationInformation) { @@ -372,14 +372,14 @@ public void setFraudMarkingInformation(TssV2TransactionsGet200ResponseFraudMarki this.fraudMarkingInformation = fraudMarkingInformation; } - public TssV2TransactionsGet200Response merchantDefinedInformation(List merchantDefinedInformation) { + public TssV2TransactionsGet200Response merchantDefinedInformation(List merchantDefinedInformation) { this.merchantDefinedInformation = merchantDefinedInformation; return this; } - public TssV2TransactionsGet200Response addMerchantDefinedInformationItem(TssV2TransactionsGet200ResponseMerchantDefinedInformation merchantDefinedInformationItem) { + public TssV2TransactionsGet200Response addMerchantDefinedInformationItem(Ptsv2paymentsMerchantDefinedInformation merchantDefinedInformationItem) { if (this.merchantDefinedInformation == null) { - this.merchantDefinedInformation = new ArrayList(); + this.merchantDefinedInformation = new ArrayList(); } this.merchantDefinedInformation.add(merchantDefinedInformationItem); return this; @@ -390,11 +390,11 @@ public TssV2TransactionsGet200Response addMerchantDefinedInformationItem(TssV2Tr * @return merchantDefinedInformation **/ @ApiModelProperty(value = "The description for this field is not available.") - public List getMerchantDefinedInformation() { + public List getMerchantDefinedInformation() { return merchantDefinedInformation; } - public void setMerchantDefinedInformation(List merchantDefinedInformation) { + public void setMerchantDefinedInformation(List merchantDefinedInformation) { this.merchantDefinedInformation = merchantDefinedInformation; } @@ -542,7 +542,7 @@ public void setSenderInformation(TssV2TransactionsGet200ResponseSenderInformatio this.senderInformation = senderInformation; } - public TssV2TransactionsGet200Response links(PtsV2PaymentsReversalsPost201ResponseLinks links) { + public TssV2TransactionsGet200Response links(TssV2TransactionsGet200ResponseLinks links) { this.links = links; return this; } @@ -552,11 +552,11 @@ public TssV2TransactionsGet200Response links(PtsV2PaymentsReversalsPost201Respon * @return links **/ @ApiModelProperty(value = "") - public PtsV2PaymentsReversalsPost201ResponseLinks getLinks() { + public TssV2TransactionsGet200ResponseLinks getLinks() { return links; } - public void setLinks(PtsV2PaymentsReversalsPost201ResponseLinks links) { + public void setLinks(TssV2TransactionsGet200ResponseLinks links) { this.links = links; } @@ -575,7 +575,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.reconciliationId, tssV2TransactionsGet200Response.reconciliationId) && Objects.equals(this.merchantId, tssV2TransactionsGet200Response.merchantId) && Objects.equals(this.status, tssV2TransactionsGet200Response.status) && - Objects.equals(this.submitTimeUtc, tssV2TransactionsGet200Response.submitTimeUtc) && + Objects.equals(this.submitTimeUTC, tssV2TransactionsGet200Response.submitTimeUTC) && Objects.equals(this.applicationInformation, tssV2TransactionsGet200Response.applicationInformation) && Objects.equals(this.buyerInformation, tssV2TransactionsGet200Response.buyerInformation) && Objects.equals(this.clientReferenceInformation, tssV2TransactionsGet200Response.clientReferenceInformation) && @@ -598,7 +598,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(id, rootId, reconciliationId, merchantId, status, submitTimeUtc, applicationInformation, buyerInformation, clientReferenceInformation, consumerAuthenticationInformation, deviceInformation, errorInformation, installmentInformation, fraudMarkingInformation, merchantDefinedInformation, merchantInformation, orderInformation, paymentInformation, processingInformation, processorInformation, pointOfSaleInformation, riskInformation, senderInformation, links); + return Objects.hash(id, rootId, reconciliationId, merchantId, status, submitTimeUTC, applicationInformation, buyerInformation, clientReferenceInformation, consumerAuthenticationInformation, deviceInformation, errorInformation, installmentInformation, fraudMarkingInformation, merchantDefinedInformation, merchantInformation, orderInformation, paymentInformation, processingInformation, processorInformation, pointOfSaleInformation, riskInformation, senderInformation, links); } @@ -612,7 +612,7 @@ public String toString() { sb.append(" reconciliationId: ").append(toIndentedString(reconciliationId)).append("\n"); sb.append(" merchantId: ").append(toIndentedString(merchantId)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" submitTimeUtc: ").append(toIndentedString(submitTimeUtc)).append("\n"); + sb.append(" submitTimeUTC: ").append(toIndentedString(submitTimeUTC)).append("\n"); sb.append(" applicationInformation: ").append(toIndentedString(applicationInformation)).append("\n"); sb.append(" buyerInformation: ").append(toIndentedString(buyerInformation)).append("\n"); sb.append(" clientReferenceInformation: ").append(toIndentedString(clientReferenceInformation)).append("\n"); diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformation.java index 907f4665d..d1491b7fc 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * TssV2TransactionsGet200ResponseApplicationInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseApplicationInformation { @SerializedName("status") private String status = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformationApplications.java b/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformationApplications.java index fbc544d48..aecadf66e 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformationApplications.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformationApplications.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseApplicationInformationApplications */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseApplicationInformationApplications { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseBuyerInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseBuyerInformation.java index 5f49b92b4..e5e3ebad9 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseBuyerInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseBuyerInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseBuyerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseBuyerInformation { @SerializedName("merchantCustomerId") private String merchantCustomerId = null; @@ -40,10 +40,10 @@ public TssV2TransactionsGet200ResponseBuyerInformation merchantCustomerId(String } /** - * Your identifier for the customer. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. **Comercio Latino**\\ For recurring payments in Mexico, the value is the customer’s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. **Litle**\\ For a follow-on credit with Litle, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return merchantCustomerId **/ - @ApiModelProperty(value = "Your identifier for the customer. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. **Comercio Latino**\\ For recurring payments in Mexico, the value is the customer’s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. **Litle**\\ For a follow-on credit with Litle, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getMerchantCustomerId() { return merchantCustomerId; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseClientReferenceInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseClientReferenceInformation.java index af81c957b..1ffe69cd9 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseClientReferenceInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseClientReferenceInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseClientReferenceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseClientReferenceInformation { @SerializedName("code") private String code = null; @@ -49,10 +49,10 @@ public TssV2TransactionsGet200ResponseClientReferenceInformation code(String cod } /** - * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. + * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. * @return code **/ - @ApiModelProperty(value = "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. ") + @ApiModelProperty(value = "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ") public String getCode() { return code; } @@ -121,10 +121,10 @@ public TssV2TransactionsGet200ResponseClientReferenceInformation comments(String } /** - * The description for this field is not available. + * Brief description of the order or any comment you wish to add to the order. * @return comments **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "Brief description of the order or any comment you wish to add to the order.") public String getComments() { return comments; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.java index dec1b6504..be55954d7 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseConsumerAuthenticationInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseConsumerAuthenticationInformation { @SerializedName("eciRaw") private String eciRaw = null; @@ -46,10 +46,10 @@ public TssV2TransactionsGet200ResponseConsumerAuthenticationInformation eciRaw(S } /** - * Raw electronic commerce indicator (ECI). + * Raw electronic commerce indicator (ECI). For the description and requirements, see \"Payer Authentication,\" page 180. * @return eciRaw **/ - @ApiModelProperty(value = "Raw electronic commerce indicator (ECI).") + @ApiModelProperty(value = "Raw electronic commerce indicator (ECI). For the description and requirements, see \"Payer Authentication,\" page 180.") public String getEciRaw() { return eciRaw; } @@ -82,10 +82,10 @@ public TssV2TransactionsGet200ResponseConsumerAuthenticationInformation xid(Stri } /** - * Transaction identifier. + * Transaction identifier. For the description and requirements, see \"Payer Authentication,\" page 180. * @return xid **/ - @ApiModelProperty(value = "Transaction identifier.") + @ApiModelProperty(value = "Transaction identifier. For the description and requirements, see \"Payer Authentication,\" page 180.") public String getXid() { return xid; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseDeviceInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseDeviceInformation.java index fb96b4ef0..d81acfa11 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseDeviceInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseDeviceInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseDeviceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseDeviceInformation { @SerializedName("ipAddress") private String ipAddress = null; @@ -43,10 +43,10 @@ public TssV2TransactionsGet200ResponseDeviceInformation ipAddress(String ipAddre } /** - * IP address of the customer. + * Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information. * @return ipAddress **/ - @ApiModelProperty(value = "IP address of the customer.") + @ApiModelProperty(value = "Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information. ") public String getIpAddress() { return ipAddress; } @@ -61,10 +61,10 @@ public TssV2TransactionsGet200ResponseDeviceInformation hostName(String hostName } /** - * DNS resolved hostname from above _ipAddress_. + * Host name reported by the customer’s browser to your Web server identified via the HTTP header. * @return hostName **/ - @ApiModelProperty(value = "DNS resolved hostname from above _ipAddress_.") + @ApiModelProperty(value = "Host name reported by the customer’s browser to your Web server identified via the HTTP header.") public String getHostName() { return hostName; } @@ -79,10 +79,10 @@ public TssV2TransactionsGet200ResponseDeviceInformation cookiesAccepted(String c } /** - * The description for this field is not available. + * Boolean that indicates whether the customer’s browser accepts cookies. This field can contain one of the following values: - `yes`: The customer’s browser accepts cookies. - `no`: The customer’s browser does not accept cookies. * @return cookiesAccepted **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "Boolean that indicates whether the customer’s browser accepts cookies. This field can contain one of the following values: - `yes`: The customer’s browser accepts cookies. - `no`: The customer’s browser does not accept cookies. ") public String getCookiesAccepted() { return cookiesAccepted; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseErrorInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseErrorInformation.java index 20c906ebc..7964f7d6d 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseErrorInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseErrorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.PtsV2PayoutsPost201ResponseErrorInformationDetails; +import Model.PtsV2PaymentsPost201ResponseErrorInformationDetails; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -29,7 +29,7 @@ /** * TssV2TransactionsGet200ResponseErrorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseErrorInformation { @SerializedName("reason") private String reason = null; @@ -38,7 +38,7 @@ public class TssV2TransactionsGet200ResponseErrorInformation { private String message = null; @SerializedName("details") - private List details = null; + private List details = null; public TssV2TransactionsGet200ResponseErrorInformation reason(String reason) { this.reason = reason; @@ -76,14 +76,14 @@ public void setMessage(String message) { this.message = message; } - public TssV2TransactionsGet200ResponseErrorInformation details(List details) { + public TssV2TransactionsGet200ResponseErrorInformation details(List details) { this.details = details; return this; } - public TssV2TransactionsGet200ResponseErrorInformation addDetailsItem(PtsV2PayoutsPost201ResponseErrorInformationDetails detailsItem) { + public TssV2TransactionsGet200ResponseErrorInformation addDetailsItem(PtsV2PaymentsPost201ResponseErrorInformationDetails detailsItem) { if (this.details == null) { - this.details = new ArrayList(); + this.details = new ArrayList(); } this.details.add(detailsItem); return this; @@ -94,11 +94,11 @@ public TssV2TransactionsGet200ResponseErrorInformation addDetailsItem(PtsV2Payou * @return details **/ @ApiModelProperty(value = "") - public List getDetails() { + public List getDetails() { return details; } - public void setDetails(List details) { + public void setDetails(List details) { this.details = details; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseFraudMarkingInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseFraudMarkingInformation.java index 1726e5628..dce02a33f 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseFraudMarkingInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseFraudMarkingInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseFraudMarkingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseFraudMarkingInformation { @SerializedName("reason") private String reason = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseInstallmentInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseInstallmentInformation.java index d2812f318..52c3cac81 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseInstallmentInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseInstallmentInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseInstallmentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseInstallmentInformation { @SerializedName("numberOfInstallments") private String numberOfInstallments = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseLinks.java b/src/main/java/Model/TssV2TransactionsGet200ResponseLinks.java new file mode 100644 index 000000000..7ebcb8f08 --- /dev/null +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseLinks.java @@ -0,0 +1,127 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import Model.PtsV2PaymentsPost201ResponseLinksSelf; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +/** + * TssV2TransactionsGet200ResponseLinks + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TssV2TransactionsGet200ResponseLinks { + @SerializedName("self") + private PtsV2PaymentsPost201ResponseLinksSelf self = null; + + @SerializedName("relatedTransactions") + private List relatedTransactions = null; + + public TssV2TransactionsGet200ResponseLinks self(PtsV2PaymentsPost201ResponseLinksSelf self) { + this.self = self; + return this; + } + + /** + * Get self + * @return self + **/ + @ApiModelProperty(value = "") + public PtsV2PaymentsPost201ResponseLinksSelf getSelf() { + return self; + } + + public void setSelf(PtsV2PaymentsPost201ResponseLinksSelf self) { + this.self = self; + } + + public TssV2TransactionsGet200ResponseLinks relatedTransactions(List relatedTransactions) { + this.relatedTransactions = relatedTransactions; + return this; + } + + public TssV2TransactionsGet200ResponseLinks addRelatedTransactionsItem(PtsV2PaymentsPost201ResponseLinksSelf relatedTransactionsItem) { + if (this.relatedTransactions == null) { + this.relatedTransactions = new ArrayList(); + } + this.relatedTransactions.add(relatedTransactionsItem); + return this; + } + + /** + * Get relatedTransactions + * @return relatedTransactions + **/ + @ApiModelProperty(value = "") + public List getRelatedTransactions() { + return relatedTransactions; + } + + public void setRelatedTransactions(List relatedTransactions) { + this.relatedTransactions = relatedTransactions; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TssV2TransactionsGet200ResponseLinks tssV2TransactionsGet200ResponseLinks = (TssV2TransactionsGet200ResponseLinks) o; + return Objects.equals(this.self, tssV2TransactionsGet200ResponseLinks.self) && + Objects.equals(this.relatedTransactions, tssV2TransactionsGet200ResponseLinks.relatedTransactions); + } + + @Override + public int hashCode() { + return Objects.hash(self, relatedTransactions); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TssV2TransactionsGet200ResponseLinks {\n"); + + sb.append(" self: ").append(toIndentedString(self)).append("\n"); + sb.append(" relatedTransactions: ").append(toIndentedString(relatedTransactions)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantDefinedInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantDefinedInformation.java deleted file mode 100644 index 3aafc1c9a..000000000 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantDefinedInformation.java +++ /dev/null @@ -1,116 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * TssV2TransactionsGet200ResponseMerchantDefinedInformation - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TssV2TransactionsGet200ResponseMerchantDefinedInformation { - @SerializedName("key") - private String key = null; - - @SerializedName("value") - private String value = null; - - public TssV2TransactionsGet200ResponseMerchantDefinedInformation key(String key) { - this.key = key; - return this; - } - - /** - * The description for this field is not available. - * @return key - **/ - @ApiModelProperty(value = "The description for this field is not available.") - public String getKey() { - return key; - } - - public void setKey(String key) { - this.key = key; - } - - public TssV2TransactionsGet200ResponseMerchantDefinedInformation value(String value) { - this.value = value; - return this; - } - - /** - * The description for this field is not available. - * @return value - **/ - @ApiModelProperty(value = "The description for this field is not available.") - public String getValue() { - return value; - } - - public void setValue(String value) { - this.value = value; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TssV2TransactionsGet200ResponseMerchantDefinedInformation tssV2TransactionsGet200ResponseMerchantDefinedInformation = (TssV2TransactionsGet200ResponseMerchantDefinedInformation) o; - return Objects.equals(this.key, tssV2TransactionsGet200ResponseMerchantDefinedInformation.key) && - Objects.equals(this.value, tssV2TransactionsGet200ResponseMerchantDefinedInformation.value); - } - - @Override - public int hashCode() { - return Objects.hash(key, value); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsGet200ResponseMerchantDefinedInformation {\n"); - - sb.append(" key: ").append(toIndentedString(key)).append("\n"); - sb.append(" value: ").append(toIndentedString(value)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformation.java index 59bab50e3..3517ea9a3 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * TssV2TransactionsGet200ResponseMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseMerchantInformation { @SerializedName("merchantDescriptor") private TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor merchantDescriptor = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.java b/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.java index ac77c670d..4b2a2e043 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformation.java index 976b0554d..1024e83f4 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -33,7 +33,7 @@ /** * TssV2TransactionsGet200ResponseOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseOrderInformation { @SerializedName("billTo") private TssV2TransactionsGet200ResponseOrderInformationBillTo billTo = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.java b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.java index 2f18e4e95..e4bff45b4 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseOrderInformationAmountDetails { @SerializedName("totalAmount") private String totalAmount = null; @@ -40,16 +40,22 @@ public class TssV2TransactionsGet200ResponseOrderInformationAmountDetails { @SerializedName("authorizedAmount") private String authorizedAmount = null; + @SerializedName("settlementAmount") + private String settlementAmount = null; + + @SerializedName("settlementCurrency") + private String settlementCurrency = null; + public TssV2TransactionsGet200ResponseOrderInformationAmountDetails totalAmount(String totalAmount) { this.totalAmount = totalAmount; return this; } /** - * Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:  Table 15, \"Authorization Information for Specific Processors,\" on page 43  Table 19, \"Capture Information for Specific Processors,\" on page 58  Table 23, \"Credit Information for Specific Processors,\" on page 75 If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247. **DCC with a Third-Party Provider**\\ Set this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used. * @return totalAmount **/ - @ApiModelProperty(value = "Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12. **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths. This information is covered in:  Table 15, \"Authorization Information for Specific Processors,\" on page 43  Table 19, \"Capture Information for Specific Processors,\" on page 58  Table 23, \"Credit Information for Specific Processors,\" on page 75 If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen. See \"Zero Amount Authorizations,\" page 247. **DCC with a Third-Party Provider**\\ Set this field to the converted amount that was returned by the DCC provider. You must include either this field or offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125. **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43. **DCC for First Data**\\ Not used. ") public String getTotalAmount() { return totalAmount; } @@ -64,10 +70,10 @@ public TssV2TransactionsGet200ResponseOrderInformationAmountDetails currency(Str } /** - * Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. + * Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. * @return currency **/ - @ApiModelProperty(value = "Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. ") + @ApiModelProperty(value = "Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your request for Payment API. **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. ") public String getCurrency() { return currency; } @@ -112,6 +118,42 @@ public void setAuthorizedAmount(String authorizedAmount) { this.authorizedAmount = authorizedAmount; } + public TssV2TransactionsGet200ResponseOrderInformationAmountDetails settlementAmount(String settlementAmount) { + this.settlementAmount = settlementAmount; + return this; + } + + /** + * This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder’s account. + * @return settlementAmount + **/ + @ApiModelProperty(value = "This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder’s account. ") + public String getSettlementAmount() { + return settlementAmount; + } + + public void setSettlementAmount(String settlementAmount) { + this.settlementAmount = settlementAmount; + } + + public TssV2TransactionsGet200ResponseOrderInformationAmountDetails settlementCurrency(String settlementCurrency) { + this.settlementCurrency = settlementCurrency; + return this; + } + + /** + * This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. + * @return settlementCurrency + **/ + @ApiModelProperty(value = "This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. ") + public String getSettlementCurrency() { + return settlementCurrency; + } + + public void setSettlementCurrency(String settlementCurrency) { + this.settlementCurrency = settlementCurrency; + } + @Override public boolean equals(java.lang.Object o) { @@ -125,12 +167,14 @@ public boolean equals(java.lang.Object o) { return Objects.equals(this.totalAmount, tssV2TransactionsGet200ResponseOrderInformationAmountDetails.totalAmount) && Objects.equals(this.currency, tssV2TransactionsGet200ResponseOrderInformationAmountDetails.currency) && Objects.equals(this.taxAmount, tssV2TransactionsGet200ResponseOrderInformationAmountDetails.taxAmount) && - Objects.equals(this.authorizedAmount, tssV2TransactionsGet200ResponseOrderInformationAmountDetails.authorizedAmount); + Objects.equals(this.authorizedAmount, tssV2TransactionsGet200ResponseOrderInformationAmountDetails.authorizedAmount) && + Objects.equals(this.settlementAmount, tssV2TransactionsGet200ResponseOrderInformationAmountDetails.settlementAmount) && + Objects.equals(this.settlementCurrency, tssV2TransactionsGet200ResponseOrderInformationAmountDetails.settlementCurrency); } @Override public int hashCode() { - return Objects.hash(totalAmount, currency, taxAmount, authorizedAmount); + return Objects.hash(totalAmount, currency, taxAmount, authorizedAmount, settlementAmount, settlementCurrency); } @@ -143,6 +187,8 @@ public String toString() { sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); sb.append(" taxAmount: ").append(toIndentedString(taxAmount)).append("\n"); sb.append(" authorizedAmount: ").append(toIndentedString(authorizedAmount)).append("\n"); + sb.append(" settlementAmount: ").append(toIndentedString(settlementAmount)).append("\n"); + sb.append(" settlementCurrency: ").append(toIndentedString(settlementCurrency)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.java b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.java index c6d134a07..618642c2e 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,6 +14,7 @@ package Model; import java.util.Objects; +import Model.Ptsv2paymentsOrderInformationBillToCompany; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -26,7 +27,7 @@ /** * TssV2TransactionsGet200ResponseOrderInformationBillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseOrderInformationBillTo { @SerializedName("firstName") private String firstName = null; @@ -56,7 +57,7 @@ public class TssV2TransactionsGet200ResponseOrderInformationBillTo { private String postalCode = null; @SerializedName("company") - private String company = null; + private Ptsv2paymentsOrderInformationBillToCompany company = null; @SerializedName("email") private String email = null; @@ -76,10 +77,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo firstName(String fi } /** - * Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return firstName **/ - @ApiModelProperty(value = "Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getFirstName() { return firstName; } @@ -94,10 +95,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo lastName(String las } /** - * Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return lastName **/ - @ApiModelProperty(value = "Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getLastName() { return lastName; } @@ -148,10 +149,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo address1(String add } /** - * First line of the billing street address as it appears on the credit card issuer’s records. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * First line of the billing street address as it appears on the credit card issuer’s records. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return address1 **/ - @ApiModelProperty(value = "First line of the billing street address as it appears on the credit card issuer’s records. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "First line of the billing street address as it appears on the credit card issuer’s records. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_address1 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getAddress1() { return address1; } @@ -166,10 +167,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo address2(String add } /** - * Additional address information. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Additional address information. For Payouts: This field may be sent only for FDC Compass. **Atos** This field must not contain colons (:). **Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions** This value is used for AVS. **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return address2 **/ - @ApiModelProperty(value = "Additional address information. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Additional address information. For Payouts: This field may be sent only for FDC Compass. **Atos** This field must not contain colons (:). **Chase Paymentech Solutions, FDC Compass, and TSYS Acquiring Solutions** This value is used for AVS. **CyberSource through VisaNet** **Important** When you populate billing street address 1 and billing street address 2, CyberSource through VisaNet concatenates the two values. If the concatenated value exceeds 40 characters, CyberSource through VisaNet truncates the value at 40 characters before sending it to Visa and the issuing bank. Truncating this value affects AVS results and therefore might also affect risk decisions and chargebacks. Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_address2 field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getAddress2() { return address2; } @@ -184,10 +185,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo locality(String loc } /** - * City of the billing address. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * City of the billing address. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return locality **/ - @ApiModelProperty(value = "City of the billing address. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "City of the billing address. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**: This field may be sent only for FDC Compass. For processor-specific information, see the bill_city field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getLocality() { return locality; } @@ -202,10 +203,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo administrativeArea( } /** - * State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return administrativeArea **/ - @ApiModelProperty(value = "State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getAdministrativeArea() { return administrativeArea; } @@ -220,10 +221,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo postalCode(String p } /** - * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For Payouts: This field may be sent only for FDC Compass. **American Express Direct** Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return postalCode **/ - @ApiModelProperty(value = "Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Postal code for the billing address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. For Payouts: This field may be sent only for FDC Compass. **American Express Direct** Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. **Atos** This field must not contain colons (:). **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. For processor-specific information, see the bill_zip field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getPostalCode() { return postalCode; } @@ -232,21 +233,21 @@ public void setPostalCode(String postalCode) { this.postalCode = postalCode; } - public TssV2TransactionsGet200ResponseOrderInformationBillTo company(String company) { + public TssV2TransactionsGet200ResponseOrderInformationBillTo company(Ptsv2paymentsOrderInformationBillToCompany company) { this.company = company; return this; } /** - * Name of the customer’s company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Get company * @return company **/ - @ApiModelProperty(value = "Name of the customer’s company. For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") - public String getCompany() { + @ApiModelProperty(value = "") + public Ptsv2paymentsOrderInformationBillToCompany getCompany() { return company; } - public void setCompany(String company) { + public void setCompany(Ptsv2paymentsOrderInformationBillToCompany company) { this.company = company; } @@ -256,10 +257,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo email(String email) } /** - * Customer's email address, including the full domain name. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return email **/ - @ApiModelProperty(value = "Customer's email address, including the full domain name. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getEmail() { return email; } @@ -274,10 +275,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo country(String coun } /** - * Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return country **/ - @ApiModelProperty(value = "Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getCountry() { return country; } @@ -310,10 +311,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo phoneNumber(String } /** - * Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. * @return phoneNumber **/ - @ApiModelProperty(value = "Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ") public String getPhoneNumber() { return phoneNumber; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationLineItems.java b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationLineItems.java index 332011343..1a07184db 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationLineItems.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationLineItems.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * TssV2TransactionsGet200ResponseOrderInformationLineItems */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseOrderInformationLineItems { @SerializedName("productCode") private String productCode = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShipTo.java b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShipTo.java index 69bbf6ee0..8bd6bf617 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShipTo.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShipTo.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseOrderInformationShipTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseOrderInformationShipTo { @SerializedName("firstName") private String firstName = null; @@ -82,10 +82,10 @@ public TssV2TransactionsGet200ResponseOrderInformationShipTo lastName(String las } /** - * Last name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 + * Last name of the recipient. **Processor-specific maximum length** - Litle: 25 - All other processors: 60 * @return lastName **/ - @ApiModelProperty(value = "Last name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 ") + @ApiModelProperty(value = "Last name of the recipient. **Processor-specific maximum length** - Litle: 25 - All other processors: 60 ") public String getLastName() { return lastName; } @@ -154,10 +154,10 @@ public TssV2TransactionsGet200ResponseOrderInformationShipTo administrativeArea( } /** - * State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. + * State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return administrativeArea **/ - @ApiModelProperty(value = "State or province of the shipping address. Use the State, Province, and Territory Codes for the United States and Canada. ") + @ApiModelProperty(value = "State or province of the billing address. Use the State, Province, and Territory Codes for the United States and Canada. For Payouts: This field may be sent only for FDC Compass. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_state field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getAdministrativeArea() { return administrativeArea; } @@ -172,10 +172,10 @@ public TssV2TransactionsGet200ResponseOrderInformationShipTo postalCode(String p } /** - * Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 + * Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 **American Express Direct**\\ Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. * @return postalCode **/ - @ApiModelProperty(value = "Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 ") + @ApiModelProperty(value = "Postal code for the shipping address. The postal code must consist of 5 to 9 digits. When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits] Example 12345-6789 When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric] Example A1B 2C3 **American Express Direct**\\ Before sending the postal code to the processor, CyberSource removes all nonalphanumeric characters and, if the remaining value is longer than nine characters, truncates the value starting from the right side. ") public String getPostalCode() { return postalCode; } @@ -208,10 +208,10 @@ public TssV2TransactionsGet200ResponseOrderInformationShipTo country(String coun } /** - * Country of the shipping address. Use the two character ISO Standard Country Codes. + * Country of the shipping address. Use the two-character ISO Standard Country Codes. * @return country **/ - @ApiModelProperty(value = "Country of the shipping address. Use the two character ISO Standard Country Codes.") + @ApiModelProperty(value = "Country of the shipping address. Use the two-character ISO Standard Country Codes.") public String getCountry() { return country; } @@ -226,10 +226,10 @@ public TssV2TransactionsGet200ResponseOrderInformationShipTo phoneNumber(String } /** - * Phone number for the shipping address. + * Phone number associated with the shipping address. * @return phoneNumber **/ - @ApiModelProperty(value = "Phone number for the shipping address.") + @ApiModelProperty(value = "Phone number associated with the shipping address.") public String getPhoneNumber() { return phoneNumber; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.java b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.java index 61c45f4a5..2173ce6ba 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,29 +26,29 @@ /** * TssV2TransactionsGet200ResponseOrderInformationShippingDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseOrderInformationShippingDetails { @SerializedName("giftWrap") - private Boolean giftWrap = null; + private String giftWrap = null; @SerializedName("shippingMethod") private String shippingMethod = null; - public TssV2TransactionsGet200ResponseOrderInformationShippingDetails giftWrap(Boolean giftWrap) { + public TssV2TransactionsGet200ResponseOrderInformationShippingDetails giftWrap(String giftWrap) { this.giftWrap = giftWrap; return this; } /** - * The description for this field is not available. + * Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - `yes`: The customer requested gift wrapping. - `no`: The customer did not request gift wrapping. * @return giftWrap **/ - @ApiModelProperty(value = "The description for this field is not available.") - public Boolean getGiftWrap() { + @ApiModelProperty(value = "Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - `yes`: The customer requested gift wrapping. - `no`: The customer did not request gift wrapping. ") + public String getGiftWrap() { return giftWrap; } - public void setGiftWrap(Boolean giftWrap) { + public void setGiftWrap(String giftWrap) { this.giftWrap = giftWrap; } @@ -58,10 +58,10 @@ public TssV2TransactionsGet200ResponseOrderInformationShippingDetails shippingMe } /** - * Shipping method for the product. Possible values: - lowcost: Lowest-cost service - sameday: Courier or same-day service - oneday: Next-day or overnight service - twoday: Two-day service - threeday: Three-day service - pickup: Store pick-up - other: Other shipping method - none: No shipping method because product is a service or subscription + * Shipping method for the product. Possible values: - `lowcost`: Lowest-cost service - `sameday`: Courier or same-day service - `oneday`: Next-day or overnight service - `twoday`: Two-day service - `threeday`: Three-day service - `pickup`: Store pick-up - `other`: Other shipping method - `none`: No shipping method because product is a service or subscription * @return shippingMethod **/ - @ApiModelProperty(value = "Shipping method for the product. Possible values: - lowcost: Lowest-cost service - sameday: Courier or same-day service - oneday: Next-day or overnight service - twoday: Two-day service - threeday: Three-day service - pickup: Store pick-up - other: Other shipping method - none: No shipping method because product is a service or subscription ") + @ApiModelProperty(value = "Shipping method for the product. Possible values: - `lowcost`: Lowest-cost service - `sameday`: Courier or same-day service - `oneday`: Next-day or overnight service - `twoday`: Two-day service - `threeday`: Three-day service - `pickup`: Store pick-up - `other`: Other shipping method - `none`: No shipping method because product is a service or subscription ") public String getShippingMethod() { return shippingMethod; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformation.java index 45e154045..60ffd6dc9 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,10 +14,10 @@ package Model; import java.util.Objects; +import Model.Ptsv2paymentsPaymentInformationCustomer; import Model.TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures; import Model.TssV2TransactionsGet200ResponsePaymentInformationBank; import Model.TssV2TransactionsGet200ResponsePaymentInformationCard; -import Model.TssV2TransactionsGet200ResponsePaymentInformationCustomer; import Model.TssV2TransactionsGet200ResponsePaymentInformationInvoice; import Model.TssV2TransactionsGet200ResponsePaymentInformationPaymentType; import com.google.gson.TypeAdapter; @@ -32,13 +32,13 @@ /** * TssV2TransactionsGet200ResponsePaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponsePaymentInformation { @SerializedName("paymentType") private TssV2TransactionsGet200ResponsePaymentInformationPaymentType paymentType = null; @SerializedName("customer") - private TssV2TransactionsGet200ResponsePaymentInformationCustomer customer = null; + private Ptsv2paymentsPaymentInformationCustomer customer = null; @SerializedName("card") private TssV2TransactionsGet200ResponsePaymentInformationCard card = null; @@ -70,7 +70,7 @@ public void setPaymentType(TssV2TransactionsGet200ResponsePaymentInformationPaym this.paymentType = paymentType; } - public TssV2TransactionsGet200ResponsePaymentInformation customer(TssV2TransactionsGet200ResponsePaymentInformationCustomer customer) { + public TssV2TransactionsGet200ResponsePaymentInformation customer(Ptsv2paymentsPaymentInformationCustomer customer) { this.customer = customer; return this; } @@ -80,11 +80,11 @@ public TssV2TransactionsGet200ResponsePaymentInformation customer(TssV2Transacti * @return customer **/ @ApiModelProperty(value = "") - public TssV2TransactionsGet200ResponsePaymentInformationCustomer getCustomer() { + public Ptsv2paymentsPaymentInformationCustomer getCustomer() { return customer; } - public void setCustomer(TssV2TransactionsGet200ResponsePaymentInformationCustomer customer) { + public void setCustomer(Ptsv2paymentsPaymentInformationCustomer customer) { this.customer = customer; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.java index 82621c443..4a73406bc 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures { @SerializedName("balanceAmount") private String balanceAmount = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.java index 92dc4a453..c655505e2 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationBank */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponsePaymentInformationBank { @SerializedName("routingNumber") private String routingNumber = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.java index b6c167c24..54bee2588 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationBankAccount */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponsePaymentInformationBankAccount { @SerializedName("suffix") private String suffix = null; @@ -91,10 +91,10 @@ public TssV2TransactionsGet200ResponsePaymentInformationBankAccount checkNumber( } /** - * The description for this field is not available. + * Check number. Chase Paymentech Solutions - Optional. CyberSource ACH Service - Not used. RBS WorldPay Atlanta - Optional on debits. Required on credits. TeleCheck - Strongly recommended on debit requests. Optional on credits. * @return checkNumber **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "Check number. Chase Paymentech Solutions - Optional. CyberSource ACH Service - Not used. RBS WorldPay Atlanta - Optional on debits. Required on credits. TeleCheck - Strongly recommended on debit requests. Optional on credits. ") public String getCheckNumber() { return checkNumber; } @@ -109,10 +109,10 @@ public TssV2TransactionsGet200ResponsePaymentInformationBankAccount type(String } /** - * The description for this field is not available. + * Account type. Possible values: - **C**: Checking. - **G**: General ledger. This value is supported only on Wells Fargo ACH. - **S**: Savings (U.S. dollars only). - **X**: Corporate checking (U.S. dollars only). * @return type **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "Account type. Possible values: - **C**: Checking. - **G**: General ledger. This value is supported only on Wells Fargo ACH. - **S**: Savings (U.S. dollars only). - **X**: Corporate checking (U.S. dollars only). ") public String getType() { return type; } @@ -163,10 +163,10 @@ public TssV2TransactionsGet200ResponsePaymentInformationBankAccount encoderId(St } /** - * The description for this field is not available. + * Identifier for the bank that provided the customer’s encoded account number. To obtain the bank identifier, contact your processor. See \"Encoded Account Numbers,\" page 39. * @return encoderId **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "Identifier for the bank that provided the customer’s encoded account number. To obtain the bank identifier, contact your processor. See \"Encoded Account Numbers,\" page 39. ") public String getEncoderId() { return encoderId; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.java index 603a77a2a..7b945bbf5 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationBankMandate */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponsePaymentInformationBankMandate { @SerializedName("referenceNumber") private String referenceNumber = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationCard.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationCard.java index f74c2623d..b8e1b7664 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationCard.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationCard.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponsePaymentInformationCard { @SerializedName("suffix") private String suffix = null; @@ -100,10 +100,10 @@ public TssV2TransactionsGet200ResponsePaymentInformationCard expirationMonth(Str } /** - * Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return expirationMonth **/ - @ApiModelProperty(value = "Two-digit month in which the credit card expires. `Format: MM`. Possible values: 01 through 12. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 12. For processor-specific information, see the customer_cc_expmo field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Two-digit month in which the payment card expires. Format: `MM`. Valid values: `01` through `12`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`01` through `12`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `12`. For processor-specific information, see the `customer_cc_expmo` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getExpirationMonth() { return expirationMonth; } @@ -118,10 +118,10 @@ public TssV2TransactionsGet200ResponsePaymentInformationCard expirationYear(Stri } /** - * Four-digit year in which the credit card expires. `Format: YYYY`. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return expirationYear **/ - @ApiModelProperty(value = "Four-digit year in which the credit card expires. `Format: YYYY`. **Encoded Account Numbers** For encoded account numbers (_type_=039), if there is no expiration date on the card, use 2021. For processor-specific information, see the customer_cc_expyr field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Four-digit year in which the credit card expires. Format: `YYYY`. **Barclays and Streamline**\\ For Maestro (UK Domestic) and Maestro (International) cards on Barclays and Streamline, this must be a valid value (`1900` through `3000`) but is not required to be a valid expiration date. In other words, an expiration date that is in the past does not cause CyberSource to reject your request. However, an invalid expiration date might cause the issuer to reject your request. **FDC Nashville Global and FDMS South**\\ You can send in 2 digits or 4 digits. If you send in 2 digits, they must be the last 2 digits of the year. **Encoded Account Numbers**\\ For encoded account numbers (_type_=039), if there is no expiration date on the card, use `2021`. For processor-specific information, see the `customer_cc_expyr` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getExpirationYear() { return expirationYear; } @@ -136,10 +136,10 @@ public TssV2TransactionsGet200ResponsePaymentInformationCard startMonth(String s } /** - * Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. The start date is not required for Maestro (UK Domestic) transactions. + * Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. **Note** The start date is not required for Maestro (UK Domestic) transactions. * @return startMonth **/ - @ApiModelProperty(value = "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. The start date is not required for Maestro (UK Domestic) transactions. ") + @ApiModelProperty(value = "Month of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: MM`. Possible values: 01 through 12. **Note** The start date is not required for Maestro (UK Domestic) transactions. ") public String getStartMonth() { return startMonth; } @@ -154,10 +154,10 @@ public TssV2TransactionsGet200ResponsePaymentInformationCard startYear(String st } /** - * Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. The start date is not required for Maestro (UK Domestic) transactions. + * Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. **Note** The start date is not required for Maestro (UK Domestic) transactions. * @return startYear **/ - @ApiModelProperty(value = "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. The start date is not required for Maestro (UK Domestic) transactions. ") + @ApiModelProperty(value = "Year of the start of the Maestro (UK Domestic) card validity period. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. `Format: YYYY`. **Note** The start date is not required for Maestro (UK Domestic) transactions. ") public String getStartYear() { return startYear; } @@ -172,10 +172,10 @@ public TssV2TransactionsGet200ResponsePaymentInformationCard issueNumber(String } /** - * Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. The issue number is not required for Maestro (UK Domestic) transactions. + * Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions. * @return issueNumber **/ - @ApiModelProperty(value = "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. The issue number is not required for Maestro (UK Domestic) transactions. ") + @ApiModelProperty(value = "Number of times a Maestro (UK Domestic) card has been issued to the account holder. The card might or might not have an issue number. The number can consist of one or two digits, and the first digit might be a zero. When you include this value in your request, include exactly what is printed on the card. A value of 2 is different than a value of 02. Do not include the field, even with a blank value, if the card is not a Maestro (UK Domestic) card. **Note** The issue number is not required for Maestro (UK Domestic) transactions. ") public String getIssueNumber() { return issueNumber; } @@ -190,10 +190,10 @@ public TssV2TransactionsGet200ResponsePaymentInformationCard type(String type) { } /** - * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover + * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) * @return type **/ - @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover ") + @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) ") public String getType() { return type; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.java deleted file mode 100644 index f6896d32f..000000000 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationCustomer.java +++ /dev/null @@ -1,93 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * TssV2TransactionsGet200ResponsePaymentInformationCustomer - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TssV2TransactionsGet200ResponsePaymentInformationCustomer { - @SerializedName("customerId") - private String customerId = null; - - public TssV2TransactionsGet200ResponsePaymentInformationCustomer customerId(String customerId) { - this.customerId = customerId; - return this; - } - - /** - * Unique identifier for the customer's card and billing information. - * @return customerId - **/ - @ApiModelProperty(value = "Unique identifier for the customer's card and billing information.") - public String getCustomerId() { - return customerId; - } - - public void setCustomerId(String customerId) { - this.customerId = customerId; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TssV2TransactionsGet200ResponsePaymentInformationCustomer tssV2TransactionsGet200ResponsePaymentInformationCustomer = (TssV2TransactionsGet200ResponsePaymentInformationCustomer) o; - return Objects.equals(this.customerId, tssV2TransactionsGet200ResponsePaymentInformationCustomer.customerId); - } - - @Override - public int hashCode() { - return Objects.hash(customerId); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsGet200ResponsePaymentInformationCustomer {\n"); - - sb.append(" customerId: ").append(toIndentedString(customerId)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationInvoice.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationInvoice.java index 8595d2e33..293e4117d 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationInvoice.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationInvoice.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationInvoice */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponsePaymentInformationInvoice { @SerializedName("number") private String number = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.java index 66caa0301..590991f45 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationPaymentType */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponsePaymentInformationPaymentType { @SerializedName("name") private String name = null; @@ -34,9 +34,6 @@ public class TssV2TransactionsGet200ResponsePaymentInformationPaymentType { @SerializedName("type") private String type = null; - @SerializedName("subType") - private String subType = null; - @SerializedName("method") private String method = null; @@ -55,10 +52,10 @@ public TssV2TransactionsGet200ResponsePaymentInformationPaymentType name(String } /** - * The description for this field is not available. + * The name of a payment method. This is required for non-credit card payment. Examples: `SEARS`, `JCREW`, `PAYPAL`, `IDEAL`, `EPS` ...etc. Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. * @return name **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "The name of a payment method. This is required for non-credit card payment. Examples: `SEARS`, `JCREW`, `PAYPAL`, `IDEAL`, `EPS` ...etc. Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. ") public String getName() { return name; } @@ -73,10 +70,10 @@ public TssV2TransactionsGet200ResponsePaymentInformationPaymentType type(String } /** - * The description for this field is not available. + * The type of payment method. This is required for non-credit card payment. Possible values: - BANK_TRANSFER - CARD (Default) - EWALLET - DIGITAL - DIRECT_DEBIT - INVOICE - PUSH_PAYMENT - CARRIER_BILLING - CASH - CHECK - CRYPTOGRAPHIC Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. * @return type **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "The type of payment method. This is required for non-credit card payment. Possible values: - BANK_TRANSFER - CARD (Default) - EWALLET - DIGITAL - DIRECT_DEBIT - INVOICE - PUSH_PAYMENT - CARRIER_BILLING - CASH - CHECK - CRYPTOGRAPHIC Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. ") public String getType() { return type; } @@ -85,34 +82,16 @@ public void setType(String type) { this.type = type; } - public TssV2TransactionsGet200ResponsePaymentInformationPaymentType subType(String subType) { - this.subType = subType; - return this; - } - - /** - * The description for this field is not available. - * @return subType - **/ - @ApiModelProperty(value = "The description for this field is not available.") - public String getSubType() { - return subType; - } - - public void setSubType(String subType) { - this.subType = subType; - } - public TssV2TransactionsGet200ResponsePaymentInformationPaymentType method(String method) { this.method = method; return this; } /** - * The description for this field is not available. + * This is an optional field. Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. * @return method **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "This is an optional field. Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. ") public String getMethod() { return method; } @@ -187,7 +166,6 @@ public boolean equals(java.lang.Object o) { TssV2TransactionsGet200ResponsePaymentInformationPaymentType tssV2TransactionsGet200ResponsePaymentInformationPaymentType = (TssV2TransactionsGet200ResponsePaymentInformationPaymentType) o; return Objects.equals(this.name, tssV2TransactionsGet200ResponsePaymentInformationPaymentType.name) && Objects.equals(this.type, tssV2TransactionsGet200ResponsePaymentInformationPaymentType.type) && - Objects.equals(this.subType, tssV2TransactionsGet200ResponsePaymentInformationPaymentType.subType) && Objects.equals(this.method, tssV2TransactionsGet200ResponsePaymentInformationPaymentType.method) && Objects.equals(this.fundingSource, tssV2TransactionsGet200ResponsePaymentInformationPaymentType.fundingSource) && Objects.equals(this.fundingSourceAffiliation, tssV2TransactionsGet200ResponsePaymentInformationPaymentType.fundingSourceAffiliation) && @@ -196,7 +174,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(name, type, subType, method, fundingSource, fundingSourceAffiliation, credential); + return Objects.hash(name, type, method, fundingSource, fundingSourceAffiliation, credential); } @@ -207,7 +185,6 @@ public String toString() { sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); - sb.append(" subType: ").append(toIndentedString(subType)).append("\n"); sb.append(" method: ").append(toIndentedString(method)).append("\n"); sb.append(" fundingSource: ").append(toIndentedString(fundingSource)).append("\n"); sb.append(" fundingSourceAffiliation: ").append(toIndentedString(fundingSourceAffiliation)).append("\n"); diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePointOfSaleInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePointOfSaleInformation.java index e09a42170..97b22a688 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePointOfSaleInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePointOfSaleInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponsePointOfSaleInformation { @SerializedName("entryMode") private String entryMode = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformation.java index 9de5548e0..2d2501631 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ /** * TssV2TransactionsGet200ResponseProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseProcessingInformation { @SerializedName("paymentSolution") private String paymentSolution = null; @@ -51,10 +51,10 @@ public TssV2TransactionsGet200ResponseProcessingInformation paymentSolution(Stri } /** - * Type of digital payment solution that is being used for the transaction. Possible Values: - **visacheckout**: Visa Checkout. - **001**: Apple Pay. - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct. - **006**: Android Pay. - **008**: Samsung Pay. + * Type of digital payment solution for the transaction. Possible Values: - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API. - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153. * @return paymentSolution **/ - @ApiModelProperty(value = "Type of digital payment solution that is being used for the transaction. Possible Values: - **visacheckout**: Visa Checkout. - **001**: Apple Pay. - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct. - **006**: Android Pay. - **008**: Samsung Pay. ") + @ApiModelProperty(value = "Type of digital payment solution for the transaction. Possible Values: - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API. - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153. ") public String getPaymentSolution() { return paymentSolution; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.java b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.java index 327807990..87fbf4d6e 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions { @SerializedName("authType") private String authType = null; @@ -37,10 +37,10 @@ public TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions } /** - * Authorization type. Possible values: - **AUTOCAPTURE**: automatic capture. - **STANDARDCAPTURE**: standard capture. - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. For processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Authorization type. Possible values: - **AUTOCAPTURE**: automatic capture. - **STANDARDCAPTURE**: standard capture. - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. **Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing**\\ Set this field to _AUTOCAPTURE_ and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to STANDARDCAPTURE and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see \"Automatic Captures,\" page 33. **Forced Capture**\\ Set this field to _VERBAL_ and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. For more information, see \"Forced Captures,\" page 123. **Verbal Authorization**\\ Set this field to _VERBAL_ and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations,\" page 84. For processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return authType **/ - @ApiModelProperty(value = "Authorization type. Possible values: - **AUTOCAPTURE**: automatic capture. - **STANDARDCAPTURE**: standard capture. - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. For processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Authorization type. Possible values: - **AUTOCAPTURE**: automatic capture. - **STANDARDCAPTURE**: standard capture. - **VERBAL**: forced capture. Include it in the payment request for a forced capture. Include it in the capture request for a verbal payment. **Asia, Middle East, and Africa Gateway; Cielo; Comercio Latino; and CyberSource Latin American Processing**\\ Set this field to _AUTOCAPTURE_ and include it in a bundled request to indicate that you are requesting an automatic capture. If your account is configured to enable automatic captures, set this field to STANDARDCAPTURE and include it in a standard authorization or bundled request to indicate that you are overriding an automatic capture. For more information, see \"Automatic Captures,\" page 33. **Forced Capture**\\ Set this field to _VERBAL_ and include it in the authorization request to indicate that you are performing a forced capture; therefore, you receive the authorization code outside the CyberSource system. For more information, see \"Forced Captures,\" page 123. **Verbal Authorization**\\ Set this field to _VERBAL_ and include it in the capture request to indicate that the request is for a verbal authorization. For more information, see \"Verbal Authorizations,\" page 84. For processor-specific information, see the auth_type field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getAuthType() { return authType; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.java b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.java index 689920a53..8aa32282e 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions { @SerializedName("secCode") private String secCode = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformation.java index 54c1e19cc..96f2c94c2 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,9 +14,9 @@ package Model; import java.util.Objects; +import Model.PtsV2PaymentsPost201ResponseProcessorInformationAchVerification; import Model.PtsV2PaymentsPost201ResponseProcessorInformationAvs; -import Model.TssV2TransactionsGet200ResponseProcessorInformationAchVerification; -import Model.TssV2TransactionsGet200ResponseProcessorInformationCardVerification; +import Model.Riskv1decisionsCardVerification; import Model.TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults; import Model.TssV2TransactionsGet200ResponseProcessorInformationProcessor; import com.google.gson.TypeAdapter; @@ -31,7 +31,7 @@ /** * TssV2TransactionsGet200ResponseProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseProcessorInformation { @SerializedName("processor") private TssV2TransactionsGet200ResponseProcessorInformationProcessor processor = null; @@ -58,14 +58,20 @@ public class TssV2TransactionsGet200ResponseProcessorInformation { private PtsV2PaymentsPost201ResponseProcessorInformationAvs avs = null; @SerializedName("cardVerification") - private TssV2TransactionsGet200ResponseProcessorInformationCardVerification cardVerification = null; + private Riskv1decisionsCardVerification cardVerification = null; @SerializedName("achVerification") - private TssV2TransactionsGet200ResponseProcessorInformationAchVerification achVerification = null; + private PtsV2PaymentsPost201ResponseProcessorInformationAchVerification achVerification = null; @SerializedName("electronicVerificationResults") private TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults electronicVerificationResults = null; + @SerializedName("systemTraceAuditNumber") + private String systemTraceAuditNumber = null; + + @SerializedName("responseCodeSource") + private String responseCodeSource = null; + public TssV2TransactionsGet200ResponseProcessorInformation processor(TssV2TransactionsGet200ResponseProcessorInformationProcessor processor) { this.processor = processor; return this; @@ -90,10 +96,10 @@ public TssV2TransactionsGet200ResponseProcessorInformation transactionId(String } /** - * Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. + * Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. * @return transactionId **/ - @ApiModelProperty(value = "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. ") + @ApiModelProperty(value = "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. ") public String getTransactionId() { return transactionId; } @@ -210,7 +216,7 @@ public void setAvs(PtsV2PaymentsPost201ResponseProcessorInformationAvs avs) { this.avs = avs; } - public TssV2TransactionsGet200ResponseProcessorInformation cardVerification(TssV2TransactionsGet200ResponseProcessorInformationCardVerification cardVerification) { + public TssV2TransactionsGet200ResponseProcessorInformation cardVerification(Riskv1decisionsCardVerification cardVerification) { this.cardVerification = cardVerification; return this; } @@ -220,15 +226,15 @@ public TssV2TransactionsGet200ResponseProcessorInformation cardVerification(TssV * @return cardVerification **/ @ApiModelProperty(value = "") - public TssV2TransactionsGet200ResponseProcessorInformationCardVerification getCardVerification() { + public Riskv1decisionsCardVerification getCardVerification() { return cardVerification; } - public void setCardVerification(TssV2TransactionsGet200ResponseProcessorInformationCardVerification cardVerification) { + public void setCardVerification(Riskv1decisionsCardVerification cardVerification) { this.cardVerification = cardVerification; } - public TssV2TransactionsGet200ResponseProcessorInformation achVerification(TssV2TransactionsGet200ResponseProcessorInformationAchVerification achVerification) { + public TssV2TransactionsGet200ResponseProcessorInformation achVerification(PtsV2PaymentsPost201ResponseProcessorInformationAchVerification achVerification) { this.achVerification = achVerification; return this; } @@ -238,11 +244,11 @@ public TssV2TransactionsGet200ResponseProcessorInformation achVerification(TssV2 * @return achVerification **/ @ApiModelProperty(value = "") - public TssV2TransactionsGet200ResponseProcessorInformationAchVerification getAchVerification() { + public PtsV2PaymentsPost201ResponseProcessorInformationAchVerification getAchVerification() { return achVerification; } - public void setAchVerification(TssV2TransactionsGet200ResponseProcessorInformationAchVerification achVerification) { + public void setAchVerification(PtsV2PaymentsPost201ResponseProcessorInformationAchVerification achVerification) { this.achVerification = achVerification; } @@ -264,6 +270,42 @@ public void setElectronicVerificationResults(TssV2TransactionsGet200ResponseProc this.electronicVerificationResults = electronicVerificationResults; } + public TssV2TransactionsGet200ResponseProcessorInformation systemTraceAuditNumber(String systemTraceAuditNumber) { + this.systemTraceAuditNumber = systemTraceAuditNumber; + return this; + } + + /** + * This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. **American Express Direct** System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. **CyberSource through VisaNet** System trace number that must be printed on the customer’s receipt. + * @return systemTraceAuditNumber + **/ + @ApiModelProperty(value = "This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. **American Express Direct** System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. **CyberSource through VisaNet** System trace number that must be printed on the customer’s receipt. ") + public String getSystemTraceAuditNumber() { + return systemTraceAuditNumber; + } + + public void setSystemTraceAuditNumber(String systemTraceAuditNumber) { + this.systemTraceAuditNumber = systemTraceAuditNumber; + } + + public TssV2TransactionsGet200ResponseProcessorInformation responseCodeSource(String responseCodeSource) { + this.responseCodeSource = responseCodeSource; + return this; + } + + /** + * Used by Visa only and contains the response source/reason code that identifies the source of the response decision. + * @return responseCodeSource + **/ + @ApiModelProperty(value = "Used by Visa only and contains the response source/reason code that identifies the source of the response decision. ") + public String getResponseCodeSource() { + return responseCodeSource; + } + + public void setResponseCodeSource(String responseCodeSource) { + this.responseCodeSource = responseCodeSource; + } + @Override public boolean equals(java.lang.Object o) { @@ -284,12 +326,14 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.avs, tssV2TransactionsGet200ResponseProcessorInformation.avs) && Objects.equals(this.cardVerification, tssV2TransactionsGet200ResponseProcessorInformation.cardVerification) && Objects.equals(this.achVerification, tssV2TransactionsGet200ResponseProcessorInformation.achVerification) && - Objects.equals(this.electronicVerificationResults, tssV2TransactionsGet200ResponseProcessorInformation.electronicVerificationResults); + Objects.equals(this.electronicVerificationResults, tssV2TransactionsGet200ResponseProcessorInformation.electronicVerificationResults) && + Objects.equals(this.systemTraceAuditNumber, tssV2TransactionsGet200ResponseProcessorInformation.systemTraceAuditNumber) && + Objects.equals(this.responseCodeSource, tssV2TransactionsGet200ResponseProcessorInformation.responseCodeSource); } @Override public int hashCode() { - return Objects.hash(processor, transactionId, networkTransactionId, responseId, providerTransactionId, approvalCode, responseCode, avs, cardVerification, achVerification, electronicVerificationResults); + return Objects.hash(processor, transactionId, networkTransactionId, responseId, providerTransactionId, approvalCode, responseCode, avs, cardVerification, achVerification, electronicVerificationResults, systemTraceAuditNumber, responseCodeSource); } @@ -309,6 +353,8 @@ public String toString() { sb.append(" cardVerification: ").append(toIndentedString(cardVerification)).append("\n"); sb.append(" achVerification: ").append(toIndentedString(achVerification)).append("\n"); sb.append(" electronicVerificationResults: ").append(toIndentedString(electronicVerificationResults)).append("\n"); + sb.append(" systemTraceAuditNumber: ").append(toIndentedString(systemTraceAuditNumber)).append("\n"); + sb.append(" responseCodeSource: ").append(toIndentedString(responseCodeSource)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationAchVerification.java b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationAchVerification.java deleted file mode 100644 index 0336b5549..000000000 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationAchVerification.java +++ /dev/null @@ -1,116 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * TssV2TransactionsGet200ResponseProcessorInformationAchVerification - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TssV2TransactionsGet200ResponseProcessorInformationAchVerification { - @SerializedName("resultCode") - private String resultCode = null; - - @SerializedName("resultCodeRaw") - private String resultCodeRaw = null; - - public TssV2TransactionsGet200ResponseProcessorInformationAchVerification resultCode(String resultCode) { - this.resultCode = resultCode; - return this; - } - - /** - * The description for this field is not available.. - * @return resultCode - **/ - @ApiModelProperty(value = "The description for this field is not available.. ") - public String getResultCode() { - return resultCode; - } - - public void setResultCode(String resultCode) { - this.resultCode = resultCode; - } - - public TssV2TransactionsGet200ResponseProcessorInformationAchVerification resultCodeRaw(String resultCodeRaw) { - this.resultCodeRaw = resultCodeRaw; - return this; - } - - /** - * The description for this field is not available. - * @return resultCodeRaw - **/ - @ApiModelProperty(value = "The description for this field is not available. ") - public String getResultCodeRaw() { - return resultCodeRaw; - } - - public void setResultCodeRaw(String resultCodeRaw) { - this.resultCodeRaw = resultCodeRaw; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TssV2TransactionsGet200ResponseProcessorInformationAchVerification tssV2TransactionsGet200ResponseProcessorInformationAchVerification = (TssV2TransactionsGet200ResponseProcessorInformationAchVerification) o; - return Objects.equals(this.resultCode, tssV2TransactionsGet200ResponseProcessorInformationAchVerification.resultCode) && - Objects.equals(this.resultCodeRaw, tssV2TransactionsGet200ResponseProcessorInformationAchVerification.resultCodeRaw); - } - - @Override - public int hashCode() { - return Objects.hash(resultCode, resultCodeRaw); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsGet200ResponseProcessorInformationAchVerification {\n"); - - sb.append(" resultCode: ").append(toIndentedString(resultCode)).append("\n"); - sb.append(" resultCodeRaw: ").append(toIndentedString(resultCodeRaw)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationCardVerification.java b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationCardVerification.java deleted file mode 100644 index 0e6691566..000000000 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationCardVerification.java +++ /dev/null @@ -1,93 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * TssV2TransactionsGet200ResponseProcessorInformationCardVerification - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TssV2TransactionsGet200ResponseProcessorInformationCardVerification { - @SerializedName("resultCode") - private String resultCode = null; - - public TssV2TransactionsGet200ResponseProcessorInformationCardVerification resultCode(String resultCode) { - this.resultCode = resultCode; - return this; - } - - /** - * CVN result code. - * @return resultCode - **/ - @ApiModelProperty(value = "CVN result code. ") - public String getResultCode() { - return resultCode; - } - - public void setResultCode(String resultCode) { - this.resultCode = resultCode; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TssV2TransactionsGet200ResponseProcessorInformationCardVerification tssV2TransactionsGet200ResponseProcessorInformationCardVerification = (TssV2TransactionsGet200ResponseProcessorInformationCardVerification) o; - return Objects.equals(this.resultCode, tssV2TransactionsGet200ResponseProcessorInformationCardVerification.resultCode); - } - - @Override - public int hashCode() { - return Objects.hash(resultCode); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsGet200ResponseProcessorInformationCardVerification {\n"); - - sb.append(" resultCode: ").append(toIndentedString(resultCode)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.java b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.java index b93afe662..ea8987e50 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults { @SerializedName("email") private String email = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationProcessor.java b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationProcessor.java index 702d2fcfc..233fcc91d 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationProcessor.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationProcessor.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseProcessorInformationProcessor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseProcessorInformationProcessor { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformation.java index e9446d59c..1dc51a694 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -15,6 +15,7 @@ import java.util.Objects; import Model.TssV2TransactionsGet200ResponseRiskInformationProfile; +import Model.TssV2TransactionsGet200ResponseRiskInformationRules; import Model.TssV2TransactionsGet200ResponseRiskInformationScore; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; @@ -30,19 +31,19 @@ /** * TssV2TransactionsGet200ResponseRiskInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseRiskInformation { @SerializedName("profile") private TssV2TransactionsGet200ResponseRiskInformationProfile profile = null; @SerializedName("rules") - private List rules = null; + private List rules = null; @SerializedName("passiveProfile") private TssV2TransactionsGet200ResponseRiskInformationProfile passiveProfile = null; @SerializedName("passiveRules") - private List passiveRules = null; + private List passiveRules = null; @SerializedName("score") private TssV2TransactionsGet200ResponseRiskInformationScore score = null; @@ -68,14 +69,14 @@ public void setProfile(TssV2TransactionsGet200ResponseRiskInformationProfile pro this.profile = profile; } - public TssV2TransactionsGet200ResponseRiskInformation rules(List rules) { + public TssV2TransactionsGet200ResponseRiskInformation rules(List rules) { this.rules = rules; return this; } - public TssV2TransactionsGet200ResponseRiskInformation addRulesItem(TssV2TransactionsGet200ResponseRiskInformationProfile rulesItem) { + public TssV2TransactionsGet200ResponseRiskInformation addRulesItem(TssV2TransactionsGet200ResponseRiskInformationRules rulesItem) { if (this.rules == null) { - this.rules = new ArrayList(); + this.rules = new ArrayList(); } this.rules.add(rulesItem); return this; @@ -86,11 +87,11 @@ public TssV2TransactionsGet200ResponseRiskInformation addRulesItem(TssV2Transact * @return rules **/ @ApiModelProperty(value = "") - public List getRules() { + public List getRules() { return rules; } - public void setRules(List rules) { + public void setRules(List rules) { this.rules = rules; } @@ -112,14 +113,14 @@ public void setPassiveProfile(TssV2TransactionsGet200ResponseRiskInformationProf this.passiveProfile = passiveProfile; } - public TssV2TransactionsGet200ResponseRiskInformation passiveRules(List passiveRules) { + public TssV2TransactionsGet200ResponseRiskInformation passiveRules(List passiveRules) { this.passiveRules = passiveRules; return this; } - public TssV2TransactionsGet200ResponseRiskInformation addPassiveRulesItem(TssV2TransactionsGet200ResponseRiskInformationProfile passiveRulesItem) { + public TssV2TransactionsGet200ResponseRiskInformation addPassiveRulesItem(TssV2TransactionsGet200ResponseRiskInformationRules passiveRulesItem) { if (this.passiveRules == null) { - this.passiveRules = new ArrayList(); + this.passiveRules = new ArrayList(); } this.passiveRules.add(passiveRulesItem); return this; @@ -130,11 +131,11 @@ public TssV2TransactionsGet200ResponseRiskInformation addPassiveRulesItem(TssV2T * @return passiveRules **/ @ApiModelProperty(value = "") - public List getPassiveRules() { + public List getPassiveRules() { return passiveRules; } - public void setPassiveRules(List passiveRules) { + public void setPassiveRules(List passiveRules) { this.passiveRules = passiveRules; } @@ -162,10 +163,10 @@ public TssV2TransactionsGet200ResponseRiskInformation localTime(String localTime } /** - * Time that the transaction was submitted in local time.. + * Time that the transaction was submitted in local time. * @return localTime **/ - @ApiModelProperty(value = "Time that the transaction was submitted in local time..") + @ApiModelProperty(value = "Time that the transaction was submitted in local time.") public String getLocalTime() { return localTime; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationProfile.java b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationProfile.java index 70138bcdf..d481e7ecf 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationProfile.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationProfile.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseRiskInformationProfile */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseRiskInformationProfile { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationRules.java b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationRules.java new file mode 100644 index 000000000..f545f0a7c --- /dev/null +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationRules.java @@ -0,0 +1,117 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * Names of one or more rules that were processed, and the decisions made by the rules. + */ +@ApiModel(description = "Names of one or more rules that were processed, and the decisions made by the rules.") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TssV2TransactionsGet200ResponseRiskInformationRules { + @SerializedName("name") + private String name = null; + + @SerializedName("decision") + private String decision = null; + + public TssV2TransactionsGet200ResponseRiskInformationRules name(String name) { + this.name = name; + return this; + } + + /** + * Description of the rule as it appears in the Profile Editor. + * @return name + **/ + @ApiModelProperty(value = "Description of the rule as it appears in the Profile Editor.") + public String getName() { + return name; + } + + public void setName(String name) { + this.name = name; + } + + public TssV2TransactionsGet200ResponseRiskInformationRules decision(String decision) { + this.decision = decision; + return this; + } + + /** + * Summarizes the result for the rule according to the setting that you chose in the Profile Editor. This field can contain one of the following values: - `IGNORE` - `REVIEW` - `REJECT` - `ACCEPT` + * @return decision + **/ + @ApiModelProperty(value = "Summarizes the result for the rule according to the setting that you chose in the Profile Editor. This field can contain one of the following values: - `IGNORE` - `REVIEW` - `REJECT` - `ACCEPT` ") + public String getDecision() { + return decision; + } + + public void setDecision(String decision) { + this.decision = decision; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TssV2TransactionsGet200ResponseRiskInformationRules tssV2TransactionsGet200ResponseRiskInformationRules = (TssV2TransactionsGet200ResponseRiskInformationRules) o; + return Objects.equals(this.name, tssV2TransactionsGet200ResponseRiskInformationRules.name) && + Objects.equals(this.decision, tssV2TransactionsGet200ResponseRiskInformationRules.decision); + } + + @Override + public int hashCode() { + return Objects.hash(name, decision); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TssV2TransactionsGet200ResponseRiskInformationRules {\n"); + + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" decision: ").append(toIndentedString(decision)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationScore.java b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationScore.java index 61aad7b74..d412d623a 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationScore.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationScore.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ /** * TssV2TransactionsGet200ResponseRiskInformationScore */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseRiskInformationScore { @SerializedName("factorCodes") private List factorCodes = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseSenderInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseSenderInformation.java index 1e48ae99e..db99489ea 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseSenderInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseSenderInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseSenderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsGet200ResponseSenderInformation { @SerializedName("referenceNumber") private String referenceNumber = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201Response.java b/src/main/java/Model/TssV2TransactionsPost201Response.java index 051d56b9b..bb8f74942 100644 --- a/src/main/java/Model/TssV2TransactionsPost201Response.java +++ b/src/main/java/Model/TssV2TransactionsPost201Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,10 +28,10 @@ /** * TssV2TransactionsPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201Response { - @SerializedName("id") - private String id = null; + @SerializedName("searchId") + private String searchId = null; @SerializedName("save") private Boolean save = null; @@ -69,22 +69,22 @@ public class TssV2TransactionsPost201Response { @SerializedName("_links") private PtsV2PaymentsReversalsPost201ResponseLinks links = null; - public TssV2TransactionsPost201Response id(String id) { - this.id = id; + public TssV2TransactionsPost201Response searchId(String searchId) { + this.searchId = searchId; return this; } /** - * An unique identification number assigned by CyberSource to identify the submitted request. - * @return id + * An unique identification number assigned by CyberSource to identify each Search request. + * @return searchId **/ - @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request.") - public String getId() { - return id; + @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify each Search request.") + public String getSearchId() { + return searchId; } - public void setId(String id) { - this.id = id; + public void setSearchId(String searchId) { + this.searchId = searchId; } public TssV2TransactionsPost201Response save(Boolean save) { @@ -255,10 +255,10 @@ public TssV2TransactionsPost201Response submitTimeUtc(String submitTimeUtc) { } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } @@ -313,7 +313,7 @@ public boolean equals(java.lang.Object o) { return false; } TssV2TransactionsPost201Response tssV2TransactionsPost201Response = (TssV2TransactionsPost201Response) o; - return Objects.equals(this.id, tssV2TransactionsPost201Response.id) && + return Objects.equals(this.searchId, tssV2TransactionsPost201Response.searchId) && Objects.equals(this.save, tssV2TransactionsPost201Response.save) && Objects.equals(this.name, tssV2TransactionsPost201Response.name) && Objects.equals(this.timezone, tssV2TransactionsPost201Response.timezone) && @@ -330,7 +330,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(id, save, name, timezone, query, offset, limit, sort, count, totalCount, submitTimeUtc, embedded, links); + return Objects.hash(searchId, save, name, timezone, query, offset, limit, sort, count, totalCount, submitTimeUtc, embedded, links); } @@ -339,7 +339,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TssV2TransactionsPost201Response {\n"); - sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" searchId: ").append(toIndentedString(searchId)).append("\n"); sb.append(" save: ").append(toIndentedString(save)).append("\n"); sb.append(" name: ").append(toIndentedString(name)).append("\n"); sb.append(" timezone: ").append(toIndentedString(timezone)).append("\n"); diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbedded.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbedded.java index 3bdaed573..0d1580b05 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbedded.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbedded.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * TssV2TransactionsPost201ResponseEmbedded */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbedded { @SerializedName("transactionSummaries") private List transactionSummaries = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.java index fb7d8b05b..ced60be7e 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedBuyerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedBuyerInformation { @SerializedName("merchantCustomerId") private String merchantCustomerId = null; @@ -37,10 +37,10 @@ public TssV2TransactionsPost201ResponseEmbeddedBuyerInformation merchantCustomer } /** - * Your identifier for the customer. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. **Comercio Latino**\\ For recurring payments in Mexico, the value is the customer’s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. **Litle**\\ For a follow-on credit with Litle, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return merchantCustomerId **/ - @ApiModelProperty(value = "Your identifier for the customer. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Your identifier for the customer. When a subscription or customer profile is being created, the maximum length for this field for most processors is 30. Otherwise, the maximum length is 100. **Comercio Latino**\\ For recurring payments in Mexico, the value is the customer’s contract number. Note Before you request the authorization, you must inform the issuer of the customer contract numbers that will be used for recurring transactions. **Litle**\\ For a follow-on credit with Litle, CyberSource checks the following locations, in the order given, for a customer account ID value and uses the first value it finds: 1. `customer_account_id` value in the follow-on credit request 2. Customer account ID value that was used for the capture that is being credited 3. Customer account ID value that was used for the original authorization If a customer account ID value cannot be found in any of these locations, then no value is used. For processor-specific information, see the customer_account_id field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getMerchantCustomerId() { return merchantCustomerId; } diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.java index 965d70d63..bd2dbfdfb 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation { @SerializedName("code") private String code = null; @@ -43,10 +43,10 @@ public TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation code(S } /** - * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. + * Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. * @return code **/ - @ApiModelProperty(value = "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. ") + @ApiModelProperty(value = "Client-generated order reference or tracking number. CyberSource recommends that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. For information about tracking orders, see [Getting Started with CyberSource Advanced for the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/Getting_Started_SCMP/html/wwhelp/wwhimpl/js/html/wwhelp.htm). **FDC Nashville Global**\\ Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports. ") public String getCode() { return code; } diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.java index 658db319b..fb9a71b6e 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation { @SerializedName("xid") private String xid = null; @@ -40,10 +40,10 @@ public TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation } /** - * Transaction identifier. + * Transaction identifier. For the description and requirements, see \"Payer Authentication,\" page 180. * @return xid **/ - @ApiModelProperty(value = "Transaction identifier.") + @ApiModelProperty(value = "Transaction identifier. For the description and requirements, see \"Payer Authentication,\" page 180.") public String getXid() { return xid; } diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.java index 285e1e4d7..ddcead094 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedDeviceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedDeviceInformation { @SerializedName("ipAddress") private String ipAddress = null; @@ -37,10 +37,10 @@ public TssV2TransactionsPost201ResponseEmbeddedDeviceInformation ipAddress(Strin } /** - * IP address of the customer. + * Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information. * @return ipAddress **/ - @ApiModelProperty(value = "IP address of the customer.") + @ApiModelProperty(value = "Customer’s IP address, such as 10.1.27.63, reported by your Web server via socket information. ") public String getIpAddress() { return ipAddress; } diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedLinks.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedLinks.java index 6cb0b730d..fb5231926 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedLinks.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedLinks.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedLinks { @SerializedName("transactionDetail") private PtsV2PaymentsPost201ResponseLinksSelf transactionDetail = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.java index 187d1e5c7..4eaea0e74 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedMerchantInformation { @SerializedName("resellerId") private String resellerId = null; @@ -37,10 +37,10 @@ public TssV2TransactionsPost201ResponseEmbeddedMerchantInformation resellerId(St } /** - * An unique identification number assigned by CyberSource to identify the submitted request. + * An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. * @return resellerId **/ - @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request.") + @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.") public String getResellerId() { return resellerId; } diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.java index 3dbca6550..deb830e34 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails; +import Model.Ptsv2paymentsidreversalsReversalInformationAmountDetails; import Model.TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo; import Model.TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo; import com.google.gson.TypeAdapter; @@ -29,7 +29,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedOrderInformation { @SerializedName("billTo") private TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo billTo = null; @@ -38,7 +38,7 @@ public class TssV2TransactionsPost201ResponseEmbeddedOrderInformation { private TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo shipTo = null; @SerializedName("amountDetails") - private TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails amountDetails = null; + private Ptsv2paymentsidreversalsReversalInformationAmountDetails amountDetails = null; public TssV2TransactionsPost201ResponseEmbeddedOrderInformation billTo(TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo billTo) { this.billTo = billTo; @@ -76,7 +76,7 @@ public void setShipTo(TssV2TransactionsPost201ResponseEmbeddedOrderInformationSh this.shipTo = shipTo; } - public TssV2TransactionsPost201ResponseEmbeddedOrderInformation amountDetails(TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails amountDetails) { + public TssV2TransactionsPost201ResponseEmbeddedOrderInformation amountDetails(Ptsv2paymentsidreversalsReversalInformationAmountDetails amountDetails) { this.amountDetails = amountDetails; return this; } @@ -86,11 +86,11 @@ public TssV2TransactionsPost201ResponseEmbeddedOrderInformation amountDetails(Ts * @return amountDetails **/ @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails getAmountDetails() { + public Ptsv2paymentsidreversalsReversalInformationAmountDetails getAmountDetails() { return amountDetails; } - public void setAmountDetails(TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails amountDetails) { + public void setAmountDetails(Ptsv2paymentsidreversalsReversalInformationAmountDetails amountDetails) { this.amountDetails = amountDetails; } diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails.java deleted file mode 100644 index 101908c8d..000000000 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails.java +++ /dev/null @@ -1,116 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails { - @SerializedName("totalAmount") - private String totalAmount = null; - - @SerializedName("currency") - private String currency = null; - - public TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails totalAmount(String totalAmount) { - this.totalAmount = totalAmount; - return this; - } - - /** - * Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) - * @return totalAmount - **/ - @ApiModelProperty(value = "Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places. * CTV, FDCCompass, Paymentech (<= 12) For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") - public String getTotalAmount() { - return totalAmount; - } - - public void setTotalAmount(String totalAmount) { - this.totalAmount = totalAmount; - } - - public TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails currency(String currency) { - this.currency = currency; - return this; - } - - /** - * Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. - * @return currency - **/ - @ApiModelProperty(value = "Currency used for the order. Use the three-character ISO Standard Currency Codes. For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. ") - public String getCurrency() { - return currency; - } - - public void setCurrency(String currency) { - this.currency = currency; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails tssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails = (TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails) o; - return Objects.equals(this.totalAmount, tssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails.totalAmount) && - Objects.equals(this.currency, tssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails.currency); - } - - @Override - public int hashCode() { - return Objects.hash(totalAmount, currency); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsPost201ResponseEmbeddedOrderInformationAmountDetails {\n"); - - sb.append(" totalAmount: ").append(toIndentedString(totalAmount)).append("\n"); - sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.java index 1104af787..7c94681d2 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo { @SerializedName("firstName") private String firstName = null; @@ -49,10 +49,10 @@ public TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo firstName( } /** - * Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return firstName **/ - @ApiModelProperty(value = "Customer’s first name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Customer’s first name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. **For Payouts**:\\ This field may be sent only for FDC Compass. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_firstname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getFirstName() { return firstName; } @@ -67,10 +67,10 @@ public TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo lastName(S } /** - * Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return lastName **/ - @ApiModelProperty(value = "Customer’s last name. This name must be the same as the name on the card. For Payouts: This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Customer’s last name. This name must be the same as the name on the card. **CyberSource Latin American Processing**\\ **Important** For an authorization request, CyberSource Latin American Processing concatenates `orderInformation.billTo.firstName` and `orderInformation.billTo.lastName`. If the concatenated value exceeds 30 characters, CyberSource Latin American Processing declines the authorization request.\\ **Note** CyberSource Latin American Processing is the name of a specific processing connection that CyberSource supports. In the CyberSource API documentation, CyberSource Latin American Processing does not refer to the general topic of processing in Latin America. The information in this field description is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. **CyberSource through VisaNet**\\ Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService\\ (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. **For Payouts** : This field may be sent only for FDC Compass. For processor-specific information, see the customer_lastname field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getLastName() { return lastName; } @@ -85,10 +85,10 @@ public TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo email(Stri } /** - * Customer's email address, including the full domain name. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return email **/ - @ApiModelProperty(value = "Customer's email address, including the full domain name. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Customer's email address, including the full domain name. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the customer_email field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getEmail() { return email; } @@ -103,10 +103,10 @@ public TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo country(St } /** - * Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return country **/ - @ApiModelProperty(value = "Country of the billing address. Use the two-character ISO Standard Country Codes. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Country of the billing address. Use the two-character ISO Standard Country Codes. **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ccAuthService (Required when the billing country is the U.S. or Canada; otherwise, optional.) This field is optional if your CyberSource account is configured for relaxed requirements for address data and expiration date. See \"Relaxed Requirements for Address Data and Expiration Date,\" page 75. Important It is your responsibility to determine whether a field is required for the transaction you are requesting. For processor-specific information, see the bill_country field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getCountry() { return country; } @@ -121,10 +121,10 @@ public TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo phoneNumbe } /** - * Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. * @return phoneNumber **/ - @ApiModelProperty(value = "Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Customer’s phone number. For Payouts: This field may be sent only for FDC Compass. CyberSource recommends that you include the country code when the order is from outside the U.S. For processor-specific information, see the customer_phone field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) **CyberSource through VisaNet** Credit card networks cannot process transactions that contain non-ASCII characters. CyberSource through VisaNet accepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations of the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the credit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless ASCII characters for transmission to the credit card networks. ") public String getPhoneNumber() { return phoneNumber; } diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.java index 5b2f17b29..4a07d0367 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo { @SerializedName("firstName") private String firstName = null; @@ -67,10 +67,10 @@ public TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo lastName(S } /** - * Last name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 + * Last name of the recipient. **Processor-specific maximum length** - Litle: 25 - All other processors: 60 * @return lastName **/ - @ApiModelProperty(value = "Last name of the recipient. **Processor specific maximum length** - Litle: 25 - All other processors: 60 ") + @ApiModelProperty(value = "Last name of the recipient. **Processor-specific maximum length** - Litle: 25 - All other processors: 60 ") public String getLastName() { return lastName; } @@ -103,10 +103,10 @@ public TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo country(St } /** - * Country of the shipping address. Use the two character ISO Standard Country Codes. + * Country of the shipping address. Use the two-character ISO Standard Country Codes. * @return country **/ - @ApiModelProperty(value = "Country of the shipping address. Use the two character ISO Standard Country Codes.") + @ApiModelProperty(value = "Country of the shipping address. Use the two-character ISO Standard Country Codes.") public String getCountry() { return country; } @@ -121,10 +121,10 @@ public TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo phoneNumbe } /** - * Phone number for the shipping address. + * Phone number associated with the shipping address. * @return phoneNumber **/ - @ApiModelProperty(value = "Phone number for the shipping address.") + @ApiModelProperty(value = "Phone number associated with the shipping address.") public String getPhoneNumber() { return phoneNumber; } diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.java index 6ecc033e5..ffd6b0a84 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,9 +14,9 @@ package Model; import java.util.Objects; -import Model.TssV2TransactionsGet200ResponsePaymentInformationCustomer; +import Model.Ptsv2paymentsPaymentInformationCustomer; import Model.TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard; -import Model.TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod; +import Model.TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -29,36 +29,36 @@ /** * TssV2TransactionsPost201ResponseEmbeddedPaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedPaymentInformation { - @SerializedName("paymentMethod") - private TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod paymentMethod = null; + @SerializedName("paymentType") + private TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType paymentType = null; @SerializedName("customer") - private TssV2TransactionsGet200ResponsePaymentInformationCustomer customer = null; + private Ptsv2paymentsPaymentInformationCustomer customer = null; @SerializedName("card") private TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard card = null; - public TssV2TransactionsPost201ResponseEmbeddedPaymentInformation paymentMethod(TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod paymentMethod) { - this.paymentMethod = paymentMethod; + public TssV2TransactionsPost201ResponseEmbeddedPaymentInformation paymentType(TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType paymentType) { + this.paymentType = paymentType; return this; } /** - * Get paymentMethod - * @return paymentMethod + * Get paymentType + * @return paymentType **/ @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod getPaymentMethod() { - return paymentMethod; + public TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType getPaymentType() { + return paymentType; } - public void setPaymentMethod(TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentMethod paymentMethod) { - this.paymentMethod = paymentMethod; + public void setPaymentType(TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType paymentType) { + this.paymentType = paymentType; } - public TssV2TransactionsPost201ResponseEmbeddedPaymentInformation customer(TssV2TransactionsGet200ResponsePaymentInformationCustomer customer) { + public TssV2TransactionsPost201ResponseEmbeddedPaymentInformation customer(Ptsv2paymentsPaymentInformationCustomer customer) { this.customer = customer; return this; } @@ -68,11 +68,11 @@ public TssV2TransactionsPost201ResponseEmbeddedPaymentInformation customer(TssV2 * @return customer **/ @ApiModelProperty(value = "") - public TssV2TransactionsGet200ResponsePaymentInformationCustomer getCustomer() { + public Ptsv2paymentsPaymentInformationCustomer getCustomer() { return customer; } - public void setCustomer(TssV2TransactionsGet200ResponsePaymentInformationCustomer customer) { + public void setCustomer(Ptsv2paymentsPaymentInformationCustomer customer) { this.customer = customer; } @@ -104,14 +104,14 @@ public boolean equals(java.lang.Object o) { return false; } TssV2TransactionsPost201ResponseEmbeddedPaymentInformation tssV2TransactionsPost201ResponseEmbeddedPaymentInformation = (TssV2TransactionsPost201ResponseEmbeddedPaymentInformation) o; - return Objects.equals(this.paymentMethod, tssV2TransactionsPost201ResponseEmbeddedPaymentInformation.paymentMethod) && + return Objects.equals(this.paymentType, tssV2TransactionsPost201ResponseEmbeddedPaymentInformation.paymentType) && Objects.equals(this.customer, tssV2TransactionsPost201ResponseEmbeddedPaymentInformation.customer) && Objects.equals(this.card, tssV2TransactionsPost201ResponseEmbeddedPaymentInformation.card); } @Override public int hashCode() { - return Objects.hash(paymentMethod, customer, card); + return Objects.hash(paymentType, customer, card); } @@ -120,7 +120,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class TssV2TransactionsPost201ResponseEmbeddedPaymentInformation {\n"); - sb.append(" paymentMethod: ").append(toIndentedString(paymentMethod)).append("\n"); + sb.append(" paymentType: ").append(toIndentedString(paymentType)).append("\n"); sb.append(" customer: ").append(toIndentedString(customer)).append("\n"); sb.append(" card: ").append(toIndentedString(card)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.java index 04320d385..7ceaa9891 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard { @SerializedName("suffix") private String suffix = null; @@ -79,10 +79,10 @@ public TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard type(Strin } /** - * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover + * Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) * @return type **/ - @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover ") + @ApiModelProperty(value = "Type of card to authorize. - 001 Visa - 002 Mastercard - 003 Amex - 004 Discover - 005: Diners Club - 007: JCB - 024: Maestro (UK Domestic) - 039 Encoded account number - 042: Maestro (International) ") public String getType() { return type; } diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.java new file mode 100644 index 000000000..a6ad602d1 --- /dev/null +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.java @@ -0,0 +1,116 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Model; + +import java.util.Objects; +import com.google.gson.TypeAdapter; +import com.google.gson.annotations.JsonAdapter; +import com.google.gson.annotations.SerializedName; +import com.google.gson.stream.JsonReader; +import com.google.gson.stream.JsonWriter; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import java.io.IOException; + +/** + * TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType { + @SerializedName("type") + private String type = null; + + @SerializedName("method") + private String method = null; + + public TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType type(String type) { + this.type = type; + return this; + } + + /** + * The type of payment method. This is required for non-credit card payment. Possible values: - BANK_TRANSFER - CARD (Default) - EWALLET - DIGITAL - DIRECT_DEBIT - INVOICE - PUSH_PAYMENT - CARRIER_BILLING - CASH - CHECK - CRYPTOGRAPHIC Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. + * @return type + **/ + @ApiModelProperty(value = "The type of payment method. This is required for non-credit card payment. Possible values: - BANK_TRANSFER - CARD (Default) - EWALLET - DIGITAL - DIRECT_DEBIT - INVOICE - PUSH_PAYMENT - CARRIER_BILLING - CASH - CHECK - CRYPTOGRAPHIC Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. ") + public String getType() { + return type; + } + + public void setType(String type) { + this.type = type; + } + + public TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType method(String method) { + this.method = method; + return this; + } + + /** + * This is an optional field. Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. + * @return method + **/ + @ApiModelProperty(value = "This is an optional field. Please contact CyberSource Customer Support to enable the payment method of your choice and the value you should send in your payment request for this field. ") + public String getMethod() { + return method; + } + + public void setMethod(String method) { + this.method = method; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType tssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType = (TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType) o; + return Objects.equals(this.type, tssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.type) && + Objects.equals(this.method, tssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.method); + } + + @Override + public int hashCode() { + return Objects.hash(type, method); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType {\n"); + + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" method: ").append(toIndentedString(method)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(java.lang.Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +} + diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.java index c3e54d716..4647b630a 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner; +import Model.Ptsv2paymentsClientReferenceInformationPartner; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -27,7 +27,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation { @SerializedName("terminalId") private String terminalId = null; @@ -39,7 +39,7 @@ public class TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation { private String deviceId = null; @SerializedName("partner") - private TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner partner = null; + private Ptsv2paymentsClientReferenceInformationPartner partner = null; public TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation terminalId(String terminalId) { this.terminalId = terminalId; @@ -65,10 +65,10 @@ public TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation terminalSe } /** - * The description for this field is not available. + * Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX. * @return terminalSerialNumber **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only on American Express Direct, FDC Nashville Global, and SIX. ") public String getTerminalSerialNumber() { return terminalSerialNumber; } @@ -95,7 +95,7 @@ public void setDeviceId(String deviceId) { this.deviceId = deviceId; } - public TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation partner(TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner partner) { + public TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation partner(Ptsv2paymentsClientReferenceInformationPartner partner) { this.partner = partner; return this; } @@ -105,11 +105,11 @@ public TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation partner(Ts * @return partner **/ @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner getPartner() { + public Ptsv2paymentsClientReferenceInformationPartner getPartner() { return partner; } - public void setPartner(TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner partner) { + public void setPartner(Ptsv2paymentsClientReferenceInformationPartner partner) { this.partner = partner; } diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.java deleted file mode 100644 index b25a223e8..000000000 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.java +++ /dev/null @@ -1,93 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Model; - -import java.util.Objects; -import com.google.gson.TypeAdapter; -import com.google.gson.annotations.JsonAdapter; -import com.google.gson.annotations.SerializedName; -import com.google.gson.stream.JsonReader; -import com.google.gson.stream.JsonWriter; -import io.swagger.annotations.ApiModel; -import io.swagger.annotations.ApiModelProperty; -import java.io.IOException; - -/** - * TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner { - @SerializedName("originalTransactionId") - private String originalTransactionId = null; - - public TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner originalTransactionId(String originalTransactionId) { - this.originalTransactionId = originalTransactionId; - return this; - } - - /** - * Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. - * @return originalTransactionId - **/ - @ApiModelProperty(value = "Network transaction identifier (TID). You can use this value to identify a specific transaction when you are discussing the transaction with your processor. Not all processors provide this value. ") - public String getOriginalTransactionId() { - return originalTransactionId; - } - - public void setOriginalTransactionId(String originalTransactionId) { - this.originalTransactionId = originalTransactionId; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner tssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner = (TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner) o; - return Objects.equals(this.originalTransactionId, tssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.originalTransactionId); - } - - @Override - public int hashCode() { - return Objects.hash(originalTransactionId); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner {\n"); - - sb.append(" originalTransactionId: ").append(toIndentedString(originalTransactionId)).append("\n"); - sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private String toIndentedString(java.lang.Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } - -} - diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.java index 2c9f10301..713261fe9 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedProcessingInformation { @SerializedName("paymentSolution") private String paymentSolution = null; @@ -40,10 +40,10 @@ public TssV2TransactionsPost201ResponseEmbeddedProcessingInformation paymentSolu } /** - * Type of digital payment solution that is being used for the transaction. Possible Values: - **visacheckout**: Visa Checkout. - **001**: Apple Pay. - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct. - **006**: Android Pay. - **008**: Samsung Pay. + * Type of digital payment solution for the transaction. Possible Values: - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API. - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153. * @return paymentSolution **/ - @ApiModelProperty(value = "Type of digital payment solution that is being used for the transaction. Possible Values: - **visacheckout**: Visa Checkout. - **001**: Apple Pay. - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct. - **006**: Android Pay. - **008**: Samsung Pay. ") + @ApiModelProperty(value = "Type of digital payment solution for the transaction. Possible Values: - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API. - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153. ") public String getPaymentSolution() { return paymentSolution; } diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.java index 5622f483a..59834059c 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedProcessorInformation { @SerializedName("processor") private TssV2TransactionsGet200ResponseProcessorInformationProcessor processor = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.java index 33496b6eb..3963eb02b 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedRiskInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedRiskInformation { @SerializedName("providers") private TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders providers = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.java index 27e7f548d..1cbea6076 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders { @SerializedName("fingerprint") private TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint fingerprint = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.java index 767bbd534..ca6e8257b 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint { @SerializedName("true_ipaddress") private String trueIpaddress = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.java index 555d1378f..db53d38b7 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,9 +14,9 @@ package Model; import java.util.Objects; +import Model.Ptsv2paymentsMerchantDefinedInformation; import Model.TssV2TransactionsGet200ResponseApplicationInformation; import Model.TssV2TransactionsGet200ResponseFraudMarkingInformation; -import Model.TssV2TransactionsGet200ResponseMerchantDefinedInformation; import Model.TssV2TransactionsPost201ResponseEmbeddedBuyerInformation; import Model.TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation; import Model.TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation; @@ -43,7 +43,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries { @SerializedName("id") private String id = null; @@ -73,7 +73,7 @@ public class TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries { private TssV2TransactionsGet200ResponseFraudMarkingInformation fraudMarkingInformation = null; @SerializedName("merchantDefinedInformation") - private List merchantDefinedInformation = null; + private List merchantDefinedInformation = null; @SerializedName("merchantInformation") private TssV2TransactionsPost201ResponseEmbeddedMerchantInformation merchantInformation = null; @@ -105,10 +105,10 @@ public TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries id(String id } /** - * An unique identification number assigned by CyberSource to identify the submitted request. + * An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource. * @return id **/ - @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request.") + @ApiModelProperty(value = "An unique identification number assigned by CyberSource to identify the submitted request. It is also appended to the endpoint of the resource.") public String getId() { return id; } @@ -123,10 +123,10 @@ public TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries submitTimeUt } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } @@ -261,14 +261,14 @@ public void setFraudMarkingInformation(TssV2TransactionsGet200ResponseFraudMarki this.fraudMarkingInformation = fraudMarkingInformation; } - public TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries merchantDefinedInformation(List merchantDefinedInformation) { + public TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries merchantDefinedInformation(List merchantDefinedInformation) { this.merchantDefinedInformation = merchantDefinedInformation; return this; } - public TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries addMerchantDefinedInformationItem(TssV2TransactionsGet200ResponseMerchantDefinedInformation merchantDefinedInformationItem) { + public TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries addMerchantDefinedInformationItem(Ptsv2paymentsMerchantDefinedInformation merchantDefinedInformationItem) { if (this.merchantDefinedInformation == null) { - this.merchantDefinedInformation = new ArrayList(); + this.merchantDefinedInformation = new ArrayList(); } this.merchantDefinedInformation.add(merchantDefinedInformationItem); return this; @@ -279,11 +279,11 @@ public TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries addMerchantD * @return merchantDefinedInformation **/ @ApiModelProperty(value = "The description for this field is not available.") - public List getMerchantDefinedInformation() { + public List getMerchantDefinedInformation() { return merchantDefinedInformation; } - public void setMerchantDefinedInformation(List merchantDefinedInformation) { + public void setMerchantDefinedInformation(List merchantDefinedInformation) { this.merchantDefinedInformation = merchantDefinedInformation; } diff --git a/src/main/java/Model/TssV2TransactionsPost400Response.java b/src/main/java/Model/TssV2TransactionsPost400Response.java index fe8cd9843..c435dc56a 100644 --- a/src/main/java/Model/TssV2TransactionsPost400Response.java +++ b/src/main/java/Model/TssV2TransactionsPost400Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.PtsV2PayoutsPost201ResponseErrorInformationDetails; +import Model.PtsV2PaymentsPost201ResponseErrorInformationDetails; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -29,13 +29,13 @@ /** * TssV2TransactionsPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class TssV2TransactionsPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; /** - * The status of the submitted transaction. + * The status of the submitted transaction. Possible values: - INVALID_REQUEST */ @JsonAdapter(StatusEnum.Adapter.class) public enum StatusEnum { @@ -86,7 +86,7 @@ public StatusEnum read(final JsonReader jsonReader) throws IOException { private String message = null; @SerializedName("details") - private List details = null; + private List details = null; public TssV2TransactionsPost400Response submitTimeUtc(String submitTimeUtc) { this.submitTimeUtc = submitTimeUtc; @@ -94,10 +94,10 @@ public TssV2TransactionsPost400Response submitTimeUtc(String submitTimeUtc) { } /** - * Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. + * Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. * @return submitTimeUtc **/ - @ApiModelProperty(value = "Time of request in UTC. `Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC. ") + @ApiModelProperty(value = "Time of request in UTC. Format: `YYYY-MM-DDThh:mm:ssZ` Example `2016-08-11T22:47:57Z` equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The `T` separates the date and the time. The `Z` indicates UTC. ") public String getSubmitTimeUtc() { return submitTimeUtc; } @@ -112,10 +112,10 @@ public TssV2TransactionsPost400Response status(StatusEnum status) { } /** - * The status of the submitted transaction. + * The status of the submitted transaction. Possible values: - INVALID_REQUEST * @return status **/ - @ApiModelProperty(value = "The status of the submitted transaction.") + @ApiModelProperty(value = "The status of the submitted transaction. Possible values: - INVALID_REQUEST ") public StatusEnum getStatus() { return status; } @@ -142,14 +142,14 @@ public void setMessage(String message) { this.message = message; } - public TssV2TransactionsPost400Response details(List details) { + public TssV2TransactionsPost400Response details(List details) { this.details = details; return this; } - public TssV2TransactionsPost400Response addDetailsItem(PtsV2PayoutsPost201ResponseErrorInformationDetails detailsItem) { + public TssV2TransactionsPost400Response addDetailsItem(PtsV2PaymentsPost201ResponseErrorInformationDetails detailsItem) { if (this.details == null) { - this.details = new ArrayList(); + this.details = new ArrayList(); } this.details.add(detailsItem); return this; @@ -160,11 +160,11 @@ public TssV2TransactionsPost400Response addDetailsItem(PtsV2PayoutsPost201Respon * @return details **/ @ApiModelProperty(value = "") - public List getDetails() { + public List getDetails() { return details; } - public void setDetails(List details) { + public void setDetails(List details) { this.details = details; } diff --git a/src/main/java/Model/UmsV1UsersGet200Response.java b/src/main/java/Model/UmsV1UsersGet200Response.java index 848dd2d63..0f909f246 100644 --- a/src/main/java/Model/UmsV1UsersGet200Response.java +++ b/src/main/java/Model/UmsV1UsersGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * UmsV1UsersGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class UmsV1UsersGet200Response { @SerializedName("users") private List users = null; diff --git a/src/main/java/Model/UmsV1UsersGet200ResponseAccountInformation.java b/src/main/java/Model/UmsV1UsersGet200ResponseAccountInformation.java index ecf4db541..ebcb44cd7 100644 --- a/src/main/java/Model/UmsV1UsersGet200ResponseAccountInformation.java +++ b/src/main/java/Model/UmsV1UsersGet200ResponseAccountInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * UmsV1UsersGet200ResponseAccountInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class UmsV1UsersGet200ResponseAccountInformation { @SerializedName("userName") private String userName = null; diff --git a/src/main/java/Model/UmsV1UsersGet200ResponseContactInformation.java b/src/main/java/Model/UmsV1UsersGet200ResponseContactInformation.java index eb018ea48..488483cec 100644 --- a/src/main/java/Model/UmsV1UsersGet200ResponseContactInformation.java +++ b/src/main/java/Model/UmsV1UsersGet200ResponseContactInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * UmsV1UsersGet200ResponseContactInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class UmsV1UsersGet200ResponseContactInformation { @SerializedName("email") private String email = null; diff --git a/src/main/java/Model/UmsV1UsersGet200ResponseOrganizationInformation.java b/src/main/java/Model/UmsV1UsersGet200ResponseOrganizationInformation.java index 24f699123..a79e9b4a1 100644 --- a/src/main/java/Model/UmsV1UsersGet200ResponseOrganizationInformation.java +++ b/src/main/java/Model/UmsV1UsersGet200ResponseOrganizationInformation.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * UmsV1UsersGet200ResponseOrganizationInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class UmsV1UsersGet200ResponseOrganizationInformation { @SerializedName("organizationId") private String organizationId = null; diff --git a/src/main/java/Model/UmsV1UsersGet200ResponseUsers.java b/src/main/java/Model/UmsV1UsersGet200ResponseUsers.java index dca127e0d..968faac7a 100644 --- a/src/main/java/Model/UmsV1UsersGet200ResponseUsers.java +++ b/src/main/java/Model/UmsV1UsersGet200ResponseUsers.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -29,7 +29,7 @@ /** * UmsV1UsersGet200ResponseUsers */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class UmsV1UsersGet200ResponseUsers { @SerializedName("accountInformation") private UmsV1UsersGet200ResponseAccountInformation accountInformation = null; diff --git a/src/main/java/Model/Body1.java b/src/main/java/Model/UpdateInstrumentIdentifierRequest.java similarity index 60% rename from src/main/java/Model/Body1.java rename to src/main/java/Model/UpdateInstrumentIdentifierRequest.java index 8a97e7faf..4c4f5bf6f 100644 --- a/src/main/java/Model/Body1.java +++ b/src/main/java/Model/UpdateInstrumentIdentifierRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.Tmsv1instrumentidentifiersProcessingInformation; +import Model.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -25,14 +25,14 @@ import java.io.IOException; /** - * Body1 + * UpdateInstrumentIdentifierRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Body1 { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class UpdateInstrumentIdentifierRequest { @SerializedName("processingInformation") - private Tmsv1instrumentidentifiersProcessingInformation processingInformation = null; + private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation = null; - public Body1 processingInformation(Tmsv1instrumentidentifiersProcessingInformation processingInformation) { + public UpdateInstrumentIdentifierRequest processingInformation(TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation) { this.processingInformation = processingInformation; return this; } @@ -42,11 +42,11 @@ public Body1 processingInformation(Tmsv1instrumentidentifiersProcessingInformati * @return processingInformation **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersProcessingInformation getProcessingInformation() { + public TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation getProcessingInformation() { return processingInformation; } - public void setProcessingInformation(Tmsv1instrumentidentifiersProcessingInformation processingInformation) { + public void setProcessingInformation(TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation) { this.processingInformation = processingInformation; } @@ -59,8 +59,8 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Body1 body1 = (Body1) o; - return Objects.equals(this.processingInformation, body1.processingInformation); + UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest = (UpdateInstrumentIdentifierRequest) o; + return Objects.equals(this.processingInformation, updateInstrumentIdentifierRequest.processingInformation); } @Override @@ -72,7 +72,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Body1 {\n"); + sb.append("class UpdateInstrumentIdentifierRequest {\n"); sb.append(" processingInformation: ").append(toIndentedString(processingInformation)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/Body2.java b/src/main/java/Model/UpdatePaymentInstrumentRequest.java similarity index 54% rename from src/main/java/Model/Body2.java rename to src/main/java/Model/UpdatePaymentInstrumentRequest.java index 871ea644d..340f75f0b 100644 --- a/src/main/java/Model/Body2.java +++ b/src/main/java/Model/UpdatePaymentInstrumentRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,15 +14,15 @@ package Model; import java.util.Objects; -import Model.Tmsv1instrumentidentifiersLinks; -import Model.Tmsv1instrumentidentifiersMetadata; -import Model.Tmsv1paymentinstrumentsBankAccount; -import Model.Tmsv1paymentinstrumentsBillTo; -import Model.Tmsv1paymentinstrumentsBuyerInformation; -import Model.Tmsv1paymentinstrumentsCard; -import Model.Tmsv1paymentinstrumentsInstrumentIdentifier; -import Model.Tmsv1paymentinstrumentsMerchantInformation; -import Model.Tmsv1paymentinstrumentsProcessingInformation; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation; +import Model.TmsV1InstrumentIdentifiersPost200ResponseLinks; +import Model.TmsV1InstrumentIdentifiersPost200ResponseMetadata; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -33,18 +33,18 @@ import java.io.IOException; /** - * Body2 + * UpdatePaymentInstrumentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") -public class Body2 { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") +public class UpdatePaymentInstrumentRequest { @SerializedName("_links") - private Tmsv1instrumentidentifiersLinks links = null; + private TmsV1InstrumentIdentifiersPost200ResponseLinks links = null; @SerializedName("id") private String id = null; /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. + * Describes type of token. */ @JsonAdapter(ObjectEnum.Adapter.class) public enum ObjectEnum { @@ -142,30 +142,30 @@ public StateEnum read(final JsonReader jsonReader) throws IOException { private StateEnum state = null; @SerializedName("bankAccount") - private Tmsv1paymentinstrumentsBankAccount bankAccount = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount bankAccount = null; @SerializedName("card") - private Tmsv1paymentinstrumentsCard card = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard card = null; @SerializedName("buyerInformation") - private Tmsv1paymentinstrumentsBuyerInformation buyerInformation = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation buyerInformation = null; @SerializedName("billTo") - private Tmsv1paymentinstrumentsBillTo billTo = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo billTo = null; @SerializedName("processingInformation") - private Tmsv1paymentinstrumentsProcessingInformation processingInformation = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation processingInformation = null; @SerializedName("merchantInformation") - private Tmsv1paymentinstrumentsMerchantInformation merchantInformation = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation merchantInformation = null; @SerializedName("metaData") - private Tmsv1instrumentidentifiersMetadata metaData = null; + private TmsV1InstrumentIdentifiersPost200ResponseMetadata metaData = null; @SerializedName("instrumentIdentifier") - private Tmsv1paymentinstrumentsInstrumentIdentifier instrumentIdentifier = null; + private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier instrumentIdentifier = null; - public Body2 links(Tmsv1instrumentidentifiersLinks links) { + public UpdatePaymentInstrumentRequest links(TmsV1InstrumentIdentifiersPost200ResponseLinks links) { this.links = links; return this; } @@ -175,11 +175,11 @@ public Body2 links(Tmsv1instrumentidentifiersLinks links) { * @return links **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersLinks getLinks() { + public TmsV1InstrumentIdentifiersPost200ResponseLinks getLinks() { return links; } - public void setLinks(Tmsv1instrumentidentifiersLinks links) { + public void setLinks(TmsV1InstrumentIdentifiersPost200ResponseLinks links) { this.links = links; } @@ -193,10 +193,10 @@ public String getId() { } /** - * Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier. + * Describes type of token. * @return object **/ - @ApiModelProperty(example = "instrumentIdentifier", value = "Describes type of token. For example: customer, paymentInstrument or instrumentIdentifier.") + @ApiModelProperty(example = "instrumentIdentifier", value = "Describes type of token.") public ObjectEnum getObject() { return object; } @@ -210,7 +210,7 @@ public StateEnum getState() { return state; } - public Body2 bankAccount(Tmsv1paymentinstrumentsBankAccount bankAccount) { + public UpdatePaymentInstrumentRequest bankAccount(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount bankAccount) { this.bankAccount = bankAccount; return this; } @@ -220,15 +220,15 @@ public Body2 bankAccount(Tmsv1paymentinstrumentsBankAccount bankAccount) { * @return bankAccount **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsBankAccount getBankAccount() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount getBankAccount() { return bankAccount; } - public void setBankAccount(Tmsv1paymentinstrumentsBankAccount bankAccount) { + public void setBankAccount(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount bankAccount) { this.bankAccount = bankAccount; } - public Body2 card(Tmsv1paymentinstrumentsCard card) { + public UpdatePaymentInstrumentRequest card(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard card) { this.card = card; return this; } @@ -238,15 +238,15 @@ public Body2 card(Tmsv1paymentinstrumentsCard card) { * @return card **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsCard getCard() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard getCard() { return card; } - public void setCard(Tmsv1paymentinstrumentsCard card) { + public void setCard(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard card) { this.card = card; } - public Body2 buyerInformation(Tmsv1paymentinstrumentsBuyerInformation buyerInformation) { + public UpdatePaymentInstrumentRequest buyerInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation buyerInformation) { this.buyerInformation = buyerInformation; return this; } @@ -256,15 +256,15 @@ public Body2 buyerInformation(Tmsv1paymentinstrumentsBuyerInformation buyerInfor * @return buyerInformation **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsBuyerInformation getBuyerInformation() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation getBuyerInformation() { return buyerInformation; } - public void setBuyerInformation(Tmsv1paymentinstrumentsBuyerInformation buyerInformation) { + public void setBuyerInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation buyerInformation) { this.buyerInformation = buyerInformation; } - public Body2 billTo(Tmsv1paymentinstrumentsBillTo billTo) { + public UpdatePaymentInstrumentRequest billTo(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo billTo) { this.billTo = billTo; return this; } @@ -274,15 +274,15 @@ public Body2 billTo(Tmsv1paymentinstrumentsBillTo billTo) { * @return billTo **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsBillTo getBillTo() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo getBillTo() { return billTo; } - public void setBillTo(Tmsv1paymentinstrumentsBillTo billTo) { + public void setBillTo(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo billTo) { this.billTo = billTo; } - public Body2 processingInformation(Tmsv1paymentinstrumentsProcessingInformation processingInformation) { + public UpdatePaymentInstrumentRequest processingInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation processingInformation) { this.processingInformation = processingInformation; return this; } @@ -292,15 +292,15 @@ public Body2 processingInformation(Tmsv1paymentinstrumentsProcessingInformation * @return processingInformation **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsProcessingInformation getProcessingInformation() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation getProcessingInformation() { return processingInformation; } - public void setProcessingInformation(Tmsv1paymentinstrumentsProcessingInformation processingInformation) { + public void setProcessingInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation processingInformation) { this.processingInformation = processingInformation; } - public Body2 merchantInformation(Tmsv1paymentinstrumentsMerchantInformation merchantInformation) { + public UpdatePaymentInstrumentRequest merchantInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation merchantInformation) { this.merchantInformation = merchantInformation; return this; } @@ -310,15 +310,15 @@ public Body2 merchantInformation(Tmsv1paymentinstrumentsMerchantInformation merc * @return merchantInformation **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsMerchantInformation getMerchantInformation() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation getMerchantInformation() { return merchantInformation; } - public void setMerchantInformation(Tmsv1paymentinstrumentsMerchantInformation merchantInformation) { + public void setMerchantInformation(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation merchantInformation) { this.merchantInformation = merchantInformation; } - public Body2 metaData(Tmsv1instrumentidentifiersMetadata metaData) { + public UpdatePaymentInstrumentRequest metaData(TmsV1InstrumentIdentifiersPost200ResponseMetadata metaData) { this.metaData = metaData; return this; } @@ -328,15 +328,15 @@ public Body2 metaData(Tmsv1instrumentidentifiersMetadata metaData) { * @return metaData **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersMetadata getMetaData() { + public TmsV1InstrumentIdentifiersPost200ResponseMetadata getMetaData() { return metaData; } - public void setMetaData(Tmsv1instrumentidentifiersMetadata metaData) { + public void setMetaData(TmsV1InstrumentIdentifiersPost200ResponseMetadata metaData) { this.metaData = metaData; } - public Body2 instrumentIdentifier(Tmsv1paymentinstrumentsInstrumentIdentifier instrumentIdentifier) { + public UpdatePaymentInstrumentRequest instrumentIdentifier(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier instrumentIdentifier) { this.instrumentIdentifier = instrumentIdentifier; return this; } @@ -346,11 +346,11 @@ public Body2 instrumentIdentifier(Tmsv1paymentinstrumentsInstrumentIdentifier in * @return instrumentIdentifier **/ @ApiModelProperty(value = "") - public Tmsv1paymentinstrumentsInstrumentIdentifier getInstrumentIdentifier() { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier getInstrumentIdentifier() { return instrumentIdentifier; } - public void setInstrumentIdentifier(Tmsv1paymentinstrumentsInstrumentIdentifier instrumentIdentifier) { + public void setInstrumentIdentifier(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier instrumentIdentifier) { this.instrumentIdentifier = instrumentIdentifier; } @@ -363,19 +363,19 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - Body2 body2 = (Body2) o; - return Objects.equals(this.links, body2.links) && - Objects.equals(this.id, body2.id) && - Objects.equals(this.object, body2.object) && - Objects.equals(this.state, body2.state) && - Objects.equals(this.bankAccount, body2.bankAccount) && - Objects.equals(this.card, body2.card) && - Objects.equals(this.buyerInformation, body2.buyerInformation) && - Objects.equals(this.billTo, body2.billTo) && - Objects.equals(this.processingInformation, body2.processingInformation) && - Objects.equals(this.merchantInformation, body2.merchantInformation) && - Objects.equals(this.metaData, body2.metaData) && - Objects.equals(this.instrumentIdentifier, body2.instrumentIdentifier); + UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest = (UpdatePaymentInstrumentRequest) o; + return Objects.equals(this.links, updatePaymentInstrumentRequest.links) && + Objects.equals(this.id, updatePaymentInstrumentRequest.id) && + Objects.equals(this.object, updatePaymentInstrumentRequest.object) && + Objects.equals(this.state, updatePaymentInstrumentRequest.state) && + Objects.equals(this.bankAccount, updatePaymentInstrumentRequest.bankAccount) && + Objects.equals(this.card, updatePaymentInstrumentRequest.card) && + Objects.equals(this.buyerInformation, updatePaymentInstrumentRequest.buyerInformation) && + Objects.equals(this.billTo, updatePaymentInstrumentRequest.billTo) && + Objects.equals(this.processingInformation, updatePaymentInstrumentRequest.processingInformation) && + Objects.equals(this.merchantInformation, updatePaymentInstrumentRequest.merchantInformation) && + Objects.equals(this.metaData, updatePaymentInstrumentRequest.metaData) && + Objects.equals(this.instrumentIdentifier, updatePaymentInstrumentRequest.instrumentIdentifier); } @Override @@ -387,7 +387,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class Body2 {\n"); + sb.append("class UpdatePaymentInstrumentRequest {\n"); sb.append(" links: ").append(toIndentedString(links)).append("\n"); sb.append(" id: ").append(toIndentedString(id)).append("\n"); diff --git a/src/main/java/Model/V1FileDetailsGet200Response.java b/src/main/java/Model/V1FileDetailsGet200Response.java index c89cec9f8..2849dd24c 100644 --- a/src/main/java/Model/V1FileDetailsGet200Response.java +++ b/src/main/java/Model/V1FileDetailsGet200Response.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * V1FileDetailsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class V1FileDetailsGet200Response { @SerializedName("fileDetails") private List fileDetails = null; diff --git a/src/main/java/Model/V1FileDetailsGet200ResponseFileDetails.java b/src/main/java/Model/V1FileDetailsGet200ResponseFileDetails.java index ea4406c90..1984f45d7 100644 --- a/src/main/java/Model/V1FileDetailsGet200ResponseFileDetails.java +++ b/src/main/java/Model/V1FileDetailsGet200ResponseFileDetails.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -28,7 +28,7 @@ /** * V1FileDetailsGet200ResponseFileDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class V1FileDetailsGet200ResponseFileDetails { @SerializedName("fileId") private String fileId = null; diff --git a/src/main/java/Model/V1FileDetailsGet200ResponseLinks.java b/src/main/java/Model/V1FileDetailsGet200ResponseLinks.java index ab23fcde3..f68455ae0 100644 --- a/src/main/java/Model/V1FileDetailsGet200ResponseLinks.java +++ b/src/main/java/Model/V1FileDetailsGet200ResponseLinks.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -30,7 +30,7 @@ /** * V1FileDetailsGet200ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class V1FileDetailsGet200ResponseLinks { @SerializedName("self") private V1FileDetailsGet200ResponseLinksSelf self = null; diff --git a/src/main/java/Model/V1FileDetailsGet200ResponseLinksFiles.java b/src/main/java/Model/V1FileDetailsGet200ResponseLinksFiles.java index a5cb26584..80a99637f 100644 --- a/src/main/java/Model/V1FileDetailsGet200ResponseLinksFiles.java +++ b/src/main/java/Model/V1FileDetailsGet200ResponseLinksFiles.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * V1FileDetailsGet200ResponseLinksFiles */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class V1FileDetailsGet200ResponseLinksFiles { @SerializedName("fileId") private String fileId = null; diff --git a/src/main/java/Model/V1FileDetailsGet200ResponseLinksSelf.java b/src/main/java/Model/V1FileDetailsGet200ResponseLinksSelf.java index 31a479d2b..c2d22821d 100644 --- a/src/main/java/Model/V1FileDetailsGet200ResponseLinksSelf.java +++ b/src/main/java/Model/V1FileDetailsGet200ResponseLinksSelf.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,7 +26,7 @@ /** * V1FileDetailsGet200ResponseLinksSelf */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class V1FileDetailsGet200ResponseLinksSelf { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/VoidCaptureRequest.java b/src/main/java/Model/VoidCaptureRequest.java index 6010951ae..285538413 100644 --- a/src/main/java/Model/VoidCaptureRequest.java +++ b/src/main/java/Model/VoidCaptureRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * VoidCaptureRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class VoidCaptureRequest { @SerializedName("clientReferenceInformation") private Ptsv2paymentsidreversalsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/main/java/Model/VoidCreditRequest.java b/src/main/java/Model/VoidCreditRequest.java index 9bf979b31..f95d46632 100644 --- a/src/main/java/Model/VoidCreditRequest.java +++ b/src/main/java/Model/VoidCreditRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * VoidCreditRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class VoidCreditRequest { @SerializedName("clientReferenceInformation") private Ptsv2paymentsidreversalsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/main/java/Model/VoidPaymentRequest.java b/src/main/java/Model/VoidPaymentRequest.java index 559e8dbe6..09558de6a 100644 --- a/src/main/java/Model/VoidPaymentRequest.java +++ b/src/main/java/Model/VoidPaymentRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * VoidPaymentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class VoidPaymentRequest { @SerializedName("clientReferenceInformation") private Ptsv2paymentsidreversalsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/main/java/Model/VoidRefundRequest.java b/src/main/java/Model/VoidRefundRequest.java index 4c391eece..31af9ad43 100644 --- a/src/main/java/Model/VoidRefundRequest.java +++ b/src/main/java/Model/VoidRefundRequest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -27,7 +27,7 @@ /** * VoidRefundRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-27T12:49:40.999Z") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-05-09T16:47:53.059+05:30") public class VoidRefundRequest { @SerializedName("clientReferenceInformation") private Ptsv2paymentsidreversalsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/test/java/Api/CaptureApiTest.java b/src/test/java/Api/CaptureApiTest.java index d9bdefc85..ec60e7ef6 100644 --- a/src/test/java/Api/CaptureApiTest.java +++ b/src/test/java/Api/CaptureApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/test/java/Api/ConversionDetailsApiTest.java b/src/test/java/Api/ConversionDetailsApiTest.java index 27c8aee62..e28785816 100644 --- a/src/test/java/Api/ConversionDetailsApiTest.java +++ b/src/test/java/Api/ConversionDetailsApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/test/java/Api/CreditApiTest.java b/src/test/java/Api/CreditApiTest.java index 328579352..8a477e2b2 100644 --- a/src/test/java/Api/CreditApiTest.java +++ b/src/test/java/Api/CreditApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/test/java/Api/DecisionManagerApiTest.java b/src/test/java/Api/DecisionManagerApiTest.java new file mode 100644 index 000000000..025be3d97 --- /dev/null +++ b/src/test/java/Api/DecisionManagerApiTest.java @@ -0,0 +1,54 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Api; + +import Invokers.ApiException; +import Model.CreateDecisionManagerCaseRequest; +import Model.PtsV2PaymentsPost502Response; +import Model.RiskV1DecisionsPost201Response; +import Model.RiskV1DecisionsPost400Response; +import org.junit.Test; +import org.junit.Ignore; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * API tests for DecisionManagerApi + */ +@Ignore +public class DecisionManagerApiTest { + + private final DecisionManagerApi api = new DecisionManagerApi(); + + + /** + * Create Decision Manager case + * + * This is the combined request to the Decision Manager Service for a transaction sent to Cybersource. Decision Manager will return a decision based on the request values. + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void createDecisionManagerCaseTest() throws ApiException { + CreateDecisionManagerCaseRequest createDecisionManagerCaseRequest = null; + RiskV1DecisionsPost201Response response = api.createDecisionManagerCase(createDecisionManagerCaseRequest); + + // TODO: test validations + } + +} diff --git a/src/test/java/Api/InstrumentIdentifierApiTest.java b/src/test/java/Api/InstrumentIdentifierApiTest.java index 66eaf5b19..c97d5aaf2 100644 --- a/src/test/java/Api/InstrumentIdentifierApiTest.java +++ b/src/test/java/Api/InstrumentIdentifierApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,10 +14,12 @@ package Api; import Invokers.ApiException; -import Model.Body1; +import Model.CreateInstrumentIdentifierRequest; import Model.InlineResponse4001; -import Model.TmsV1InstrumentidentifiersDelete409Response; -import Model.TmsV1InstrumentidentifiersPost200Response; +import Model.TmsV1InstrumentIdentifiersDelete409Response; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response; +import Model.TmsV1InstrumentIdentifiersPost200Response; +import Model.UpdateInstrumentIdentifierRequest; import org.junit.Test; import org.junit.Ignore; @@ -35,6 +37,23 @@ public class InstrumentIdentifierApiTest { private final InstrumentIdentifierApi api = new InstrumentIdentifierApi(); + /** + * Create an Instrument Identifier + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void createInstrumentIdentifierTest() throws ApiException { + String profileId = null; + CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest = null; + TmsV1InstrumentIdentifiersPost200Response response = api.createInstrumentIdentifier(profileId, createInstrumentIdentifierRequest); + + // TODO: test validations + } + /** * Delete an Instrument Identifier * @@ -44,10 +63,29 @@ public class InstrumentIdentifierApiTest { * if the Api call fails */ @Test - public void tmsV1InstrumentidentifiersTokenIdDeleteTest() throws ApiException { + public void deleteInstrumentIdentifierTest() throws ApiException { + String profileId = null; + String tokenId = null; + api.deleteInstrumentIdentifier(profileId, tokenId); + + // TODO: test validations + } + + /** + * Retrieve all Payment Instruments associated with an Instrument Identifier + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getAllPaymentInstrumentsTest() throws ApiException { String profileId = null; String tokenId = null; - api.tmsV1InstrumentidentifiersTokenIdDelete(profileId, tokenId); + Long offset = null; + Long limit = null; + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response response = api.getAllPaymentInstruments(profileId, tokenId, offset, limit); // TODO: test validations } @@ -61,10 +99,10 @@ public void tmsV1InstrumentidentifiersTokenIdDeleteTest() throws ApiException { * if the Api call fails */ @Test - public void tmsV1InstrumentidentifiersTokenIdGetTest() throws ApiException { + public void getInstrumentIdentifierTest() throws ApiException { String profileId = null; String tokenId = null; - TmsV1InstrumentidentifiersPost200Response response = api.tmsV1InstrumentidentifiersTokenIdGet(profileId, tokenId); + TmsV1InstrumentIdentifiersPost200Response response = api.getInstrumentIdentifier(profileId, tokenId); // TODO: test validations } @@ -78,11 +116,11 @@ public void tmsV1InstrumentidentifiersTokenIdGetTest() throws ApiException { * if the Api call fails */ @Test - public void tmsV1InstrumentidentifiersTokenIdPatchTest() throws ApiException { + public void updateInstrumentIdentifierTest() throws ApiException { String profileId = null; String tokenId = null; - Body1 body = null; - TmsV1InstrumentidentifiersPost200Response response = api.tmsV1InstrumentidentifiersTokenIdPatch(profileId, tokenId, body); + UpdateInstrumentIdentifierRequest updateInstrumentIdentifierRequest = null; + TmsV1InstrumentIdentifiersPost200Response response = api.updateInstrumentIdentifier(profileId, tokenId, updateInstrumentIdentifierRequest); // TODO: test validations } diff --git a/src/test/java/Api/InstrumentIdentifiersApiTest.java b/src/test/java/Api/InstrumentIdentifiersApiTest.java deleted file mode 100644 index 064bdce98..000000000 --- a/src/test/java/Api/InstrumentIdentifiersApiTest.java +++ /dev/null @@ -1,54 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Api; - -import Invokers.ApiException; -import Model.Body; -import Model.InlineResponse4001; -import Model.TmsV1InstrumentidentifiersPost200Response; -import org.junit.Test; -import org.junit.Ignore; - -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for InstrumentIdentifiersApi - */ -@Ignore -public class InstrumentIdentifiersApiTest { - - private final InstrumentIdentifiersApi api = new InstrumentIdentifiersApi(); - - - /** - * Create an Instrument Identifier - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void tmsV1InstrumentidentifiersPostTest() throws ApiException { - String profileId = null; - Body body = null; - TmsV1InstrumentidentifiersPost200Response response = api.tmsV1InstrumentidentifiersPost(profileId, body); - - // TODO: test validations - } - -} diff --git a/src/test/java/Api/KeyGenerationApiTest.java b/src/test/java/Api/KeyGenerationApiTest.java index ff384f790..afafa9cff 100644 --- a/src/test/java/Api/KeyGenerationApiTest.java +++ b/src/test/java/Api/KeyGenerationApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/test/java/Api/NetFundingsApiTest.java b/src/test/java/Api/NetFundingsApiTest.java index 76af7986c..168c20450 100644 --- a/src/test/java/Api/NetFundingsApiTest.java +++ b/src/test/java/Api/NetFundingsApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -43,12 +43,12 @@ public class NetFundingsApiTest { * if the Api call fails */ @Test - public void getNetFundingInfoTest() throws ApiException { + public void getNetFundingDetailsTest() throws ApiException { DateTime startTime = null; DateTime endTime = null; String organizationId = null; String groupName = null; - ReportingV3NetFundingsGet200Response response = api.getNetFundingInfo(startTime, endTime, organizationId, groupName); + ReportingV3NetFundingsGet200Response response = api.getNetFundingDetails(startTime, endTime, organizationId, groupName); // TODO: test validations } diff --git a/src/test/java/Api/NotificationOfChangesApiTest.java b/src/test/java/Api/NotificationOfChangesApiTest.java index 4ac513727..342415a82 100644 --- a/src/test/java/Api/NotificationOfChangesApiTest.java +++ b/src/test/java/Api/NotificationOfChangesApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/test/java/Api/PaymentBatchSummariesApiTest.java b/src/test/java/Api/PaymentBatchSummariesApiTest.java new file mode 100644 index 000000000..2b61a846c --- /dev/null +++ b/src/test/java/Api/PaymentBatchSummariesApiTest.java @@ -0,0 +1,58 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Api; + +import Invokers.ApiException; +import org.joda.time.DateTime; +import Model.InlineResponse200; +import Model.Reportingv3ReportDownloadsGet400Response; +import org.junit.Test; +import org.junit.Ignore; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * API tests for PaymentBatchSummariesApi + */ +@Ignore +public class PaymentBatchSummariesApiTest { + + private final PaymentBatchSummariesApi api = new PaymentBatchSummariesApi(); + + + /** + * Get payment batch summary data + * + * Scope can be either account/merchant or reseller. + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getPaymentBatchSummaryTest() throws ApiException { + DateTime startTime = null; + DateTime endTime = null; + String organizationId = null; + String rollUp = null; + String breakdown = null; + Integer startDayOfWeek = null; + InlineResponse200 response = api.getPaymentBatchSummary(startTime, endTime, organizationId, rollUp, breakdown, startDayOfWeek); + + // TODO: test validations + } + +} diff --git a/src/test/java/Api/PaymentInstrumentApiTest.java b/src/test/java/Api/PaymentInstrumentApiTest.java new file mode 100644 index 000000000..bba14dd32 --- /dev/null +++ b/src/test/java/Api/PaymentInstrumentApiTest.java @@ -0,0 +1,107 @@ +/* + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html + * + * OpenAPI spec version: 0.0.1 + * + * + * NOTE: This class is auto generated by the swagger code generator program. + * https://github.com/swagger-api/swagger-codegen.git + * Do not edit the class manually. + */ + + +package Api; + +import Invokers.ApiException; +import Model.CreatePaymentInstrumentRequest; +import Model.InlineResponse4001; +import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments; +import Model.UpdatePaymentInstrumentRequest; +import org.junit.Test; +import org.junit.Ignore; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +/** + * API tests for PaymentInstrumentApi + */ +@Ignore +public class PaymentInstrumentApiTest { + + private final PaymentInstrumentApi api = new PaymentInstrumentApi(); + + + /** + * Create a Payment Instrument + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void createPaymentInstrumentTest() throws ApiException { + String profileId = null; + CreatePaymentInstrumentRequest createPaymentInstrumentRequest = null; + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments response = api.createPaymentInstrument(profileId, createPaymentInstrumentRequest); + + // TODO: test validations + } + + /** + * Delete a Payment Instrument + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void deletePaymentInstrumentTest() throws ApiException { + String profileId = null; + String tokenId = null; + api.deletePaymentInstrument(profileId, tokenId); + + // TODO: test validations + } + + /** + * Retrieve a Payment Instrument + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getPaymentInstrumentTest() throws ApiException { + String profileId = null; + String tokenId = null; + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments response = api.getPaymentInstrument(profileId, tokenId); + + // TODO: test validations + } + + /** + * Update a Payment Instrument + * + * + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void updatePaymentInstrumentTest() throws ApiException { + String profileId = null; + String tokenId = null; + UpdatePaymentInstrumentRequest updatePaymentInstrumentRequest = null; + TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments response = api.updatePaymentInstrument(profileId, tokenId, updatePaymentInstrumentRequest); + + // TODO: test validations + } + +} diff --git a/src/test/java/Api/PaymentInstrumentsApiTest.java b/src/test/java/Api/PaymentInstrumentsApiTest.java deleted file mode 100644 index 2ae9551ce..000000000 --- a/src/test/java/Api/PaymentInstrumentsApiTest.java +++ /dev/null @@ -1,128 +0,0 @@ -/* - * CyberSource Flex API - * Simple PAN tokenization service - * - * OpenAPI spec version: 0.0.1 - * - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * Do not edit the class manually. - */ - - -package Api; - -import Invokers.ApiException; -import Model.Body2; -import Model.Body3; -import Model.InlineResponse4001; -import Model.TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response; -import Model.TmsV1PaymentinstrumentsGet200Response; -import Model.TmsV1PaymentinstrumentsPost201Response; -import org.junit.Test; -import org.junit.Ignore; - -import java.util.ArrayList; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -/** - * API tests for PaymentInstrumentsApi - */ -@Ignore -public class PaymentInstrumentsApiTest { - - private final PaymentInstrumentsApi api = new PaymentInstrumentsApi(); - - - /** - * Retrieve all Payment Instruments associated with an Instrument Identifier - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGetTest() throws ApiException { - String profileId = null; - String tokenId = null; - String offset = null; - String limit = null; - TmsV1InstrumentidentifiersPaymentinstrumentsGet200Response response = api.tmsV1InstrumentidentifiersTokenIdPaymentinstrumentsGet(profileId, tokenId, offset, limit); - - // TODO: test validations - } - - /** - * Create a Payment Instrument - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void tmsV1PaymentinstrumentsPostTest() throws ApiException { - String profileId = null; - Body2 body = null; - TmsV1PaymentinstrumentsPost201Response response = api.tmsV1PaymentinstrumentsPost(profileId, body); - - // TODO: test validations - } - - /** - * Delete a Payment Instrument - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void tmsV1PaymentinstrumentsTokenIdDeleteTest() throws ApiException { - String profileId = null; - String tokenId = null; - api.tmsV1PaymentinstrumentsTokenIdDelete(profileId, tokenId); - - // TODO: test validations - } - - /** - * Retrieve a Payment Instrument - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void tmsV1PaymentinstrumentsTokenIdGetTest() throws ApiException { - String profileId = null; - String tokenId = null; - TmsV1PaymentinstrumentsGet200Response response = api.tmsV1PaymentinstrumentsTokenIdGet(profileId, tokenId); - - // TODO: test validations - } - - /** - * Update a Payment Instrument - * - * - * - * @throws ApiException - * if the Api call fails - */ - @Test - public void tmsV1PaymentinstrumentsTokenIdPatchTest() throws ApiException { - String profileId = null; - String tokenId = null; - Body3 body = null; - TmsV1PaymentinstrumentsGet200Response response = api.tmsV1PaymentinstrumentsTokenIdPatch(profileId, tokenId, body); - - // TODO: test validations - } - -} diff --git a/src/test/java/Api/PaymentsApiTest.java b/src/test/java/Api/PaymentsApiTest.java index 39397baaa..30dfee055 100644 --- a/src/test/java/Api/PaymentsApiTest.java +++ b/src/test/java/Api/PaymentsApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/test/java/Api/ProcessAPayoutApiTest.java b/src/test/java/Api/PayoutsApiTest.java similarity index 70% rename from src/test/java/Api/ProcessAPayoutApiTest.java rename to src/test/java/Api/PayoutsApiTest.java index 9f178850c..eafe0e920 100644 --- a/src/test/java/Api/ProcessAPayoutApiTest.java +++ b/src/test/java/Api/PayoutsApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,10 +14,10 @@ package Api; import Invokers.ApiException; +import Model.OctCreatePaymentRequest; +import Model.PtsV2PaymentsPost502Response; import Model.PtsV2PayoutsPost201Response; import Model.PtsV2PayoutsPost400Response; -import Model.PtsV2PayoutsPost502Response; -import Model.PtsV2PayoutsPostResponse; import org.junit.Test; import org.junit.Ignore; @@ -27,12 +27,12 @@ import java.util.Map; /** - * API tests for ProcessAPayoutApi + * API tests for PayoutsApi */ @Ignore -public class ProcessAPayoutApiTest { +public class PayoutsApiTest { - private final ProcessAPayoutApi api = new ProcessAPayoutApi(); + private final PayoutsApi api = new PayoutsApi(); /** @@ -45,7 +45,7 @@ public class ProcessAPayoutApiTest { */ @Test public void octCreatePaymentTest() throws ApiException { - PtsV2PayoutsPostResponse octCreatePaymentRequest = null; + OctCreatePaymentRequest octCreatePaymentRequest = null; PtsV2PayoutsPost201Response response = api.octCreatePayment(octCreatePaymentRequest); // TODO: test validations diff --git a/src/test/java/Api/PurchaseAndRefundDetailsApiTest.java b/src/test/java/Api/PurchaseAndRefundDetailsApiTest.java index d2f04ae1e..103c2d76d 100644 --- a/src/test/java/Api/PurchaseAndRefundDetailsApiTest.java +++ b/src/test/java/Api/PurchaseAndRefundDetailsApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/test/java/Api/RefundApiTest.java b/src/test/java/Api/RefundApiTest.java index 5609850b3..5ce19a217 100644 --- a/src/test/java/Api/RefundApiTest.java +++ b/src/test/java/Api/RefundApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/test/java/Api/ReportDefinitionsApiTest.java b/src/test/java/Api/ReportDefinitionsApiTest.java index 390734722..4ae23fbc5 100644 --- a/src/test/java/Api/ReportDefinitionsApiTest.java +++ b/src/test/java/Api/ReportDefinitionsApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/test/java/Api/ReportDownloadsApiTest.java b/src/test/java/Api/ReportDownloadsApiTest.java index 4f2c23f35..e6cf88282 100644 --- a/src/test/java/Api/ReportDownloadsApiTest.java +++ b/src/test/java/Api/ReportDownloadsApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/test/java/Api/ReportSubscriptionsApiTest.java b/src/test/java/Api/ReportSubscriptionsApiTest.java index 7e8fc6f86..a676281c7 100644 --- a/src/test/java/Api/ReportSubscriptionsApiTest.java +++ b/src/test/java/Api/ReportSubscriptionsApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/test/java/Api/ReportsApiTest.java b/src/test/java/Api/ReportsApiTest.java index 48223241b..7a8aab005 100644 --- a/src/test/java/Api/ReportsApiTest.java +++ b/src/test/java/Api/ReportsApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/test/java/Api/ReversalApiTest.java b/src/test/java/Api/ReversalApiTest.java index 610f82976..31a7bf253 100644 --- a/src/test/java/Api/ReversalApiTest.java +++ b/src/test/java/Api/ReversalApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -15,6 +15,7 @@ import Invokers.ApiException; import Model.AuthReversalRequest; +import Model.MitReversalRequest; import Model.PtsV2PaymentsPost502Response; import Model.PtsV2PaymentsReversalsPost201Response; import Model.PtsV2PaymentsReversalsPost400Response; @@ -52,4 +53,20 @@ public void authReversalTest() throws ApiException { // TODO: test validations } + /** + * Merchant Initiated Reversal + * + * This is to reverse a previous payment that merchant does not receive a reply. + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void mitReversalTest() throws ApiException { + MitReversalRequest mitReversalRequest = null; + PtsV2PaymentsReversalsPost201Response response = api.mitReversal(mitReversalRequest); + + // TODO: test validations + } + } diff --git a/src/test/java/Api/SearchTransactionsApiTest.java b/src/test/java/Api/SearchTransactionsApiTest.java index b2594128f..4068b5f66 100644 --- a/src/test/java/Api/SearchTransactionsApiTest.java +++ b/src/test/java/Api/SearchTransactionsApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,10 +14,10 @@ package Api; import Invokers.ApiException; -import Model.PtsV2PayoutsPost502Response; +import Model.CreateSearchRequest; +import Model.PtsV2PaymentsPost502Response; import Model.TssV2TransactionsPost201Response; import Model.TssV2TransactionsPost400Response; -import Model.TssV2TransactionsPostResponse; import org.junit.Test; import org.junit.Ignore; @@ -45,7 +45,7 @@ public class SearchTransactionsApiTest { */ @Test public void createSearchTest() throws ApiException { - TssV2TransactionsPostResponse createSearchRequest = null; + CreateSearchRequest createSearchRequest = null; TssV2TransactionsPost201Response response = api.createSearch(createSearchRequest); // TODO: test validations @@ -54,15 +54,15 @@ public void createSearchTest() throws ApiException { /** * Get Search results * - * Include the Search ID in the GET request to retrieve the search results. + * Include the Search ID in the GET request to retrieve the search results. * * @throws ApiException * if the Api call fails */ @Test public void getSearchTest() throws ApiException { - String id = null; - TssV2TransactionsPost201Response response = api.getSearch(id); + String searchId = null; + TssV2TransactionsPost201Response response = api.getSearch(searchId); // TODO: test validations } diff --git a/src/test/java/Api/SecureFileShareApiTest.java b/src/test/java/Api/SecureFileShareApiTest.java index 29fcafa72..4c4078c9d 100644 --- a/src/test/java/Api/SecureFileShareApiTest.java +++ b/src/test/java/Api/SecureFileShareApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -60,11 +60,11 @@ public void getFileTest() throws ApiException { * if the Api call fails */ @Test - public void getFileDetailsTest() throws ApiException { + public void getFileDetailTest() throws ApiException { LocalDate startDate = null; LocalDate endDate = null; String organizationId = null; - V1FileDetailsGet200Response response = api.getFileDetails(startDate, endDate, organizationId); + V1FileDetailsGet200Response response = api.getFileDetail(startDate, endDate, organizationId); // TODO: test validations } diff --git a/src/test/java/Api/FlexTokenApiTest.java b/src/test/java/Api/TokenizationApiTest.java similarity index 78% rename from src/test/java/Api/FlexTokenApiTest.java rename to src/test/java/Api/TokenizationApiTest.java index 5cfc5b754..45dfcb0ec 100644 --- a/src/test/java/Api/FlexTokenApiTest.java +++ b/src/test/java/Api/TokenizationApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -26,16 +26,16 @@ import java.util.Map; /** - * API tests for FlexTokenApi + * API tests for TokenizationApi */ @Ignore -public class FlexTokenApiTest { +public class TokenizationApiTest { - private final FlexTokenApi api = new FlexTokenApi(); + private final TokenizationApi api = new TokenizationApi(); /** - * Flex Tokenize card + * Tokenize card * * Returns a token representing the supplied card details. The token replaces card data and can be used as the Subscription ID in the CyberSource Simple Order API or SCMP API. This is an unauthenticated call that you should initiate from your customer’s device or browser. * diff --git a/src/test/java/Api/TransactionBatchesApiTest.java b/src/test/java/Api/TransactionBatchesApiTest.java index 17ed24143..ac0a9b22a 100644 --- a/src/test/java/Api/TransactionBatchesApiTest.java +++ b/src/test/java/Api/TransactionBatchesApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -15,6 +15,7 @@ import Invokers.ApiException; import org.joda.time.DateTime; +import org.joda.time.LocalDate; import Model.PtsV1TransactionBatchesGet200Response; import Model.PtsV1TransactionBatchesGet400Response; import Model.PtsV1TransactionBatchesGet500Response; @@ -36,6 +37,24 @@ public class TransactionBatchesApiTest { private final TransactionBatchesApi api = new TransactionBatchesApi(); + /** + * Filters batch response. + * + * Filters batch response. + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getTransactionBatchDetailsTest() throws ApiException { + String transactionBatchId = null; + LocalDate uploadDate = null; + String status = null; + api.getTransactionBatchDetails(transactionBatchId, uploadDate, status); + + // TODO: test validations + } + /** * Get individual batch file * diff --git a/src/test/java/Api/TransactionDetailsApiTest.java b/src/test/java/Api/TransactionDetailsApiTest.java index f9fcfbbf8..d191a352a 100644 --- a/src/test/java/Api/TransactionDetailsApiTest.java +++ b/src/test/java/Api/TransactionDetailsApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * diff --git a/src/test/java/Api/UserManagementApiTest.java b/src/test/java/Api/UserManagementApiTest.java index b958f4c65..468b9c745 100644 --- a/src/test/java/Api/UserManagementApiTest.java +++ b/src/test/java/Api/UserManagementApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,8 +14,8 @@ package Api; import Invokers.ApiException; +import Model.PtsV2PaymentsRefundPost400Response; import Model.UmsV1UsersGet200Response; -import Model.UmsV1UsersGet400Response; import org.junit.Test; import org.junit.Ignore; diff --git a/src/test/java/Api/VoidApiTest.java b/src/test/java/Api/VoidApiTest.java index cec6e9c44..a8e7f9b35 100644 --- a/src/test/java/Api/VoidApiTest.java +++ b/src/test/java/Api/VoidApiTest.java @@ -1,6 +1,6 @@ /* - * CyberSource Flex API - * Simple PAN tokenization service + * CyberSource Merged Spec + * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html * * OpenAPI spec version: 0.0.1 * @@ -14,6 +14,7 @@ package Api; import Invokers.ApiException; +import Model.MitVoidRequest; import Model.PtsV2PaymentsPost502Response; import Model.PtsV2PaymentsVoidsPost201Response; import Model.PtsV2PaymentsVoidsPost400Response; @@ -38,6 +39,22 @@ public class VoidApiTest { private final VoidApi api = new VoidApi(); + /** + * Merchant Initiated Void + * + * This is to void a previous payment, capture, refund, or credit that merchant does not receive a reply. + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void mitVoidTest() throws ApiException { + MitVoidRequest mitVoidRequest = null; + PtsV2PaymentsVoidsPost201Response response = api.mitVoid(mitVoidRequest); + + // TODO: test validations + } + /** * Void a Capture *