diff --git a/docs/ConversionDetailsApi.md b/docs/ConversionDetailsApi.md index 1c5dd8292..a47350894 100644 --- a/docs/ConversionDetailsApi.md +++ b/docs/ConversionDetailsApi.md @@ -54,5 +54,5 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json + - **Accept**: application/hal+json, application/xml diff --git a/docs/CreateInstrumentIdentifierRequest.md b/docs/CreateInstrumentIdentifierRequest.md index 3067fb0af..257e7b58e 100644 --- a/docs/CreateInstrumentIdentifierRequest.md +++ b/docs/CreateInstrumentIdentifierRequest.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **String** | Type of Card | [optional] **card** | [**Tmsv1instrumentidentifiersCard**](Tmsv1instrumentidentifiersCard.md) | | [optional] +**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional] **billTo** | [**Tmsv1instrumentidentifiersBillTo**](Tmsv1instrumentidentifiersBillTo.md) | | [optional] diff --git a/docs/DownloadDTDApi.md b/docs/DownloadDTDApi.md new file mode 100644 index 000000000..21f5bb9cf --- /dev/null +++ b/docs/DownloadDTDApi.md @@ -0,0 +1,53 @@ +# DownloadDTDApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getDTDV2**](DownloadDTDApi.md#getDTDV2) | **GET** /dtds/{reportDefinitionNameVersion} | Used to download DTDs for reports + + + +# **getDTDV2** +> getDTDV2(reportDefinitionNameVersion) + +Used to download DTDs for reports + +Downloads DTDs for reports on no-auth. + +### Example +```java +// Import classes: +//import Invokers.ApiException; +//import Api.DownloadDTDApi; + + +DownloadDTDApi apiInstance = new DownloadDTDApi(); +String reportDefinitionNameVersion = "reportDefinitionNameVersion_example"; // String | 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 +try { + apiInstance.getDTDV2(reportDefinitionNameVersion); +} catch (ApiException e) { + System.err.println("Exception when calling DownloadDTDApi#getDTDV2"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **reportDefinitionNameVersion** | **String**| 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 | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/xml-dtd + diff --git a/docs/DownloadXSDApi.md b/docs/DownloadXSDApi.md new file mode 100644 index 000000000..2f2803704 --- /dev/null +++ b/docs/DownloadXSDApi.md @@ -0,0 +1,53 @@ +# DownloadXSDApi + +All URIs are relative to *https://apitest.cybersource.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**getXSDV2**](DownloadXSDApi.md#getXSDV2) | **GET** /xsds/{reportDefinitionNameVersion} | Used to download XSDs for reports + + + +# **getXSDV2** +> getXSDV2(reportDefinitionNameVersion) + +Used to download XSDs for reports + +Downloads XSDs for reports on no-auth. + +### Example +```java +// Import classes: +//import Invokers.ApiException; +//import Api.DownloadXSDApi; + + +DownloadXSDApi apiInstance = new DownloadXSDApi(); +String reportDefinitionNameVersion = "reportDefinitionNameVersion_example"; // String | 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 +try { + apiInstance.getXSDV2(reportDefinitionNameVersion); +} catch (ApiException e) { + System.err.println("Exception when calling DownloadXSDApi#getXSDV2"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **reportDefinitionNameVersion** | **String**| 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 | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: text/xml + diff --git a/docs/EmbeddedInstrumentIdentifier.md b/docs/EmbeddedInstrumentIdentifier.md index 545a433aa..e76517d40 100644 --- a/docs/EmbeddedInstrumentIdentifier.md +++ b/docs/EmbeddedInstrumentIdentifier.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**TmsV1InstrumentIdentifiersPost200ResponseLinks**](TmsV1InstrumentIdentifiersPost200ResponseLinks.md) | | [optional] **object** | **String** | 'Describes type of token.' Valid values: - instrumentIdentifier | [optional] -**state** | **String** | 'Current state of the token.' Valid values: - ACTIVE - CLOSED | [optional] +**state** | **String** | 'Current state of the token.' Valid values: - ACTIVE - CLOSED | [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] +**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional] **processingInformation** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md) | | [optional] **metadata** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional] diff --git a/docs/Error.md b/docs/Error.md index 6282eb97d..7eb4d21bf 100644 --- a/docs/Error.md +++ b/docs/Error.md @@ -4,9 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **String** | | [optional] -**message** | **String** | The detailed message related to the type stated above. | [optional] -**details** | [**Tmsv1instrumentidentifiersDetails**](Tmsv1instrumentidentifiersDetails.md) | | [optional] +**responseStatus** | [**InlineResponseDefaultResponseStatus**](InlineResponseDefaultResponseStatus.md) | | [optional] +**links** | [**ErrorLinks**](ErrorLinks.md) | | [optional] diff --git a/docs/ErrorBean.md b/docs/ErrorBean.md index a203ec024..d54ce4b3c 100644 --- a/docs/ErrorBean.md +++ b/docs/ErrorBean.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **localizationKey** | **String** | Localization Key Name | [optional] **correlationId** | **String** | Correlation Id | [optional] **detail** | **String** | Error Detail | [optional] -**fields** | [**List<InlineResponse400Fields>**](InlineResponse400Fields.md) | Error fields List | [optional] +**fields** | [**List<InlineResponse4001Fields>**](InlineResponse4001Fields.md) | Error fields List | [optional] diff --git a/docs/ErrorLinks.md b/docs/ErrorLinks.md index 1f330be8b..7f0007872 100644 --- a/docs/ErrorLinks.md +++ b/docs/ErrorLinks.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**next** | [**List<InlineResponseDefaultLinksNext>**](InlineResponseDefaultLinksNext.md) | | [optional] -**documentation** | [**List<InlineResponseDefaultLinksNext>**](InlineResponseDefaultLinksNext.md) | | [optional] **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 index 6cc153ab5..4769209c9 100644 --- a/docs/ErrorResponse.md +++ b/docs/ErrorResponse.md @@ -4,6 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**responseStatus** | [**InlineResponseDefaultResponseStatus**](InlineResponseDefaultResponseStatus.md) | | [optional] +**links** | [**InlineResponseDefaultLinks**](InlineResponseDefaultLinks.md) | | [optional] diff --git a/docs/InlineResponse400.md b/docs/InlineResponse400.md index c9cd4f410..3c2c07c3a 100644 --- a/docs/InlineResponse400.md +++ b/docs/InlineResponse400.md @@ -4,12 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**code** | **String** | Error code | -**message** | **String** | Error message | -**localizationKey** | **String** | Localization Key Name | [optional] -**correlationId** | **String** | Correlation Id | [optional] -**detail** | **String** | Error Detail | [optional] -**fields** | [**List<InlineResponse400Fields>**](InlineResponse400Fields.md) | Error fields List | [optional] +**type** | **String** | | [optional] +**message** | **String** | The detailed message related to the type stated above. | [optional] +**details** | [**Tmsv1instrumentidentifiersDetails**](Tmsv1instrumentidentifiersDetails.md) | | [optional] diff --git a/docs/InlineResponse4001.md b/docs/InlineResponse4001.md index 2c2432566..a3e001d74 100644 --- a/docs/InlineResponse4001.md +++ b/docs/InlineResponse4001.md @@ -4,9 +4,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **String** | | [optional] -**message** | **String** | The detailed message related to the type stated above. | [optional] -**details** | [**Tmsv1instrumentidentifiersDetails**](Tmsv1instrumentidentifiersDetails.md) | | [optional] +**code** | **String** | Error code | +**message** | **String** | Error message | +**localizationKey** | **String** | Localization Key Name | [optional] +**correlationId** | **String** | Correlation Id | [optional] +**detail** | **String** | Error Detail | [optional] +**fields** | [**List<InlineResponse4001Fields>**](InlineResponse4001Fields.md) | Error fields List | [optional] diff --git a/docs/InlineResponse400Fields.md b/docs/InlineResponse4001Fields.md similarity index 92% rename from docs/InlineResponse400Fields.md rename to docs/InlineResponse4001Fields.md index a98ab40cf..5f02c8fe3 100644 --- a/docs/InlineResponse400Fields.md +++ b/docs/InlineResponse4001Fields.md @@ -1,5 +1,5 @@ -# InlineResponse400Fields +# InlineResponse4001Fields ## Properties Name | Type | Description | Notes diff --git a/docs/InstrumentIdentifier.md b/docs/InstrumentIdentifier.md index 3b0454832..bfc03dbc2 100644 --- a/docs/InstrumentIdentifier.md +++ b/docs/InstrumentIdentifier.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **object** | **String** | 'Describes type of token.' Valid values: - instrumentIdentifier | [optional] **state** | **String** | 'Current state of the token.' Valid values: - ACTIVE - CLOSED | [optional] **card** | [**TmsV1InstrumentIdentifiersPost200ResponseCard**](TmsV1InstrumentIdentifiersPost200ResponseCard.md) | | [optional] -**bankAccount** | [**TmsV1InstrumentIdentifiersPost200ResponseBankAccount**](TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md) | | [optional] +**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional] **processingInformation** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md) | | [optional] **metadata** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional] diff --git a/docs/InstrumentIdentifierEnrollableCard.md b/docs/InstrumentIdentifierEnrollableCard.md index cff19adc0..6ad7d9716 100644 --- a/docs/InstrumentIdentifierEnrollableCard.md +++ b/docs/InstrumentIdentifierEnrollableCard.md @@ -6,6 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **String** | Type of Card | [optional] **card** | [**Tmsv1instrumentidentifiersCard**](Tmsv1instrumentidentifiersCard.md) | | [optional] +**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional] **billTo** | [**Tmsv1instrumentidentifiersBillTo**](Tmsv1instrumentidentifiersBillTo.md) | | [optional] diff --git a/docs/Link.md b/docs/Link.md index 669695a80..7c58c99ad 100644 --- a/docs/Link.md +++ b/docs/Link.md @@ -4,7 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**href** | **String** | | [optional] +**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 index ceffb7765..94fb8223f 100644 --- a/docs/Links.md +++ b/docs/Links.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**self** | [**TmsV1InstrumentIdentifiersPost200ResponseLinksSelf**](TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.md) | | [optional] -**ancestor** | [**TmsV1InstrumentIdentifiersPost200ResponseLinksSelf**](TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.md) | | [optional] -**successor** | [**TmsV1InstrumentIdentifiersPost200ResponseLinksSelf**](TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.md) | | [optional] +**self** | [**InlineResponseDefaultLinksNext**](InlineResponseDefaultLinksNext.md) | | [optional] +**documentation** | [**List<InlineResponseDefaultLinksNext>**](InlineResponseDefaultLinksNext.md) | | [optional] +**next** | [**List<InlineResponseDefaultLinksNext>**](InlineResponseDefaultLinksNext.md) | | [optional] diff --git a/docs/NetFundingsApi.md b/docs/NetFundingsApi.md index 591e38a8e..10e989f12 100644 --- a/docs/NetFundingsApi.md +++ b/docs/NetFundingsApi.md @@ -56,5 +56,5 @@ No authorization required ### HTTP request headers - **Content-Type**: application/json;charset=utf-8 - - **Accept**: application/hal+json + - **Accept**: application/hal+json, application/xml diff --git a/docs/PaymentBatchSummariesApi.md b/docs/PaymentBatchSummariesApi.md new file mode 100644 index 000000000..123e39f25 --- /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** +> ReportingV3PaymentBatchSummariesGet200Response 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.[Rfc Date 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.[Rfc Date 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/all_merchant/selected_merchant. 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 { + ReportingV3PaymentBatchSummariesGet200Response 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.[Rfc Date 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.[Rfc Date 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] + **breakdown** | **String**| Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant. | [optional] + **startDayOfWeek** | **Integer**| Optional - Start day of week to breakdown data for weeks in a month | [optional] + +### Return type + +[**ReportingV3PaymentBatchSummariesGet200Response**](ReportingV3PaymentBatchSummariesGet200Response.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: application/hal+json + diff --git a/docs/PtsV2PaymentsPost201ResponseIssuerInformation.md b/docs/PtsV2PaymentsPost201ResponseIssuerInformation.md index ff1e1a5c0..45ef5c0e3 100644 --- a/docs/PtsV2PaymentsPost201ResponseIssuerInformation.md +++ b/docs/PtsV2PaymentsPost201ResponseIssuerInformation.md @@ -5,7 +5,7 @@ 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. For details, see `auth_card_issuer_country` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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 **Visa Platform Connect**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] **responseCode** | **String** | Additional authorization code that must be printed on the receipt when returned by the processor. This value is generated by the processor and is returned only for a successful transaction. This field is supported only on FDC Nashville Global and SIX. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.md b/docs/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.md index 73fb90053..12e13e758 100644 --- a/docs/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.md +++ b/docs/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.md @@ -5,7 +5,7 @@ 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 Visa Platform Connect. | [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.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details, see `auth_account_balance_currency` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] @@ -13,7 +13,7 @@ Name | Type | Description | Notes **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 or Mastercard product ID that is associated with the primary account number (PAN). For descriptions of the Visa product IDs, see the Product ID table on the [Visa Request & Response Codes web page.](https://developer.visa.com/guides/request_response_codes) Data Length: String (3) #### GPN Visa or Mastercard product ID that is associated with the primary account number (PAN). For descriptions of the Visa product IDs, seepag the Product ID table on the [Visa Request & Response Codes web page.](https://developer.visa.com/guides/request_response_codes) For descriptions of the Mastercard product IDs, see \"Product IDs\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) Data Length: String (3) #### Worldpay VAP **Important** Before using this field on Worldpay VAP, you must contact CyberSource Customer Support to have your account configured for this feature. Type of card used in the transaction. The only possible value is: - `PREPAID`: Prepaid Card Data Length: String (7) #### 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 Data Length: String (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 For details, see `auth_card_commercial` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] -**group** | **String** | Type of commercial card. This field is supported only for Visa Platform Connect. Possible values: - **B**: Business card - **R**: Corporate card - **S**: Purchasing card - **0**: Noncommercial card | [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 For details, see `auth_card_healthcare` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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 For details, see `auth_card_payroll` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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 For details, see `auth_card_level_3_eligible` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.md b/docs/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.md index 1795b0abe..00d900697 100644 --- a/docs/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.md +++ b/docs/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.md @@ -7,10 +7,10 @@ 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. For details, see `token_prefix` field description in [Google Pay Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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. For details, see `token_suffix` field description in [Google Pay Using the SCMP API.] (https://apps.cybersource.com/library/documentation/dev_guides/Google_Pay_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] **type** | **String** | Three-digit value that indicates the card type. 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) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**assuranceLevel** | **String** | Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **Visa Platform Connect** and **FDC Nashville Global**. | [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** | One of two possible meanings: - The two-digit month in which a token expires. - The two-digit month in which a card expires. Format: `MM` Possible values: `01` through `12` **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### 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 (`card_type=039`), if there is no expiration date on the card, use `12`.\\ **Important** It is your responsibility to determine whether a field is required for the transaction you are requesting. #### Samsung Pay and Apple Pay Month in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. 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** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### 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. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### 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. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **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_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [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 **Visa Platform Connect** and **FDC Nashville Global**. | [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/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.md b/docs/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.md index befc6c171..0b194deba 100644 --- a/docs/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.md +++ b/docs/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.md @@ -5,6 +5,8 @@ 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. For details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **Note** The information about EMV applies to credit card processing and PIN debit processing. All other information in this guide applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Note** For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **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, and 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] +**chipValidationType** | **String** | Entity or service that provided the validation results returned in **chipValidationResult**. Possible values: - **02**: MasterCard on-behalf pre-validation service (The MasterCard authorization platform validated the M/Chip cryptogram before the authorization request reached the issuer.) - **03**: MasterCard on-behalf stand-in service (The MasterCard authorization platform validated the M/Chip cryptogram because the issuer was not available.) - **50**: Issuer - **90**: Chip fall-back transaction downgrade process (The chip could not be read.) This field is returned only for NFC payment network tokenization transactions with MasterCard. **Note** No CyberSource through VisaNet acquirers support EMV at this time. | [optional] +**chipValidationResult** | **String** | Cryptogram validation results returned by the entity or service specified in **chipValidationType**. Possible values: - **A**: Application cryptogram is valid, but the application transaction counter (ATC) is outside allowed range. (A large jump in ATC values may indicate data copying or other fraud.) - **C**: Chip validation was completed successfully. - **E**: Application cryptogram is valid but the ATC indicates possible replay fraud. - **F**: Format error in the chip data. - **G**: Application cryptogram is valid but is not a valid authorization request cryptogram (ARQC). - **I**: Application cryptogram is invalid. - **T**: Application cryptogram is valid but terminal verification results (TVR) or card verification results (CVR) are invalid. - **U**: Application cryptogram could not be validated because of a technical error. This field is returned only for NFC payment network tokenization transactions with MasterCard. **Note** No CyberSource through VisaNet acquirers support EMV at this time. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md b/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md index 76ce0cba5..7d83d05fe 100644 --- a/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md +++ b/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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] **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. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### Visa Platform Connect and GPN For details about this value for Visa Platform Connect and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] **networkTransactionId** | **String** | The description for this field is not available. | [optional] **providerTransactionId** | **String** | The description for this field is not available. | [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. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `responseCategoryCode` field. | [optional] @@ -21,14 +21,14 @@ Name | Type | Description | Notes **achVerification** | [**PtsV2PaymentsPost201ResponseProcessorInformationAchVerification**](PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.md) | | [optional] **customer** | [**PtsV2PaymentsPost201ResponseProcessorInformationCustomer**](PtsV2PaymentsPost201ResponseProcessorInformationCustomer.md) | | [optional] **consumerAuthenticationResponse** | [**PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse**](PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse.md) | | [optional] -**systemTraceAuditNumber** | **String** | This field is returned only for **American Express Direct** and **Visa Platform Connect**. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### Visa Platform Connect System trace number that must be printed on the customer’s receipt. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] **paymentAccountReferenceNumber** | **String** | Visa-generated reference number that identifies a card-present transaction for which you provided 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 **Visa Platform Connect**. 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. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file,<sup>1</sup>: - Record: CP01 TCR6 - Position: 136-137 - Field: Mastercard Transaction Integrity Classification <sup>1</sup> The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. Visa Platform Connect creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks. | [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. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file,<sup>1</sup>: - Record: CP01 TCR6 - Position: 136-137 - Field: Mastercard Transaction Integrity Classification <sup>1</sup> 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’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks. | [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 #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for Visa Platform Connect. | [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 **Visa Platform Connect**. | [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. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 132 - Field: Mastercard Member Defined service. **Note** This field is returned only for Visa Platform Connect. | [optional] +**salesSlipNumber** | **Integer** | 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 #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for CyberSource through VisaNet. | [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. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 132 - Field: Mastercard Member Defined service. **Note** This field is returned only for CyberSource through VisaNet. | [optional] **name** | **String** | Name of the Processor. | [optional] **routing** | [**PtsV2PaymentsPost201ResponseProcessorInformationRouting**](PtsV2PaymentsPost201ResponseProcessorInformationRouting.md) | | [optional] **merchantNumber** | **String** | Identifier that was assigned to you by your acquirer. This value must be printed on the receipt. This field is supported only on **American Express Direct**, **FDC Nashville Global**, and **SIX**. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.md b/docs/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.md index ba52bead8..a571a7c60 100644 --- a/docs/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.md +++ b/docs/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.md @@ -14,8 +14,8 @@ Name | Type | Description | Notes **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. For details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] **streetRaw** | **String** | Raw Electronic Verification response code from the processor for the customer’s street address. | [optional] -**name** | **String** | The description for this field is not available. | [optional] -**nameRaw** | **String** | The description for this field is not available. | [optional] +**name** | **String** | Mapped Electronic Verification response code for the customer’s name. | [optional] +**nameRaw** | **String** | Raw Electronic Verification response code from the processor for the customer’s name. | [optional] diff --git a/docs/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md b/docs/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md index 8ee634aa5..1dedba571 100644 --- a/docs/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md +++ b/docs/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md @@ -5,7 +5,7 @@ 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. For processor-specific information, see the `auth_merchant_advice_code` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**codeRaw** | **String** | Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code 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] +**codeRaw** | **String** | Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code 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/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.md b/docs/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.md index b80ad51ac..4ad530001 100644 --- a/docs/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.md +++ b/docs/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.md @@ -8,8 +8,8 @@ Name | Type | Description | Notes **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. #### AIBMS If this value is `08`, you can accept the transaction if the customer provides you with identification. #### Atos This value is the response code sent from Atos and it might also include the response code from the bank. Format: `aa,bb` with the two values separated by a comma and where: - `aa` is the two-digit error message from Atos. - `bb` is the optional two-digit error message from the bank. #### Comercio Latino This value is the status code and the error or response code received from the processor separated by a colon. Format: [status code]:E[error code] or [status code]:R[response code] Example `2:R06` #### JCN Gateway Processor-defined detail error code. The associated response category code is in the `responseCategoryCode` field. | [optional] **responseCategoryCode** | **String** | Processor-defined response category code. The associated detail error code is in the `responseCode` field of the 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 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 #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for Visa Platform Connect. | [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 **Visa Platform Connect**. | [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 #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for CyberSource through VisaNet. | [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/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md b/docs/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md index 012bca295..c87762a8c 100644 --- a/docs/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md +++ b/docs/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. | [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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. | [optional] **currency** | **String** | Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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 payment authorization request. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). | [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/PtsV2PayoutsPost201ResponseProcessorInformation.md b/docs/PtsV2PayoutsPost201ResponseProcessorInformation.md index 0b9499d80..4b1b8b02e 100644 --- a/docs/PtsV2PayoutsPost201ResponseProcessorInformation.md +++ b/docs/PtsV2PayoutsPost201ResponseProcessorInformation.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes **approvalCode** | **String** | Issuer-generated approval code for the transaction. | [optional] **responseCode** | **String** | Transaction status from the processor. | [optional] **transactionId** | **String** | Network transaction identifier (TID). This value can be used to identify a specific transaction when you are discussing the transaction with your processor. | [optional] -**systemTraceAuditNumber** | **String** | This field is returned only for **American Express Direct** and **Visa Platform Connect**. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### Visa Platform Connect System trace number that must be printed on the customer’s receipt. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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/Ptsv2creditsPointOfSaleInformationEmv.md b/docs/Ptsv2creditsPointOfSaleInformationEmv.md index 9117a8baf..7422f779f 100644 --- a/docs/Ptsv2creditsPointOfSaleInformationEmv.md +++ b/docs/Ptsv2creditsPointOfSaleInformationEmv.md @@ -6,7 +6,7 @@ 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. For details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **Note** The information about EMV applies to credit card processing and PIN debit processing. All other information in this guide applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Note** For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **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, and 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 pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed. Possible values: - **true** - **false** (default) 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**. **NOTE**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card. For details, see the `emv_request_fallback_condition` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] +**fallbackCondition** | **Integer** | 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**. **NOTE**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card. For details, see the `emv_request_fallback_condition` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] diff --git a/docs/Ptsv2creditsProcessingInformation.md b/docs/Ptsv2creditsProcessingInformation.md index 2ddc4d225..51f0626e6 100644 --- a/docs/Ptsv2creditsProcessingInformation.md +++ b/docs/Ptsv2creditsProcessingInformation.md @@ -12,6 +12,7 @@ Name | Type | Description | Notes **reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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. For details, see the `vc_order_id` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] **purchaseLevel** | **String** | Set this field to 3 to indicate that the request includes Level III data. | [optional] +**industryDataType** | **String** | Flag that indicates that the transaction includes airline data or restaurant data. This field must be set to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to restaurant or is not included in the request, CyberSource does not send restaurant data to the processor. Possible Values: - **airline** - **restaurant** | [optional] **recurringOptions** | [**Ptsv2paymentsidrefundsProcessingInformationRecurringOptions**](Ptsv2paymentsidrefundsProcessingInformationRecurringOptions.md) | | [optional] **bankTransferOptions** | [**Ptsv2creditsProcessingInformationBankTransferOptions**](Ptsv2creditsProcessingInformationBankTransferOptions.md) | | [optional] diff --git a/docs/Ptsv2paymentsAggregatorInformation.md b/docs/Ptsv2paymentsAggregatorInformation.md index 029deefbe..0ae88ce90 100644 --- a/docs/Ptsv2paymentsAggregatorInformation.md +++ b/docs/Ptsv2paymentsAggregatorInformation.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. 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. **American Express Direct**\\ 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.\\ #### Visa Platform Connect With 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. **FDC Compass**\\ This value must consist of uppercase characters. 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] +**aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. 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. **American Express Direct**\\ 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.\\ #### CyberSource through VisaNet With 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. **FDC Compass**\\ This value must consist of uppercase characters. 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** | [**Ptsv2paymentsAggregatorInformationSubMerchant**](Ptsv2paymentsAggregatorInformationSubMerchant.md) | | [optional] diff --git a/docs/Ptsv2paymentsAggregatorInformationSubMerchant.md b/docs/Ptsv2paymentsAggregatorInformationSubMerchant.md index 17f60b1f3..f399d1f9e 100644 --- a/docs/Ptsv2paymentsAggregatorInformationSubMerchant.md +++ b/docs/Ptsv2paymentsAggregatorInformationSubMerchant.md @@ -5,15 +5,15 @@ 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. #### American Express Direct 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. #### Visa Platform Connect With 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. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. | [optional] -**address1** | **String** | First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**locality** | **String** | Sub-merchant’s city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**administrativeArea** | **String** | Sub-merchant’s state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**name** | **String** | Sub-merchant’s business name. #### American Express Direct 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. #### CyberSource through VisaNet With 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. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. | [optional] +**address1** | **String** | First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**locality** | **String** | Sub-merchant’s city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**administrativeArea** | **String** | Sub-merchant’s state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] **region** | **String** | Sub-merchant’s region. **Example**\\ `NE` indicates that the sub-merchant is in the northeast region. For processor-specific details, see `submerchant_region` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] -**postalCode** | **String** | Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**country** | **String** | Sub-merchant’s country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. See \"Aggregator Support,\" page 101. | [optional] -**email** | **String** | Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - Visa Platform Connect: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### Visa Platform Connect With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. Visa Platform Connect creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] -**phoneNumber** | **String** | Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - Visa Platform Connect: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### Visa Platform Connect With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` | [optional] +**postalCode** | **String** | Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**country** | **String** | Sub-merchant’s country. Use the two-character ISO Standard Country Codes. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. See \"Aggregator Support,\" page 101. | [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 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **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’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [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 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` | [optional] diff --git a/docs/Ptsv2paymentsBuyerInformationPersonalIdentification.md b/docs/Ptsv2paymentsBuyerInformationPersonalIdentification.md index e7e00b7ac..bb3093220 100644 --- a/docs/Ptsv2paymentsBuyerInformationPersonalIdentification.md +++ b/docs/Ptsv2paymentsBuyerInformationPersonalIdentification.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **String** | 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. | [optional] +**type** | **String** | 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. 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] **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** | The government agency that issued the driver's license or passport. If **type**` = DRIVER_LICENSE`, this is the State or province where the customer’s driver’s license was issued. If **type**` = PASSPORT`, this is the Issuing country for the cardholder’s passport. Recommended for Discover ProtectBuy. 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. For details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API] (https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] diff --git a/docs/Ptsv2paymentsIssuerInformation.md b/docs/Ptsv2paymentsIssuerInformation.md index 05787aa78..b6184ad90 100644 --- a/docs/Ptsv2paymentsIssuerInformation.md +++ b/docs/Ptsv2paymentsIssuerInformation.md @@ -4,7 +4,7 @@ ## 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 **Visa Platform Connect**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] diff --git a/docs/Ptsv2paymentsMerchantDefinedInformation.md b/docs/Ptsv2paymentsMerchantDefinedInformation.md index 0a3bfa653..b009267f2 100644 --- a/docs/Ptsv2paymentsMerchantDefinedInformation.md +++ b/docs/Ptsv2paymentsMerchantDefinedInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**key** | **String** | The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### Visa Platform Connect For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. For details, see \"Installment Payments on Visa Platform Connect\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] +**key** | **String** | The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. For details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] **value** | **String** | The value you assign for your merchant-defined data field. For details, see `merchant_defined_data1` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **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. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and `merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the transaction. For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For details, see \"Installment Payments on CyberSource through VisaNet\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) For installment payments with Mastercard in Brazil: - The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 25-44 - Field: Reference Field 2 - The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR5 - Position: 45-64 - Field: Reference Field 3 | [optional] diff --git a/docs/Ptsv2paymentsMerchantInformation.md b/docs/Ptsv2paymentsMerchantInformation.md index 4318e5c2f..1966959fe 100644 --- a/docs/Ptsv2paymentsMerchantInformation.md +++ b/docs/Ptsv2paymentsMerchantInformation.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **merchantDescriptor** | [**Ptsv2paymentsMerchantInformationMerchantDescriptor**](Ptsv2paymentsMerchantInformationMerchantDescriptor.md) | | [optional] -**salesOrganizationId** | **String** | Company ID assigned to an independent sales organization. Get this value from Mastercard. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Mastercard Independent Sales Organization ID **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. Visa Platform Connect creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the `sales_organization_ID` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**salesOrganizationId** | **String** | Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Mastercard Independent Sales Organization ID **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’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the `sales_organization_ID` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] **categoryCode** | **Integer** | The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards. When 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### 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] **categoryCodeDomestic** | **Integer** | Merchant category code for domestic transactions. The value for this field is a four-digit number that the payment card industry uses to classify merchants into market segments. A payment card company assigned one or more of these values to your business when you started accepting the payment card company’s cards. Including this field in a request for a domestic transaction might reduce interchange fees. When you include this field in a request: - Do not include the `merchant_category_code` field. - The value for this field overrides the value in your CyberSource account. This field is supported only for: - Domestic transactions with Mastercard in Spain. Domestic means that you and the cardholder are in the same country. - Merchants enrolled in the OmniPay Direct interchange program. - First Data Merchant Solutions (Europe) on OmniPay Direct. | [optional] **taxId** | **String** | Your Cadastro Nacional da Pessoa Jurídica (CNPJ) number. This field is supported only for BNDES transactions on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR6 - Position: 40-59 - Field: BNDES Reference Field 1 For details, see `bill_merchant_tax_id` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] diff --git a/docs/Ptsv2paymentsOrderInformationAmountDetails.md b/docs/Ptsv2paymentsOrderInformationAmountDetails.md index bec874e11..e61a4f953 100644 --- a/docs/Ptsv2paymentsOrderInformationAmountDetails.md +++ b/docs/Ptsv2paymentsOrderInformationAmountDetails.md @@ -4,10 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. | [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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. | [optional] **currency** | **String** | Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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 payment authorization request. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). | [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] +**gratuityAmount** | **String** | Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. For information about partial authorizations, see Credit Card Services Using the SCMP API. Restaurant data is supported only on CyberSource through VisaNet. | [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] diff --git a/docs/Ptsv2paymentsOrderInformationAmountDetailsSurcharge.md b/docs/Ptsv2paymentsOrderInformationAmountDetailsSurcharge.md index 8fda3b835..7c920cedd 100644 --- a/docs/Ptsv2paymentsOrderInformationAmountDetailsSurcharge.md +++ b/docs/Ptsv2paymentsOrderInformationAmountDetailsSurcharge.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. 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 Visa Platform Connect (VPC) 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] +**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] **description** | **String** | Merchant-defined field for describing the surcharge amount. | [optional] diff --git a/docs/Ptsv2paymentsOrderInformationBillTo.md b/docs/Ptsv2paymentsOrderInformationBillTo.md index e84a9b462..7827e8c55 100644 --- a/docs/Ptsv2paymentsOrderInformationBillTo.md +++ b/docs/Ptsv2paymentsOrderInformationBillTo.md @@ -9,19 +9,19 @@ Name | Type | Description | Notes **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. **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 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** | Payment card 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, Visa Platform Connect 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. **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` request-level field description 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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. #### 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 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** | Payment card 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. **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` request-level field description 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] **address3** | **String** | Additional address information (third line of the billing address) | [optional] **address4** | **String** | Additional address information (fourth line of the billing address) | [optional] -**locality** | **String** | Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**locality** | **String** | Payment card billing city. #### 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 description 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. **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 description 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` **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**country** | **String** | Payment card billing country. 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. **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 description 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. For example, if the street address is: Rua da Quitanda 187 then the building number is 187. 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. #### 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. **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` request-level field description 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. | [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** | **String** | 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/Ptsv2paymentsOrderInformationInvoiceDetails.md b/docs/Ptsv2paymentsOrderInformationInvoiceDetails.md index d321e2b96..23edd0c51 100644 --- a/docs/Ptsv2paymentsOrderInformationInvoiceDetails.md +++ b/docs/Ptsv2paymentsOrderInformationInvoiceDetails.md @@ -13,7 +13,7 @@ Name | Type | Description | Notes **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) Possible values: - **true** - **false** | [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] +**merchandiseCode** | **Integer** | Identifier for the merchandise. Possible value: - 1000: Gift card This field is supported only for **American Express Direct**. | [optional] **transactionAdviceAddendum** | [**List<Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum>**](Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.md) | | [optional] **referenceDataCode** | **String** | Code that identifies the value of the `referenceDataNumber` field. For the possible values, see \"Reference Data Codes\" in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. | [optional] **referenceDataNumber** | **String** | Reference number. The meaning of this value is identified by the value of the `referenceDataCode` field. 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. | [optional] diff --git a/docs/Ptsv2paymentsPaymentInformationCard.md b/docs/Ptsv2paymentsPaymentInformationCard.md index 56c6a0272..6bbe20180 100644 --- a/docs/Ptsv2paymentsPaymentInformationCard.md +++ b/docs/Ptsv2paymentsPaymentInformationCard.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **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. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### 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. **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_cc_expyr` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] **type** | **String** | Three-digit value that indicates the card type. 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) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [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. **Note** The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 51 - Field: Combination Card Transaction Identifier This field is supported only for Mastercard transactions in Brazil 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] +**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 CyberSource through VisaNet (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 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] **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_ field in the request. - 1 (default): CVN service requested and supported. CyberSource uses this default value when you include _securityCode_ field 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] diff --git a/docs/Ptsv2paymentsPaymentInformationFluidData.md b/docs/Ptsv2paymentsPaymentInformationFluidData.md index 6206f9ffc..17982abcc 100644 --- a/docs/Ptsv2paymentsPaymentInformationFluidData.md +++ b/docs/Ptsv2paymentsPaymentInformationFluidData.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**key** | **String** | The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html) | [optional] +**keySerialNumber** | **String** | The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html) | [optional] **descriptor** | **String** | The identifier for a payment solution, which is sending the encrypted payment data to CyberSource for decryption. Valid values: - Samsung Pay: `RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ=` **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. For details about the list of payment solution identifiers, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html). For details about the encrypted payment data, see the `encrypted_payment_descriptor` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). | [optional] **value** | **String** | Represents the encrypted payment data BLOB. The entry for this field is dependent on the payment solution a merchant uses. For details, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html) for the specific payment- solution entry. | [optional] **encoding** | **String** | Encoding method used to encrypt the payment data. Valid value: Base64 | [optional] diff --git a/docs/Ptsv2paymentsPaymentInformationTokenizedCard.md b/docs/Ptsv2paymentsPaymentInformationTokenizedCard.md index 2d25b239d..c539b674d 100644 --- a/docs/Ptsv2paymentsPaymentInformationTokenizedCard.md +++ b/docs/Ptsv2paymentsPaymentInformationTokenizedCard.md @@ -9,9 +9,9 @@ Name | Type | Description | Notes **expirationYear** | **String** | One of two possible meanings: - The four-digit year in which a token expires. - The four-digit year in which a card expires. Format: `YYYY` Possible values: `1900` through `3000` Data type: Non-negative integer **NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below. #### 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. #### Encoded Account Numbers For encoded account numbers (`card_ type=039`), if there is no expiration date on the card, use `2021`. #### 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. #### Samsung Pay and Apple Pay Year in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction. **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_cc_expyr` or `token_expiration_year` 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** | Three-digit value that indicates the card type. 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) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [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 **Visa Platform Connect** and **FDC Nashville Global**. | [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 **Visa Platform Connect** and **FDC Nashville Global**. | [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** | Card Verification Number (CVN). #### Ingenico ePayments Do not include this field when **commerceIndicator=recurring**. **Note** Ingenico ePayments was previously called _Global Collect_. For details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] diff --git a/docs/Ptsv2paymentsPointOfSaleInformationEmv.md b/docs/Ptsv2paymentsPointOfSaleInformationEmv.md index 5c6c0452d..27769da91 100644 --- a/docs/Ptsv2paymentsPointOfSaleInformationEmv.md +++ b/docs/Ptsv2paymentsPointOfSaleInformationEmv.md @@ -5,10 +5,10 @@ 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. For details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **Note** The information about EMV applies to credit card processing and PIN debit processing. All other information in this guide applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Note** For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **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, and 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] -**cardholderVerificationMethodUsed** | [**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] +**cardholderVerificationMethodUsed** | **Integer** | 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. For details, see `emv_request_card_sequence_number` field description in the [Card-Present Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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 pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed. Possible values: - **true** - **false** (default) 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**. **NOTE**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card. For details, see the `emv_request_fallback_condition` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] +**fallbackCondition** | **Integer** | 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**. **NOTE**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card. For details, see the `emv_request_fallback_condition` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformation.md b/docs/Ptsv2paymentsProcessingInformation.md index 9e5550622..931ddd897 100644 --- a/docs/Ptsv2paymentsProcessingInformation.md +++ b/docs/Ptsv2paymentsProcessingInformation.md @@ -14,6 +14,7 @@ Name | Type | Description | Notes **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 **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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. For details, see the `vc_order_id` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] +**industryDataType** | **String** | Flag that indicates that the transaction includes airline data or restaurant data. This field must be set to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to restaurant or is not included in the request, CyberSource does not send restaurant data to the processor. Possible Values: - **airline** - **restaurant** | [optional] **authorizationOptions** | [**Ptsv2paymentsProcessingInformationAuthorizationOptions**](Ptsv2paymentsProcessingInformationAuthorizationOptions.md) | | [optional] **captureOptions** | [**Ptsv2paymentsProcessingInformationCaptureOptions**](Ptsv2paymentsProcessingInformationCaptureOptions.md) | | [optional] **recurringOptions** | [**Ptsv2paymentsProcessingInformationRecurringOptions**](Ptsv2paymentsProcessingInformationRecurringOptions.md) | | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md index e5c306f95..05e0d67ae 100644 --- a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md +++ b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md @@ -7,15 +7,15 @@ 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. #### 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 the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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\" in [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). #### 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\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html). 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 description 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). #### FDMS South This field is required for verbal authorizations and forced captures with the American Express card type to comply with the CAPN requirements: - Forced capture: Obtain the value for this field from the authorization response. - Verbal authorization: You cannot obtain a value for this field so CyberSource uses the default value of `000000000000000` (15 zeros). For more information about using this default value, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] -**authIndicator** | **String** | Flag that specifies the purpose of the authorization. Possible values: - **0**: Preauthorization - **1**: Final authorization To set the default for this field, contact CyberSource Customer Support. For details, see \"Final Authorization Indicator\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). #### Barclays and Elavon The default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support. #### Visa Platform Connect When the value for this field is 0, it corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators When the value for this field is 1, it does not correspond to any data in the TC 33 capture file. 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) #### Visa Platform Connect To set the default for this field, contact CyberSource Customer Support. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators Possible values: - **true** Enable the transaction for partial authorization. - **false** Do not enable the transaction for partial authorization. | [optional] +**authIndicator** | **String** | Flag that specifies the purpose of the authorization. Possible values: - **0**: Preauthorization - **1**: Final authorization To set the default for this field, contact CyberSource Customer Support. For details, see \"Final Authorization Indicator\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). #### Barclays and Elavon The default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support. #### CyberSource through VisaNet When the value for this field is 0, it corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators When the value for this field is 1, it does not correspond to any data in the TC 33 capture file. 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) #### CyberSource through VisaNet To set the default for this field, contact CyberSource Customer Support. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators Possible values: - **true** Enable the transaction for partial authorization. - **false** Do not enable the transaction for partial authorization. | [optional] **balanceInquiry** | **Boolean** | Flag that indicates whether to return balance information. Possible values: - **true** - **false** | [optional] **ignoreAvsResult** | **Boolean** | Flag that indicates whether to allow the capture service to run, even when the payment receives an AVS decline. Possible values: - **true** Ignore the results of AVS checking and run the capture service. - **false** (default): If the authorization receives an AVS decline, do not run the capture service. | [optional] -**declineAvsFlags** | **List<String>** | Comma-separated list of AVS flags that cause the reply flag `DAVSNO` to be returned. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the comma-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **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 section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For Visa Platform Connect, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type.<br/><br/> _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer's payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member’s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member’s name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member’s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member’s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member’s name, street address, and postal code do not match.| |O|Partial match: card member’s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member’s name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member’s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| | [optional] +**declineAvsFlags** | **List<String>** | Comma-separated list of AVS flags that cause the reply flag `DAVSNO` to be returned. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the comma-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **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 section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For CyberSource through VisaNet, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type.<br/><br/> _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer's payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member’s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member’s name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member’s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member’s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member’s name, street address, and postal code do not match.| |O|Partial match: card member’s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member’s name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member’s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| | [optional] **ignoreCvResult** | **Boolean** | Flag that indicates whether to allow the capture service to run even when the payment receives a CVN decline. Possible values: - **true** Ignore the results of CVN checking and run the capture service. - **false** (default) If the authorization receives a CVN decline, do not run the capture service. | [optional] **initiator** | [**Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator**](Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md) | | [optional] **billPayment** | **Boolean** | Flag that indicates that this is a payment for a bill or for an existing contractual loan. For processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) Possible values: - `true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. | [optional] -**billPaymentType** | **String** | Reason for the payment. Possible values: - 001: Utility payment - 002: Government services - 003: Mobile phone top-up - 004: Coupon payment The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 48-50 - Field: Bill Payment Transaction Type Identifier This field is supported only for bill payments in Brazil with Mastercard on Visa Platform Connect. **Note** For details about Mastercard bill payments or bill payments with Visa, see `bill_payment_type` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] +**billPaymentType** | **String** | Reason for the payment. Possible values: - 001: Utility payment - 002: Government services - 003: Mobile phone top-up - 004: Coupon payment The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 48-50 - Field: Bill Payment Transaction Type Identifier This field is supported only for bill payments in Brazil with Mastercard on CyberSource through VisaNet. **Note** For details about Mastercard bill payments or bill payments with Visa, see `bill_payment_type` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md index 1e699ebe2..adc47e08f 100644 --- a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md +++ b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **String** | This field indicates whether the transaction is a merchant-initiated transaction or customer-initiated transaction. Valid values: - **customer** - **merchant** | [optional] -**credentialStoredOnFile** | **Boolean** | Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder’s credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant’s file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. For details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on Visa Platform Connect. | [optional] +**credentialStoredOnFile** | **Boolean** | Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder’s credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant’s file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. For details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. | [optional] **storedCredentialUsed** | **Boolean** | Indicates to an issuing bank whether a merchant-initiated transaction came from a card that was already stored on file. Possible values: - **true** means the merchant-initiated transaction came from a card that was already stored on file. - **false** means the merchant-initiated transaction came from a card that was not stored on file. | [optional] **merchantInitiatedTransaction** | [**Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction**](Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md) | | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md index 17c63ff2b..0f88ff34d 100644 --- a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md +++ b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md @@ -4,8 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**reason** | **String** | Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] -**previousTransactionId** | **String** | Network 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. 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. **NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on Visa Platform Connect. | [optional] +**reason** | **String** | Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] +**previousTransactionId** | **String** | Network 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. 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. **NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. | [optional] +**originalAuthorizedAmount** | **String** | Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. See \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformationBankTransferOptions.md b/docs/Ptsv2paymentsProcessingInformationBankTransferOptions.md index 0f3566283..4590aaf00 100644 --- a/docs/Ptsv2paymentsProcessingInformationBankTransferOptions.md +++ b/docs/Ptsv2paymentsProcessingInformationBankTransferOptions.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**declineAvsFlags** | **String** | Space-separated list of AVS flags that cause the request to be declined for AVS reasons. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the space-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **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 section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For Visa Platform Connect, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type. _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer’s payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member’s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member’s name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member’s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member’s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member’s name, street address, and postal code do not match.| |O|Partial match: card member’s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member’s name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member’s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| | [optional] +**declineAvsFlags** | **String** | Space-separated list of AVS flags that cause the request to be declined for AVS reasons. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the space-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **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 section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For CyberSource through VisaNet, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type. _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer’s payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member’s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member’s name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member’s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member’s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member’s name, street address, and postal code do not match.| |O|Partial match: card member’s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member’s name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member’s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| | [optional] **secCode** | **String** | Specifies the authorization method for the transaction. #### TeleCheck Accepts only the following values: - `ARC`: account receivable conversion - `CCD`: corporate cash disbursement - `POP`: point of purchase conversion - `PPD`: prearranged payment and deposit entry - `TEL`: telephone-initiated entry - `WEB`: internet-initiated entry For details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] **terminalCity** | **String** | City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters. | [optional] **terminalState** | **String** | State in which the terminal is located. If more than two alphanumeric characters are submitted, the transaction will be declined. You cannot include any special characters. | [optional] diff --git a/docs/Ptsv2paymentsProcessingInformationCaptureOptions.md b/docs/Ptsv2paymentsProcessingInformationCaptureOptions.md index fce1e3f53..c63aa29fb 100644 --- a/docs/Ptsv2paymentsProcessingInformationCaptureOptions.md +++ b/docs/Ptsv2paymentsProcessingInformationCaptureOptions.md @@ -4,9 +4,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**captureSequenceNumber** | [**BigDecimal**](BigDecimal.md) | Capture number when requesting multiple partial captures for one authorization. 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` field 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] -**dateToCapture** | **String** | Date on which you want the capture to occur. This field is supported only for Visa Platform Connect.\\ `Format: MMDD` | [optional] +**captureSequenceNumber** | **Integer** | Capture number when requesting multiple partial captures for one authorization. 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** | **Integer** | Total number of captures when requesting multiple partial captures for one payment. Used along with `captureSequenceNumber` field 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] +**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/Ptsv2paymentsidcapturesAggregatorInformation.md b/docs/Ptsv2paymentsidcapturesAggregatorInformation.md index ded0ad12f..93eaf6075 100644 --- a/docs/Ptsv2paymentsidcapturesAggregatorInformation.md +++ b/docs/Ptsv2paymentsidcapturesAggregatorInformation.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. 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. **American Express Direct**\\ 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.\\ #### Visa Platform Connect With 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. **FDC Compass**\\ This value must consist of uppercase characters. 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] +**aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. 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. **American Express Direct**\\ 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.\\ #### CyberSource through VisaNet With 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. **FDC Compass**\\ This value must consist of uppercase characters. 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** | [**Ptsv2paymentsidcapturesAggregatorInformationSubMerchant**](Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.md) | | [optional] diff --git a/docs/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.md b/docs/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.md index 570f1e8f2..bb60a8d36 100644 --- a/docs/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.md +++ b/docs/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.md @@ -4,14 +4,14 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | Sub-merchant’s business name. #### American Express Direct 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. #### Visa Platform Connect With 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. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. | [optional] -**address1** | **String** | First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**locality** | **String** | Sub-merchant’s city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**administrativeArea** | **String** | Sub-merchant’s state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**postalCode** | **String** | Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] -**country** | **String** | Sub-merchant’s country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. See \"Aggregator Support,\" page 101. | [optional] -**email** | **String** | Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - Visa Platform Connect: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### Visa Platform Connect With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. Visa Platform Connect creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [optional] -**phoneNumber** | **String** | Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - Visa Platform Connect: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### Visa Platform Connect With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` | [optional] +**name** | **String** | Sub-merchant’s business name. #### American Express Direct 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. #### CyberSource through VisaNet With 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. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. | [optional] +**address1** | **String** | First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**locality** | **String** | Sub-merchant’s city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**administrativeArea** | **String** | Sub-merchant’s state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**postalCode** | **String** | Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. | [optional] +**country** | **String** | Sub-merchant’s country. Use the two-character ISO Standard Country Codes. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. See \"Aggregator Support,\" page 101. | [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 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **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’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. | [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 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` | [optional] diff --git a/docs/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md b/docs/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md index b48e334bb..33aed2d25 100644 --- a/docs/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md +++ b/docs/Ptsv2paymentsidcapturesOrderInformationAmountDetails.md @@ -4,10 +4,11 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. | [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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. | [optional] **currency** | **String** | Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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 payment authorization request. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). | [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] +**gratuityAmount** | **String** | Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. For information about partial authorizations, see Credit Card Services Using the SCMP API. Restaurant data is supported only on CyberSource through VisaNet. | [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] diff --git a/docs/Ptsv2paymentsidcapturesOrderInformationBillTo.md b/docs/Ptsv2paymentsidcapturesOrderInformationBillTo.md index 3fd408dc4..d7a77af10 100644 --- a/docs/Ptsv2paymentsidcapturesOrderInformationBillTo.md +++ b/docs/Ptsv2paymentsidcapturesOrderInformationBillTo.md @@ -6,15 +6,15 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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. **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` request-level field description 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. **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` request-level field description 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. **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 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** | Payment card 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, Visa Platform Connect 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. **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` request-level field description 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**locality** | **String** | Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. #### 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 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** | Payment card 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. **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` request-level field description 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**locality** | **String** | Payment card billing city. #### 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 description 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. **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 description 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` **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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` request-level field description 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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] +**country** | **String** | Payment card billing country. 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. **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 description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. | [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/Ptsv2paymentsidcapturesProcessingInformation.md b/docs/Ptsv2paymentsidcapturesProcessingInformation.md index a6cb21609..5acd6588c 100644 --- a/docs/Ptsv2paymentsidcapturesProcessingInformation.md +++ b/docs/Ptsv2paymentsidcapturesProcessingInformation.md @@ -10,6 +10,7 @@ Name | Type | Description | Notes **reportGroup** | **String** | Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**. For details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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. For details, see the `vc_order_id` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] **purchaseLevel** | **String** | Set this field to 3 to indicate that the request includes Level III data. | [optional] +**industryDataType** | **String** | Flag that indicates that the transaction includes airline data or restaurant data. This field must be set to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to restaurant or is not included in the request, CyberSource does not send restaurant data to the processor. Possible Values: - **airline** - **restaurant** | [optional] **issuer** | [**Ptsv2paymentsIssuerInformation**](Ptsv2paymentsIssuerInformation.md) | | [optional] **authorizationOptions** | [**Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions**](Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.md) | | [optional] **captureOptions** | [**Ptsv2paymentsidcapturesProcessingInformationCaptureOptions**](Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.md) | | [optional] diff --git a/docs/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.md b/docs/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.md index be7e82ce9..4e8e360cd 100644 --- a/docs/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.md +++ b/docs/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**captureSequenceNumber** | [**BigDecimal**](BigDecimal.md) | Capture number when requesting multiple partial captures for one authorization. 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` field 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] +**captureSequenceNumber** | **Integer** | Capture number when requesting multiple partial captures for one authorization. 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** | **Integer** | Total number of captures when requesting multiple partial captures for one payment. Used along with `captureSequenceNumber` field 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] diff --git a/docs/Ptsv2paymentsidreversalsPointOfSaleInformation.md b/docs/Ptsv2paymentsidreversalsPointOfSaleInformation.md index 8f869cccd..967d80f16 100644 --- a/docs/Ptsv2paymentsidreversalsPointOfSaleInformation.md +++ b/docs/Ptsv2paymentsidreversalsPointOfSaleInformation.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**emv** | [**PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv**](PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.md) | | [optional] +**emv** | [**Ptsv2paymentsidreversalsPointOfSaleInformationEmv**](Ptsv2paymentsidreversalsPointOfSaleInformationEmv.md) | | [optional] diff --git a/docs/Ptsv2paymentsidreversalsPointOfSaleInformationEmv.md b/docs/Ptsv2paymentsidreversalsPointOfSaleInformationEmv.md new file mode 100644 index 000000000..194036404 --- /dev/null +++ b/docs/Ptsv2paymentsidreversalsPointOfSaleInformationEmv.md @@ -0,0 +1,10 @@ + +# Ptsv2paymentsidreversalsPointOfSaleInformationEmv + +## 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. For details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **Note** The information about EMV applies to credit card processing and PIN debit processing. All other information in this guide applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Note** For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **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, and 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/Ptsv2paymentsidreversalsReversalInformationAmountDetails.md b/docs/Ptsv2paymentsidreversalsReversalInformationAmountDetails.md index 0b067e75d..a712f76f1 100644 --- a/docs/Ptsv2paymentsidreversalsReversalInformationAmountDetails.md +++ b/docs/Ptsv2paymentsidreversalsReversalInformationAmountDetails.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. | [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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. | [optional] **currency** | **String** | Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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 payment authorization request. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). | [optional] diff --git a/docs/Ptsv2payoutsOrderInformationAmountDetails.md b/docs/Ptsv2payoutsOrderInformationAmountDetails.md index d749a3c87..998cf89f6 100644 --- a/docs/Ptsv2payoutsOrderInformationAmountDetails.md +++ b/docs/Ptsv2payoutsOrderInformationAmountDetails.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. | [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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. | [optional] **currency** | **String** | Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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 payment authorization request. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). | [optional] **surcharge** | [**Ptsv2payoutsOrderInformationAmountDetailsSurcharge**](Ptsv2payoutsOrderInformationAmountDetailsSurcharge.md) | | [optional] diff --git a/docs/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.md b/docs/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.md index 9336c8581..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. 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 Visa Platform Connect (VPC) 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] +**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 7728fa200..1c0ce4a83 100644 --- a/docs/Ptsv2payoutsOrderInformationBillTo.md +++ b/docs/Ptsv2payoutsOrderInformationBillTo.md @@ -6,13 +6,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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. **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` request-level field description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**address1** | **String** | Payment card 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, Visa Platform Connect 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. **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` request-level field description 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**locality** | **String** | Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**address1** | **String** | Payment card 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. **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` request-level field description 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**country** | **String** | Payment card billing country. 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**locality** | **String** | Payment card billing city. #### 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 description 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. **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 description 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` **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` request-level field description 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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] +**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** | **String** | 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/Ptsv2payoutsPaymentInformationCard.md b/docs/Ptsv2payoutsPaymentInformationCard.md index d7687ad24..c3b9cffd5 100644 --- a/docs/Ptsv2payoutsPaymentInformationCard.md +++ b/docs/Ptsv2payoutsPaymentInformationCard.md @@ -8,7 +8,7 @@ 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 description 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`. **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_cc_expmo` field description 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. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### 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. **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_cc_expyr` field description 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] +**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 CyberSource through VisaNet (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 or credit portion of combo card - `PREPAID`: Prepaid card account or prepaid portion of combo card - `UNIVERSAL`: Universal account | [optional] diff --git a/docs/Ptsv2payoutsProcessingInformationPayoutsOptions.md b/docs/Ptsv2payoutsProcessingInformationPayoutsOptions.md index 5761428ad..773378e0c 100644 --- a/docs/Ptsv2payoutsProcessingInformationPayoutsOptions.md +++ b/docs/Ptsv2payoutsProcessingInformationPayoutsOptions.md @@ -6,7 +6,7 @@ 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] +**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. Format: Positions 1-4: The yddd equivalent of the date, where y = 0-9 and ddd = 001 – 366. Positions 5-12: A unique identification number generated by the merchant * 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/ReportingV3PaymentBatchSummariesGet200Response.md b/docs/ReportingV3PaymentBatchSummariesGet200Response.md new file mode 100644 index 000000000..e8af3a2d3 --- /dev/null +++ b/docs/ReportingV3PaymentBatchSummariesGet200Response.md @@ -0,0 +1,12 @@ + +# ReportingV3PaymentBatchSummariesGet200Response + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**startTime** | [**DateTime**](DateTime.md) | | [optional] +**endTime** | [**DateTime**](DateTime.md) | | [optional] +**paymentBatchSummaries** | [**List<ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries>**](ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.md) | | [optional] + + + diff --git a/docs/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.md b/docs/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.md new file mode 100644 index 000000000..c52df06c1 --- /dev/null +++ b/docs/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.md @@ -0,0 +1,21 @@ + +# ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries + +## 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/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md index 2c19fa150..d07014dee 100644 --- a/docs/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md +++ b/docs/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.md @@ -6,6 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **requestId** | **String** | An unique identification number assigned by CyberSource to identify the submitted request. | [optional] **interchangePerItemFee** | **String** | interchange Per Item Fee | [optional] +**interchangeDescription** | **String** | interchange Description | [optional] +**interchangePercentage** | **String** | interchange Percentage | [optional] +**interchangePercentageAmount** | **String** | interchange Percentage Amount | [optional] **discountPercentage** | **String** | Discount Percentage | [optional] **discountAmount** | **String** | Discount Amount | [optional] **discountPerItemFee** | **String** | Discount Per Item Fee | [optional] diff --git a/docs/Riskv1decisionsOrderInformationAmountDetails.md b/docs/Riskv1decisionsOrderInformationAmountDetails.md index 3dba89822..546d1ef22 100644 --- a/docs/Riskv1decisionsOrderInformationAmountDetails.md +++ b/docs/Riskv1decisionsOrderInformationAmountDetails.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **currency** | **String** | Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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 payment authorization request. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). | -**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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. | [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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. | [optional] diff --git a/docs/Riskv1decisionsOrderInformationBillTo.md b/docs/Riskv1decisionsOrderInformationBillTo.md index fd40855d0..196d087e8 100644 --- a/docs/Riskv1decisionsOrderInformationBillTo.md +++ b/docs/Riskv1decisionsOrderInformationBillTo.md @@ -4,15 +4,15 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**address1** | **String** | Payment card 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, Visa Platform Connect 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. **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` request-level field description 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**locality** | **String** | Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**address1** | **String** | Payment card 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. **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` request-level field description 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 description 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**country** | **String** | Payment card billing country. 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**locality** | **String** | Payment card billing city. #### 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 description 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. **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` request-level field description 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. **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` request-level field description 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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` request-level field description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. | [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` **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` request-level field description 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/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.md b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.md index 86e22a00b..891b13708 100644 --- a/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.md +++ b/docs/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.md @@ -6,10 +6,10 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **links** | [**TmsV1InstrumentIdentifiersPost200ResponseLinks**](TmsV1InstrumentIdentifiersPost200ResponseLinks.md) | | [optional] **object** | **String** | 'Describes type of token.' Valid values: - instrumentIdentifier | [optional] -**state** | **String** | 'Current state of the token.' Valid values: - ACTIVE - CLOSED | [optional] +**state** | **String** | 'Current state of the token.' Valid values: - ACTIVE - CLOSED | [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] +**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional] **processingInformation** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md) | | [optional] **metadata** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional] diff --git a/docs/TmsV1InstrumentIdentifiersPost200Response.md b/docs/TmsV1InstrumentIdentifiersPost200Response.md index 956f49a2c..fbf30ff94 100644 --- a/docs/TmsV1InstrumentIdentifiersPost200Response.md +++ b/docs/TmsV1InstrumentIdentifiersPost200Response.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **object** | **String** | 'Describes type of token.' Valid values: - instrumentIdentifier | [optional] **state** | **String** | 'Current state of the token.' Valid values: - ACTIVE - CLOSED | [optional] **card** | [**TmsV1InstrumentIdentifiersPost200ResponseCard**](TmsV1InstrumentIdentifiersPost200ResponseCard.md) | | [optional] -**bankAccount** | [**TmsV1InstrumentIdentifiersPost200ResponseBankAccount**](TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md) | | [optional] +**bankAccount** | [**Tmsv1instrumentidentifiersBankAccount**](Tmsv1instrumentidentifiersBankAccount.md) | | [optional] **processingInformation** | [**TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation**](TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.md) | | [optional] **metadata** | [**TmsV1InstrumentIdentifiersPost200ResponseMetadata**](TmsV1InstrumentIdentifiersPost200ResponseMetadata.md) | | [optional] diff --git a/docs/TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md b/docs/Tmsv1instrumentidentifiersBankAccount.md similarity index 81% rename from docs/TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md rename to docs/Tmsv1instrumentidentifiersBankAccount.md index c95a6de92..b01937555 100644 --- a/docs/TmsV1InstrumentIdentifiersPost200ResponseBankAccount.md +++ b/docs/Tmsv1instrumentidentifiersBankAccount.md @@ -1,5 +1,5 @@ -# TmsV1InstrumentIdentifiersPost200ResponseBankAccount +# Tmsv1instrumentidentifiersBankAccount ## Properties Name | Type | Description | Notes diff --git a/docs/TransactionBatchesApi.md b/docs/TransactionBatchesApi.md index 3f09d1ca9..e2f703c2c 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/{id} | Get transaction details for a given batch id [**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(id, uploadDate, status) + +Get transaction details for a given batch id + +Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service. + +### Example +```java +// Import classes: +//import Invokers.ApiException; +//import Api.TransactionBatchesApi; + + +TransactionBatchesApi apiInstance = new TransactionBatchesApi(); +String id = "id_example"; // String | The batch id assigned for the template. +LocalDate uploadDate = new LocalDate(); // LocalDate | Date in which the original batch file was uploaded. Date must be in ISO-8601 format. Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd +String status = "status_example"; // String | Allows you to filter by rejected response. Valid values: - Rejected +try { + apiInstance.getTransactionBatchDetails(id, uploadDate, status); +} catch (ApiException e) { + System.err.println("Exception when calling TransactionBatchesApi#getTransactionBatchDetails"); + e.printStackTrace(); +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| The batch id assigned for the template. | + **uploadDate** | **LocalDate**| Date in which the original batch file was uploaded. Date must be in ISO-8601 format. Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd | [optional] + **status** | **String**| Allows you to filter by rejected response. Valid values: - Rejected | [optional] + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json;charset=utf-8 + - **Accept**: text/csv, application/xml + # **getTransactionBatchId** > PtsV1TransactionBatchesIdGet200Response getTransactionBatchId(id) diff --git a/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md b/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md index b4fa970f4..e34f1fe2e 100644 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.md @@ -4,7 +4,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. | [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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. | [optional] **currency** | **String** | Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) 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 payment authorization request. #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). | [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] diff --git a/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md b/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md index eb01c2882..7e45166b9 100644 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationBillTo.md @@ -8,16 +8,16 @@ Name | Type | Description | Notes **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. **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` request-level field description 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] -**address1** | **String** | Payment card 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, Visa Platform Connect 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. **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` request-level field description 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**locality** | **String** | Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**address1** | **String** | Payment card 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. **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` request-level field description 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] +**locality** | **String** | Payment card billing city. #### 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 description 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. **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 description 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` **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` request-level field description 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. **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 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. #### 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. #### 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 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. #### 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. | [optional] +**country** | **String** | Payment card billing country. 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. **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 description 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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] +**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/TssV2TransactionsGet200ResponseOrderInformationLineItems.md b/docs/TssV2TransactionsGet200ResponseOrderInformationLineItems.md index 8780e1041..7e2255e4d 100644 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationLineItems.md +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationLineItems.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes **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] **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. For details, see `tax_amount` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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] +**quantity** | **Integer** | 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] **fulfillmentType** | **String** | The description for this field is not available. | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md b/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md index 0644dd930..78c85220d 100644 --- a/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md +++ b/docs/TssV2TransactionsGet200ResponseOrderInformationShipTo.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **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 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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 description 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] diff --git a/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md b/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md index 11cb6b64a..dbe820275 100644 --- a/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md +++ b/docs/TssV2TransactionsGet200ResponsePaymentInformationCard.md @@ -5,7 +5,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. **Note** This field is returned only for CyberSource through VisaNet and FDC Nashville Global. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 85 - Field: American Express last 4 PAN return indicator. | [optional] -**prefix** | **String** | The description for this field is not available. | [optional] +**prefix** | **String** | Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. | [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`. **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_cc_expmo` field description 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. #### Encoded Account Numbers For encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`. #### 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. **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_cc_expyr` field description 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] diff --git a/docs/TssV2TransactionsGet200ResponseProcessorInformation.md b/docs/TssV2TransactionsGet200ResponseProcessorInformation.md index 357cc9cdb..e99c9f30e 100644 --- a/docs/TssV2TransactionsGet200ResponseProcessorInformation.md +++ b/docs/TssV2TransactionsGet200ResponseProcessorInformation.md @@ -5,7 +5,7 @@ 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. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### Visa Platform Connect and GPN For details about this value for Visa Platform Connect and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] **networkTransactionId** | **String** | The description for this field is not available. | [optional] **responseId** | **String** | Response ID sent from the processor. | [optional] **providerTransactionId** | **String** | The description for this field is not available. | [optional] @@ -15,7 +15,7 @@ Name | Type | Description | Notes **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 **Visa Platform Connect**. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### Visa Platform Connect System trace number that must be printed on the customer’s receipt. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [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/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md b/docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md index bec050682..e31d8c811 100644 --- a/docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md +++ b/docs/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.md @@ -6,8 +6,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **email** | **String** | Mapped Electronic Verification response code for the customer’s email address. For details, see `auth_ev_email` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] **emailRaw** | **String** | Raw Electronic Verification response code from the processor for the customer’s email address. | [optional] -**name** | **String** | The description for this field is not available. | [optional] -**nameRaw** | **String** | The description for this field is not available. | [optional] +**name** | **String** | Mapped Electronic Verification response code for the customer’s name. | [optional] +**nameRaw** | **String** | Raw Electronic Verification response code from the processor for the customer’s name. | [optional] **phoneNumber** | **String** | Mapped Electronic Verification response code for the customer’s phone number. For details, see `auth_ev_phone_number` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] **phoneNumberRaw** | **String** | Raw Electronic Verification response code from the processor for the customer’s phone number. | [optional] **street** | **String** | Mapped Electronic Verification response code for the customer’s street address. For details, see `auth_ev_street` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) | [optional] diff --git a/docs/TssV2TransactionsGet200ResponseRiskInformationProfile.md b/docs/TssV2TransactionsGet200ResponseRiskInformationProfile.md index a5e289eb5..5a37ae615 100644 --- a/docs/TssV2TransactionsGet200ResponseRiskInformationProfile.md +++ b/docs/TssV2TransactionsGet200ResponseRiskInformationProfile.md @@ -4,8 +4,8 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**name** | **String** | The description for this field is not available. | [optional] -**decision** | **String** | The description for this field is not available. | [optional] +**name** | **String** | The name of the profile. | [optional] +**decision** | **String** | Decision returned by the profile; this field contains one of these values: - ACCEPT - REJECT - REVIEW | [optional] diff --git a/docs/TssV2TransactionsPost201Response1.md b/docs/TssV2TransactionsPost201Response1.md deleted file mode 100644 index 9f7b020a7..000000000 --- a/docs/TssV2TransactionsPost201Response1.md +++ /dev/null @@ -1,23 +0,0 @@ - -# TssV2TransactionsPost201Response1 - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**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 in ISO format. | [optional] -**query** | **String** | transaction search query string. | [optional] -**offset** | **Integer** | offset. | [optional] -**limit** | **Integer** | Limit on number of results. | [optional] -**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] -**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] -**embedded** | [**TssV2TransactionsPost201Response1Embedded**](TssV2TransactionsPost201Response1Embedded.md) | | [optional] -**links** | [**PtsV2PaymentsReversalsPost201ResponseLinks**](PtsV2PaymentsReversalsPost201ResponseLinks.md) | | [optional] - - - diff --git a/docs/TssV2TransactionsPost201Response1Embedded.md b/docs/TssV2TransactionsPost201Response1Embedded.md deleted file mode 100644 index 817dd2e18..000000000 --- a/docs/TssV2TransactionsPost201Response1Embedded.md +++ /dev/null @@ -1,10 +0,0 @@ - -# TssV2TransactionsPost201Response1Embedded - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**transactionSummaries** | [**List<TssV2TransactionsPost201Response1EmbeddedTransactionSummaries>**](TssV2TransactionsPost201Response1EmbeddedTransactionSummaries.md) | transaction search summary | [optional] - - - diff --git a/docs/TssV2TransactionsPost201Response1EmbeddedPaymentInformation.md b/docs/TssV2TransactionsPost201Response1EmbeddedPaymentInformation.md deleted file mode 100644 index 40d73fe74..000000000 --- a/docs/TssV2TransactionsPost201Response1EmbeddedPaymentInformation.md +++ /dev/null @@ -1,12 +0,0 @@ - -# TssV2TransactionsPost201Response1EmbeddedPaymentInformation - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**paymentType** | [**TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType**](TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType.md) | | [optional] -**customer** | [**Ptsv2paymentsPaymentInformationCustomer**](Ptsv2paymentsPaymentInformationCustomer.md) | | [optional] -**card** | [**TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard**](TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md) | | [optional] - - - diff --git a/docs/TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType.md b/docs/TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType.md deleted file mode 100644 index 93e31b910..000000000 --- a/docs/TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType.md +++ /dev/null @@ -1,11 +0,0 @@ - -# TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. | [optional] -**method** | [**TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod**](TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod.md) | | [optional] - - - diff --git a/docs/TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod.md b/docs/TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod.md deleted file mode 100644 index 950de9cc6..000000000 --- a/docs/TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod.md +++ /dev/null @@ -1,13 +0,0 @@ - -# TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **String** | A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal | [optional] -**operator** | **String** | An operator of the Payment Type Method. Examples: Visa, PayPal, Google, Apple | [optional] -**schemeName** | **String** | A Payment Scheme is a formal, commercial relationship amongst payment ecosystem players (banks and merchants, typically, extended to include merchants payment service providers, banks processors, etc.), whereby the participants agree to an organizational, legal, and operational framework necessary for the functioning of the services these entities provide. Examples: Visa, Master Card, ApplePay, iDeal | [optional] -**schemeOperator** | **String** | Operator of the Scheme. Examples European Payment Council, Visa, Currence Ideal B.V | [optional] - - - diff --git a/docs/TssV2TransactionsPost201Response1EmbeddedTransactionSummaries.md b/docs/TssV2TransactionsPost201Response1EmbeddedTransactionSummaries.md deleted file mode 100644 index 522114d13..000000000 --- a/docs/TssV2TransactionsPost201Response1EmbeddedTransactionSummaries.md +++ /dev/null @@ -1,27 +0,0 @@ - -# TssV2TransactionsPost201Response1EmbeddedTransactionSummaries - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**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** | Your CyberSource merchant ID. | [optional] -**applicationInformation** | [**TssV2TransactionsGet200ResponseApplicationInformation**](TssV2TransactionsGet200ResponseApplicationInformation.md) | | [optional] -**buyerInformation** | [**TssV2TransactionsPost201ResponseEmbeddedBuyerInformation**](TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.md) | | [optional] -**clientReferenceInformation** | [**TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation**](TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.md) | | [optional] -**consumerAuthenticationInformation** | [**TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation**](TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.md) | | [optional] -**deviceInformation** | [**TssV2TransactionsPost201ResponseEmbeddedDeviceInformation**](TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.md) | | [optional] -**fraudMarkingInformation** | [**TssV2TransactionsGet200ResponseFraudMarkingInformation**](TssV2TransactionsGet200ResponseFraudMarkingInformation.md) | | [optional] -**merchantDefinedInformation** | [**List<Ptsv2paymentsMerchantDefinedInformation>**](Ptsv2paymentsMerchantDefinedInformation.md) | The object containing the custom data that the merchant defines. | [optional] -**merchantInformation** | [**TssV2TransactionsPost201ResponseEmbeddedMerchantInformation**](TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.md) | | [optional] -**orderInformation** | [**TssV2TransactionsPost201ResponseEmbeddedOrderInformation**](TssV2TransactionsPost201ResponseEmbeddedOrderInformation.md) | | [optional] -**paymentInformation** | [**TssV2TransactionsPost201Response1EmbeddedPaymentInformation**](TssV2TransactionsPost201Response1EmbeddedPaymentInformation.md) | | [optional] -**processingInformation** | [**TssV2TransactionsPost201ResponseEmbeddedProcessingInformation**](TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.md) | | [optional] -**processorInformation** | [**TssV2TransactionsPost201ResponseEmbeddedProcessorInformation**](TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.md) | | [optional] -**pointOfSaleInformation** | [**TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation**](TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.md) | | [optional] -**riskInformation** | [**TssV2TransactionsPost201ResponseEmbeddedRiskInformation**](TssV2TransactionsPost201ResponseEmbeddedRiskInformation.md) | | [optional] -**links** | [**TssV2TransactionsPost201ResponseEmbeddedLinks**](TssV2TransactionsPost201ResponseEmbeddedLinks.md) | | [optional] - - - diff --git a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md index 8d36f2898..6078aa90f 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.md @@ -6,9 +6,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **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. **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` request-level field description 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. **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` request-level field description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] -**country** | **String** | Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. | [optional] +**country** | **String** | Payment card billing country. 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. **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 description 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/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md index cc2cfd565..f1605ab7f 100644 --- a/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md +++ b/docs/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.md @@ -5,7 +5,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. **Note** This field is returned only for CyberSource through VisaNet and FDC Nashville Global. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 85 - Field: American Express last 4 PAN return indicator. | [optional] -**prefix** | **String** | The description for this field is not available. | [optional] +**prefix** | **String** | Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. | [optional] **type** | **String** | Three-digit value that indicates the card type. 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) For the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) | [optional] diff --git a/generator/cybersource-rest-spec.json b/generator/cybersource-rest-spec.json index 872bc35bc..0d9ccdf11 100644 --- a/generator/cybersource-rest-spec.json +++ b/generator/cybersource-rest-spec.json @@ -17,9 +17,6 @@ "application/json;charset=utf-8" ], "tags": [ - { - "name": "Flex API" - }, { "name": "payments", "description": "A payment authorizes the amount for the transaction. There are a number of supported payment\ninstruments, such as Credit Card, Debit Card, e-Wallet, and Alternative Payments. A payment\nresponse includes the status of the request. It also includes processor-specific information\nwhen the request is successful and errors if unsuccessful.\n" @@ -48,6 +45,21 @@ "name": "TransactionBatches", "description": "Get a list of batch files or details of Individual file processed through the Offline Transaction Submission Services.\n" }, + { + "name": "Instrument Identifier", + "description": "The instrument identifier token type represents the tokenized PAN, a tokenized PAN can also have an associated network token used for card payments. The instrument identifier token type can also represent the tokenized account number and routing number for bank account (eCheck) payments." + }, + { + "name": "Payment Instrument", + "description": "The Payment Instrument token type represents the tokenized billing information and card expiration dates for card payments, or bank account information for eCheck payments.\u2028" + }, + { + "name": "Flex API" + }, + { + "name": "decision manager", + "description": "REST API for the Decision Manager Service" + }, { "name": "Payouts", "description": "A payout enables an originator to send funds on behalf of itself, merchants, or customers to credit card\naccounts using an Original Credit Transaction (OCT). An originator is a merchant, government entity, or\ncorporation with a merchant account from an acquiring bank.\n" @@ -76,6 +88,10 @@ "name": "Purchase And Refund Details", "description": "API for Purchase and Refund Details" }, + { + "name": "Payment Batch Summaries", + "description": "API for payment batch summary reports" + }, { "name": "Net Fundings", "description": "API for retrieving the netfunding data for an account or a merchant" @@ -85,8 +101,12 @@ "description": "API for retrieving conversion data for merchant" }, { - "name": "decision manager", - "description": "REST API for the Decision Manager Service" + "name": "Download DTD", + "description": "API to download report DTDs" + }, + { + "name": "Download XSD", + "description": "API to download report XSDs" }, { "name": "File Details", @@ -96,14 +116,6 @@ "name": "File Downloads", "description": "API to download a file" }, - { - "name": "Instrument Identifier", - "description": "The instrument identifier token type represents the tokenized PAN, a tokenized PAN can also have an associated network token used for card payments. The instrument identifier token type can also represent the tokenized account number and routing number for bank account (eCheck) payments." - }, - { - "name": "Payment Instrument", - "description": "The Payment Instrument token type represents the tokenized billing information and card expiration dates for card payments, or bank account information for eCheck payments.\u2028" - }, { "name": "user-management", "description": "User Management API" @@ -111,10 +123,6 @@ ], "x-devcenter-metaData": { "categoryTagArray": [ - { - "name": "Flex", - "description": "For more information about Flex Microform transactions, see the [Flex Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-flex/SAFlexibleToken.html)." - }, { "name": "Payments", "description": "For more information about Payments transactions, see the [Payments Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-payments/GettingStarted.html)." @@ -124,24 +132,20 @@ "description": "For more information about Transaction Batches, see the [Transaction Batches Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-transaction-batch-api/txn_batch_api_intro.html)." }, { - "name": "Payouts", - "description": "For more information about Payouts, see the [Payouts Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-payouts/Introduction.html).\n" + "name": "Token_Management", + "description": "For more information about Token Management, see the [Token Management Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-tms/intro.html)." }, { - "name": "Reporting", - "description": "For more information about Reporting, see the [Reporting Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-reporting-rest-api-dev-guide-102718/intro.html).\n" + "name": "Flex", + "description": "For more information about Flex Microform transactions, see the [Flex Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-flex/SAFlexibleToken.html)." }, { "name": "Decision_Manager", "description": "For more information about Decision Manager, see the [Decision Manager Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-risk/decisionmanager/intro.html)." }, { - "name": "Secure_File_Share", - "description": "For more information about Secure File Share, see the [Secure File Share Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-secure-file-share-api-102718/secure_file_share_api_intro.html)." - }, - { - "name": "Token_Management", - "description": "For more information about Token Management, see the [Token Management Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-tms/intro.html)." + "name": "Payouts", + "description": "For more information about Payouts, see the [Payouts Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-payouts/Introduction.html).\n" }, { "name": "Transaction_Details", @@ -151,6 +155,14 @@ "name": "Transaction_Search", "description": "For more information about Transaction Search, see the [Transaction Search Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-txn-search-details-rest-api-dev-guide-102718/txn_search_api.html)." }, + { + "name": "Reporting", + "description": "For more information about Reporting, see the [Reporting Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-reporting-rest-api-dev-guide-102718/reporting_api.html).\n" + }, + { + "name": "Secure_File_Share", + "description": "For more information about Secure File Share, see the [Secure File Share Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-secure-file-share-api-102718/secure_file_share_api_intro.html)." + }, { "name": "User_Management", "description": "For more information about User Management, see the [User Managment Developer Guides Page](https://developer.cybersource.com/api/developer-guides/dita-user-management-api-102718/user_management_api_intro.html)." @@ -158,913 +170,458 @@ ] }, "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.", + "/pts/v2/payments/": { "post": { + "summary": "Process a Payment", + "description": "Authorize the payment for the transaction.\n", "tags": [ - "Key Generation" + "payments" ], - "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", + "operationId": "createPayment", "x-devcenter-metaData": { - "categoryTag": "Flex" + "categoryTag": "Payments" }, - "produces": [ - "application/json" - ], "parameters": [ { + "name": "createPaymentRequest", "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": "None" - } - } - }, - "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": { + "clientReferenceInformation": { "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": { + "code": { "type": "string", - "description": "Specifies the format of the public key; currently X.509." + "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 \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://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" }, - "algorithm": { + "transactionId": { "type": "string", - "description": "Algorithm used to encrypt the public key." + "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\nFor details, see \"Merchant-Initiated Reversals and Voids\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, - "publicKey": { + "comments": { "type": "string", - "description": "Base64 encoded public key value." + "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\n**Note** 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\n**Note** When you see a partner ID of 999 in reports, the partner ID that was submitted is incorrect.\n" + } + } } } }, - "jwk": { + "processingInformation": { "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": { + "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", + "default": false + }, + "processorId": { "type": "string", - "description": "Algorithm used to encrypt the public key." + "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" }, - "use": { + "businessApplicationId": { "type": "string", - "description": "Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc." + "description": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n\nFor valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf)\n" }, - "kid": { + "commerceIndicator": { "type": "string", - "description": "The key ID in JWK format." + "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" }, - "n": { + "paymentSolution": { "type": "string", - "description": "JWK RSA Modulus" + "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. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\n" }, - "e": { + "reconciliationId": { "type": "string", - "description": "JWK RSA Exponent" - } - } - } - } - } - }, - "default": { - "description": "Error retrieving key.", - "schema": { - "type": "object", - "properties": { - "responseStatus": { - "properties": { - "status": { - "type": "number", - "description": "HTTP Status code." + "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" }, - "reason": { + "linkId": { "type": "string", - "description": "Error Reason Code." + "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\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, - "message": { + "purchaseLevel": { "type": "string", - "description": "Error Message." + "maxLength": 1, + "description": "Set this field to 3 to indicate that the request includes Level III data." }, - "correlationId": { + "reportGroup": { "type": "string", - "description": "API correlation ID." + "maxLength": 25, + "description": "Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.\n\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, - "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." - } - } - } + "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 details, see the `vc_order_id` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, - "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." + "industryDataType": { + "type": "string", + "maxLength": 10, + "description": "Flag that indicates that the transaction includes airline data or restaurant data.\n\nThis field must be set to `airline` in order for airline data to be sent to the processor.\n\nFor example, if this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor.\n\nYou must set this field to `restaurant` in order for restaurant data to be sent to the processor.\n\nWhen this field is not set to restaurant or is not included in the request, CyberSource does not send restaurant data to the processor.\n\nPossible Values:\n\n- **airline**\n- **restaurant**\n" + }, + "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 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 the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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.\n\nFor more information, see \"Forced Captures\" in [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\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\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\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 description 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).\n\n#### FDMS South\nThis field is required for verbal authorizations\nand forced captures with the American\nExpress card type to comply with the CAPN\nrequirements:\n- Forced capture: Obtain the value for this\nfield from the authorization response.\n- Verbal authorization: You cannot obtain a\nvalue for this field so CyberSource uses the\ndefault value of `000000000000000` (15\nzeros).\n\nFor more information about using this default value, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + }, + "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.\nFor details, see \"Final Authorization Indicator\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n#### Barclays and Elavon\nThe default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support.\n\n#### CyberSource 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" + }, + "balanceInquiry": { + "type": "boolean", + "description": "Flag that indicates whether to return balance information.\n\nPossible values:\n- **true**\n- **false**\n" + }, + "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", + "default": false + }, + "declineAvsFlags": { + "type": "array", + "description": "Comma-separated list of AVS flags that cause the reply flag `DAVSNO` to be returned.\n\n**Important** To receive declines for the AVS code `N`, you must include the value `N` in the comma-separated\nlist.\n\n### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing\n\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 section 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|AVS Code|Description|\n|--- |--- |\n|D|Partial match: postal code and address match.|\n|E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.|\n|F|Partial match: postal code matches, but CPF and address do not match.*|\n|G|Not supported: AVS not supported or not verified.|\n|I|No match: AVS information is not available.|\n|K|Partial match: CPF matches, but postal code and address do not match.*|\n|L|Partial match: postal code and CPF match, but address does not match.*|\n|N|No match: postal code, CPF, and address do not match.*|\n|O|Partial match: CPF and address match, but postal code does not match.*|\n|R|Not supported: your implementation does not support AVS _or_ System unavailable.|\n|T|Partial match: address matches, but postal code and CPF do not match.*|\n|V|Match: postal code, CPF, and address match.*|\n|* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.||\n\n### AVS Codes for All Other Processors\n\n**Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes.\n\n#### American Express Cards\nFor American Express cards only, you can receive Visa and CyberSource\nAVS codes in addition to the American Express AVS codes.\n\n**Note** For CyberSource through VisaNet, the American Express AVS codes are converted to Visa\nAVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for\nthe American Express card type.

\n\n_American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V`\n\n#### Domestic and International Visa Cards\nThe international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps\nthe standard AVS return codes for other types of payment cards, including American Express cards, to\nthe Visa standard AVS codes.\n\nAVS is considered either domestic or international, depending on the location of the bank that issued the\ncustomer's payment card:\n- When the bank is in the U.S., the AVS is domestic.\n- When the bank is outside the U.S., the AVS is international.\n\nYou should be prepared to handle both domestic and international AVS result codes:\n- For international cards, you can receive domestic AVS codes in addition to the international AVS codes.\n- For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes.\n\n_International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P`\n\n_Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z`\n\n#### CyberSource Codes\nThe numeric AVS codes are created by CyberSource\nand are not standard Visa codes. These AVS codes\ncan be returned for any card type.\n\n_CyberSource Codes_: `1`, `2`, `3`, `4`\n\n### Table of AVS Codes for All Other Processors\n\n|AVS Code|Description|\n|--- |--- |\n|A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.|\n|B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.|\n|C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.|\n|D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.|\n|E|Invalid: AVS data is invalid or AVS is not allowed for this card type.|\n|F|Partial match: card member\u2019s name does not match, but billing postal code matches.|\n|G|Not supported: issuing bank outside the U.S. does not support AVS.|\n|H|Partial match: card member\u2019s name does not match, but street address and postal code match. Returned only for the American Express card type.|\n|I|No match: address not verified. Returned only for Visa cards not issued in the U.S.|\n|K|Partial match: card member\u2019s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.|\n|L|Partial match: card member\u2019s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.|\n|M|See the entry for D & M.|\n|N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member\u2019s name, street address, and postal code do not match.|\n|O|Partial match: card member\u2019s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.|\n|P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.|\n|R|System unavailable.|\n|S|Not supported: issuing bank in the U.S. does not support AVS.|\n|T|Partial match: card member\u2019s name does not match, but street address matches. Returned only for the American Express card type.|\n|U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.|\n|V|Match: card member\u2019s name, billing address, and billing postal code match. Returned only for the American Express card type.|\n|W|Partial match: street address does not match, but 9-digit postal code matches.|\n|X|Match: street address and 9-digit postal code match.|\n|Y|Match: street address and 5-digit postal code match.|\n|Z|Partial match: street address does not match, but 5-digit postal code matches.|\n|1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.|\n|2|Unrecognized: the processor returned an unrecognized value for the AVS response.|\n|3|Match: address is confirmed. Returned only for PayPal Express Checkout.|\n|4|No match: address is not confirmed. Returned only for PayPal Express Checkout.|\n|5|No match: no AVS code was returned by the processor.|\n", + "items": { + "type": "string" + } + }, + "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", + "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" + }, + "credentialStoredOnFile": { + "type": "boolean", + "description": "Indicates to the issuing bank two things:\n- The merchant has received consent from the cardholder to store their card details on file\n- The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder.\nThe purpose of the merchant-initiated transaction is to ensure that the cardholder\u2019s credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant\u2019s file for future 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\nFor details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5.\n\nThis field is supported only for Visa transactions on CyberSource through VisaNet.\n" + }, + "storedCredentialUsed": { + "type": "boolean", + "description": "Indicates to an issuing bank whether a merchant-initiated transaction came from a card that was already stored on file.\n\nPossible values:\n- **true** means the merchant-initiated transaction came from a card that was already stored on file.\n- **false** means the merchant-initiated transaction came from a card that was not stored on file.\n" + }, + "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\nFor details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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" + }, + "originalAuthorizedAmount": { + "type": "string", + "maxLength": 61, + "description": "Amount of the original authorization.\n\nThis field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech.\n\nSee \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization\nUsing the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + } + } + } } + }, + "billPayment": { + "type": "boolean", + "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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.\n\n**Note** For details about Mastercard bill payments or bill payments with Visa, see `bill_payment_type` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" } } }, - "self": { + "captureOptions": { + "type": "object", "properties": { - "href": { + "captureSequenceNumber": { + "type": "integer", + "minimum": 1, + "maximum": 99, + "description": "Capture number when requesting multiple partial captures for one authorization.\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": "integer", + "minimum": 1, + "maximum": 99, + "description": "Total number of captures when requesting multiple partial captures for one payment.\nUsed along with `captureSequenceNumber` field 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" + }, + "dateToCapture": { "type": "string", - "description": "URI of the linked resource." + "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\nFor processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n", + "default": false }, - "title": { + "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 details, see `auth_first_recurring_payment` field description and \"Recurring Payments\" in\n[Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n", + "default": false + } + } + }, + "bankTransferOptions": { + "type": "object", + "properties": { + "declineAvsFlags": { "type": "string", - "description": "Label of the linked resource." + "maxLength": 15, + "description": "Space-separated list of AVS flags that cause the request to be declined for AVS reasons.\n\n**Important** To receive declines for the AVS code `N`, you must include the value `N` in the space-separated list.\n\n### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing\n\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 section 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|AVS Code|Description|\n|--- |--- |\n|D|Partial match: postal code and address match.|\n|E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.|\n|F|Partial match: postal code matches, but CPF and address do not match.*|\n|G|Not supported: AVS not supported or not verified.|\n|I|No match: AVS information is not available.|\n|K|Partial match: CPF matches, but postal code and address do not match.*|\n|L|Partial match: postal code and CPF match, but address does not match.*|\n|N|No match: postal code, CPF, and address do not match.*|\n|O|Partial match: CPF and address match, but postal code does not match.*|\n|R|Not supported: your implementation does not support AVS _or_ System unavailable.|\n|T|Partial match: address matches, but postal code and CPF do not match.*|\n|V|Match: postal code, CPF, and address match.*|\n|* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.||\n\n### AVS Codes for All Other Processors\n\n**Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes.\n\n#### American Express Cards\nFor American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes.\n\n**Note** For CyberSource through VisaNet, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type.\n\n_American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V`\n\n#### Domestic and International Visa Cards\nThe international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes.\n\nAVS is considered either domestic or international, depending on the location of the bank that issued the customer\u2019s payment card:\n- When the bank is in the U.S., the AVS is domestic.\n- When the bank is outside the U.S., the AVS is international.\n\nYou should be prepared to handle both domestic and international AVS result codes:\n- For international cards, you can receive domestic AVS codes in addition to the international AVS codes.\n- For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes.\n\n_International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P`\n\n_Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z`\n\n#### CyberSource Codes\nThe numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type.\n\n_CyberSource Codes_: `1`, `2`, `3`, `4`\n\n### Table of AVS Codes for All Other Processors\n\n|AVS Code|Description|\n|--- |--- |\n|A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.|\n|B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.|\n|C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.|\n|D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.|\n|E|Invalid: AVS data is invalid or AVS is not allowed for this card type.|\n|F|Partial match: card member\u2019s name does not match, but billing postal code matches.|\n|G|Not supported: issuing bank outside the U.S. does not support AVS.|\n|H|Partial match: card member\u2019s name does not match, but street address and postal code match. Returned only for the American Express card type.|\n|I|No match: address not verified. Returned only for Visa cards not issued in the U.S.|\n|K|Partial match: card member\u2019s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.|\n|L|Partial match: card member\u2019s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.|\n|M|See the entry for D & M.|\n|N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member\u2019s name, street address, and postal code do not match.|\n|O|Partial match: card member\u2019s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.|\n|P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.|\n|R|System unavailable.|\n|S|Not supported: issuing bank in the U.S. does not support AVS.|\n|T|Partial match: card member\u2019s name does not match, but street address matches. Returned only for the American Express card type.|\n|U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.|\n|V|Match: card member\u2019s name, billing address, and billing postal code match. Returned only for the American Express card type.|\n|W|Partial match: street address does not match, but 9-digit postal code matches.|\n|X|Match: street address and 9-digit postal code match.|\n|Y|Match: street address and 5-digit postal code match.|\n|Z|Partial match: street address does not match, but 5-digit postal code matches.|\n|1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.|\n|2|Unrecognized: the processor returned an unrecognized value for the AVS response.|\n|3|Match: address is confirmed. Returned only for PayPal Express Checkout.|\n|4|No match: address is not confirmed. Returned only for PayPal Express Checkout.|\n|5|No match: no AVS code was returned by the processor.|\n" }, - "method": { + "secCode": { "type": "string", - "description": "HTTP method of the linked resource." + "maxLength": 3, + "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nAccepts only the following values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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.\nFor details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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.\nFor details, see `ecp_payment_mode` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\n#### Chase Paymentech Solutions and TeleCheck\nUse for deferred and partial payments.\n\n#### CyberSource ACH Service\nNot used.\n\n#### RBS WorldPay Atlanta\nNot 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\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n" } } } } - } - } - } - } - }, - "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": { + "issuerInformation": { "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": { + "discretionaryData": { "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." - } - } - } + "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 details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" } } }, - "_links": { + "paymentInformation": { "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": { + "card": { + "type": "object", "properties": { - "href": { + "number": { "type": "string", - "description": "URI of the linked resource." + "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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" }, - "title": { + "expirationMonth": { "type": "string", - "description": "Label of the linked resource." + "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\n**Important** 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_cc_expmo` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" }, - "method": { + "expirationYear": { "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 \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://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\nFor details, see \"Merchant-Initiated Reversals and Voids\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" - }, - "comments": { - "type": "string", - "description": "Comments" - }, - "partner": { - "type": "object", - "properties": { - "originalTransactionId": { + "maxLength": 4, + "description": "Four-digit year in which the credit card expires.\n\nFormat: `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#### Encoded Account Numbers\nFor encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`.\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**Important** 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_cc_expyr` field description 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", - "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": "Three-digit value that indicates the card type.\n\nType 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\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" }, - "developerId": { + "useAs": { "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\n**Note** When you see a developer ID of 999 in reports, the developer ID that was submitted is incorrect.\n" + "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\n**Note** The value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR0\n- Position: 51\n- Field: Combination Card Transaction Identifier\n\nThis field is supported only for Mastercard transactions in Brazil on CyberSource through VisaNet.\n" }, - "solutionId": { + "sourceAccountType": { "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\n**Note** 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", - "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": "Payouts transaction type.\nRequired for OCT transactions.\nThis field is a pass-through, which means that CyberSource does not verify the value or\nmodify it in any way before sending it to the processor.\n**Note** When the request includes this field, this value overrides the information in your CyberSource account.\n\nFor valid values, see the `invoiceHeader_businessApplicationID` field description in [Payouts Using the Simple Order API.](http://apps.cybersource.com/library/documentation/dev_guides/payouts_SO/Payouts_SO_API.pdf)\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" - }, - "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. For details, see `payment_solution` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `001`: Apple Pay.\n - `004`: Cybersource In-App Solution.\n - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. For details, see \"Masterpass\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n - `006`: Android Pay.\n - `007`: Chase Pay.\n - `008`: Samsung Pay.\n - `012`: Google Pay.\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\n- Split shipments\n\nFor details, see `link_to_request` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\nFor details, see `report_group` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 details, see the `vc_order_id` field description in [Visa Checkout Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/VCO_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" - }, - "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 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 the `auth_type` field description in [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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.\n\nFor more information, see \"Forced Captures\" in [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\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\" in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\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 description in [Credit Card Services Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html).\n" + "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 CyberSource through VisaNet (CtV).\n \n**Note** Combo 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" }, - "verbalAuthTransactionId": { + "securityCode": { "type": "string", - "maxLength": 15, - "description": "Transaction ID (TID).\n\n#### FDMS South\nThis field is required for verbal authorizations\nand forced captures with the American\nExpress card type to comply with the CAPN\nrequirements:\n- Forced capture: Obtain the value for this\nfield from the authorization response.\n- Verbal authorization: You cannot obtain a\nvalue for this field so CyberSource uses the\ndefault value of `000000000000000` (15\nzeros).\n\nFor more information about using this default value, see \"Verbal Authorizations\" in [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "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" }, - "authIndicator": { + "securityCodeIndicator": { "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.\nFor details, see \"Final Authorization Indicator\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\n#### Barclays and Elavon\nThe default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support.\n\n#### Visa Platform Connect\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#### Visa Platform Connect\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" - }, - "balanceInquiry": { - "type": "boolean", - "description": "Flag that indicates whether to return balance information.\n\nPossible values:\n- **true**\n- **false**\n" - }, - "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", - "default": false - }, - "declineAvsFlags": { - "type": "array", - "description": "Comma-separated list of AVS flags that cause the reply flag `DAVSNO` to be returned.\n\n**Important** To receive declines for the AVS code `N`, you must include the value `N` in the comma-separated\nlist.\n\n### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing\n\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 section 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|AVS Code|Description|\n|--- |--- |\n|D|Partial match: postal code and address match.|\n|E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.|\n|F|Partial match: postal code matches, but CPF and address do not match.*|\n|G|Not supported: AVS not supported or not verified.|\n|I|No match: AVS information is not available.|\n|K|Partial match: CPF matches, but postal code and address do not match.*|\n|L|Partial match: postal code and CPF match, but address does not match.*|\n|N|No match: postal code, CPF, and address do not match.*|\n|O|Partial match: CPF and address match, but postal code does not match.*|\n|R|Not supported: your implementation does not support AVS _or_ System unavailable.|\n|T|Partial match: address matches, but postal code and CPF do not match.*|\n|V|Match: postal code, CPF, and address match.*|\n|* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.||\n\n### AVS Codes for All Other Processors\n\n**Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes.\n\n#### American Express Cards\nFor American Express cards only, you can receive Visa and CyberSource\nAVS codes in addition to the American Express AVS codes.\n\n**Note** For Visa Platform Connect, the American Express AVS codes are converted to Visa\nAVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for\nthe American Express card type.

\n\n_American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V`\n\n#### Domestic and International Visa Cards\nThe international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps\nthe standard AVS return codes for other types of payment cards, including American Express cards, to\nthe Visa standard AVS codes.\n\nAVS is considered either domestic or international, depending on the location of the bank that issued the\ncustomer's payment card:\n- When the bank is in the U.S., the AVS is domestic.\n- When the bank is outside the U.S., the AVS is international.\n\nYou should be prepared to handle both domestic and international AVS result codes:\n- For international cards, you can receive domestic AVS codes in addition to the international AVS codes.\n- For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes.\n\n_International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P`\n\n_Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z`\n\n#### CyberSource Codes\nThe numeric AVS codes are created by CyberSource\nand are not standard Visa codes. These AVS codes\ncan be returned for any card type.\n\n_CyberSource Codes_: `1`, `2`, `3`, `4`\n\n### Table of AVS Codes for All Other Processors\n\n|AVS Code|Description|\n|--- |--- |\n|A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.|\n|B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.|\n|C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.|\n|D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.|\n|E|Invalid: AVS data is invalid or AVS is not allowed for this card type.|\n|F|Partial match: card member\u2019s name does not match, but billing postal code matches.|\n|G|Not supported: issuing bank outside the U.S. does not support AVS.|\n|H|Partial match: card member\u2019s name does not match, but street address and postal code match. Returned only for the American Express card type.|\n|I|No match: address not verified. Returned only for Visa cards not issued in the U.S.|\n|K|Partial match: card member\u2019s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.|\n|L|Partial match: card member\u2019s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.|\n|M|See the entry for D & M.|\n|N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member\u2019s name, street address, and postal code do not match.|\n|O|Partial match: card member\u2019s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.|\n|P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.|\n|R|System unavailable.|\n|S|Not supported: issuing bank in the U.S. does not support AVS.|\n|T|Partial match: card member\u2019s name does not match, but street address matches. Returned only for the American Express card type.|\n|U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.|\n|V|Match: card member\u2019s name, billing address, and billing postal code match. Returned only for the American Express card type.|\n|W|Partial match: street address does not match, but 9-digit postal code matches.|\n|X|Match: street address and 9-digit postal code match.|\n|Y|Match: street address and 5-digit postal code match.|\n|Z|Partial match: street address does not match, but 5-digit postal code matches.|\n|1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.|\n|2|Unrecognized: the processor returned an unrecognized value for the AVS response.|\n|3|Match: address is confirmed. Returned only for PayPal Express Checkout.|\n|4|No match: address is not confirmed. Returned only for PayPal Express Checkout.|\n|5|No match: no AVS code was returned by the processor.|\n", - "items": { - "type": "string" - } - }, - "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", - "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" - }, - "credentialStoredOnFile": { - "type": "boolean", - "description": "Indicates to the issuing bank two things:\n- The merchant has received consent from the cardholder to store their card details on file\n- The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder.\nThe purpose of the merchant-initiated transaction is to ensure that the cardholder\u2019s credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant\u2019s file for future 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\nFor details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 Visa Platform Connect.\n" - }, - "storedCredentialUsed": { - "type": "boolean", - "description": "Indicates to an issuing bank whether a merchant-initiated transaction came from a card that was already stored on file.\n\nPossible values:\n- **true** means the merchant-initiated transaction came from a card that was already stored on file.\n- **false** means the merchant-initiated transaction came from a card that was not stored on file.\n" - }, - "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#### Visa Platform Connect\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\nFor details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 Visa Platform Connect.\n" - } - } - } - } + "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" }, - "billPayment": { - "type": "boolean", - "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nFor processor-specific details, see the `bill_payment` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nPossible values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\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" }, - "billPaymentType": { + "issueNumber": { "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 Visa Platform Connect.\n\n**Note** For details about Mastercard bill payments or bill payments with Visa, see `bill_payment_type` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" - } - } - }, - "captureOptions": { - "type": "object", - "properties": { - "captureSequenceNumber": { - "type": "number", - "minimum": 1, - "maximum": 99, - "description": "Capture number when requesting multiple partial captures for one authorization.\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" + "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" }, - "totalCaptureCount": { - "type": "number", - "minimum": 1, - "maximum": 99, - "description": "Total number of captures when requesting multiple partial captures for one payment.\nUsed along with `captureSequenceNumber` field 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" + "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" }, - "dateToCapture": { + "startYear": { "type": "string", "maxLength": 4, - "description": "Date on which you want the capture to occur. This field is supported only for Visa Platform Connect.\\\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\nFor processor-specific details, see `debt_indicator` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n", - "default": false + "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" }, - "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 details, see `auth_first_recurring_payment` field description and \"Recurring Payments\" in\n[Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n", - "default": false + "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. For details, see `card_product_name` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\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" } } }, - "bankTransferOptions": { + "tokenizedCard": { "type": "object", "properties": { - "declineAvsFlags": { + "number": { "type": "string", - "maxLength": 15, - "description": "Space-separated list of AVS flags that cause the request to be declined for AVS reasons.\n\n**Important** To receive declines for the AVS code `N`, you must include the value `N` in the space-separated list.\n\n### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing\n\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 section 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|AVS Code|Description|\n|--- |--- |\n|D|Partial match: postal code and address match.|\n|E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.|\n|F|Partial match: postal code matches, but CPF and address do not match.*|\n|G|Not supported: AVS not supported or not verified.|\n|I|No match: AVS information is not available.|\n|K|Partial match: CPF matches, but postal code and address do not match.*|\n|L|Partial match: postal code and CPF match, but address does not match.*|\n|N|No match: postal code, CPF, and address do not match.*|\n|O|Partial match: CPF and address match, but postal code does not match.*|\n|R|Not supported: your implementation does not support AVS _or_ System unavailable.|\n|T|Partial match: address matches, but postal code and CPF do not match.*|\n|V|Match: postal code, CPF, and address match.*|\n|* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.||\n\n### AVS Codes for All Other Processors\n\n**Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes.\n\n#### American Express Cards\nFor American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes.\n\n**Note** For Visa Platform Connect, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type.\n\n_American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V`\n\n#### Domestic and International Visa Cards\nThe international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes.\n\nAVS is considered either domestic or international, depending on the location of the bank that issued the customer\u2019s payment card:\n- When the bank is in the U.S., the AVS is domestic.\n- When the bank is outside the U.S., the AVS is international.\n\nYou should be prepared to handle both domestic and international AVS result codes:\n- For international cards, you can receive domestic AVS codes in addition to the international AVS codes.\n- For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes.\n\n_International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P`\n\n_Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z`\n\n#### CyberSource Codes\nThe numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type.\n\n_CyberSource Codes_: `1`, `2`, `3`, `4`\n\n### Table of AVS Codes for All Other Processors\n\n|AVS Code|Description|\n|--- |--- |\n|A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.|\n|B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.|\n|C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.|\n|D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.|\n|E|Invalid: AVS data is invalid or AVS is not allowed for this card type.|\n|F|Partial match: card member\u2019s name does not match, but billing postal code matches.|\n|G|Not supported: issuing bank outside the U.S. does not support AVS.|\n|H|Partial match: card member\u2019s name does not match, but street address and postal code match. Returned only for the American Express card type.|\n|I|No match: address not verified. Returned only for Visa cards not issued in the U.S.|\n|K|Partial match: card member\u2019s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.|\n|L|Partial match: card member\u2019s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.|\n|M|See the entry for D & M.|\n|N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member\u2019s name, street address, and postal code do not match.|\n|O|Partial match: card member\u2019s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.|\n|P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.|\n|R|System unavailable.|\n|S|Not supported: issuing bank in the U.S. does not support AVS.|\n|T|Partial match: card member\u2019s name does not match, but street address matches. Returned only for the American Express card type.|\n|U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.|\n|V|Match: card member\u2019s name, billing address, and billing postal code match. Returned only for the American Express card type.|\n|W|Partial match: street address does not match, but 9-digit postal code matches.|\n|X|Match: street address and 9-digit postal code match.|\n|Y|Match: street address and 5-digit postal code match.|\n|Z|Partial match: street address does not match, but 5-digit postal code matches.|\n|1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.|\n|2|Unrecognized: the processor returned an unrecognized value for the AVS response.|\n|3|Match: address is confirmed. Returned only for PayPal Express Checkout.|\n|4|No match: address is not confirmed. Returned only for PayPal Express Checkout.|\n|5|No match: no AVS code was returned by the processor.|\n" + "maxLength": 20, + "description": "Customer\u2019s payment network token value.\n" }, - "secCode": { + "expirationMonth": { "type": "string", - "maxLength": 3, - "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nAccepts only the following values:\n- `ARC`: account receivable conversion\n- `CCD`: corporate cash disbursement\n- `POP`: point of purchase conversion\n- `PPD`: prearranged payment and deposit entry\n- `TEL`: telephone-initiated entry\n- `WEB`: internet-initiated entry\n\nFor details, see `ecp_sec_code` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "maxLength": 2, + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\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 (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\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" }, - "terminalCity": { + "expirationYear": { "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" + "description": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\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\n3000) 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 (`card_ type=039`), if there is no expiration date on the card, use `2021`.\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\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" }, - "terminalState": { + "type": { "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" + "description": "Three-digit value that indicates the card type.\n\nType 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\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" }, - "effectiveDate": { + "cryptogram": { "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" + "maxLength": 40, + "description": "This field is used internally." }, - "partialPaymentId": { + "requestorId": { "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.\nFor details, see `partial_payment_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "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" }, - "customerMemo": { + "transactionType": { "type": "string", - "maxLength": 80, - "description": "Payment related information.\n\nThis information is included on the customer\u2019s statement.\n" + "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" }, - "paymentCategoryCode": { + "assuranceLevel": { "type": "string", - "maxLength": 1, - "description": "Flag that indicates whether to process the payment.\n\nUse with deferred payments.\nFor details, see `ecp_payment_mode` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\n#### Chase Paymentech Solutions and TeleCheck\nUse for deferred and partial payments.\n\n#### CyberSource ACH Service\nNot used.\n\n#### RBS WorldPay Atlanta\nNot used.\n" + "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" }, - "settlementMethod": { + "storageMethod": { "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\nFor details, see `ecp_settlement_method` field description for credit cars and `ecp_debit_settlement_method` for debit cards in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "maxLength": 3, + "description": "Type of technology used in the device to store token data. Possible values:\n\n- `001`: Secure Element (SE). Smart card or memory with restricted access and encryption to prevent data tampering. For storing payment\n credentials, 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). Emulation 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" }, - "fraudScreeningLevel": { + "securityCode": { "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\" in the [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n" + "maxLength": 4, + "description": "Card Verification Number (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n\nFor details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 **Visa Platform Connect**.\n\nFor details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" - } - } - }, - "paymentInformation": { - "type": "object", - "properties": { - "card": { + }, + "fluidData": { "type": "object", "properties": { - "number": { + "keySerialNumber": { "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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html)\n" }, - "expirationMonth": { + "descriptor": { "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\n**Important** 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_cc_expmo` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "maxLength": 128, + "description": "The identifier for a payment solution, which is sending the encrypted payment data to CyberSource for decryption.\nValid values:\n- Samsung Pay: `RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ=`\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.\n\nFor details about the list of payment solution identifiers, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html).\n\nFor details about the encrypted payment data, see the `encrypted_payment_descriptor` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n" }, - "expirationYear": { - "type": "string", - "maxLength": 4, - "description": "Four-digit year in which the credit card expires.\n\nFormat: `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#### Encoded Account Numbers\nFor encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`.\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**Important** 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_cc_expyr` field description 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": "Three-digit value that indicates the card type.\n\nType 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\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\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\n**Note** The value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR0\n- Position: 51\n- Field: Combination Card Transaction Identifier\n\nThis field is supported only for Mastercard transactions in Brazil 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** Combo 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. For details, see `card_product_name` field description in the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\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": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\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 (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\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": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\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\n3000) 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 (`card_ type=039`), if there is no expiration date on the card, use `2021`.\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\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` 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": "Three-digit value that indicates the card type.\n\nType 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\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\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 **Visa Platform Connect** 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 **Visa Platform Connect** 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). Smart card or memory with restricted access and encryption to prevent data tampering. For storing payment\n credentials, 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). Emulation 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 (CVN).\n\n#### Ingenico ePayments\nDo not include this field when **commerceIndicator=recurring**.\n**Note** Ingenico ePayments was previously called _Global Collect_.\n\nFor details, see `customer_cc_cv_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" - } - } - }, - "fluidData": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html)\n" - }, - "descriptor": { - "type": "string", - "maxLength": 128, - "description": "The identifier for a payment solution, which is sending the encrypted payment data to CyberSource for decryption.\nValid values:\n- Samsung Pay: `RklEPUNPTU1PTi5TQU1TVU5HLklOQVBQLlBBWU1FTlQ=`\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.\n\nFor details about the list of payment solution identifiers, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html).\n\nFor details about the encrypted payment data, see the `encrypted_payment_descriptor` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n" - }, - "value": { + "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\nFor details, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html) for the specific payment- solution entry.\n" @@ -1136,7 +693,7 @@ "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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n" + "description": "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.\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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n\n#### Invoicing\nGrand total for the order, this is required for creating a new invoice.\n" }, "currency": { "type": "string", @@ -1153,6 +710,11 @@ "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" }, + "gratuityAmount": { + "type": "string", + "maxLength": 13, + "description": "Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`.\nWhen your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not\nsubmit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the\nissuer has chargeback rights for the excess amount.\n\nFor information about partial authorizations, see Credit Card Services Using the SCMP API.\n\nRestaurant data is supported only on CyberSource through VisaNet.\n" + }, "taxAmount": { "type": "string", "maxLength": 12, @@ -1209,7 +771,7 @@ "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 Visa Platform Connect (VPC) 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": "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", @@ -1334,17 +896,17 @@ "company": { "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.\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" + "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.\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": 60, - "description": "Payment card 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, Visa Platform Connect 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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card 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\n**Important** 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` request-level field description 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#### Visa Platform Connect\n**Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" }, "address3": { "type": "string", @@ -1359,12 +921,12 @@ "locality": { "type": "string", "maxLength": 50, - "description": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing city.\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:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description 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": 20, - "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##### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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 description 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", @@ -1374,7 +936,7 @@ "country": { "type": "string", "maxLength": 2, - "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing country. 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\n**Important** 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 description 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", @@ -1389,12 +951,12 @@ "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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n" }, "phoneNumber": { "type": "string", "maxLength": 15, - "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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" + "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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", @@ -1685,7 +1247,7 @@ "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", + "type": "integer", "description": "Identifier for the merchandise. Possible value:\n\n - 1000: Gift card\n\nThis field is supported only for **American Express Direct**.\n" }, "transactionAdviceAddendum": { @@ -1765,7 +1327,7 @@ "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" + "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\nFor 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)\n" }, "id": { "type": "string", @@ -1876,7 +1438,7 @@ "salesOrganizationId": { "type": "string", "maxLength": 11, - "description": "Company ID assigned to an independent sales organization. Get this value from Mastercard.\n\n#### Visa Platform Connect\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. Visa Platform Connect 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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 description 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", @@ -1936,12 +1498,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### Visa Platform Connect\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\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" + "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\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#### Visa Platform Connect\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" + "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", @@ -1954,22 +1516,22 @@ "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#### Visa Platform Connect\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" + "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\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "First line of the sub-merchant\u2019s street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Sub-merchant\u2019s city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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" }, "administrativeArea": { "type": "string", "maxLength": 3, - "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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", @@ -1979,22 +1541,22 @@ "postalCode": { "type": "string", "maxLength": 15, - "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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#### Visa Platform Connect\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" + "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 - Visa Platform Connect: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### Visa Platform Connect\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. Visa Platform Connect 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" + "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 - Visa Platform Connect: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### Visa Platform Connect\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" + "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" } } } @@ -2100,7 +1662,7 @@ "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\nFor details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Note** The information about EMV applies to credit card processing and PIN debit\nprocessing. All other information in this guide applies only to credit card processing. PIN debit\nprocessing is available only on FDC Nashville Global.\n\n**Note** 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", + "type": "integer", "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": { @@ -2115,7 +1677,7 @@ "default": false }, "fallbackCondition": { - "type": "number", + "type": "integer", "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**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card.\n\nFor details, see the `emv_request_fallback_condition` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" } } @@ -2208,7 +1770,7 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### Visa Platform Connect\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see \"Installment Payments on Visa Platform Connect\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "value": { "type": "string", @@ -2482,7 +2044,7 @@ "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\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### Visa Platform Connect and GPN\nFor details about this value for Visa Platform Connect and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "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\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "networkTransactionId": { "type": "string", @@ -2558,7 +2120,7 @@ "codeRaw": { "type": "string", "maxLength": 2, - "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### Visa Platform Connect\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\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" + "description": "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard.\n\n#### CyberSource through VisaNet\nThe value for this field corresponds to the following data in the TC 33 capture file1:\n- Record: CP01 TCR7\n- Position: 96-99\n- Field: Response Data-Merchant Advice Code\n\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" } } }, @@ -2618,12 +2180,12 @@ "name": { "type": "string", "maxLength": 30, - "description": "The description for this field is not available.\n" + "description": "Mapped Electronic Verification response code for the customer\u2019s name.\n" }, "nameRaw": { "type": "string", "maxLength": 30, - "description": "The description for this field is not available." + "description": "Raw Electronic Verification response code from the processor for the customer\u2019s name.\n" } } }, @@ -2670,7 +2232,7 @@ "systemTraceAuditNumber": { "type": "string", "maxLength": 6, - "description": "This field is returned only for **American Express Direct** and **Visa Platform Connect**.\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#### Visa Platform Connect\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n\nFor details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "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\nFor details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "paymentAccountReferenceNumber": { "type": "string", @@ -2680,7 +2242,7 @@ "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 **Visa Platform Connect**.\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\n#### Visa Platform Connect\n\nThe value for this field corresponds to the following data in the TC 33 capture file,1:\n- Record: CP01 TCR6\n- Position: 136-137\n- Field: Mastercard Transaction Integrity Classification\n\n1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.\nVisa Platform Connect creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses\nthis information to facilitate end-of-day clearing processing with payment networks.\n" + "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\n#### CyberSource through VisaNet\n\nThe value for this field corresponds to the following data in the TC 33 capture file,1:\n- Record: CP01 TCR6\n- Position: 136-137\n- Field: Mastercard Transaction Integrity Classification\n\n1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource.\nCyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant\u2019s acquirer, who uses\nthis information to facilitate end-of-day clearing processing with payment networks.\n" }, "amexVerbalAuthReferenceNumber": { "type": "string", @@ -2688,24 +2250,24 @@ "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", + "type": "integer", "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\n#### Visa Platform Connect\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 133-134\n- Field: Mastercard Merchant on-behalf service.\n**Note** This field is returned only for Visa Platform Connect.\n" + "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\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: 133-134\n- Field: Mastercard Merchant on-behalf service.\n**Note** This field is returned only for CyberSource through VisaNet.\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\n**Note** This field is returned only for **Visa Platform Connect**.\n" + "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\n**Note** 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\n#### Visa Platform Connect\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 132\n- Field: Mastercard Member Defined service.\n**Note** This field is returned only for Visa Platform Connect.\n" + "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\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: 132\n- Field: Mastercard Member Defined service.\n**Note** This field is returned only for CyberSource through VisaNet.\n" }, "name": { "type": "string", @@ -2750,7 +2312,7 @@ "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 **Visa Platform Connect**.\n\nFor details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "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 details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "responseCode": { "type": "string", @@ -2791,7 +2353,7 @@ "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 **Visa Platform Connect** and **FDC Nashville Global**.\n" + "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", @@ -2806,7 +2368,7 @@ "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 **Visa Platform Connect** and **FDC Nashville Global**.\n" + "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" } } }, @@ -2821,7 +2383,7 @@ "accountStatus": { "type": "string", "maxLength": 1, - "description": "Possible values:\n\n - `N`: Nonregulated\n - `R`: Regulated\n\n**Note** This field is returned only for Visa Platform Connect.\n" + "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", @@ -2861,7 +2423,7 @@ "group": { "type": "string", "maxLength": 1, - "description": "Type of commercial card. This field is supported only for Visa Platform Connect. Possible values:\n\n - **B**: Business card\n - **R**: Corporate card\n - **S**: Purchasing card\n - **0**: Noncommercial card\n" + "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", @@ -2966,6 +2528,16 @@ "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\nFor details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**Note** The information about EMV applies to credit card processing and PIN debit\nprocessing. All other information in this guide applies only to credit card processing. PIN debit\nprocessing is available only on FDC Nashville Global.\n\n**Note** 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" + }, + "chipValidationType": { + "type": "string", + "maxLength": 2, + "description": "Entity or service that provided the validation results returned in **chipValidationResult**.\n\nPossible values:\n - **02**: MasterCard on-behalf pre-validation service (The MasterCard authorization platform validated the M/Chip cryptogram before the authorization request reached the issuer.)\n - **03**: MasterCard on-behalf stand-in service (The MasterCard authorization platform validated the M/Chip cryptogram because the issuer was not available.)\n - **50**: Issuer\n - **90**: Chip fall-back transaction downgrade process (The chip could not be read.)\n\nThis field is returned only for NFC payment network tokenization transactions with MasterCard.\n\n**Note** No CyberSource through VisaNet acquirers support EMV at this time.\n" + }, + "chipValidationResult": { + "type": "string", + "maxLength": 1, + "description": "Cryptogram validation results returned by the entity or service specified in **chipValidationType**.\n\nPossible values:\n- **A**: Application cryptogram is valid, but the application transaction counter (ATC) is outside allowed range. (A large jump in ATC values may indicate data copying or other fraud.)\n- **C**: Chip validation was completed successfully.\n- **E**: Application cryptogram is valid but the ATC indicates possible replay fraud.\n- **F**: Format error in the chip data.\n- **G**: Application cryptogram is valid but is not a valid authorization request cryptogram (ARQC).\n- **I**: Application cryptogram is invalid.\n- **T**: Application cryptogram is valid but terminal verification results (TVR) or card verification results (CVR) are invalid.\n- **U**: Application cryptogram could not be validated because of a technical error.\n\nThis field is returned only for NFC payment network tokenization transactions with MasterCard.\n\n**Note** No CyberSource through VisaNet acquirers support EMV at this time.\n" } } }, @@ -3773,7 +3345,7 @@ "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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n" + "description": "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.\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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n\n#### Invoicing\nGrand total for the order, this is required for creating a new invoice.\n" }, "currency": { "type": "string", @@ -3822,7 +3394,7 @@ "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 **Visa Platform Connect**.\n\nFor details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "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 details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" } } } @@ -4001,12 +3573,12 @@ "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\n#### Visa Platform Connect\nThe value for this field corresponds to the following data in the TC 33 capture file:\n- Record: CP01 TCR6\n- Position: 133-134\n- Field: Mastercard Merchant on-behalf service.\n**Note** This field is returned only for Visa Platform Connect.\n" + "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\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: 133-134\n- Field: Mastercard Merchant on-behalf service.\n**Note** This field is returned only for CyberSource through VisaNet.\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\n**Note** This field is returned only for **Visa Platform Connect**.\n" + "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\n**Note** This field is returned only for **CyberSource through VisaNet**.\n" } } }, @@ -4278,13 +3850,18 @@ "maxLength": 1, "description": "Set this field to 3 to indicate that the request includes Level III data." }, + "industryDataType": { + "type": "string", + "maxLength": 10, + "description": "Flag that indicates that the transaction includes airline data or restaurant data.\n\nThis field must be set to `airline` in order for airline data to be sent to the processor.\n\nFor example, if this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor.\n\nYou must set this field to `restaurant` in order for restaurant data to be sent to the processor.\n\nWhen this field is not set to restaurant or is not included in the request, CyberSource does not send restaurant data to the processor.\n\nPossible Values:\n\n- **airline**\n- **restaurant**\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 **Visa Platform Connect**.\n\nFor details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "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 details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" } } }, @@ -4312,13 +3889,13 @@ "type": "object", "properties": { "captureSequenceNumber": { - "type": "number", + "type": "integer", "minimum": 1, "maximum": 99, "description": "Capture number when requesting multiple partial captures for one authorization.\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", + "type": "integer", "minimum": 1, "maximum": 99, "description": "Total number of captures when requesting multiple partial captures for one payment.\nUsed along with `captureSequenceNumber` field 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" @@ -4350,7 +3927,7 @@ "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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n" + "description": "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.\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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n\n#### Invoicing\nGrand total for the order, this is required for creating a new invoice.\n" }, "currency": { "type": "string", @@ -4367,6 +3944,11 @@ "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" }, + "gratuityAmount": { + "type": "string", + "maxLength": 13, + "description": "Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`.\nWhen your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not\nsubmit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the\nissuer has chargeback rights for the excess amount.\n\nFor information about partial authorizations, see Credit Card Services Using the SCMP API.\n\nRestaurant data is supported only on CyberSource through VisaNet.\n" + }, "taxAmount": { "type": "string", "maxLength": 12, @@ -4504,27 +4086,27 @@ "company": { "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.\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" + "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.\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": 60, - "description": "Payment card 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, Visa Platform Connect 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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card 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\n**Important** 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` request-level field description 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#### Visa Platform Connect\n**Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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 description 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": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing city.\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:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description 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": 20, - "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##### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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 description 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", @@ -4534,17 +4116,17 @@ "country": { "type": "string", "maxLength": 2, - "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing country. 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\n**Important** 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 description 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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n" }, "phoneNumber": { "type": "string", "maxLength": 15, - "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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" + "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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" } } }, @@ -4930,12 +4512,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### Visa Platform Connect\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\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" + "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\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#### Visa Platform Connect\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" + "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", @@ -4943,42 +4525,42 @@ "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#### Visa Platform Connect\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" + "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\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "First line of the sub-merchant\u2019s street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Sub-merchant\u2019s city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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" }, "administrativeArea": { "type": "string", "maxLength": 3, - "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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#### Visa Platform Connect\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" + "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 - Visa Platform Connect: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### Visa Platform Connect\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. Visa Platform Connect 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" + "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 - Visa Platform Connect: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### Visa Platform Connect\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" + "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" } } } @@ -5019,7 +4601,7 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### Visa Platform Connect\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see \"Installment Payments on Visa Platform Connect\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "value": { "type": "string", @@ -5663,7 +5245,7 @@ "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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n" + "description": "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.\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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n\n#### Invoicing\nGrand total for the order, this is required for creating a new invoice.\n" }, "currency": { "type": "string", @@ -5680,6 +5262,11 @@ "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" }, + "gratuityAmount": { + "type": "string", + "maxLength": 13, + "description": "Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`.\nWhen your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not\nsubmit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the\nissuer has chargeback rights for the excess amount.\n\nFor information about partial authorizations, see Credit Card Services Using the SCMP API.\n\nRestaurant data is supported only on CyberSource through VisaNet.\n" + }, "taxAmount": { "type": "string", "maxLength": 12, @@ -5817,27 +5404,27 @@ "company": { "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.\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" + "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.\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": 60, - "description": "Payment card 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, Visa Platform Connect 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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card 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\n**Important** 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` request-level field description 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#### Visa Platform Connect\n**Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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 description 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": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing city.\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:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description 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": 20, - "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##### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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 description 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", @@ -5847,17 +5434,17 @@ "country": { "type": "string", "maxLength": 2, - "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing country. 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\n**Important** 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 description 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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n" }, "phoneNumber": { "type": "string", "maxLength": 15, - "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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" + "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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" } } }, @@ -6194,12 +5781,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### Visa Platform Connect\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\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" + "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\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#### Visa Platform Connect\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" + "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", @@ -6207,42 +5794,42 @@ "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#### Visa Platform Connect\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" + "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\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "First line of the sub-merchant\u2019s street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Sub-merchant\u2019s city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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" }, "administrativeArea": { "type": "string", "maxLength": 3, - "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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#### Visa Platform Connect\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" + "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 - Visa Platform Connect: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### Visa Platform Connect\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. Visa Platform Connect 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" + "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 - Visa Platform Connect: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### Visa Platform Connect\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" + "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" } } } @@ -6278,7 +5865,7 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### Visa Platform Connect\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see \"Installment Payments on Visa Platform Connect\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "value": { "type": "string", @@ -6783,7 +6370,7 @@ "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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n" + "description": "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.\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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n\n#### Invoicing\nGrand total for the order, this is required for creating a new invoice.\n" }, "currency": { "type": "string", @@ -6800,6 +6387,11 @@ "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" }, + "gratuityAmount": { + "type": "string", + "maxLength": 13, + "description": "Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`.\nWhen your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not\nsubmit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the\nissuer has chargeback rights for the excess amount.\n\nFor information about partial authorizations, see Credit Card Services Using the SCMP API.\n\nRestaurant data is supported only on CyberSource through VisaNet.\n" + }, "taxAmount": { "type": "string", "maxLength": 12, @@ -6937,27 +6529,27 @@ "company": { "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.\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" + "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.\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": 60, - "description": "Payment card 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, Visa Platform Connect 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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card 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\n**Important** 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` request-level field description 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#### Visa Platform Connect\n**Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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 description 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": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing city.\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:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description 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": 20, - "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##### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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 description 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", @@ -6967,17 +6559,17 @@ "country": { "type": "string", "maxLength": 2, - "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing country. 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\n**Important** 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 description 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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n" }, "phoneNumber": { "type": "string", "maxLength": 15, - "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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" + "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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" } } }, @@ -7314,12 +6906,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### Visa Platform Connect\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\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" + "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\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#### Visa Platform Connect\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" + "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", @@ -7327,42 +6919,42 @@ "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#### Visa Platform Connect\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" + "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\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "First line of the sub-merchant\u2019s street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Sub-merchant\u2019s city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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" }, "administrativeArea": { "type": "string", "maxLength": 3, - "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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#### Visa Platform Connect\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" + "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 - Visa Platform Connect: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### Visa Platform Connect\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. Visa Platform Connect 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" + "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 - Visa Platform Connect: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### Visa Platform Connect\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" + "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" } } } @@ -7398,7 +6990,7 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### Visa Platform Connect\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see \"Installment Payments on Visa Platform Connect\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "value": { "type": "string", @@ -7794,6 +7386,11 @@ "maxLength": 1, "description": "Set this field to 3 to indicate that the request includes Level III data." }, + "industryDataType": { + "type": "string", + "maxLength": 10, + "description": "Flag that indicates that the transaction includes airline data or restaurant data.\n\nThis field must be set to `airline` in order for airline data to be sent to the processor.\n\nFor example, if this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor.\n\nYou must set this field to `restaurant` in order for restaurant data to be sent to the processor.\n\nWhen this field is not set to restaurant or is not included in the request, CyberSource does not send restaurant data to the processor.\n\nPossible Values:\n\n- **airline**\n- **restaurant**\n" + }, "recurringOptions": { "type": "object", "properties": { @@ -7953,7 +7550,7 @@ "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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n" + "description": "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.\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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n\n#### Invoicing\nGrand total for the order, this is required for creating a new invoice.\n" }, "currency": { "type": "string", @@ -7970,6 +7567,11 @@ "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" }, + "gratuityAmount": { + "type": "string", + "maxLength": 13, + "description": "Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`.\nWhen your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not\nsubmit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the\nissuer has chargeback rights for the excess amount.\n\nFor information about partial authorizations, see Credit Card Services Using the SCMP API.\n\nRestaurant data is supported only on CyberSource through VisaNet.\n" + }, "taxAmount": { "type": "string", "maxLength": 12, @@ -8107,27 +7709,27 @@ "company": { "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.\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" + "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.\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": 60, - "description": "Payment card 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, Visa Platform Connect 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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card 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\n**Important** 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` request-level field description 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#### Visa Platform Connect\n**Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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 description 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": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing city.\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:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description 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": 20, - "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##### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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 description 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", @@ -8137,17 +7739,17 @@ "country": { "type": "string", "maxLength": 2, - "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing country. 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\n**Important** 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 description 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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n" }, "phoneNumber": { "type": "string", "maxLength": 15, - "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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" + "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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" } } }, @@ -8484,12 +8086,12 @@ "aggregatorId": { "type": "string", "maxLength": 20, - "description": "Value that identifies you as a payment aggregator. Get this value from the\nprocessor.\n\n#### Visa Platform Connect\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\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" + "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\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#### Visa Platform Connect\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" + "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", @@ -8497,42 +8099,42 @@ "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#### Visa Platform Connect\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" + "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\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "First line of the sub-merchant\u2019s street address.\n\nFor processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Sub-merchant\u2019s city.\n\nFor processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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" }, "administrativeArea": { "type": "string", "maxLength": 3, - "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Sub-merchant\u2019s state or province.\n\nFor possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Visa Platform Connect\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" + "description": "Partial postal code for the sub-merchant\u2019s address.\n\nFor processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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#### Visa Platform Connect\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" + "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 - Visa Platform Connect: 40\n - FDC Compass: 40\n - FDC Nashville Global: 19\n\n#### Visa Platform Connect\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. Visa Platform Connect 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" + "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 - Visa Platform Connect: 20\n - FDC Compass: 13\n - FDC Nashville Global: 10\n\n#### Visa Platform Connect\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" + "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" } } } @@ -8556,7 +8158,7 @@ "default": false }, "fallbackCondition": { - "type": "number", + "type": "integer", "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**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card.\n\nFor details, see the `emv_request_fallback_condition` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" } } @@ -8630,7 +8232,7 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### Visa Platform Connect\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see \"Installment Payments on Visa Platform Connect\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "value": { "type": "string", @@ -10056,8 +9658,8 @@ "categoryTag": "Transaction_Batches" }, "x-queryParameterDefaults": { - "startTime": "2018-10-01T00:00:00.000Z", - "endTime": "2018-10-30T23:59:59.000Z" + "startTime": "2019-05-22T01:47:57.000Z", + "endTime": "2019-07-22T22:47:57.000Z" }, "produces": [ "application/hal+json" @@ -10628,522 +10230,588 @@ } } }, - "/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", + "/pts/v1/transaction-batch-details/{id}": { + "get": { "tags": [ - "Payouts" + "TransactionBatches" ], - "operationId": "octCreatePayment", + "summary": "Get transaction details for a given batch id\n", + "description": "Provides real-time detailed status information about the transactions \nthat you previously uploaded in the Business Center or processed with \nthe Offline Transaction File Submission service.\n", + "operationId": "getTransactionBatchDetails", "x-devcenter-metaData": { - "categoryTag": "Payouts" + "categoryTag": "Transaction_Batches", + "isClientSideApi": true }, + "produces": [ + "text/csv", + "application/xml" + ], "parameters": [ { - "name": "octCreatePaymentRequest", - "in": "body", + "name": "id", + "in": "path", + "description": "The batch id assigned for the template.", "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.\nPlease refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)\n**Example date format:**\n - yyyy-MM-dd\n", + "required": false, + "type": "string", + "format": "date" + }, + { + "name": "status", + "in": "query", + "description": "Allows you to filter by rejected response.\n\nValid values:\n- Rejected\n", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "examples": { + "text/csv": "Submission Date/Time,Submission File ID,link_to_request,request_id,transaction_date,cybs_mid,processor_mid,hierarchy_id,trans_ref_number,merchant_ref_number,transaction_type,amount,transaction_amount_currency,payment_method,payment_type,account_suffix,decision,reason_code,reserved,auth_trans_ref_number,auth_date,auth_request_id,auth_amount,auth_currency,auth_code,auth_reason_code,auth_rcode,merchant_defined_data1,merchant_defined_data2,merchant_defined_data3,merchant_defined_data4\n2019-03-08 10:50:23 GMT,01lzdah4,5520424090516341303098,5520424090516341303098,2019-03-08 10:53:29 GMT,testrest,,101011000871000110003,51512455,4,ics_auth,8.00,GBP ,credit card,Visa,1111,,100,,,,5520424090516341303098,,,,,,3817,,,\n", + "application/xml": "\n\n\n \n 5520424090516341303098\n 5520424090516341303098\n 2019-03-08 10:53:29 GMT\n pa_gpn\n 101011000871000110003\n 51512455\n 7vvc3645\n ics_auth\n 8.00\n GBP\n credit card\n Visa\n 1111\n 100\n \n 5520424090516341303098\n \n 3817\n \n \n" + } + }, + "400": { + "description": "Bad Request", "schema": { + "title": "ptsV1TransactionBatchDetailsGet400Response", "type": "object", "properties": { - "clientReferenceInformation": { + "errorInformation": { "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 \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://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" + "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" + } + } + } } } }, - "orderInformation": { + "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": "ptsV1TransactionBatchDetailsGet401Response", + "type": "object", + "properties": { + "errorInformation": { "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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\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 Visa Platform Connect (VPC) 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\n**Important** 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` request-level field description 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\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `customer_lastname` request-level field description 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": "Payment card 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, Visa Platform Connect 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\n**Important** 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` request-level field description 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#### Visa Platform Connect\n**Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description 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": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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\nFor processor-specific information, see the `bill_city` field description 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": 20, - "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##### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description 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\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][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\n 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` request-level field description 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\n#### For Payouts:\nThis 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#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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", - "description": "Customer's phone number type.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nPossible Values:\n* day\n* home\n* night\n* work\n" + "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" + } } } } } }, - "merchantInformation": { + "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": "ptsV1TransactionBatchDetailsGet403Response", + "type": "object", + "properties": { + "errorInformation": { "type": "object", "properties": { - "categoryCode": { - "type": "integer", - "maximum": 9999, - "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company\u2019s cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description 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\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", - "description": "Time that the transaction was submitted in local time. The time is in hhmmss format.\n" + "reason": { + "type": "string" }, - "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 description 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" + "message": { + "type": "string" }, - "merchantDescriptor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Merchant's name.\n\nFor more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n" - }, - "locality": { - "type": "string", - "maxLength": 13, - "description": "Merchant's City.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description\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": "Merchant's country.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description\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": "The state where the merchant is located.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_state` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nMerchant 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": "Merchant's postal code.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_postal_code` field description\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_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\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.\n" + }, + "message": { + "type": "string", + "description": "The detailed message related to the status and reason listed above.\n" + } } } } } }, - "recipientInformation": { + "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": "ptsV1TransactionBatchDetailsGet404Response", + "type": "object", + "properties": { + "errorInformation": { "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." + "reason": { + "type": "string" }, - "phoneNumber": { - "type": "string", - "maxLength": 20, - "description": "Recipient phone number. Required only for FDCCompass." + "message": { + "type": "string" }, - "dateOfBirth": { - "type": "string", - "minLength": 8, - "maxLength": 8, - "description": "Recipient date of birth in YYYYMMDD format. Required only for FDCCompass." + "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" + } + } + } } } }, - "senderInformation": { + "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": "ptsV1TransactionBatchDetailsGet502Response", + "type": "object", + "properties": { + "errorInformation": { "type": "object", "properties": { - "referenceNumber": { + "reason": { "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" - } - } + "description": "The reason of status" }, - "firstName": { + "message": { "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": { + "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" + } + } + } + } + } + } + }, + "/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", - "maxLength": 2, - "description": "Sender\u2019s state. Use the State, Province, and Territory Codes for the United States and Canada.\n" + "example": "4622943127013705", + "minLength": 12, + "maxLength": 19, + "description": "Credit card number (PAN)." }, - "countryCode": { + "expirationMonth": { "type": "string", + "format": "MM", + "example": "12", + "minLength": 2, "maxLength": 2, - "description": "Country of sender. Use the ISO Standard Country Codes.\n* CTV (3)\n" + "description": "Card expiration month.\n\nFormat: `MM`.\nPossible values: `01` through `12`.\n" }, - "postalCode": { + "expirationYear": { "type": "string", - "maxLength": 10, - "description": "Sender\u2019s postal code. Required only for FDCCompass." + "format": "YYYY", + "example": "2022", + "minLength": 4, + "maxLength": 4, + "description": "Card expiration year.\n\nFormat: `YYYY`.\nPossible values: `1900` through `2099`.\n" }, - "phoneNumber": { + "securityCode": { "type": "string", - "maxLength": 20, - "description": "Sender\u2019s phone number. Required only for FDCCompass." - }, - "dateOfBirth": { + "example": "838", + "minLength": 3, + "maxLength": 4, + "description": "Card security code." + } + } + }, + "BankAccount": { + "type": "object", + "properties": { + "number": { "type": "string", - "minLength": 8, - "maxLength": 8, - "description": "Sender\u2019s date of birth in YYYYMMDD format. Required only for FDCCompass." + "example": "1234567890123456800", + "minLength": 1, + "maxLength": 19, + "description": "Checking account number." }, - "vatRegistrationNumber": { + "routingNumber": { "type": "string", - "maxLength": 13, - "description": "Customer's government-assigned tax identification number.\n" + "example": "123456789", + "minLength": 1, + "maxLength": 9, + "description": "Routing number." } } }, - "processingInformation": { + "billTo": { "type": "object", "properties": { - "businessApplicationId": { + "address1": { "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" + "example": "8310 Capital of Texas Highway North", + "description": "First address line registered with card." }, - "networkRoutingOrder": { + "address2": { "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" + "example": "Bluffstone Drive", + "description": "Second address line registered with card." }, - "commerceIndicator": { + "locality": { "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\nFor details, see the `e_commerce_indicator` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nPossible value for Payouts:\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\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Other Types of Transactions\nFor details, see \"Commerce Indicators\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "example": "Austin", + "description": "Locality registered with card." }, - "reconciliationId": { + "administrativeArea": { "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" + "example": "TX", + "description": "Administrative area registered with card." }, - "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" - } - } + "postalCode": { + "type": "string", + "example": "78731", + "description": "Postal code registered with card." + }, + "country": { + "type": "string", + "example": "US", + "description": "Country registered with card." } } - }, - "paymentInformation": { + } + } + } + } + ], + "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": { - "card": { + "self": { "type": "object", "properties": { - "type": { - "type": "string", - "description": "Three-digit value that indicates the card type.\n\nType 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\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\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 description 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 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\n**Important** 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_cc_expmo` field description 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#### 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#### Encoded Account Numbers\nFor encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`.\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**Important** 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_cc_expyr` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "sourceAccountType": { + "href": { "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** Combo 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" + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" } } }, - "customer": { + "ancestor": { "type": "object", "properties": { - "customerId": { + "href": { "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\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" } } - } - } - } - }, - "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" + }, + "successor": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + } } }, - "processingInformation": { - "commerceIndicator": "internet", - "businessApplicationId": "FD", - "networkRoutingOrder": "ECG" + "id": { + "type": "string", + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." }, - "payoutsOptions": { - "retrievalReferenceNumber": "123456789012", - "acquirerBin": "567890124" + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "'Describes type of token.'\n\nValid values:\n- instrumentIdentifier\n" }, - "reconciliationId": "1087488702VIAQNSPQ", - "orderInformation": { - "amountDetails": { - "totalAmount": "100.00", - "currency": "USD" + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + }, + "card": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." + } } }, - "merchantInformation": { - "merchantCategoryCode": "123", - "merchantDescriptor": { - "country": "US", - "postalCode": "94440", - "locality": "FC", - "name": "Thomas", - "administrativeArea": "CA" + "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." + } } }, - "paymentInformation": { - "card": { - "expirationYear": "2025", - "number": "4111111111111111", - "expirationMonth": "12", - "type": "001", - "sourceAccountType": "CH" + "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." + } + } + } + } + } + } + } } }, - "recipientInformation": { - "firstName": "John", - "lastName": "Doe", - "address1": "Paseo Padre Boulevard", - "locality": "Foster City", - "administrativeArea": "CA", - "postalCode": "94400", - "phoneNumber": "6504320556", - "dateOfBirth": "19801009", - "country": "US" + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } + } } } - } - } - ], - "responses": { - "201": { - "description": "Successful response.", - "schema": { - "title": "ptsV2PayoutsPost201Response", - "example": { + }, + "examples": { + "application/json": { "_links": { "self": { - "href": "/pts/v2/payouts/5287556536256000401540", - "method": "GET" + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" } }, - "clientReferenceInformation": { - "code": "1528755653559" + "paymentInstruments": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments" }, - "id": "5287556536256000401540", - "orderInformation": { - "amountDetails": { - "totalAmount": "100.00", - "currency": "USD" - } + "id": "1234567890123456789", + "object": "instrumentIdentifier", + "state": "ACTIVE", + "card": { + "number": "444444XXXXXX4444" }, - "processorInformation": { - "systemTraceAuditNumber": "897596", - "approvalCode": "831000", - "transactionId": "016153570198200", - "responseCode": "00", - "responseCodeSource": "5" + "processingInformation": { + "authorizationOptions": { + "initiator": { + "merchantInitiatedTransaction": { + "previousTransactionId": "123456789012345" + } + } + } }, - "reconciliationId": "1087488702VIAQNSPQ", - "status": "ACCEPTED", - "submitTimeUtc": "2018-06-11T222054Z" + "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", - "description": "This is the endpoint of the resource that was created by the successful request." - }, - "method": { + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + } + } + }, + "ancestor": { + "type": "object", + "properties": { + "href": { "type": "string", - "description": "`method` refers to the HTTP method that you can send to the `self` endpoint to retrieve details of the resource." + "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" } } } @@ -11151,239 +10819,311 @@ }, "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`\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" + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." }, - "status": { + "object": { "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - ACCEPTED\n - DECLINED\n - INVALID_REQUEST\n" + "readOnly": true, + "example": "instrumentIdentifier", + "description": "'Describes type of token.'\n\nValid values:\n- instrumentIdentifier\n" }, - "reconciliationId": { + "state": { "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" + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" }, - "errorInformation": { + "card": { "type": "object", "properties": { - "reason": { + "number": { "type": "string", - "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" - }, - "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" - } - } - } + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." } } }, - "clientReferenceInformation": { + "bankAccount": { "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 \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://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": { + "number": { "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" + "example": "1234567890123456800", + "minLength": 1, + "maxLength": 19, + "description": "Checking account number." }, - "ownerMerchantId": { + "routingNumber": { "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\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\nFor details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "properties": { - "name": { - "type": "string", - "description": "Merchant's name.\n\nFor more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n" - }, - "locality": { - "type": "string", - "maxLength": 13, - "description": "Merchant's City.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description\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": "Merchant's country.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - } - } + "example": "123456789", + "minLength": 1, + "maxLength": 9, + "description": "Routing number." } } }, - "orderInformation": { + "processingInformation": { "type": "object", "properties": { - "amountDetails": { + "authorizationOptions": { "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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n" - }, - "currency": { - "type": "string", - "maxLength": 3, - "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\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" + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + } + } } } } } }, - "processorInformation": { + "metadata": { "type": "object", + "readOnly": true, "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 **Visa Platform Connect**.\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#### Visa Platform Connect\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n\nFor details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" - }, - "responseCodeSource": { + "creator": { "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" + "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" + } }, - "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" - } + "id": "1234567890123456789", + "object": "instrumentIdentifier", + "state": "ACTIVE", + "card": { + "number": "444444XXXXXX4444" + }, + "processingInformation": { + "authorizationOptions": { + "initiator": { + "merchantInitiatedTransaction": { + "previousTransactionId": "123456789012345" } } } + }, + "metadata": { + "creator": "user" } - }, - "type": "object" + } } }, "400": { - "description": "Invalid request.", + "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": "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\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" - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." - }, - "details": { - "type": "array", - "items": { + "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": { - "field": { + "name": { "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." + "description": "The name of the field that threw the error." }, - "reason": { + "location": { "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" + "description": "The location of the field that threw the error." } } } } } + }, + "examples": { + "Missing Headers": { + "errors": [ + { + "type": "missingHeaders", + "message": "Missing header values." + } + ] + } } }, - "502": { - "description": "Unexpected system error or system timeout.", + "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": "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" - }, - "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" - }, - "message": { - "type": "string", - "description": "The detail message related to the status and reason listed above." + "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." + } + } + } } } } @@ -11391,6844 +11131,1508 @@ }, "x-example": { "example0": { - "summary": "Payout (Card not Token)", + "summary": "Create Instrument Identifier (Card)", "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" + "card": { + "number": "411111111111112" } } }, "example1": { - "summary": "Payout (Token)", + "summary": "Create Instrument Identifier (Bank Account)", "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" + "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" + } + } + } + } + } }, - "/reporting/v3/report-downloads": { + "/tms/v1/instrumentidentifiers/{tokenId}": { "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" - ], + "summary": "Retrieve an Instrument Identifier", "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.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)\n\n**Example date format:**\n - yyyy-MM-dd\n", + "name": "profile-id", + "in": "header", + "description": "The id of a profile containing user specific TMS configuration.", "required": true, "type": "string", - "format": "date" + "minLength": 36, + "maxLength": 36 }, { - "name": "reportName", - "in": "query", - "description": "Name of the report to download", + "name": "tokenId", + "in": "path", + "description": "The TokenId of an Instrument Identifier.", + "required": true, "type": "string", - "required": true + "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": "OK" - }, - "400": { - "description": "Invalid Request", + "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": "reportingv3ReportDownloadsGet400Response", + "title": "tmsV1InstrumentIdentifiersGet200Response", "type": "object", - "required": [ - "submitTimeUtc", - "reason", - "message", - "details" - ], "properties": { - "submitTimeUtc": { + "_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", - "format": "date-time", - "description": "Time of request in UTC. \n", - "example": "2016-08-11T22:47:57Z" + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." }, - "reason": { + "object": { "type": "string", - "description": "Documented reason code\n", - "example": "INVALID_DATA" + "readOnly": true, + "example": "instrumentIdentifier", + "description": "'Describes type of token.'\n\nValid values:\n- instrumentIdentifier\n" }, - "message": { + "state": { "type": "string", - "description": "Short descriptive message to the user.\n", - "example": "One or more fields contains invalid data" + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" }, - "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" - } + "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." }, - "description": "Provides failed validation input field detail\n" + "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." + } } } - }, - "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.[Rfc Date Format](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.[Rfc Date Format](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\n\nValid values:\n- reportTimeFrame\n- executedTime\n", - "required": true, - "type": "string" - }, - { - "name": "reportMimeType", - "in": "query", - "description": "Valid Report Format\n\nValid values:\n- application/xml\n- text/csv\n", - "required": false, - "type": "string" - }, - { - "name": "reportFrequency", - "in": "query", - "description": "Valid Report Frequency\n\nValid values:\n- DAILY\n- WEEKLY\n- MONTHLY\n- ADHOC\n", - "required": false, - "type": "string" - }, - { - "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" + } + }, + "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" + } + } + } }, - { - "name": "reportStatus", - "in": "query", - "description": "Valid Report Status\n\nValid values:\n- COMPLETED\n- PENDING\n- QUEUED\n- RUNNING\n- ERROR\n- NO_DATA\n", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "OK", + "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": "reportingV3ReportsGet200Response", - "type": "object", - "properties": { - "reportSearchResults": { - "type": "array", - "items": { + "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": { - "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\n\nValid values:\n- application/xml\n- text/csv\n" - }, - "reportFrequency": { - "type": "string", - "example": "DAILY", - "description": "Frequency of the report to get generated\n\nValid values:\n- DAILY\n- WEEKLY\n- MONTHLY\n- ADHOC\n" - }, - "status": { - "type": "string", - "description": "Status of the report\n\nValid values:\n- COMPLETED\n- PENDING\n- QUEUED\n- RUNNING\n- ERROR\n- NO_DATA\n" - }, - "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": { + "name": { "type": "string", - "example": "CUSTOM", - "description": "Specifies whether the subscription created is either Custom, Standard or Classic\n" + "description": "The name of the field that threw the error." }, - "groupId": { + "location": { "type": "string", - "example": "12345", - "description": "Id for selected group." + "description": "The location of the field that threw the error." } - }, - "description": "Report Search Result Bean" + } } } } + }, + "examples": { + "Missing Headers": { + "errors": [ + { + "type": "missingHeaders", + "message": "Missing header values." + } + ] + } } }, - "400": { - "description": "Invalid Request", + "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": "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": { + "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": { - "field": { + "name": { "type": "string", - "description": "Field in request that caused an error\n" + "description": "The name of the field that threw the error." }, - "reason": { + "location": { "type": "string", - "description": "Documented reason code\n" + "description": "The location of the field that threw the error." } - }, - "description": "Provides failed validation input field detail\n" + } } } - }, - "description": "HTTP status code for client application" + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted." + } + ] + } } }, "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, + "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": { - "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": { + "title": "tmsV1TokenNotFound404Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { "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'\n \nValid values:\n- application/xml\n- text/csv\n", - "example": "application/xml" - }, - "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" - } + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." }, - "description": "List of filters to apply", - "example": { - "Application.Name": [ - "ics_auth", - "ics_bill" - ] - } - }, - "reportPreferences": { - "type": "object", - "description": "Report Preferences", - "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)\n\nValid values:\n- SOAPI\n- SCMP\n" + "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." + } } } - }, - "groupName": { - "type": "string", - "pattern": "[0-9]*", - "description": "Specifies the group name", - "example": "myGroup" } } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Token not found" + } + ] + } } - } - ], - "responses": { - "201": { - "description": "Created" - }, - "304": { - "description": "Not Modified" }, - "400": { - "description": "Invalid request", + "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": "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": { + "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": { - "field": { + "name": { "type": "string", - "description": "Field in request that caused an error\n" + "description": "The name of the field that threw the error." }, - "reason": { + "location": { "type": "string", - "description": "Documented reason code\n" + "description": "The location of the field that threw the error." } - }, - "description": "Provides failed validation input field detail\n" + } } } - }, - "description": "HTTP status code for client application" + } + }, + "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" }, - "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\n\nValid values:\n- application/xml\n- text/csv\n" - }, - "reportFrequency": { - "type": "string", - "example": "DAILY", - "description": "Report Frequency Value\n\nValid values:\n- DAILY\n- WEEKLY\n- MONTHLY\n- ADHOC\n" - }, - "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\n\nValid values:\n- COMPLETED\n- PENDING\n- QUEUED\n- RUNNING\n- ERROR\n- NO_DATA\n- RERUN\n" - }, - "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)\n\nValid values:\n- SOAPI\n- SCMP\n" - } - } - }, - "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", - "description": "Valid values:\n- application/xml\n- text/csv\n" - } - }, - "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", - "description": "Valid values:\n- application/xml\n- text/csv\n" - } - }, - "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 \n \nValid values:\n- application/xml\n- text/csv\n" - }, - "reportFrequency": { - "type": "string", - "example": "DAILY", - "description": "'Report Frequency'\n\nValid values:\n- DAILY\n- WEEKLY\n- MONTHLY\n- ADHOC\n" - }, - "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", - "description": "Report Preferences", - "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)\n\nValid values:\n- SOAPI\n- SCMP\n" - } - } - }, - "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", - "description": "Valid values:\n- application/xml\n- text/csv\n", - "example": "application/xml" - }, - "reportFrequency": { - "type": "string", - "description": "'The frequency for which subscription is created.'\n\nValid values:\n- 'DAILY'\n- 'WEEKLY'\n- 'MONTHLY'\n- 'ADHOC'\n", - "example": "DAILY" - }, - "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", - "description": "Report Preferences", - "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)\n\nValid values:\n- SOAPI\n- SCMP\n" - } - } - }, - "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 \n \nValid values:\n- application/xml\n- text/csv\n" - }, - "reportFrequency": { - "type": "string", - "example": "DAILY", - "description": "'Report Frequency'\n\nValid values:\n- DAILY\n- WEEKLY\n- MONTHLY\n- ADHOC\n" - }, - "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", - "description": "Report Preferences", - "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)\n\nValid values:\n- SOAPI\n- SCMP\n" - } - } - }, - "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.[Rfc Date Format](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.[Rfc Date Format](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.[Rfc Date Format](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.[Rfc Date Format](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" - }, - { - "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" - }, - { - "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", - "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." - } - } - }, - "type": "object" - } - }, - "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/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.[Rfc Date Format](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.[Rfc Date Format](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.[Rfc Date Format](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.[Rfc Date Format](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.[Rfc Date Format](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", - "description": "Valid values:\n- PURCHASES\n- REFUNDS\n- FEES\n- CHARGEBACKS\n", - "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" - } - } - } - } - } - }, - "/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", - "sendDisabled": true, - "disabledReason": "DM API response is a mock response, Please integrate with DM API to test the real-time response from the server." - }, - "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 \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://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 description 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": "Three-digit value that indicates the card type.\n\nType 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\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\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\n**Important** 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_cc_expmo` field description 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#### 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#### Encoded Account Numbers\nFor encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`.\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**Important** 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_cc_expyr` field description 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": "Three-digit value that indicates the card type.\n\nType 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\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" - }, - "number": { - "type": "string", - "maxLength": 20, - "description": "Customer\u2019s payment network token value.\n" - }, - "expirationMonth": { - "type": "string", - "maxLength": 2, - "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\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 (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\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": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\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\n3000) 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 (`card_ type=039`), if there is no expiration date on the card, use `2021`.\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\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` 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 I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n" - } - } - }, - "shippingDetails": { - "type": "object", - "description": "Contains shipping information not related to address.", - "properties": { - "giftWrap": { - "type": "boolean", - "description": "Boolean that indicates whether the customer requested gift wrapping for this\npurchase. This field can contain one of the following\nvalues:\n- true: The customer requested gift wrapping.\n- false: 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": "boolean", - "description": "Boolean that indicates whether returns are accepted for this order.\nThis field can contain one of the following values:\n- true: Returns are accepted for this order.\n- false: 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 description 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\namounts and maximum field lengths. See these guides for details:\n- [Merchant Descriptors Using the SCMP API Guide]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n- \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party\nProvider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" - }, - "quantity": { - "type": "number", - "minimum": 1, - "maximum": 9999999999, - "description": "Number of units for this order.\n\nThe default is `1`. 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\nWhen orderInformation.lineItems[].productCode is \"gift_card\",\nthis 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\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" - }, - "gift": { - "type": "boolean", - "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- true: Orders are assigned only slight additional risk if billing and shipping addresses are different.\n- false: Orders are assigned higher additional risk if billing and shipping addresses are different.\n" - }, - "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 [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\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." - }, - "nationality": { - "type": "string", - "maxLength": 2, - "description": "Passenger's nationality country. Use the two character ISO Standard Country Codes." - } - } - } - } - } - }, - "billTo": { - "type": "object", - "properties": { - "address1": { - "type": "string", - "maxLength": 60, - "description": "Payment card 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, Visa Platform Connect 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\n**Important** 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` request-level field description 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#### Visa Platform Connect\n**Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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": 20, - "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##### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description 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": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description 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": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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\nFor processor-specific information, see the `bill_city` field description 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\n**Important** 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` request-level field description 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\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `customer_lastname` request-level field description 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\n#### For Payouts:\nThis 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#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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\n**Important** 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` request-level field description 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\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][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\n 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` request-level field description 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": { - "username": { - "type": "string", - "maxLength": 255, - "description": "Specifies the customer account user name." - }, - "hashedPassword": { - "type": "string", - "maxLength": 100, - "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n\nFor details about this field, see the `customer_password` field description in [Decision Manager Developer Guide Using the SCMP API.](https://www.cybersource.com/developers/documentation/fraud_management/)\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 `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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" - }, - "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": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer\u2019s driver\u2019s license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder\u2019s passport. Recommended for Discover ProtectBuy.\n\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\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" - } - } - } - } - } - }, - "deviceInformation": { - "type": "object", - "properties": { - "cookiesAccepted": { - "type": "string", - "description": "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": 48, - "description": "IP address of the customer.\n" - }, - "hostName": { - "type": "string", - "maxLength": 60, - "description": "DNS resolved hostname from `ipAddress`." - }, - "fingerprintSessionId": { - "type": "string", - "description": "Field that 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\ndifferent session IDs.\n\nThe session ID must be unique for each merchant ID. You can use any string that you are already\ngenerating, such as an order number or web session ID.\n\nThe session ID must be unique for each page load, regardless of an individual\u2019s web session ID.\nIf a user navigates to a profiled page and is assigned a web session, navigates away from the\nprofiled page, then navigates back to the profiled page, the generated session ID should be different\nand unique. You may use a web session ID, but it is preferable to use an application GUID (Globally\nUnique Identifier). This measure ensures that a unique ID is generated every time the page is\nloaded, 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": "CVN result code.\n\nFor details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\n**Note** By default, your default profile is the active profile, or the Profile Selector chooses the active profile. Use this field\nonly if you want to specify the name of a different profile. The passed-in profile will then become the active profile.\n" - } - } - }, - "eventType": { - "type": "string", - "maxLength": 255, - "description": "Specifies one of the following types of events:\n- login\n- account_creation\n- account_update\nFor regular payment transactions, do not send this field.\n" - } - } - }, - "travelInformation": { - "type": "object", - "properties": { - "actualFinalDestination": { - "type": "string", - "maxLength": 3, - "description": "IATA Code for the actual final destination that the customer intends to travel to.\nIt should be a destination on the completeRoute.\n" - }, - "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:\n`travelInformation.legs.0.origination=SFO`\n`travelInformation.legs.1.origination=SFO`\n\n**Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you\nsend all the fields, the complete route takes precedence over the individual legs.\n\nFor details, see the `decision_manager_travel_leg#_orig` field description in [Decision Manager Using the SCMP API Developer Guide.](https://www.cybersource.com/developers/documentation/fraud_management/)\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 [IATA Airline and Airport Code Search](https://www.iata.org/publications/Pages/code-search.aspx). The leg number can be a\npositive integer from 0 to N.\nFor example:\n\n`travelInformation.legs.0.destination=SFO`\n`travelInformation.legs.1.destination=SFO`\n\n**Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you\nsend all the fields, the complete route takes precedence over the individual legs.\n\nFor details, see the `decision_manager_travel_leg#_dest` field description in [Decision Manager Using the SCMP API Developer Guide.](https://www.cybersource.com/developers/documentation/fraud_management/)\n" - }, - "departureDateTime": { - "type": "string", - "maxLength": 25, - "description": "Departure date and time for the each 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\nWhere:\\\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\nairline is based in city A, but the flight departs from city\nB, `z` is the time zone of city B at the time of departure.\\\n**Important** For travel information, use GMT instead of UTC, or use the local time zone.\n\n#### Examples\n\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\\\n\n**Note** 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" - } - } - } - } - } - }, - "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.\n**Warning** 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\n**Note** By default, your default profile is the active profile, or the Profile Selector chooses the active profile. Use this field\nonly if you want to specify the name of a different profile. The passed-in profile will then become the active profile.\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\nFor all possible values, see the `decision_velocity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\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.\n\nFor all possible values, see the `score_address_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", - "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\nFor all possible values, see the `score_hotlist_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\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\nFor all possible values, see the `score_identity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", - "items": { - "type": "string" - } - }, - "internet": { - "type": "array", - "description": "Indicates a problem with the customer\u2019s email address, IP address, or billing address.\n\nFor all possible values, see the `score_internet_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", - "items": { - "type": "string" - } - }, - "phone": { - "type": "array", - "description": "Indicates a problem with the customer\u2019s phone number.\n\nFor all possible values, see the `score_phone_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", - "items": { - "type": "string" - } - }, - "suspicious": { - "type": "array", - "description": "Indicates that the customer provided potentially suspicious information.\n\nFor all possible values, see the `score_suspicious_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", - "items": { - "type": "string" - } - }, - "globalVelocity": { - "type": "array", - "description": "Indicates that the customer has a high purchase frequency.\n\nFor all possible values, see the `score_velocity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", - "items": { - "type": "string" - } - } - } - }, - "velocity": { - "type": "object", - "properties": { - "morphing": { - "type": "array", - "description": "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.\n\nFor all possible values, see the `decision_velocity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", - "items": { - "type": "object", - "properties": { - "count": { - "type": "integer", - "maxLength": 5, - "description": "Morphing count specified by the number #.\n\n**Note** The count is not returned for the initial transaction.\n\nFor all possible values, see the `decision_velocity_morphing_#_count` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" - }, - "fieldName": { - "type": "string", - "maxLength": 255, - "description": "Field name of the morphing element. specified by the setting that you chose in the\nVelocity Editor.\n\nFor all possible values, see the `decisionReply_morphingElement_#_fieldName` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" - }, - "informationCode": { - "type": "string", - "maxLength": 255, - "description": "Identifier that CyberSource assigned to the velocity rule specified by the number #.\n\nFor all possible values, see the `decision_velocity_morphing_#_info_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" - } - } - } - }, - "address": { - "type": "array", - "items": { - "type": "string", - "maxLength": 255, - "description": "Indicates a mismatch between the customer's billing and shipping addresses.\n\nFor all possible values, see the `score_address_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" - } - } - } - }, - "casePriority": { - "type": "integer", - "maxLength": 1, - "description": "You receive this field only if you subscribe to the Enhanced Case Management service. The priority level ranges from 1 (highest) to 5 (lowest); the default value is 3. If you do not assign a priority to your rules or to your profiles, the default value is given to the order.\n\nFor all possible values, see the `decision_case_priority` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\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\nFor details, see the `score_time_local` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/)\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\nFor all possible values, see the `score_factors` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\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\nFor all possible values, see the `score_model_used` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" - }, - "result": { - "type": "string", - "maxLength": 255, - "description": "Total score calculated for this order. The value cannot be negative.\n\nFor all possible values, see the `score_score_result` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\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.\n\nFor all possible values, see the `score_ip_anonymizer_status` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" - }, - "locality": { - "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\nFor all possible values, see the `score_ip_city` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\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\nFor all possible values, see the `score_ip_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" - }, - "administrativeArea": { - "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\nFor all possible values, see the `score_ip_state` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\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.\n\nFor all possible values, see the `score_ip_routing_method` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" - } - } - }, - "providers": { - "type": "object", - "properties": { - "providerName": { - "type": "array", - "items": { - "type": "object", - "description": "Name of the 3rd party provider, for example, Emailage.\n\nFor all possible values, see the `decision_provider_#_name` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", - "properties": { - "fieldName": { - "type": "array", - "items": { - "type": "string", - "description": "Field name, for example, email address domain name (domain_name).\n\nFor all possible values, see the `decision_provider_#_field_#_name` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" - } - }, - "fieldValue": { - "type": "array", - "items": { - "type": "string", - "description": "Value for the field, for example, yahoo.com." - } - } - } - } - } - } - }, - "travel": { - "type": "object", - "properties": { - "actualFinalDestination": { - "type": "object", - "properties": { - "country": { - "type": "string", - "maxLength": 90, - "description": "Country of actual final destination on the route." - }, - "locality": { - "type": "string", - "maxLength": 90, - "description": "City of actual final destination on the route." - }, - "latitude": { - "type": "string", - "maxLength": 10, - "description": "Latitude of actual final destination on the route." - }, - "longitude": { - "type": "string", - "maxLength": 10, - "description": "Longitude of actual final destination on the route." - } - } - }, - "firstDeparture": { - "type": "object", - "properties": { - "country": { - "type": "string", - "maxLength": 90, - "description": "Country of first departure on the route." - }, - "locality": { - "type": "string", - "maxLength": 90, - "description": "City of first departure on the route." - }, - "latitude": { - "type": "string", - "maxLength": 10, - "description": "Latitude of first departure on the route." - }, - "longitude": { - "type": "string", - "maxLength": 10, - "description": "Longitude of first departure on the route." - } - } - }, - "firstDestination": { - "type": "object", - "properties": { - "country": { - "type": "string", - "maxLength": 90, - "description": "Country of first destination on the route." - }, - "locality": { - "type": "string", - "maxLength": 90, - "description": "City of first destination on the route." - }, - "latitude": { - "type": "string", - "maxLength": 10, - "description": "Latitude of first destination on the route." - }, - "longitude": { - "type": "string", - "maxLength": 10, - "description": "Longitude of first destination on the route." - } - } - }, - "lastDestination": { - "type": "object", - "properties": { - "country": { - "type": "string", - "maxLength": 90, - "description": "Country of last destination on the route." - }, - "locality": { - "type": "string", - "maxLength": 90, - "description": "City of last destination on the route." - }, - "latitude": { - "type": "string", - "maxLength": 10, - "description": "Latitude of last destination on the route." - }, - "longitude": { - "type": "string", - "maxLength": 10, - "description": "Longitude of last destination on the route." - } - } - } - } - } - } - }, - "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 CyberSource Business Center.\n\nFor all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\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\nFor all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" - }, - "issuer": { - "type": "string", - "maxLength": 255, - "description": "Name of the bank or entity that issued the card account.\n\nFor all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" - }, - "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\n**Note** Additional values may be present.\n\nFor all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" - }, - "bin": { - "type": "string", - "maxLength": 255, - "description": "Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field\nor from the first six characters of the `customer_cc_num` field.\n\nFor all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\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 - PENDING_AUTHENTICATION\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" - } - } - } - } - } - } + "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" } - } - }, - "400": { - "description": "Invalid request", + }, "schema": { - "title": "riskV1DecisionsPost400Response", + "title": "tmsV1InstrumentIdentifiersPatch200Response", "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" - }, - "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" + "_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" + } } } } - } - } - } - }, - "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" }, - "reason": { + "id": { "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" + "readOnly": true, + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." }, - "message": { + "object": { "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." + "readOnly": true, + "example": "instrumentIdentifier", + "description": "'Describes type of token.'\n\nValid values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" }, - "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" + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." + } + } }, - "amountDetails": { - "currency": "USD", - "totalAmount": "144.14" - } - }, - "merchantDefinedInformation": [ - { - "key": "1", - "value": "Test" + "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." + } + } }, - { - "key": "2", - "value": "Test2" + "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." + } + } } - ] + } }, - "responseValue": { - "riskInformation": { - "score": { - "result": "99", - "modelUsed": "default" + "examples": { + "application/json": { + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500" + } }, - "localTime": "10:02:05", - "profile": { - "name": "Profile 1_test", - "selectorRule": "Default Active Profile" + "id": "58FEBAEFD2EEFCE1E0539399D30A7500", + "object": "instrumentIdentifier", + "state": "ACTIVE", + "card": { + "number": "424242XXXXXX4242" }, - "paymentInformation": { - "scheme": "VISA CREDIT", - "bin": "444444", - "accountType": "GOLD", - "issuer": "CREDIT AGRICOLE BANK POLSKA, S.A." + "processingInformation": { + "authorizationOptions": { + "initiator": { + "merchantInitiatedTransaction": { + "previousTransactionId": 123456789012345 + } + } + } }, - "casePriority": "3" - }, - "rules": [ - { - "decision": "REJECT", - "name": "Incorrect merchant defined data " + "metadata": { + "creator": "user" } - ] + } } }, - "example3": { - "summary": "DM with Travel Information", - "value": { - "clientReferenceInformation": { - "code": "54323007" - }, - "paymentInformation": { - "card": { - "expirationMonth": "12", - "expirationYear": "2020", - "number": "4444444444444448" + "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." + } + ] }, - "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" - } + "Invalid Parameters": { + "errors": [ + { + "type": "invalidParameters", + "message": "Invalid parameter values.", + "details": [ + { + "name": "id" + } + ] + } + ] }, - "travelInformation": { - "completeRoute": "SFO-JFK:JFK-BLR", - "departureTime": "2011-03-20 11:30pm GMT", - "journeyType": "One way", - "legs": [ + "Unknown Field": { + "errors": [ { - "destination": "JFK", - "origination": "SFO" - }, + "type": "unknownField", + "message": "Unknown body values.", + "details": [ + { + "name": "id" + } + ] + } + ] + }, + "Unsupported Fields": { + "errors": [ { - "destination": "BLR", - "origination": "JFK" + "type": "unsupportedFields", + "message": "Unsupported body values for this action.", + "details": [ + { + "name": "bankAccount" + }, + { + "name": "card" + } + ] } ] } - }, - "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" + "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." + } + } + } } - }, - "buyerInformation": { - "hashedPassword": "", - "dateOfBirth": "1998-05-05", - "personalIdentification": [ + } + }, + "examples": { + "application/json": { + "errors": [ { - "id": "1a23apwe98", - "type": "CPF" + "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" + } }, - "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 " + "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" + } + ] + } } }, - "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" + "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." + } + } + } } } }, - "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." - }, + "examples": { + "application/json": { + "errors": [ { - "decision": "IGNORE", - "name": "CVN not submitted" + "type": "notAvailable", + "message": "Token not available." } - ], - "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" - } + "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" } }, - "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" + "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." + } + } + } } - }, - "status": "REJECTED", - "submitTimeUtc": "2019-03-14T09:31:35Z" + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Profile not found" + } + ] + } } }, - "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" - } + "500": { + "description": "Unexpected error.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" } }, - "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": [ + "examples": { + "application/json": { + "errors": [ { - "decision": "IGNORE", - "name": "Correctable errors in addresses" + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, + "schema": { + "title": "tmsV1Error500Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" }, - { - "decision": "REVIEW", - "name": "Order is above your AFS threshold for review." + "message": { + "type": "string", + "description": "The detailed message related to the type stated above." }, - { - "decision": "IGNORE", - "name": "CVN not submitted" + "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." + } + } } - ], - "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": { + }, + "delete": { + "summary": "Delete an Instrument Identifier", "tags": [ - "SecureFileShare" + "Instrument Identifier" ], - "summary": "Get list of files", - "description": "Get list of files and it's information of them available inside the report directory", - "operationId": "getFileDetail", + "operationId": "deleteInstrumentIdentifier", "x-devcenter-metaData": { - "categoryTag": "Secure_File_Share" - }, - "x-queryParameterDefaults": { - "organizationId": "testrest", - "startDate": "2018-10-20", - "endDate": "2018-10-30" + "categoryTag": "Token_Management" }, + "consumes": [ + "application/json;charset=utf-8" + ], "produces": [ - "application/hal+json" + "application/json;charset=utf-8" ], "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.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)\n\n **Example date format:**\n - yyyy-MM-dd\n", + "name": "profile-id", + "in": "header", + "description": "The id of a profile containing user specific TMS configuration.", "required": true, "type": "string", - "format": "date" + "minLength": 36, + "maxLength": 36 }, { - "name": "endDate", - "in": "query", - "description": "Valid end date in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14)\n\n **Example date format:**\n - yyyy-MM-dd\n", + "name": "tokenId", + "in": "path", + "description": "The TokenId of an Instrument Identifier.", "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, + "minLength": 16, "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'\n\nValid values:\n- 'application/xml'\n- 'text/csv'\n- 'application/pdf'\n- 'application/octet-stream'\n", - "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" - } - } - } - } - } - } + "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" } } }, - "400": { - "description": "Invalid request", + "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": "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": { + "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": { - "path": { - "type": "string", - "description": "Path of the failed property" - }, - "message": { + "name": { "type": "string", - "description": "Error description about validation failed field" + "description": "The name of the field that threw the error." }, - "localizationKey": { + "location": { "type": "string", - "description": "Localized Key Name" + "description": "The location of the field that threw the error." } - }, - "description": "Provide validation failed input field details" + } } } - }, - "description": "Error Bean" + } }, "examples": { "application/json": { - "code": "VALIDATION_ERROR", - "correlationId": null, - "detail": null, - "fields": [ + "errors": [ { - "path": "startTime", - "message": "Start date should not precede 18 months from current time in GMT", - "localizationKey": null + "type": "forbidden", + "message": "Request not permitted." } - ], - "localizationKey": "cybsapi.validation.errors", - "message": "Field validation errors" + ] } } }, - "401": { - "description": "Ok", + "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": "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": { + "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": { - "path": { - "type": "string", - "description": "Path of the failed property" - }, - "message": { + "name": { "type": "string", - "description": "Error description about validation failed field" + "description": "The name of the field that threw the error." }, - "localizationKey": { + "location": { "type": "string", - "description": "Localized Key Name" + "description": "The location of the field that threw the error." } - }, - "description": "Provide validation failed input field details" + } } } - }, - "description": "Error Bean" + } }, "examples": { "application/json": { - "code": "VALIDATION_ERROR", - "correlationId": null, - "detail": null, - "fields": [ + "errors": [ { - "path": "organizationId", - "message": "Organization doesn't has access to File details", - "localizationKey": null + "type": "notFound", + "message": "Token not found" } - ], - "localizationKey": "cybsapi.validation.errors", - "message": "Field validation errors" + ] } } }, - "404": { - "description": "Files Info 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": "V1FileDetailsGet404Response", - "type": "object", - "required": [ - "code", - "message" - ], + "title": "tmsV1InstrumentIdentifiersDelete409Response", + "type": "array", "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": { + "_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": { - "path": { - "type": "string", - "description": "Path of the failed property" - }, - "message": { + "name": { "type": "string", - "description": "Error description about validation failed field" + "description": "The name of the field that threw the error." }, - "localizationKey": { + "location": { "type": "string", - "description": "Localized Key Name" + "description": "The location of the field that threw the error." } - }, - "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" + "_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." + } + ] } } }, - "500": { - "description": "Internal Server Error", + "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": "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": { + "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": { - "path": { - "type": "string", - "description": "Path of the failed property" - }, - "message": { + "name": { "type": "string", - "description": "Error description about validation failed field" + "description": "The name of the field that threw the error." }, - "localizationKey": { + "location": { "type": "string", - "description": "Localized Key Name" + "description": "The location of the field that threw the error." } - }, - "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" + "errors": [ + { + "type": "notAvailable", + "message": "Token not available." + } + ] } } - } - } - } - }, - "/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", + "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": "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": { + "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": { - "path": { - "type": "string", - "description": "Path of the failed property" - }, - "message": { + "name": { "type": "string", - "description": "Error description about validation failed field" + "description": "The name of the field that threw the error." }, - "localizationKey": { + "location": { "type": "string", - "description": "Localized Key Name" + "description": "The location of the field that threw the error." } - }, - "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." + } + } + }, + "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", + "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": "createInstrumentIdentifier", + "operationId": "getAllPaymentInstruments", "x-devcenter-metaData": { "categoryTag": "Token_Management" }, @@ -18240,19 +12644,19 @@ ], "responses": { "200": { - "description": "An existing Instrument Identifier containing the same data has already been returned.", + "description": "Returns an array of Payment Instruments associated with the supplied Instrument Identifier.", "headers": { - "Location": { - "description": "Link to the Instrument Identifier.", - "type": "string" - }, "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": "tmsV1InstrumentIdentifiersPost200Response", + "title": "tmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response", "type": "object", "properties": { "_links": { @@ -18264,264 +12668,504 @@ "properties": { "href": { "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + "description": "A link to the current requested collection.", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=20&limit=5\"" } } }, - "ancestor": { + "first": { "type": "object", "properties": { "href": { "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + "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" } } }, - "successor": { + "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/1234567890123456789" + "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" } } } } }, - "id": { + "object": { "type": "string", "readOnly": true, - "example": "1234567890123456800", - "description": "Unique identification number assigned by CyberSource to the submitted request." + "example": "collection", + "description": "'Shows the response is a collection of objects.'\n\nValid values:\n- collection\n" }, - "object": { + "offset": { "type": "string", "readOnly": true, - "example": "instrumentIdentifier", - "description": "'Describes type of token.'\n\nValid values:\n- instrumentIdentifier\n" + "example": "20", + "description": "The offset parameter supplied in the request." }, - "state": { + "limit": { "type": "string", "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + "example": "1", + "description": "The limit parameter supplied in the request." }, - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Customer\u2019s credit card number." - } - } + "count": { + "type": "string", + "readOnly": true, + "example": "1", + "description": "The number of Payment Instruments returned in the array." }, - "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." - } - } + "total": { + "type": "string", + "readOnly": true, + "example": "39", + "description": "The total number of Payment Instruments associated with the Instrument Identifier in the zero-based dataset." }, - "processingInformation": { + "_embedded": { "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." + "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.'\n\nValid values:\n- paymentInstrument\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + }, + "type": { + "type": "string", + "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- 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", + "example": "driver license", + "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\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", + "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." - } - } - } - } - }, - "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.'\n\nValid values:\n- instrumentIdentifier\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" - }, - "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." + } + } + }, + "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.'\n\nValid values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + }, + "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." + } } } } @@ -18530,17 +13174,6 @@ } } } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } } } }, @@ -18548,29 +13181,97 @@ "application/json": { "_links": { "self": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/5B32CE6167B09343E05333B9D30A53E1/paymentinstruments?offset=20&limit=1" }, - "paymentInstruments": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments" + "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" } }, - "id": "1234567890123456789", - "object": "instrumentIdentifier", - "state": "ACTIVE", - "card": { - "number": "444444XXXXXX4444" - }, - "processingInformation": { - "authorizationOptions": { - "initiator": { - "merchantInitiatedTransaction": { - "previousTransactionId": "123456789012345" + "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" + } + } } } - } - }, - "metadata": { - "creator": "user" + ] } } } @@ -18624,121 +13325,15 @@ } }, "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" - } - ] + "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": "tmsV1Error500Response", + "title": "tmsV1Forbidden403Response", "type": "array", "items": { "type": "object", @@ -18765,253 +13360,68 @@ } } } - } - } - }, - "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" + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "forbidden", + "message": "Request not permitted." + } + ] } } - } - } - } - }, - "/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.", + "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.", + "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.'\n\nValid values:\n- instrumentIdentifier\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" - }, - "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" + "title": "tmsV1TokenNotFound404Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string" }, - "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" + "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." } } } - }, - "metadata": { - "creator": "user" } } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Token not found" + } + ] + } } }, - "400": { - "description": "Bad Request. A required header value could be missing.", + "410": { + "description": "Token Not Available. The token has been deleted.", "headers": { "uniqueTransactionID": { "description": "A globally unique ID associated with your request.", @@ -19019,7 +13429,7 @@ } }, "schema": { - "title": "tmsV1BadRequest400Response", + "title": "tmsV1TokenNotAvailable410Response", "type": "array", "items": { "type": "object", @@ -19048,26 +13458,26 @@ } }, "examples": { - "Missing Headers": { + "application/json": { "errors": [ { - "type": "missingHeaders", - "message": "Missing header values." + "type": "notAvailable", + "message": "Token not available." } ] } } }, - "403": { - "description": "Forbidden. The profile might not have permission to perform the token operation.", + "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.", + "description": "A globally unique id associated with your request.", "type": "string" } }, "schema": { - "title": "tmsV1Forbidden403Response", + "title": "tmsV1FailedDependency424Response", "type": "array", "items": { "type": "object", @@ -19099,23 +13509,33 @@ "application/json": { "errors": [ { - "type": "forbidden", - "message": "Request not permitted." + "type": "notFound", + "message": "Profile not found" } ] } } }, - "404": { - "description": "Token Not Found. The `tokenid` may not exist or was entered incorrectly.", + "500": { + "description": "Unexpected error.", "headers": { "uniqueTransactionID": { - "description": "A globally unique ID associated with your request.", + "description": "A globally unique id associated with your request.", "type": "string" } }, + "examples": { + "application/json": { + "errors": [ + { + "type": "serverError", + "message": "Internal server error" + } + ] + } + }, "schema": { - "title": "tmsV1TokenNotFound404Response", + "title": "tmsV1Error500Response", "type": "array", "items": { "type": "object", @@ -19140,218 +13560,447 @@ } } } - } - } - }, - "examples": { - "application/json": { - "errors": [ - { - "type": "notFound", - "message": "Token not found" + } + } + } + } + } + } + }, + "/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.'\n\nValid values:\n- paymentInstrument\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + }, + "type": { + "type": "string", + "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- 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", + "example": "driver license", + "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\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" + } } - ] - } - } - }, - "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." + }, + "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", + "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" + } } } } - } - } - }, - "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." + }, + "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." + } } } } - } - } - }, - "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." - } + }, + "metaData": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." } } - } - } - } - } - } - }, - "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": { + }, + "instrumentIdentifier": { "type": "object", "properties": { - "authorizationOptions": { + "_links": { "type": "object", + "readOnly": true, "properties": { - "initiator": { + "self": { "type": "object", "properties": { - "merchantInitiatedTransaction": { + "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.'\n\nValid values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + }, + "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": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." + "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." + } + } } } } @@ -19360,9 +14009,9 @@ } ], "tags": [ - "Instrument Identifier" + "Payment Instrument" ], - "operationId": "updateInstrumentIdentifier", + "operationId": "createPaymentInstrument", "x-devcenter-metaData": { "categoryTag": "Token_Management" }, @@ -19373,8 +14022,8 @@ "application/json;charset=utf-8" ], "responses": { - "200": { - "description": "The updated Instrument Identifier has been returned.", + "201": { + "description": "A new Payment Instrument has been created.", "headers": { "uniqueTransactionID": { "description": "A globally unique ID associated with your request.", @@ -19382,7 +14031,7 @@ } }, "schema": { - "title": "tmsV1InstrumentIdentifiersPatch200Response", + "title": "tmsV1PaymentInstrumentsPost201Response", "type": "object", "properties": { "_links": { @@ -19428,7 +14077,7 @@ "type": "string", "readOnly": true, "example": "instrumentIdentifier", - "description": "'Describes type of token.'\n\nValid values:\n- instrumentIdentifier\n" + "description": "'Describes type of token.'\n\nValid values:\n- paymentInstrument\n" }, "state": { "type": "string", @@ -19436,55 +14085,118 @@ "example": "ACTIVE", "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" }, - "card": { + "bankAccount": { "type": "object", "properties": { - "number": { + "type": { "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Customer\u2019s credit card number." + "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" } } }, - "bankAccount": { + "card": { "type": "object", + "required": [ + "type" + ], "properties": { - "number": { + "expirationMonth": { "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Checking account number." + "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" }, - "routingNumber": { + "expirationYear": { "type": "string", - "example": "123456789", + "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + }, + "type": { + "type": "string", + "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- Falabella private label (063)\n" + }, + "issueNumber": { + "type": "string", + "example": "01", "minLength": 1, - "maxLength": 9, - "description": "Routing number." + "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." } } }, - "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." - } + "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", + "example": "driver license", + "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\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" } } } @@ -19493,312 +14205,247 @@ } } }, - "metadata": { + "billTo": { "type": "object", - "readOnly": true, "properties": { - "creator": { + "firstName": { "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." - } + "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" } } - } - } - }, - "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." + }, + "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", + "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" + } } } } - } - } - }, - "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." + }, + "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." + } } } } - } - } - }, - "examples": { - "application/json": { - "errors": [ - { - "type": "notAvailable", - "message": "Token not available." + }, + "metaData": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } } - ] - } - } - }, - "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." + }, + "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.'\n\nValid values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + }, + "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." + } } } } @@ -19807,160 +14454,77 @@ }, "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" + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/paymentinstruments/5910683634E6B035E0539399D30A4B46" } - ] - } - }, - "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." + }, + "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" } - } - } - } - } - } - } - } - }, - "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." + }, + "id": "58FEBAEFD2EEFCE1E0539399D30A7500", + "object": "instrumentIdentifier", + "state": "ACTIVE", + "card": { + "number": "424242XXXXXX4242" + }, + "processingInformation": { + "authorizationOptions": { + "initiator": { + "merchantInitiatedTransaction": { + "previousTransactionId": 123456789012345 + } + } } - } - } - } - } - }, - "examples": { - "application/json": { - "errors": [ - { - "type": "forbidden", - "message": "Request not permitted." + }, + "metadata": { + "creator": "user" + } } - ] + } } } }, - "404": { - "description": "Token Not Found. The `tokenid` may not exist or was entered incorrectly.", + "400": { + "description": "Bad Request. A required header value could be missing.", "headers": { "uniqueTransactionID": { "description": "A globally unique ID associated with your request.", @@ -19968,7 +14532,7 @@ } }, "schema": { - "title": "tmsV1TokenNotFound404Response", + "title": "tmsV1PaymentInstruments400Response", "type": "array", "items": { "type": "object", @@ -19997,18 +14561,69 @@ } }, "examples": { - "application/json": { + "Missing Headers": { "errors": [ { - "type": "notFound", - "message": "Token not found" + "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" + } + ] } ] } } }, - "409": { - "description": "Conflict. The token is linked to a Payment Instrument.", + "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.", @@ -20016,25 +14631,8 @@ } }, "schema": { - "title": "tmsV1InstrumentIdentifiersDelete409Response", + "title": "tmsV1Forbidden403Response", "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": { @@ -20063,30 +14661,25 @@ }, "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." + "type": "forbidden", + "message": "Request not permitted." } ] } } }, - "410": { - "description": "Token Not Available. The token has been deleted.", + "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.", + "description": "A globally unique id associated with your request.", "type": "string" } }, "schema": { - "title": "tmsV1TokenNotAvailable410Response", + "title": "tmsV1FailedDependency424Response", "type": "array", "items": { "type": "object", @@ -20118,23 +14711,33 @@ "application/json": { "errors": [ { - "type": "notAvailable", - "message": "Token not available." + "type": "notFound", + "message": "Profile not found" } ] } } }, - "424": { - "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "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": "tmsV1FailedDependency424Response", + "title": "tmsV1Error500Response", "type": "array", "items": { "type": "object", @@ -20161,62 +14764,263 @@ } } } - }, - "examples": { - "application/json": { - "errors": [ + } + } + }, + "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": "US", + "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": [ { - "type": "notFound", - "message": "Profile not found" + "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": "US", + "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": "US", + "email": "john.smith@test.com", + "phoneNumber": "+44 2890447951" + }, + "processingInformation": { + "billPaymentProgramEnabled": true + }, + "instrumentIdentifier": { + "card": { + "number": "411111111111112" + } } } }, - "500": { - "description": "Unexpected error.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" + "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": "US", + "email": "john.smith@test.com", + "phoneNumber": "+44 2890447951" + }, + "processingInformation": { + "billPaymentProgramEnabled": true + }, + "instrumentIdentifier": { + "id": "9000000000000000001003" } - }, - "examples": { - "application/json": { - "errors": [ - { - "type": "serverError", - "message": "Internal server error" - } - ] + } + }, + "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": "US", + "email": "john.smith@test.com", + "phoneNumber": "+44 2890447951" + }, + "processingInformation": { + "billPaymentProgramEnabled": true + }, + "instrumentIdentifier": { + "card": { + "number": "411111111111112" + } } - }, - "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." - } - } - } + } + }, + "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": "US", + "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" } } } @@ -20224,9 +15028,9 @@ } } }, - "/tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments": { - "get": { - "summary": "Retrieve all Payment Instruments", + "/tms/v1/paymentinstruments/{tokenId}": { + "patch": { + "summary": "Update a Payment Instrument", "parameters": [ { "name": "profile-id", @@ -20240,572 +15044,629 @@ { "name": "tokenId", "in": "path", - "description": "The TokenId of an Instrument Identifier.", + "description": "The TokenId of a Payment Instrument.", "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": { + "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", - "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" + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" } } }, - "next": { + "ancestor": { "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" + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" } } }, - "last": { + "successor": { "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" + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" } } } } }, - "object": { + "id": { "type": "string", "readOnly": true, - "example": "collection", - "description": "'Shows the response is a collection of objects.'\n\nValid values:\n- collection\n" + "example": "1234567890123456800", + "description": "Unique identification number assigned by CyberSource to the submitted request." }, - "offset": { + "object": { "type": "string", "readOnly": true, - "example": "20", - "description": "The offset parameter supplied in the request." + "example": "instrumentIdentifier", + "description": "'Describes type of token.'\n\nValid values:\n- paymentInstrument\n" }, - "limit": { + "state": { "type": "string", "readOnly": true, - "example": "1", - "description": "The limit parameter supplied in the request." + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" }, - "count": { - "type": "string", - "readOnly": true, - "example": "1", - "description": "The number of Payment Instruments returned in the array." + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "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" + } + } }, - "total": { - "type": "string", - "readOnly": true, - "example": "39", - "description": "The total number of Payment Instruments associated with the Instrument Identifier in the zero-based dataset." + "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + }, + "type": { + "type": "string", + "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- 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." + } + } }, - "_embedded": { + "buyerInformation": { "type": "object", "properties": { - "paymentInstruments": { - "description": "Array of Payment Instruments returned for the supplied Instrument Identifier.", + "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": { - "_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.'\n\nValid values:\n- paymentInstrument\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" - }, - "bankAccount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" - }, - "type": { - "type": "string", - "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- 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." - } - } + "example": "1234567890", + "description": "Customer's identification number.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" }, - "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", - "example": "driver license", - "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\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" - } - } - } - } - } - } - } + "type": { + "type": "string", + "example": "driver license", + "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\n" }, - "billTo": { + "issuedBy": { "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" + "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" } } - }, - "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", - "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" - } - } - } + } + } + } + } + } + }, + "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", + "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" } - }, - "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." + } + }, + "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.'\n\nValid values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + }, + "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.'\n\nValid values:\n- paymentInstrument\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + }, + "type": { + "type": "string", + "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- 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" }, - "metaData": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } + "type": { + "type": "string", + "example": "driver license", + "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\n" }, - "instrumentIdentifier": { + "issuedBy": { "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.'\n\nValid values:\n- instrumentIdentifier\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n \nValid values:\n- ACTIVE\n- CLOSED\n" - }, - "id": { + "administrativeArea": { "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." - } - } + "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" } } } @@ -20813,187 +15674,248 @@ } } } - } - } - }, - "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" + }, + "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", + "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." + } + } + } } }, - "object": "collection", - "offset": 20, - "limit": 1, - "count": 1, - "total": 39, - "_embedded": { - "paymentInstruments": [ - { - "_links": { + "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": { - "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" + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" } - }, - "id": "5B32CE6167B09343E05333B9D30A53E1", - "object": "instrumentIdentifier", - "state": "ACTIVE", - "card": { - "number": "424242XXXXXX1237" - }, - "processingInformation": { - "authorizationOptions": { - "initiator": { + } + }, + "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.'\n\nValid values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + }, + "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": { - "previousTransactionId": "123456789012345" + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } } - } - } - }, - "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." + }, + "metadata": { + "type": "object", + "readOnly": true, + "properties": { + "creator": { + "type": "string", + "example": "merchantName", + "description": "The creator of the token." + } } } } @@ -21002,121 +15924,85 @@ }, "examples": { "application/json": { - "errors": [ - { - "type": "forbidden", - "message": "Request not permitted." + "_links": { + "self": { + "href": "https://api.cybersource.com/tms/v1/paymentinstruments/5910683634E6B035E0539399D30A4B46" } - ] - } - } - }, - "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." + }, + "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" } - } - } - } - } - }, - "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." + }, + "id": "58FEBAEFD2EEFCE1E0539399D30A7500", + "object": "instrumentIdentifier", + "state": "ACTIVE", + "card": { + "number": "424242XXXXXX4242" + }, + "processingInformation": { + "authorizationOptions": { + "initiator": { + "merchantInitiatedTransaction": { + "previousTransactionId": 123456789012345 + } + } } + }, + "metadata": { + "creator": "user" } } } } - }, - "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.", + "400": { + "description": "Bad Request. A required header value could be missing.", "headers": { "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", + "description": "A globally unique ID associated with your request.", "type": "string" } }, "schema": { - "title": "tmsV1FailedDependency424Response", + "title": "tmsV1PaymentInstruments400Response", "type": "array", "items": { "type": "object", @@ -21145,500 +16031,300 @@ } }, "examples": { - "application/json": { + "Missing Headers": { "errors": [ { - "type": "notFound", - "message": "Profile not found" + "type": "missingHeaders", + "message": "Missing header values." } ] - } - } - }, - "500": { - "description": "Unexpected error.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" - } - }, - "examples": { - "application/json": { + }, + "Payment Instrument cannot be linked to instrument identifier because it does not exist": { "errors": [ { - "type": "serverError", - "message": "Internal server error" + "type": "instrumentIdentifierNotFound", + "message": "Action cannot be performed. The `InstrumentIdentifier` is not found" } ] - } - }, - "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.'\n\nValid values:\n- paymentInstrument\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" - }, - "bankAccount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" - }, - "type": { - "type": "string", - "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- 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", - "example": "driver license", - "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\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" - } - } - } - } + }, + "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" } - } + ] } - }, - "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" + ] + }, + "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." + } } } - }, - "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", - "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" - } + } + } + }, + "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." } } } - }, - "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." - } + } + } + }, + "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." } } } - }, - "metaData": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notAvailable", + "message": "Token not available." } - }, - "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.'\n\nValid values:\n- instrumentIdentifier\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n \nValid values:\n- ACTIVE\n- CLOSED\n" - }, - "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." - } - } - } - } - } - } - } + ] + } + } + }, + "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." } - }, - "metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } + } + } + } + } + }, + "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." } } } @@ -21646,11 +16332,34 @@ } } } + } + }, + "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": "createPaymentInstrument", + "operationId": "getPaymentInstrument", "x-devcenter-metaData": { "categoryTag": "Token_Management" }, @@ -21661,8 +16370,8 @@ "application/json;charset=utf-8" ], "responses": { - "201": { - "description": "A new Payment Instrument has been created.", + "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.", @@ -21670,7 +16379,7 @@ } }, "schema": { - "title": "tmsV1PaymentInstrumentsPost201Response", + "title": "tmsV1PaymentinstrumentsPatch200Response", "type": "object", "properties": { "_links": { @@ -22010,7 +16719,7 @@ "type": "string", "readOnly": true, "example": "ACTIVE", - "description": "'Current state of the token.'\n \nValid values:\n- ACTIVE\n- CLOSED\n" + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" }, "id": { "type": "string", @@ -22171,7 +16880,7 @@ } }, "schema": { - "title": "tmsV1PaymentInstruments400Response", + "title": "tmsV1BadRequest400Response", "type": "array", "items": { "type": "object", @@ -22207,57 +16916,293 @@ "message": "Missing header values." } ] - }, - "Payment Instrument cannot be linked to instrument identifier because it does not exist": { + } + } + }, + "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": "instrumentIdentifierNotFound", - "message": "Action cannot be performed. The `InstrumentIdentifier` is not found" + "type": "forbidden", + "message": "Request not permitted." } ] - }, - "Payment Instrument cannot be linked to instrument identifier because it has been deleted": { + } + } + }, + "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": "instrumentIdentifierGone", - "message": "Action cannot be performed. The `InstrumentIdentifier` is gone." + "type": "notFound", + "message": "Token not found" } ] - }, - "Payment Instrument cannot be linked to instrument identifier due to a token type mismatch": { + } + } + }, + "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": "invalidCombination", - "message": "The combination is invalid.", - "details": [ - { - "name": "bankAccount" + "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." }, - { - "name": "card", - "location": "instrumentIdentifier" + "location": { + "type": "string", + "description": "The location of the field that threw the error." } - ] + } + } + } + } + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notFound", + "message": "Profile not found" } ] - }, - "Payment Instrument cannot be created due to invalid combination of Instrument Identifier fields": { + } + } + }, + "500": { + "description": "Unexpected error.", + "headers": { + "uniqueTransactionID": { + "description": "A globally unique id associated with your request.", + "type": "string" + } + }, + "examples": { + "application/json": { "errors": [ { - "type": "invalidCombination", - "message": "The combination is invalid.", - "details": [ - { - "name": "id", - "location": "instrumentIdentifier" + "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." }, - { - "name": "card", - "location": "instrumentIdentifier" + "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" } } }, @@ -22309,16 +17254,16 @@ } } }, - "424": { - "description": "Failed Dependency: e.g. The profile represented by the profile-id may not exist or the profile-id was entered incorrectly.", + "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.", + "description": "A globally unique ID associated with your request.", "type": "string" } }, "schema": { - "title": "tmsV1FailedDependency424Response", + "title": "tmsV1TokenNotFound404Response", "type": "array", "items": { "type": "object", @@ -22351,32 +17296,22 @@ "errors": [ { "type": "notFound", - "message": "Profile not found" + "message": "Token not found" } ] } } }, - "500": { - "description": "Unexpected error.", + "410": { + "description": "Token Not Available. The token has been deleted.", "headers": { "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", + "description": "A globally unique ID associated with your request.", "type": "string" } }, - "examples": { - "application/json": { - "errors": [ - { - "type": "serverError", - "message": "Internal server error" - } - ] - } - }, "schema": { - "title": "tmsV1Error500Response", + "title": "tmsV1TokenNotAvailable410Response", "type": "array", "items": { "type": "object", @@ -22403,263 +17338,110 @@ } } } - } - } - }, - "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": "US", - "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": "US", - "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": "US", - "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": "US", - "email": "john.smith@test.com", - "phoneNumber": "+44 2890447951" - }, - "processingInformation": { - "billPaymentProgramEnabled": true - }, - "instrumentIdentifier": { - "id": "9000000000000000001003" + }, + "examples": { + "application/json": { + "errors": [ + { + "type": "notAvailable", + "message": "Token not available." + } + ] } } }, - "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": "US", - "email": "john.smith@test.com", - "phoneNumber": "+44 2890447951" - }, - "processingInformation": { - "billPaymentProgramEnabled": true - }, - "instrumentIdentifier": { - "card": { - "number": "411111111111112" + "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" + } + ] + } } }, - "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": "US", - "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" + "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." + } + } + } } } } @@ -22667,447 +17449,443 @@ } } }, - "/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": { + "/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", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "'Describes type of token.'\n\nValid values:\n- paymentInstrument\n" - }, - "state": { + "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": "None" + } + } + }, + "responses": { + "200": { + "description": "Retrieved key.", + "schema": { + "title": "flexV1KeysPost200Response", + "properties": { + "keyId": { "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + "description": "Unique identifier for the generated token. Used in the subsequent Tokenize Card request from your customer\u2019s device or browser." }, - "bankAccount": { + "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": { - "type": { + "format": { "type": "string", - "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" + "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." } } }, - "card": { + "jwk": { "type": "object", - "required": [ - "type" - ], + "description": "The public key in JSON Web Key (JWK) format. This format is useful for client side encryption in JavaScript based implementations.", "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" - }, - "type": { + "kty": { "type": "string", - "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- Falabella private label (063)\n" + "description": "Algorithm used to encrypt the public key." }, - "issueNumber": { + "use": { "type": "string", - "example": "01", - "minLength": 1, - "maxLength": 2, - "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder." + "description": "Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc." }, - "startMonth": { + "kid": { "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" + "description": "The key ID in JWK format." }, - "startYear": { + "n": { "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" + "description": "JWK RSA Modulus" }, - "useAs": { + "e": { "type": "string", - "example": "pinless debit", - "description": "Card Use As Field. Supported value of `pinless debit` only. Only for use with Pinless Debit tokens." + "description": "JWK RSA Exponent" } } - }, - "buyerInformation": { - "type": "object", + } + } + } + }, + "default": { + "description": "Error retrieving key.", + "schema": { + "type": "object", + "properties": { + "responseStatus": { "properties": { - "companyTaxID": { + "status": { + "type": "number", + "description": "HTTP Status code." + }, + "reason": { "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" + "description": "Error Reason Code." }, - "currency": { + "message": { "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." + "description": "Error Message." }, - "dateOBirth": { + "correlationId": { "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" + "description": "API correlation ID." }, - "personalIdentification": { + "details": { "type": "array", "items": { - "type": "object", "properties": { - "id": { + "location": { "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" + "description": "Field name referred to for validation issues." }, - "type": { + "message": { "type": "string", - "example": "driver license", - "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\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" - } - } + "description": "Description or code of any error response." } } } } } }, - "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": { + "_links": { "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" + "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." + } + } + } }, - "bankTransferOptions": { - "type": "object", - "properties": { - "SECCode": { - "type": "string", - "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" + "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." + } } } - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { - "type": "object", + }, + "self": { "properties": { - "alternateName": { + "href": { "type": "string", - "example": "Branch Name", - "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." + "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." }, - "metaData": { + "cardInfo": { "type": "object", - "readOnly": true, + "required": [ + "cardNumber", + "cardType" + ], "properties": { - "creator": { + "cardNumber": { "type": "string", - "example": "merchantName", - "description": "The creator of the token." + "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." }, - "instrumentIdentifier": { + "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": { - "_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" - } - } - } - } + "status": { + "type": "number", + "description": "HTTP Status code." }, - "object": { + "reason": { "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "'Describes type of token.'\n\nValid values:\n- instrumentIdentifier\n" + "description": "Error Reason Code." }, - "state": { + "message": { "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n \nValid values:\n- ACTIVE\n- CLOSED\n" + "description": "Error Message." }, - "id": { + "correlationId": { "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." + "description": "API correlation ID." }, - "card": { - "type": "object", - "properties": { - "number": { - "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Customer\u2019s credit card number." + "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." + } } } - }, - "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." + } + } + }, + "_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." + } } } }, - "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." - } - } - } - } - } + "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." } } } }, - "metadata": { - "type": "object", - "readOnly": true, + "self": { "properties": { - "creator": { + "href": { "type": "string", - "example": "merchantName", - "description": "The creator of the token." + "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." } } } @@ -23116,429 +17894,865 @@ } } } - ], + }, + "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": {} + } + } + }, + "/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": [ - "Payment Instrument" + "decision manager" ], - "operationId": "updatePaymentInstrument", - "x-devcenter-metaData": { - "categoryTag": "Token_Management" - }, "consumes": [ "application/json;charset=utf-8" ], "produces": [ - "application/json;charset=utf-8" + "application/hal+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" - } - }, + "x-devcenter-metaData": { + "categoryTag": "Decision_Manager", + "sendDisabled": true, + "disabledReason": "DM API response is a mock response, Please integrate with DM API to test the real-time response from the server." + }, + "parameters": [ + { + "name": "createDecisionManagerCaseRequest", + "in": "body", + "required": true, "schema": { - "title": "tmsV1PaymentinstrumentsPatch200Response", "type": "object", + "required": [ + "orderInformation", + "clientReferenceInformation" + ], "properties": { - "_links": { + "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 \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://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 description 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": "Three-digit value that indicates the card type.\n\nType 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\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\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\n**Important** 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_cc_expmo` field description 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#### 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#### Encoded Account Numbers\nFor encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`.\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**Important** 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_cc_expyr` field description 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": "Three-digit value that indicates the card type.\n\nType 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\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + }, + "number": { + "type": "string", + "maxLength": 20, + "description": "Customer\u2019s payment network token value.\n" + }, + "expirationMonth": { + "type": "string", + "maxLength": 2, + "description": "One of two possible meanings:\n- The two-digit month in which a token expires.\n- The two-digit month in which a card expires.\nFormat: `MM`\nPossible values: `01` through `12`\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\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 (`card_type=039`), if there is no expiration date on the card, use `12`.\\\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### Samsung Pay and Apple Pay\nMonth in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\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": "One of two possible meanings:\n- The four-digit year in which a token expires.\n- The four-digit year in which a card expires.\nFormat: `YYYY`\nPossible values: `1900` through `3000`\nData type: Non-negative integer\n\n**NOTE** The meaning of this field is dependent on the payment processor that is returning the value in an authorization reply. Please see the processor-specific details below.\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\n3000) 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 (`card_ type=039`), if there is no expiration date on the card, use `2021`.\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\nthe year.\n\n#### Samsung Pay and Apple Pay\nYear in which the token expires. CyberSource includes this field in the reply message when it decrypts the payment blob for the tokenized transaction.\n\n**Important** It is your responsibility to determine whether a field is required for the transaction\nyou are requesting.\n\nFor processor-specific information, see the `customer_cc_expyr` or `token_expiration_year` 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", - "readOnly": true, + "description": "Contains detailed order-level information.", "properties": { - "self": { + "amountDetails": { "type": "object", + "description": "Contains `currency` and `totalAmount` for this order.", + "required": [ + "currency" + ], "properties": { - "href": { + "currency": { "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + "maxLength": 3, + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n\n#### Invoicing\nGrand total for the order, this is required for creating a new invoice.\n" } } }, - "ancestor": { + "shippingDetails": { "type": "object", + "description": "Contains shipping information not related to address.", "properties": { - "href": { + "giftWrap": { + "type": "boolean", + "description": "Boolean that indicates whether the customer requested gift wrapping for this\npurchase. This field can contain one of the following\nvalues:\n- true: The customer requested gift wrapping.\n- false: The customer did not request gift wrapping.\n" + }, + "shippingMethod": { "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + "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" } } }, - "successor": { + "shipTo": { "type": "object", + "description": "Contains recipient shipping information.", "properties": { - "href": { + "address1": { "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + "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" } } - } - } - }, - "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.'\n\nValid values:\n- paymentInstrument\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" - }, - "bankAccount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" - }, - "type": { - "type": "string", - "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- 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" + "returnsAccepted": { + "type": "boolean", + "description": "Boolean that indicates whether returns are accepted for this order.\nThis field can contain one of the following values:\n- true: Returns are accepted for this order.\n- false: Returns are not accepted for this order.\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" + "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 description 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\namounts and maximum field lengths. See these guides for details:\n- [Merchant Descriptors Using the SCMP API Guide]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n- \"Capture Information for Specific Processors\" section in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\nthe 1st line item in the order and this field, or the request-level field `orderInformation.amountDetails.totalAmount` in your request. For details, see \"Dynamic Currency Conversion with a Third Party\nProvider\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in the [Merchant Descriptors Using the SCMP API Guide.]\n(https://apps.cybersource.com/library/documentation/dev_guides/Merchant_Descriptors_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Zero Amount Authorizations\nIf your processor supports zero amount authorizations, you can set this field to 0 for the\nauthorization to check if the card is lost or stolen. See \"Zero Amount Authorizations\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + }, + "quantity": { + "type": "number", + "minimum": 1, + "maximum": 9999999999, + "description": "Number of units for this order.\n\nThe default is `1`. 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\nWhen orderInformation.lineItems[].productCode is \"gift_card\",\nthis 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\nFor details, see the `product_code` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + }, + "gift": { + "type": "boolean", + "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- true: Orders are assigned only slight additional risk if billing and shipping addresses are different.\n- false: Orders are assigned higher additional risk if billing and shipping addresses are different.\n" + }, + "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 [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)\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." + }, + "nationality": { + "type": "string", + "maxLength": 2, + "description": "Passenger's nationality country. Use the two character ISO Standard Country Codes." + } + } + } + } + } }, - "useAs": { - "type": "string", - "example": "pinless debit", - "description": "Card Use As Field. Supported value of `pinless debit` only. Only for use with Pinless Debit tokens." + "billTo": { + "type": "object", + "properties": { + "address1": { + "type": "string", + "maxLength": 60, + "description": "Payment card 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\n**Important** 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` request-level field description 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 description 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": 20, + "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\n**Important** 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 description 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": "Payment card billing country. 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\n**Important** 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 description 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": "Payment card billing city.\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:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description 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\n**Important** 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` request-level field description 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\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `customer_lastname` request-level field description 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\n#### For Payouts:\nThis 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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\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\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][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\n 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` request-level field description 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": { - "companyTaxID": { + "username": { "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" + "maxLength": 255, + "description": "Specifies the customer account user name." }, - "currency": { + "hashedPassword": { "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." + "maxLength": 100, + "description": "The merchant's password that CyberSource hashes and stores as a hashed password.\n\nFor details about this field, see the `customer_password` field description in [Decision Manager Developer Guide Using the SCMP API.](https://www.cybersource.com/developers/documentation/fraud_management/)\n" }, - "dateOBirth": { + "dateOfBirth": { "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" + "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 `recipient_date_of_birth` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "personalIdentification": { "type": "array", "items": { "type": "object", "properties": { - "id": { + "type": { "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" + "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\nFor 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)\n" }, - "type": { + "id": { "type": "string", - "example": "driver license", - "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\n" + "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": "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" - } - } + "type": "string", + "description": "The government agency that issued the driver's license or passport.\n\nIf **type**` = DRIVER_LICENSE`, this is the State or province where the customer\u2019s driver\u2019s license was issued.\n\nIf **type**` = PASSPORT`, this is the Issuing country for the cardholder\u2019s passport. Recommended for Discover ProtectBuy.\n\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\nFor details about the country that issued the passport, see `customer_passport_country` field description in [CyberSource Payer Authentication Using the SCMP API]\n(https://apps.cybersource.com/library/documentation/dev_guides/Payer_Authentication_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nFor details about the state or province that issued the passport, see `driver_license_state` field description in [Electronic Check Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" } } } } } }, - "billTo": { + "deviceInformation": { "type": "object", "properties": { - "firstName": { + "cookiesAccepted": { "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" + "description": "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" }, - "lastName": { + "ipAddress": { "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" + "maxLength": 48, + "description": "IP address of the customer.\n" }, - "company": { + "hostName": { "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" + "description": "DNS resolved hostname from `ipAddress`." }, - "address1": { + "fingerprintSessionId": { "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" + "description": "Field that 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\ndifferent session IDs.\n\nThe session ID must be unique for each merchant ID. You can use any string that you are already\ngenerating, such as an order number or web session ID.\n\nThe session ID must be unique for each page load, regardless of an individual\u2019s web session ID.\nIf a user navigates to a profiled page and is assigned a web session, navigates away from the\nprofiled page, then navigates back to the profiled page, the generated session ID should be different\nand unique. You may use a web session ID, but it is preferable to use an application GUID (Globally\nUnique Identifier). This measure ensures that a unique ID is generated every time the page is\nloaded, even if it is the same user reloading the page.\n" }, - "address2": { + "httpBrowserEmail": { "type": "string", - "example": "20 My Street", - "maxLength": 60, - "description": "Additional address information." + "description": "Email address set in the customer\u2019s browser, which may differ from customer email.\n" }, - "locality": { + "userAgent": { "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": { + "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", - "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" + "maxLength": 1, + "description": "CVN result code.\n\nFor details, see the `auth_cv_result` reply field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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\n**Note** By default, your default profile is the active profile, or the Profile Selector chooses the active profile. Use this field\nonly if you want to specify the name of a different profile. The passed-in profile will then become the active profile.\n" + } + } }, - "postalCode": { + "eventType": { "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": { + "maxLength": 255, + "description": "Specifies one of the following types of events:\n- login\n- account_creation\n- account_update\nFor regular payment transactions, do not send this field.\n" + } + } + }, + "travelInformation": { + "type": "object", + "properties": { + "actualFinalDestination": { "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" + "description": "IATA Code for the actual final destination that the customer intends to travel to.\nIt should be a destination on the completeRoute.\n" }, - "email": { + "completeRoute": { "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" + "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" }, - "phoneNumber": { + "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", - "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" + "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:\n`travelInformation.legs.0.origination=SFO`\n`travelInformation.legs.1.origination=SFO`\n\n**Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you\nsend all the fields, the complete route takes precedence over the individual legs.\n\nFor details, see the `decision_manager_travel_leg#_orig` field description in [Decision Manager Using the SCMP API Developer Guide.](https://www.cybersource.com/developers/documentation/fraud_management/)\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 [IATA Airline and Airport Code Search](https://www.iata.org/publications/Pages/code-search.aspx). The leg number can be a\npositive integer from 0 to N.\nFor example:\n\n`travelInformation.legs.0.destination=SFO`\n`travelInformation.legs.1.destination=SFO`\n\n**Note** In your request, send either the complete route or the individual legs (`legs.0.origination` and `legs.n.destination`). If you\nsend all the fields, the complete route takes precedence over the individual legs.\n\nFor details, see the `decision_manager_travel_leg#_dest` field description in [Decision Manager Using the SCMP API Developer Guide.](https://www.cybersource.com/developers/documentation/fraud_management/)\n" + }, + "departureDateTime": { + "type": "string", + "maxLength": 25, + "description": "Departure date and time for the each 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\nWhere:\\\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\nairline is based in city A, but the flight departs from city\nB, `z` is the time zone of city B at the time of departure.\\\n**Important** For travel information, use GMT instead of UTC, or use the local time zone.\n\n#### Examples\n\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\\\n\n**Note** 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" + } + } + } + } + } + }, + "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.\n**Warning** 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" + } } } - }, - "processingInformation": { + } + } + } + } + ], + "responses": { + "201": { + "description": "Successful response", + "schema": { + "title": "riskV1DecisionsPost201Response", + "type": "object", + "properties": { + "_links": { "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" + "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." + } + } }, - "bankTransferOptions": { + "reversal": { "type": "object", "properties": { - "SECCode": { + "href": { "type": "string", - "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" + "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." } } - } - } - }, - "merchantInformation": { - "type": "object", - "properties": { - "merchantDescriptor": { + }, + "capture": { "type": "object", "properties": { - "alternateName": { + "href": { "type": "string", - "example": "Branch Name", - "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." + "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." } } } } }, - "metaData": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." - } - } + "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." }, - "instrumentIdentifier": { + "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": { - "_links": { + "profile": { "type": "object", - "readOnly": true, "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } + "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\n**Note** By default, your default profile is the active profile, or the Profile Selector chooses the active profile. Use this field\nonly if you want to specify the name of a different profile. The passed-in profile will then become the active profile.\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\nFor all possible values, see the `decision_velocity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", + "items": { + "type": "string", + "description": "Indicates excessive volume of transactions." } }, - "ancestor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } + "address": { + "type": "array", + "description": "Indicates a mismatch between the customer\u2019s billing and shipping addresses.\n\nFor all possible values, see the `score_address_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", + "items": { + "type": "string" } }, - "successor": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } + "customerList": { + "type": "array", + "description": "Indicates that customer information is associated with transactions that are either on the negative or\nthe positive list.\n\nFor all possible values, see the `score_hotlist_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\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\nFor all possible values, see the `score_identity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", + "items": { + "type": "string" + } + }, + "internet": { + "type": "array", + "description": "Indicates a problem with the customer\u2019s email address, IP address, or billing address.\n\nFor all possible values, see the `score_internet_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", + "items": { + "type": "string" + } + }, + "phone": { + "type": "array", + "description": "Indicates a problem with the customer\u2019s phone number.\n\nFor all possible values, see the `score_phone_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", + "items": { + "type": "string" + } + }, + "suspicious": { + "type": "array", + "description": "Indicates that the customer provided potentially suspicious information.\n\nFor all possible values, see the `score_suspicious_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", + "items": { + "type": "string" + } + }, + "globalVelocity": { + "type": "array", + "description": "Indicates that the customer has a high purchase frequency.\n\nFor all possible values, see the `score_velocity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", + "items": { + "type": "string" } } } }, - "object": { - "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "'Describes type of token.'\n\nValid values:\n- instrumentIdentifier\n" + "velocity": { + "type": "object", + "properties": { + "morphing": { + "type": "array", + "description": "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.\n\nFor all possible values, see the `decision_velocity_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", + "items": { + "type": "object", + "properties": { + "count": { + "type": "integer", + "maxLength": 5, + "description": "Morphing count specified by the number #.\n\n**Note** The count is not returned for the initial transaction.\n\nFor all possible values, see the `decision_velocity_morphing_#_count` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + }, + "fieldName": { + "type": "string", + "maxLength": 255, + "description": "Field name of the morphing element. specified by the setting that you chose in the\nVelocity Editor.\n\nFor all possible values, see the `decisionReply_morphingElement_#_fieldName` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + }, + "informationCode": { + "type": "string", + "maxLength": 255, + "description": "Identifier that CyberSource assigned to the velocity rule specified by the number #.\n\nFor all possible values, see the `decision_velocity_morphing_#_info_code` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + } + } + } + }, + "address": { + "type": "array", + "items": { + "type": "string", + "maxLength": 255, + "description": "Indicates a mismatch between the customer's billing and shipping addresses.\n\nFor all possible values, see the `score_address_info` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + } + } + } }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n \nValid values:\n- ACTIVE\n- CLOSED\n" + "casePriority": { + "type": "integer", + "maxLength": 1, + "description": "You receive this field only if you subscribe to the Enhanced Case Management service. The priority level ranges from 1 (highest) to 5 (lowest); the default value is 3. If you do not assign a priority to your rules or to your profiles, the default value is given to the order.\n\nFor all possible values, see the `decision_case_priority` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" }, - "id": { + "localTime": { "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." + "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\nFor details, see the `score_time_local` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/)\n" }, - "card": { + "score": { "type": "object", "properties": { - "number": { + "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\nFor all possible values, see the `score_factors` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + } + }, + "modelUsed": { "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Customer\u2019s credit card number." + "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\nFor all possible values, see the `score_model_used` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + }, + "result": { + "type": "string", + "maxLength": 255, + "description": "Total score calculated for this order. The value cannot be negative.\n\nFor all possible values, see the `score_score_result` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" } } }, - "bankAccount": { + "ipAddress": { "type": "object", + "description": "Contains detailed response information about the customer's IP address.", "properties": { - "number": { + "anonymizerStatus": { "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Checking account number." + "maxLength": 255, + "description": "Indicates whether the transaction IP address is associated with a known anonymous proxy.\n\nFor all possible values, see the `score_ip_anonymizer_status` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" }, - "routingNumber": { + "locality": { "type": "string", - "example": "123456789", - "minLength": 1, - "maxLength": 9, - "description": "Routing number." + "maxLength": 255, + "description": "Name of the city decoded from the IP address used directly or indirectly by the customer to send the order.\n\nFor all possible values, see the `score_ip_city` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\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\nFor all possible values, see the `score_ip_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + }, + "administrativeArea": { + "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\nFor all possible values, see the `score_ip_state` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\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.\n\nFor all possible values, see the `score_ip_routing_method` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" } } }, - "processingInformation": { + "providers": { "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." - } - } + "providerName": { + "type": "array", + "items": { + "type": "object", + "description": "Name of the 3rd party provider, for example, Emailage.\n\nFor all possible values, see the `decision_provider_#_name` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n", + "properties": { + "fieldName": { + "type": "array", + "items": { + "type": "string", + "description": "Field name, for example, email address domain name (domain_name).\n\nFor all possible values, see the `decision_provider_#_field_#_name` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + } + }, + "fieldValue": { + "type": "array", + "items": { + "type": "string", + "description": "Value for the field, for example, yahoo.com." } } } @@ -23546,86 +18760,170 @@ } } }, - "metadata": { + "travel": { "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 + "actualFinalDestination": { + "type": "object", + "properties": { + "country": { + "type": "string", + "maxLength": 90, + "description": "Country of actual final destination on the route." + }, + "locality": { + "type": "string", + "maxLength": 90, + "description": "City of actual final destination on the route." + }, + "latitude": { + "type": "string", + "maxLength": 10, + "description": "Latitude of actual final destination on the route." + }, + "longitude": { + "type": "string", + "maxLength": 10, + "description": "Longitude of actual final destination on the route." + } + } + }, + "firstDeparture": { + "type": "object", + "properties": { + "country": { + "type": "string", + "maxLength": 90, + "description": "Country of first departure on the route." + }, + "locality": { + "type": "string", + "maxLength": 90, + "description": "City of first departure on the route." + }, + "latitude": { + "type": "string", + "maxLength": 10, + "description": "Latitude of first departure on the route." + }, + "longitude": { + "type": "string", + "maxLength": 10, + "description": "Longitude of first departure on the route." + } + } + }, + "firstDestination": { + "type": "object", + "properties": { + "country": { + "type": "string", + "maxLength": 90, + "description": "Country of first destination on the route." + }, + "locality": { + "type": "string", + "maxLength": 90, + "description": "City of first destination on the route." + }, + "latitude": { + "type": "string", + "maxLength": 10, + "description": "Latitude of first destination on the route." + }, + "longitude": { + "type": "string", + "maxLength": 10, + "description": "Longitude of first destination on the route." + } + } + }, + "lastDestination": { + "type": "object", + "properties": { + "country": { + "type": "string", + "maxLength": 90, + "description": "Country of last destination on the route." + }, + "locality": { + "type": "string", + "maxLength": 90, + "description": "City of last destination on the route." + }, + "latitude": { + "type": "string", + "maxLength": 10, + "description": "Latitude of last destination on the route." + }, + "longitude": { + "type": "string", + "maxLength": 10, + "description": "Longitude of last destination on the route." + } + } + } + } + } + } }, - "metadata": { - "creator": "user" + "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 CyberSource Business Center.\n\nFor all possible values, see the `bin_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\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\nFor all possible values, see the `score_card_account_type` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + }, + "issuer": { + "type": "string", + "maxLength": 255, + "description": "Name of the bank or entity that issued the card account.\n\nFor all possible values, see the `score_card_issuer` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + }, + "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\n**Note** Additional values may be present.\n\nFor all possible values, see the `score_card_scheme` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + }, + "bin": { + "type": "string", + "maxLength": 255, + "description": "Credit card BIN (the first six digits of the credit card).Derived either from the `cc_bin` request field\nor from the first six characters of the `customer_cc_num` field.\n\nFor all possible values, see the `score_cc_bin` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n" + } + } }, - "_embedded": { - "instrumentIdentifier": { - "_links": { - "self": { - "href": "https://api.cybersource.com/tms/v1/instrumentidentifiers/58FEBAEFD2EEFCE1E0539399D30A7500" - } + "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 - PENDING_AUTHENTICATION\n" }, - "id": "58FEBAEFD2EEFCE1E0539399D30A7500", - "object": "instrumentIdentifier", - "state": "ACTIVE", - "card": { - "number": "424242XXXXXX4242" + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." }, - "processingInformation": { - "authorizationOptions": { - "initiator": { - "merchantInitiatedTransaction": { - "previousTransactionId": 123456789012345 + "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" } } } - }, - "metadata": { - "creator": "user" } } } @@ -23633,1455 +18931,1573 @@ } }, "400": { - "description": "Bad Request. A required header value could be missing.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique ID associated with your request.", - "type": "string" - } - }, + "description": "Invalid request", "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": { + "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" + }, + "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": { - "name": { + "field": { "type": "string", - "description": "The name of the field that threw the error." + "description": "This is the flattened JSON object field name/path that is either missing or invalid." }, - "location": { + "reason": { "type": "string", - "description": "The location of the field that threw the error." + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" } } } } } + } + }, + "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" + }, + "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" + }, + "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" + } }, - "examples": { - "Missing Headers": { - "errors": [ - { - "type": "missingHeaders", - "message": "Missing header values." - } - ] - }, - "Payment Instrument cannot be linked to instrument identifier because it does not exist": { - "errors": [ + "responseValue": { + "riskInformation": { + "score": { + "result": "99", + "modelUsed": "default" + }, + "localTime": "10:02:05", + "profile": { + "name": "Profile 1_test", + "selectorRule": "Default Active Profile" + }, + "rules": [ { - "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": [ + "decision": "IGNORE", + "name": "Correctable errors in addresses" + }, { - "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": [ + "decision": "REVIEW", + "name": "Order is above your AFS threshold for review." + }, { - "type": "invalidCombination", - "message": "The combination is invalid.", - "details": [ - { - "name": "bankAccount" - }, - { - "name": "card", - "location": "instrumentIdentifier" - } - ] + "decision": "IGNORE", + "name": "CVN not submitted" } - ] + ], + "paymentInformation": { + "scheme": "VISA CREDIT", + "bin": "444444", + "accountType": "GOLD", + "issuer": "CREDIT AGRICOLE BANK POLSKA, S.A." + }, + "casePriority": "3" }, - "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" - } - ] - } - ] + "ipAddress": { + "country": "us", + "city": "seattle", + "state": "wa", + "routingMethod": "fixed" } } }, - "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." - } - } - } + "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" + } + ] }, - "examples": { - "application/json": { - "errors": [ - { - "type": "forbidden", - "message": "Request not permitted." - } - ] - } + "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 " + } + ] } }, - "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." - } - } - } + "example3": { + "summary": "DM with Travel Information", + "value": { + "clientReferenceInformation": { + "code": "54323007" + }, + "paymentInformation": { + "card": { + "expirationMonth": "12", + "expirationYear": "2020", + "number": "4444444444444448" } - } - }, - "examples": { - "application/json": { - "errors": [ + }, + "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": [ { - "type": "notFound", - "message": "Token not found" + "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" + } + ] } }, - "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." - } - } - } + "example4": { + "summary": "DM with Buyer Information", + "value": { + "clientReferenceInformation": { + "code": "54323007" + }, + "paymentInformation": { + "card": { + "expirationMonth": "12", + "expirationYear": "2020", + "number": "4444444444444448" } - } - }, - "examples": { - "application/json": { - "errors": [ + }, + "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": [ { - "type": "notAvailable", - "message": "Token not available." + "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 " + } + ] } }, - "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." - } - } - } + "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" } } }, - "examples": { - "application/json": { - "errors": [ + "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": [ { - "type": "notFound", - "message": "Profile not found" + "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" } } }, - "500": { - "description": "Unexpected error.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique id associated with your request.", - "type": "string" + "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" + } } }, - "examples": { - "application/json": { - "errors": [ - { - "type": "serverError", - "message": "Internal server error" - } - ] + "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" + } } }, - "schema": { - "title": "tmsV1Error500Response", - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string" + "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" }, - "message": { - "type": "string", - "description": "The detailed message related to the type stated above." + { + "decision": "REVIEW", + "name": "Order is above your AFS threshold for review." }, - "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." - } - } + { + "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" } } } - }, - "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 - } - ], + } + }, + "/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": [ - "Payment Instrument" + "Payouts" ], - "operationId": "getPaymentInstrument", + "operationId": "octCreatePayment", "x-devcenter-metaData": { - "categoryTag": "Token_Management" + "categoryTag": "Payouts" }, - "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" - } - }, + "parameters": [ + { + "name": "octCreatePaymentRequest", + "in": "body", + "required": true, "schema": { - "title": "tmsV1PaymentinstrumentsPatch200Response", "type": "object", "properties": { - "_links": { + "clientReferenceInformation": { "type": "object", - "readOnly": true, "properties": { - "self": { + "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 \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://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": { - "href": { + "totalAmount": { "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "ancestor": { - "type": "object", - "properties": { - "href": { + "maxLength": 19, + "description": "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.\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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n\n#### Invoicing\nGrand total for the order, this is required for creating a new invoice.\n" + }, + "currency": { "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + "maxLength": 3, + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\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" + } + } } } }, - "successor": { + "billTo": { "type": "object", "properties": { - "href": { + "firstName": { "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + "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\n**Important** 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` request-level field description 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\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `customer_lastname` request-level field description 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": "Payment card 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\n**Important** 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` request-level field description 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 description 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": "Payment card billing country. 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\n**Important** 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 description 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": "Payment card billing city.\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:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description 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": 20, + "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\n**Important** 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 description 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\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][numeric][alpha][numeric]\n\n**Example** `A1B 2C3`\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.\n\n#### For Payouts:\n 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` request-level field description 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\n#### For Payouts:\nThis 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", + "description": "Customer's phone number type.\n\n#### For Payouts:\nThis field may be sent only for FDC Compass.\n\nPossible Values:\n* day\n* home\n* night\n* work\n" } } } } }, - "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.'\n\nValid values:\n- paymentInstrument\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" - }, - "bankAccount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" - }, - "type": { - "type": "string", - "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- 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": { + "merchantInformation": { "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" + "categoryCode": { + "type": "integer", + "maximum": 9999, + "description": "The value for this field is a four-digit number that the payment card industry uses to classify\nmerchants into market segments. A payment card company assigned one or more of these values to your business when you started\naccepting the payment card company\u2019s cards. When you do not include this field in your request, CyberSource uses the value in your\nCyberSource account.\n\nFor processor-specific information, see the `merchant_category_code` field description 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\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" }, - "currency": { + "submitLocalDateTime": { "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." + "description": "Time that the transaction was submitted in local time. The time is in hhmmss format.\n" }, - "dateOBirth": { + "vatRegistrationNumber": { "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" + "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 description 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" }, - "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", - "example": "driver license", - "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\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" - } - } - } + "merchantDescriptor": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Merchant's name.\n\nFor more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n" + }, + "locality": { + "type": "string", + "maxLength": 13, + "description": "Merchant's City.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description\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": "Merchant's country.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description\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": "The state where the merchant is located.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_state` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\nMerchant 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": "Merchant's postal code.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_postal_code` field description\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_descriptor_contact` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)-->\nContact information for the merchant.\n\n**Note** These are the maximum data lengths for the following payment processors:\n- FDCCompass (13)\n- Paymentech (13)\n" } } } } }, - "billTo": { + "recipientInformation": { "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" + "maxLength": 35, + "description": "First name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\n" }, - "lastName": { + "middleInitial": { "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" + "maxLength": 1, + "description": "Middle Initial of recipient. Required only for FDCCompass.\n" }, - "company": { + "lastName": { "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" + "maxLength": 35, + "description": "Last name of recipient.\ncharacters.\n* CTV (14)\n* Paymentech (30)\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." + "maxLength": 50, + "description": "Recipient address information. Required only for FDCCompass." }, "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" + "maxLength": 25, + "description": "Recipient city. Required only for FDCCompass." }, "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" + "maxLength": 3, + "description": "Recipient State. Required only for FDCCompass." }, "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" + "maxLength": 2, + "description": "Recipient country code. Required only for FDCCompass." }, - "email": { + "postalCode": { "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" + "maxLength": 10, + "description": "Recipient postal code. Required only for FDCCompass." }, "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" + "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." } } }, - "processingInformation": { + "senderInformation": { "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" + "referenceNumber": { + "type": "string", + "maxLength": 19, + "description": "Reference number generated by you that uniquely identifies the sender." }, - "bankTransferOptions": { + "account": { "type": "object", "properties": { - "SECCode": { + "fundsSource": { "type": "string", - "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": { + "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", - "example": "Branch Name", - "description": "Alternate information for your business. This API field overrides the company entry description value in your CyberSource account." + "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" } } - } - } - }, - "metaData": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { + }, + "firstName": { "type": "string", - "example": "merchantName", - "description": "The creator of the token." + "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" } } }, - "instrumentIdentifier": { + "processingInformation": { "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" - } - } - } - } + "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" }, - "object": { + "networkRoutingOrder": { "type": "string", - "readOnly": true, - "example": "instrumentIdentifier", - "description": "'Describes type of token.'\n\nValid values:\n- instrumentIdentifier\n" + "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" }, - "state": { + "commerceIndicator": { "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n \nValid values:\n- ACTIVE\n- CLOSED\n" + "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\nFor details, see the `e_commerce_indicator` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\nPossible value for Payouts:\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\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### Other Types of Transactions\nFor details, see \"Commerce Indicators\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, - "id": { + "reconciliationId": { "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." + "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" }, - "card": { + "payoutsOptions": { "type": "object", "properties": { - "number": { + "acquirerMerchantId": { "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Customer\u2019s credit card number." - } - } - }, - "bankAccount": { - "type": "object", - "properties": { - "number": { + "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", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Checking account number." + "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" }, - "routingNumber": { + "retrievalReferenceNumber": { "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": { + "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;\nthat is, to a given transaction set.\n\nFormat:\n Positions 1-4: The yddd equivalent of the date, where y = 0-9 and ddd = 001 \u2013 366.\n Positions 5-12: A unique identification number generated by the merchant\n\n* Applicable only for CTV for Payouts.\n" + }, + "accountFundingReferenceId": { "type": "string", - "example": "merchantName", - "description": "The creator of the token." + "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" } } } } - } - } - }, - "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", + "paymentInformation": { + "type": "object", + "properties": { "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." + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Three-digit value that indicates the card type.\n\nType 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\nFor the complete list of possible values, see `card_type` field description in the [Credit Card Services Using the SCMP API Guide.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\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 description 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 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\n**Important** 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_cc_expmo` field description 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#### 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#### Encoded Account Numbers\nFor encoded account numbers (**_type_**`=039`), if there is no expiration date on the card, use `2021`.\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**Important** 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_cc_expyr` field description 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 CyberSource through VisaNet (CtV).\n \n**Note** Combo 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\nFor details, see the `subscription_id` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + } } } } } - } - }, - "examples": { - "application/json": { - "errors": [ - { - "type": "forbidden", - "message": "Request not permitted." + }, + "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" + } } } - }, - "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" - } - }, + } + ], + "responses": { + "201": { + "description": "Successful response.", "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." + "title": "ptsV2PayoutsPost201Response", + "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" + }, + "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." + } } } } - } - } - }, - "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." + }, + "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`\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 - ACCEPTED\n - DECLINED\n - INVALID_REQUEST\n" + }, + "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" + }, + "errorInformation": { + "type": "object", + "properties": { + "reason": { + "type": "string", + "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" + }, + "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" + } + } } } } - } - } - }, - "examples": { - "application/json": { - "errors": [ - { - "type": "notAvailable", - "message": "Token not available." + }, + "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 \"Tracking and Reconciling Your Orders\" in [Getting Started with CyberSource Advanced for the SCMP API.](https://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\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\nFor details about how this field is used for Recurring Billing or Payment Tokenization, see the `ecp_debit_owner_merchant_id` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + } } - ] - } - } - }, - "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." + }, + "merchantInformation": { + "type": "object", + "properties": { + "merchantDescriptor": { + "properties": { + "name": { + "type": "string", + "description": "Merchant's name.\n\nFor more details about the merchant-related fields, see the `merchant_descriptor` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n**Note** For Paymentech processor using Cybersource Payouts, the maximum data length is 22.\n" + }, + "locality": { + "type": "string", + "maxLength": 13, + "description": "Merchant's City.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_city` field description\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": "Merchant's country.\n\nFor the descriptions, used-by information, data types, and lengths for these fields, see the `merchant_descriptor_country` field description\nin [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + } } } } - } - } - }, - "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." + }, + "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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n\n#### Invoicing\nGrand total for the order, this is required for creating a new invoice.\n" + }, + "currency": { + "type": "string", + "maxLength": 3, + "description": "Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)\n\nFor details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 payment authorization request.\n\n#### DCC for First Data\nYour local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\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" + } } } } - } - } - } - } - } - }, - "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." - } + }, + "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\nFor details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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" } } - } - } - }, - "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." + }, + "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" + } } } } } - } - }, - "examples": { - "application/json": { - "errors": [ - { - "type": "notFound", - "message": "Token not found" - } - ] - } + }, + "type": "object" } }, - "410": { - "description": "Token Not Available. The token has been deleted.", - "headers": { - "uniqueTransactionID": { - "description": "A globally unique ID associated with your request.", - "type": "string" - } - }, + "400": { + "description": "Invalid request.", "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": { + "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\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" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." + }, + "details": { + "type": "array", + "items": { "type": "object", "properties": { - "name": { + "field": { "type": "string", - "description": "The name of the field that threw the error." + "description": "This is the flattened JSON object field name/path that is either missing or invalid." }, - "location": { + "reason": { "type": "string", - "description": "The location of the field that threw the error." + "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" } } } } } - }, - "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" - } - }, + "502": { + "description": "Unexpected system error or system timeout.", "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." - } - } - } + "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" + }, + "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" + }, + "message": { + "type": "string", + "description": "The detail message related to the status and reason listed above." } } - }, - "examples": { - "application/json": { - "errors": [ - { - "type": "notFound", - "message": "Profile not found" - } - ] + } + } + }, + "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" } } }, - "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." - } - } - } + "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" } } } @@ -25344,7 +20760,7 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### Visa Platform Connect\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see \"Installment Payments on Visa Platform Connect\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "value": { "type": "string", @@ -25397,22 +20813,22 @@ "address1": { "type": "string", "maxLength": 60, - "description": "Payment card 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, Visa Platform Connect 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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card 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\n**Important** 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` request-level field description 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#### Visa Platform Connect\n**Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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 description 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": "Payment card billing city.\n\n#### Atos\nThis field must not contain colons (:).\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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\nFor processor-specific information, see the `bill_city` field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing city.\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:\nThis field may be sent only for FDC Compass.\n\nFor processor-specific information, see the `bill_city` field description 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": 20, - "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##### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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 description 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", @@ -25422,17 +20838,17 @@ "company": { "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.\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" + "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.\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\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**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n" }, "country": { "type": "string", "maxLength": 2, - "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing country. 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\n**Important** 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 description 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", @@ -25442,7 +20858,7 @@ "phoneNumber": { "type": "string", "maxLength": 15, - "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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" + "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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" } } }, @@ -25477,7 +20893,7 @@ "administrativeArea": { "type": "string", "maxLength": 20, - "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##### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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 description 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", @@ -25528,9 +20944,9 @@ "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\nFor details, see `tax_amount` field description in [Level II and Level III Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "quantity": { - "type": "number", + "type": "integer", "minimum": 1, - "maximum": 9999999999, + "maximum": 999999999, "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 }, @@ -25552,7 +20968,7 @@ "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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n" + "description": "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.\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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n\n#### Invoicing\nGrand total for the order, this is required for creating a new invoice.\n" }, "currency": { "type": "string", @@ -25665,7 +21081,7 @@ "prefix": { "type": "string", "maxLength": 6, - "description": "The description for this field is not available." + "description": "Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number.\n" }, "expirationMonth": { "type": "string", @@ -25879,7 +21295,7 @@ "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\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### Visa Platform Connect and GPN\nFor details about this value for Visa Platform Connect and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "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\n#### Cielo\nFor Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank.\n\n#### Comercio Latino\nFor Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank.\n\n#### CyberSource through VisaNet and GPN\nFor details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "networkTransactionId": { "type": "string", @@ -25958,12 +21374,12 @@ "name": { "type": "string", "maxLength": 30, - "description": "The description for this field is not available.\n" + "description": "Mapped Electronic Verification response code for the customer\u2019s name.\n" }, "nameRaw": { "type": "string", "maxLength": 30, - "description": "The description for this field is not available." + "description": "Raw Electronic Verification response code from the processor for the customer\u2019s name.\n" }, "phoneNumber": { "type": "string", @@ -26000,7 +21416,7 @@ "systemTraceAuditNumber": { "type": "string", "maxLength": 6, - "description": "This field is returned only for **American Express Direct** and **Visa Platform Connect**.\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#### Visa Platform Connect\n\nSystem trace number that must be printed on the customer\u2019s receipt.\n\nFor details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "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\nFor details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "responseCodeSource": { "type": "string", @@ -26033,11 +21449,11 @@ "properties": { "name": { "type": "string", - "description": "The description for this field is not available." + "description": "The name of the profile.\n" }, "decision": { "type": "string", - "description": "The description for this field is not available." + "description": "Decision returned by the profile; this field contains one of these values:\n- ACCEPT\n- REJECT\n- REVIEW\n" } } }, @@ -26065,11 +21481,11 @@ "properties": { "name": { "type": "string", - "description": "The description for this field is not available." + "description": "The name of the profile.\n" }, "decision": { "type": "string", - "description": "The description for this field is not available." + "description": "Decision returned by the profile; this field contains one of these values:\n- ACCEPT\n- REJECT\n- REVIEW\n" } } }, @@ -26733,7 +22149,7 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### Visa Platform Connect\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see \"Installment Payments on Visa Platform Connect\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "value": { "type": "string", @@ -26772,17 +22188,17 @@ "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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n" }, "country": { "type": "string", "maxLength": 2, - "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing country. 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\n**Important** 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 description 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\n#### For Payouts:\nThis 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#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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" + "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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" } } }, @@ -26822,7 +22238,7 @@ "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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n" + "description": "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.\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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n\n#### Invoicing\nGrand total for the order, this is required for creating a new invoice.\n" }, "currency": { "type": "string", @@ -26843,10 +22259,10 @@ "type": "string", "description": "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit.\n" }, - "method": { - "type": "string", - "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal" - } + "method": { + "type": "string", + "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal" + } } }, "customer": { @@ -26868,7 +22284,7 @@ "prefix": { "type": "string", "maxLength": 6, - "description": "The description for this field is not available." + "description": "Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number.\n" }, "type": { "type": "string", @@ -27460,7 +22876,7 @@ "key": { "type": "string", "maxLength": 50, - "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### Visa Platform Connect\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see \"Installment Payments on Visa Platform Connect\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + "description": "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100.\n\nFor example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and\n`merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the\ntransaction.\n\nFor details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" }, "value": { "type": "string", @@ -27499,17 +22915,17 @@ "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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "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\n**Important** 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` request-level field description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n\n#### Invoicing\nEmail address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link.\n" }, "country": { "type": "string", "maxLength": 2, - "description": "Payment card billing country. Use the two-character ISO Standard Country Codes.\n\n#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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**Important** 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 description in\n[Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)\n" + "description": "Payment card billing country. 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\n**Important** 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 description 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\n#### For Payouts:\nThis 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#### Visa Platform Connect\nCredit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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" + "description": "Customer\u2019s phone number.\n\n#### For Payouts:\nThis 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" } } }, @@ -27549,7 +22965,7 @@ "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 characters. 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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n" + "description": "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.\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. For details, see:\n- \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n- \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).\n\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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).\n\n#### FDMS South\nIf you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n#### DCC for First Data\nNot used.\n\n#### Invoicing\nGrand total for the order, this is required for creating a new invoice.\n" }, "currency": { "type": "string", @@ -27572,7 +22988,7 @@ }, "method": { "type": "string", - "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal" + "description": "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal" } } }, @@ -27595,7 +23011,7 @@ "prefix": { "type": "string", "maxLength": 6, - "description": "The description for this field is not available." + "description": "Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number.\n" }, "type": { "type": "string", @@ -27619,1136 +23035,5831 @@ } } }, - "processorInformation": { - "type": "object", - "properties": { - "processor": { - "type": "object", - "properties": { - "name": { - "type": "string", - "maxLength": 30, - "description": "Name of the Processor.\n" - } - } + "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\n#### FDC Nashville Global\nTo have your account configured to support this field, contact CyberSource Customer Support. This value must be\na value that FDC Nashville Global issued to you.\n\nFor details, see the `terminal_id` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**For 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\nFor details, see the `terminal_serial_number` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + }, + "deviceId": { + "type": "string", + "description": "Value created by the client software that uniquely identifies the POS device.\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to\nthe CyberSource reporting functionality.\n\nThis field is supported only for specific CyberSource integrations. For details, see the `pos_device_id` field description\nin the [Card-Present Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" + }, + "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" + } + } + } + } + }, + "riskInformation": { + "type": "object", + "properties": { + "providers": { + "type": "object", + "properties": { + "fingerprint": { + "type": "object", + "properties": { + "true_ipaddress": { + "type": "string", + "maxLength": 255, + "description": "Customer\u2019s true IP address detected by the application.\n\nFor details, see the `true_ipaddress` field description in [CyberSource Decision Manager Device Fingerprinting Guide.](https://www.cybersource.com/developers/documentation/fraud_management)\n" + }, + "hash": { + "type": "string", + "maxLength": 255, + "description": "The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field.\n\nNOTE: For details about the value of this field, see the `decision_provider_#_field_#_value` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n\nFor more details about this field, see the `device_fingerprint_hash` field description in the _CyberSource Decision Manager Device Fingerprinting Guide_on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link)\n" + }, + "smartId": { + "type": "string", + "maxLength": 255, + "description": "The device identifier generated from attributes collected during profiling. Returned by a 3rd party when you use device fingerprinting.\n\nFor details, see the `device_fingerprint_smart_id` field description in [CyberSource Decision Manager Device Fingerprinting Guide.](https://www.cybersource.com/developers/documentation/fraud_management)\n" + } + } + } + } + } + } + }, + "_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, + "status": "status", + "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": { + "name": "CARD", + "method": { + "name": "method name" + } + }, + "customer": { + "customerId": "12345" + }, + "card": { + "suffix": "1111", + "prefix": "123456", + "type": "001" + } + }, + "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." + } + } + } + }, + "/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.[Rfc Date Format](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.[Rfc Date Format](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.[Rfc Date Format](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\n\nValid values:\n- reportTimeFrame\n- executedTime\n", + "required": true, + "type": "string" + }, + { + "name": "reportMimeType", + "in": "query", + "description": "Valid Report Format\n\nValid values:\n- application/xml\n- text/csv\n", + "required": false, + "type": "string" + }, + { + "name": "reportFrequency", + "in": "query", + "description": "Valid Report Frequency\n\nValid values:\n- DAILY\n- WEEKLY\n- MONTHLY\n- ADHOC\n", + "required": false, + "type": "string" + }, + { + "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\n\nValid values:\n- COMPLETED\n- PENDING\n- QUEUED\n- RUNNING\n- ERROR\n- NO_DATA\n", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "title": "reportingV3ReportsGet200Response", + "type": "object", + "properties": { + "reportSearchResults": { + "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\n\nValid values:\n- application/xml\n- text/csv\n" + }, + "reportFrequency": { + "type": "string", + "example": "DAILY", + "description": "Frequency of the report to get generated\n\nValid values:\n- DAILY\n- WEEKLY\n- MONTHLY\n- ADHOC\n" + }, + "status": { + "type": "string", + "description": "Status of the report\n\nValid values:\n- COMPLETED\n- PENDING\n- QUEUED\n- RUNNING\n- ERROR\n- NO_DATA\n" + }, + "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'\n \nValid values:\n- application/xml\n- text/csv\n", + "example": "application/xml" + }, + "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", + "description": "Report Preferences", + "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)\n\nValid values:\n- SOAPI\n- SCMP\n" + } + } + }, + "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\n\nValid values:\n- application/xml\n- text/csv\n" + }, + "reportFrequency": { + "type": "string", + "example": "DAILY", + "description": "Report Frequency Value\n\nValid values:\n- DAILY\n- WEEKLY\n- MONTHLY\n- ADHOC\n" + }, + "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\n\nValid values:\n- COMPLETED\n- PENDING\n- QUEUED\n- RUNNING\n- ERROR\n- NO_DATA\n- RERUN\n" + }, + "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)\n\nValid values:\n- SOAPI\n- SCMP\n" + } + } + }, + "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", + "description": "Valid values:\n- application/xml\n- text/csv\n" + } + }, + "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", + "description": "Valid values:\n- application/xml\n- text/csv\n" + } + }, + "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 \n \nValid values:\n- application/xml\n- text/csv\n" + }, + "reportFrequency": { + "type": "string", + "example": "DAILY", + "description": "'Report Frequency'\n\nValid values:\n- DAILY\n- WEEKLY\n- MONTHLY\n- ADHOC\n" + }, + "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", + "description": "Report Preferences", + "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)\n\nValid values:\n- SOAPI\n- SCMP\n" + } + } + }, + "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", + "description": "Valid values:\n- application/xml\n- text/csv\n", + "example": "application/xml" + }, + "reportFrequency": { + "type": "string", + "description": "'The frequency for which subscription is created.'\n\nValid values:\n- 'DAILY'\n- 'WEEKLY'\n- 'MONTHLY'\n- 'ADHOC'\n", + "example": "DAILY" + }, + "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", + "description": "Report Preferences", + "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)\n\nValid values:\n- SOAPI\n- SCMP\n" + } + } + }, + "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 \n \nValid values:\n- application/xml\n- text/csv\n" + }, + "reportFrequency": { + "type": "string", + "example": "DAILY", + "description": "'Report Frequency'\n\nValid values:\n- DAILY\n- WEEKLY\n- MONTHLY\n- ADHOC\n" + }, + "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", + "description": "Report Preferences", + "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)\n\nValid values:\n- SOAPI\n- SCMP\n" + } + } + }, + "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.[Rfc Date Format](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.[Rfc Date Format](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.[Rfc Date Format](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.[Rfc Date Format](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" + }, + { + "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" + }, + { + "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", + "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" + }, + "interchangeDescription": { + "type": "string", + "example": "Visa International Assessments (Enhanced)", + "description": "interchange Description" + }, + "interchangePercentage": { + "type": "string", + "example": "0.25", + "description": "interchange Percentage" + }, + "interchangePercentageAmount": { + "type": "string", + "example": "-3.7500", + "description": "interchange Percentage Amount" + }, + "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." + } + } + }, + "type": "object" + } + }, + "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": "2019-05-01T12:00:00-05:00", + "endTime": "2019-08-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.[Rfc Date Format](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.[Rfc Date Format](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" + }, + { + "name": "breakdown", + "in": "query", + "description": "Conditional - Breakdown on account_rollup/all_merchant/selected_merchant. Required while getting breakdown data for a Merchant.", + "required": false, + "type": "string" + }, + { + "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": { + "title": "reportingV3PaymentBatchSummariesGet200Response", + "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": { + "title": "reportingV3PaymentBatchSummariesGet200Response", + "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", + "application/xml" + ], + "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.[Rfc Date Format](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.[Rfc Date Format](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", + "xml": { + "name": "MerchantID", + "attribute": true + } + }, + "startTime": { + "type": "string", + "format": "date-time", + "example": "2017-10-01T10:10:10+05:00", + "xml": { + "name": "ReportStartDate", + "attribute": true + } + }, + "endTime": { + "type": "string", + "format": "date-time", + "example": "2017-10-01T10:10:10+05:00", + "xml": { + "name": "ReportEndDate", + "attribute": true + } + }, + "conversionDetails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "merchantReferenceNumber": { + "type": "string", + "description": "Merchant reference number of a merchant", + "example": "1234567890", + "xml": { + "name": "MerchantReferenceNumber", + "attribute": true + } + }, + "conversionTime": { + "type": "string", + "format": "date-time", + "description": "Date of conversion", + "example": "2017-10-01T10:10:10+05:00", + "xml": { + "name": "ConversionDate", + "attribute": true + } + }, + "requestId": { + "type": "string", + "description": "Cybersource Transation request id", + "example": "1234567890123456789012", + "xml": { + "name": "RequestID", + "attribute": true + } + }, + "originalDecision": { + "type": "string", + "description": "Original decision", + "example": "REVIEW", + "xml": { + "name": "OriginalDecision" + } + }, + "newDecision": { + "type": "string", + "description": "New decision", + "example": "ACCEPT", + "xml": { + "name": "NewDecision" + } + }, + "reviewer": { + "type": "string", + "description": "User name of the reviewer", + "example": "testuserId", + "xml": { + "name": "Reviewer" + } + }, + "reviewerComments": { + "type": "string", + "description": "Comments of the reviewer", + "example": "Verified order.", + "xml": { + "name": "ReviewerComments" + } + }, + "queue": { + "type": "string", + "description": "Name of the queue", + "example": "Review Queue", + "xml": { + "name": "Queue" + } + }, + "profile": { + "type": "string", + "description": "Name of the profile", + "example": "Test Profile", + "xml": { + "name": "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", + "xml": { + "name": "Date", + "attribute": true } - } - }, - "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\n#### FDC Nashville Global\nTo have your account configured to support this field, contact CyberSource Customer Support. This value must be\na value that FDC Nashville Global issued to you.\n\nFor details, see the `terminal_id` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n\n**For 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\nFor details, see the `terminal_serial_number` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" - }, - "deviceId": { - "type": "string", - "description": "Value created by the client software that uniquely identifies the POS device.\nCyberSource does not forward this value to the processor. Instead, the value is forwarded to\nthe CyberSource reporting functionality.\n\nThis field is supported only for specific CyberSource integrations. For details, see the `pos_device_id` field description\nin the [Card-Present Processing Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)\n" - }, - "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" - } - } + }, + "addedBy": { + "type": "string", + "description": "Note added by reviewer", + "example": "testuserId", + "xml": { + "name": "AddedBy", + "attribute": true } - } - }, - "riskInformation": { - "type": "object", - "properties": { - "providers": { - "type": "object", - "properties": { - "fingerprint": { - "type": "object", - "properties": { - "true_ipaddress": { - "type": "string", - "maxLength": 255, - "description": "Customer\u2019s true IP address detected by the application.\n\nFor details, see the `true_ipaddress` field description in [CyberSource Decision Manager Device Fingerprinting Guide.](https://www.cybersource.com/developers/documentation/fraud_management)\n" - }, - "hash": { - "type": "string", - "maxLength": 255, - "description": "The unique identifier of the device that is returned in the `riskInformation.providers.fingerprint.device_fingerprint_hash` API reply field.\n\nNOTE: For details about the value of this field, see the `decision_provider_#_field_#_value` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).\n\nFor more details about this field, see the `device_fingerprint_hash` field description in the _CyberSource Decision Manager Device Fingerprinting Guide_on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link)\n" - }, - "smartId": { - "type": "string", - "maxLength": 255, - "description": "The device identifier generated from attributes collected during profiling. Returned by a 3rd party when you use device fingerprinting.\n\nFor details, see the `device_fingerprint_smart_id` field description in [CyberSource Decision Manager Device Fingerprinting Guide.](https://www.cybersource.com/developers/documentation/fraud_management)\n" - } - } - } - } + }, + "comments": { + "type": "string", + "description": "Comments given by the reviewer", + "example": "Verified the order and accepted.", + "xml": { + "name": "Comment", + "attribute": true } } }, - "_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." - } - } - } - } + "xml": { + "name": "Note" } + }, + "xml": { + "name": "Notes" } } + }, + "xml": { + "name": "Conversion" } } + } + }, + "xml": { + "name": "Report" + } + } + }, + "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" }, - "_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." - } + "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" } } }, - "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, - "status": "status", - "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" + "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", + "application/xml" + ], + "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.[Rfc Date Format](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.[Rfc Date Format](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.[Rfc Date Format](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", + "description": "Valid values:\n- PURCHASES\n- REFUNDS\n- FEES\n- CHARGEBACKS\n", + "example": "PURCHASES" }, - "clientReferenceInformation": { - "code": "12345", - "applicationName": "Service Fee Request", - "applicationUser": "sandeep_wf" + "paymentSubType": { + "type": "string", + "example": "VI" }, - "consumerAuthenticationInformation": { - "xid": "12345678", - "transactionId": "00152259513040478521" + "conveyedCount": { + "type": "integer", + "example": 10 }, - "deviceInformation": { - "ipAddress": "1.10.10.10" + "conveyedAmount": { + "type": "string", + "example": "100.50" }, - "fraudMarkingInformation": { - "reason": "fraud txn" + "settledCount": { + "type": "integer", + "example": 10 }, - "merchantDefinedInformation": [ - { - "key": "abc", - "value": "xyz" - } - ], - "merchantInformation": { - "resellerId": "wfbmcp" + "fundedCount": { + "type": "integer", + "example": 10 }, - "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" - } + "fundedAmount": { + "type": "string", + "example": "150.50" }, - "paymentInformation": { - "paymentType": { - "name": "CARD", - "method": { - "name": "method name" - } - }, - "customer": { - "customerId": "12345" - }, - "card": { - "suffix": "1111", - "prefix": "123456", - "type": "001" - } + "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" }, - "processingInformation": { - "paymentSolution": "xyz", - "businessApplicationId": "12345" + "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" }, - "processorInformation": { - "processor": { - "name": "FirstData" - } + "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" }, - "pointOfSaleInformation": { - "terminalId": "1", - "terminalSerialNumber": "123111123", - "deviceId": "asfaf12312313", - "partner": { - "originalTransactionId": "131231414414" - } + "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" }, - "riskInformation": { - "providers": { - "fingerprint": { - "true_ipaddress": "1.101.102.112", - "hash": "tuWmt8Ubw0EAybBF3wrZcEqIcZsLr8YPldTQDUxAg2k=", - "smart_id": "23442fdadfa" - } - } + "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" }, - "_links": { - "transactionDetail": { - "href": "https://sl73paysvapq002.visa.com:2031/payment/tss/v2/transactions/5217848115816817001541", - "method": "GET" - } + "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" }, - "_links": { - "self": { - "href": "https://sl73paysvapq002.visa.com:2031/payment/tss/v2/searches/87e1e4bd-cac2-49b1-919a-4d5e29a2e55d", - "method": "GET" + "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" } } + } + } + } + }, + "/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": "The specified resource not found in the system." + "description": "DTD file not found" }, "500": { - "description": "Unexpected server error." + "description": "Internal Server Error" } } } }, - "/ums/v1/users": { + "/xsds/{reportDefinitionNameVersion}": { "get": { - "summary": "Get user information", - "description": "This endpoint is to get all the user information depending on the filter criteria passed in the query.", "tags": [ - "UserManagement" + "DownloadXSD" ], - "operationId": "getUsers", + "summary": "Used to download XSDs for reports", + "description": "Downloads XSDs for reports on no-auth.", + "operationId": "getXSDV2", "x-devcenter-metaData": { - "categoryTag": "User_Management" + "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" + } + } + } + }, + "/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", - "permissionId": "CustomerProfileViewPermission" + "startDate": "2018-10-20", + "endDate": "2018-10-30" }, + "produces": [ + "application/hal+json" + ], "parameters": [ { + "name": "startDate", "in": "query", - "name": "organizationId", - "type": "string", - "description": "This is the orgId of the organization which the user belongs to." - }, - { - "in": "query", - "name": "userName", + "description": "Valid start date in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.[Rfc Date Format](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", - "description": "User ID of the user you want to get details on." + "format": "date" }, { + "name": "endDate", "in": "query", - "name": "permissionId", + "description": "Valid end date in **ISO 8601 format**\nPlease refer the following link to know more about ISO 8601 format.[Rfc Date Format](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", - "description": "permission that you are trying to search user on." + "format": "date" }, { + "name": "organizationId", "in": "query", - "name": "roleId", + "description": "Valid Cybersource Organization Id", + "pattern": "[a-zA-Z0-9-_]+", + "required": false, "type": "string", - "description": "role of the user you are trying to search on." + "minLength": 1, + "maxLength": 32 } ], "responses": { "200": { - "description": "OK", + "description": "Ok", "schema": { + "title": "V1FileDetailsGet200Response", "type": "object", - "title": "umsV1UsersGet200Response", "properties": { - "users": { + "fileDetails": { "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", - "description": "Valid values:\n- active\n- inactive\n- locked\n- disabled\n- forgotpassword\n- deleted\n" - }, - "createdTime": { - "type": "string", - "format": "date-time" - }, - "lastAccessTime": { - "type": "string", - "format": "date-time" - }, - "languagePreference": { - "type": "string" - }, - "timezone": { - "type": "string" - } - } + "fileId": { + "type": "string", + "description": "Unique identifier of a file", + "example": "AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B" }, - "organizationInformation": { - "type": "object", - "properties": { - "organizationId": { - "type": "string" - } - } + "name": { + "type": "string", + "description": "Name of the file", + "example": "MyTransactionDetailreport.xml" }, - "contactInformation": { - "type": "object", - "properties": { - "email": { - "type": "string" - }, - "phoneNumber": { - "type": "string" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - } - } + "createdTime": { + "type": "string", + "format": "date-time", + "description": "Date and time for the file in PST", + "example": "2017-10-01T00:00:00+05:00" }, - "customFields": { - "additionalProperties": { - "type": "string" - } + "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'\n\nValid values:\n- 'application/xml'\n- 'text/csv'\n- 'application/pdf'\n- 'application/octet-stream'\n", + "example": "application/xml" + }, + "size": { + "type": "integer", + "description": "Size of the file in bytes", + "example": 2245397 } } } - } - }, - "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" + }, + "_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" + } + } }, - "customFields": { - "employeeId": "12344", - "employeeName": "John Doe", - "employeeDesignation": "abc", - "zone": "NA", - "department": "map" + "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.", + "description": "Invalid request", "schema": { + "title": "V1FilesGet400Response", "type": "object", - "title": "umsV1UsersGet400Response", + "required": [ + "code", + "message" + ], "properties": { - "submitTimeUtc": { + "code": { "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" + "description": "Error code" }, - "status": { + "message": { "type": "string", - "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" + "description": "Error message" }, - "reason": { + "localizationKey": { "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" + "description": "Localization Key Name" }, - "message": { + "correlationId": { "type": "string", - "description": "The detail message related to the status and reason listed above." + "description": "Correlation Id" }, - "details": { + "detail": { + "type": "string", + "description": "Error Detail" + }, + "fields": { "type": "array", + "description": "Error fields List", "items": { "type": "object", "properties": { - "field": { + "path": { "type": "string", - "description": "This is the flattened JSON object field name/path that is either missing or invalid." + "description": "Path of the failed property" }, - "reason": { - "type": "string", - "description": "Possible reasons for the error.\n\nPossible values:\n - MISSING_FIELD\n - INVALID_DATA\n" - } - } - } - } - } - } - }, - "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", - "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." - } - } - } - } - }, - "KeyParameters": { - "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." - } - } - }, - "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" + "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" }, - "e": { - "type": "string", - "description": "JWK RSA Exponent" + "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" + } } - } - } - } - }, - "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." - } - } - }, - "Error": { - "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." + }, + "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" }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." - } - } - } - } - }, - "Link": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" - } - } - }, - "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" + "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" + } } - } - } - } - }, - "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." + }, + "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" + } + } }, - "message": { - "type": "string", - "description": "Description or code of any error response." + "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" } } - } - } - } - }, - "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": "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." + "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" + } + } }, - "location": { - "type": "string", - "description": "The location of the field that threw the error." + "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" } } } } } }, - "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." - } - } - } + "/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" }, - "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." - } - } - } + "x-queryParameterDefaults": { + "organizationId": "testrest" }, - "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." + "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" } } } }, - "FileDetailsResponse": { - "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'\n\nValid values:\n- 'application/xml'\n- 'text/csv'\n- 'application/pdf'\n- 'application/octet-stream'\n", - "example": "application/xml" + "/ums/v1/users": { + "get": { + "summary": "Get user information", + "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", + "description": "Valid values:\n- active\n- inactive\n- locked\n- disabled\n- forgotpassword\n- deleted\n" + }, + "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" + } + } + } + } + } }, - "size": { - "type": "integer", - "description": "Size of the file in bytes", - "example": 2245397 + "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" + } + } + ] } } - } - }, - "_links": { - "type": "object", - "properties": { - "self": { + }, + "400": { + "description": "Invalid request.", + "schema": { "type": "object", + "title": "umsV1UsersGet400Response", "properties": { - "href": { + "submitTimeUtc": { "type": "string", - "example": "/sfs/v1/file-details?startDate=2018-01-01&endDate=2018-01-02" + "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" }, - "method": { + "status": { "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" + "description": "The status of the submitted transaction.\n\nPossible values:\n - INVALID_REQUEST\n" + }, + "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" + }, + "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" + } + } } } } } + }, + "500": { + "description": "Unexpected server error." } } } - }, - "FileDetail": { + } + }, + "definitions": { + "Metadata": { "type": "object", + "readOnly": true, "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": { + "creator": { "type": "string", - "description": "'File extension'\n\nValid values:\n- 'application/xml'\n- 'text/csv'\n- 'application/pdf'\n- 'application/octet-stream'\n", - "example": "application/xml" - }, - "size": { - "type": "integer", - "description": "Size of the file in bytes", - "example": 2245397 + "example": "merchantName", + "description": "The creator of the token." } } }, - "ErrorBean": { - "type": "object", - "required": [ - "code", - "message" - ], + "Links": { "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" + "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." + } + } }, - "fields": { + "documentation": { "type": "array", - "description": "Error fields List", "items": { - "type": "object", "properties": { - "path": { + "href": { "type": "string", - "description": "Path of the failed property" + "description": "URI of the linked resource." }, - "message": { + "title": { "type": "string", - "description": "Error description about validation failed field" + "description": "Label of the linked resource." }, - "localizationKey": { + "method": { "type": "string", - "description": "Localized Key Name" + "description": "HTTP method of the linked resource." } - }, - "description": "Provide validation failed input field details" + } } - } - }, - "description": "Error Bean" - }, - "ErrorFieldBean": { - "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" - }, - "SelfLinkBean": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "/sfs/v1/file-details?startDate=2018-01-01&endDate=2018-01-02" }, - "method": { - "type": "string", - "example": "GET" + "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." + } + } + } } } }, - "FileBean": { - "type": "object", + "Link": { "properties": { - "fileId": { + "href": { "type": "string", - "description": "Unique identifier for each file", - "example": "AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B" + "description": "URI of the linked resource." }, - "href": { + "title": { "type": "string", - "example": "/sfs/v1/files/AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B" + "description": "Label of the linked resource." }, "method": { "type": "string", - "example": "GET" - } - } - }, - "Metadata": { - "type": "object", - "readOnly": true, - "properties": { - "creator": { - "type": "string", - "example": "merchantName", - "description": "The creator of the token." + "description": "HTTP method of the linked resource." } } }, @@ -28873,15 +28984,114 @@ } } }, - "409Link": { - "type": "object", - "properties": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments" - } - } - }, + "409Link": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789/paymentinstruments" + } + } + }, + "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." + } + } + } + }, + "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." + } + } + } + } + } + } + }, "ErrorResponseWithHAL": { "type": "array", "properties": { @@ -28927,6 +29137,103 @@ } } }, + "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." + } + } + } + } + } + } + } + }, "Detail": { "type": "object", "properties": { @@ -29488,7 +29795,7 @@ "type": "string", "readOnly": true, "example": "ACTIVE", - "description": "'Current state of the token.'\n \nValid values:\n- ACTIVE\n- CLOSED\n" + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" }, "id": { "type": "string", @@ -29615,7 +29922,7 @@ "type": "string", "readOnly": true, "example": "ACTIVE", - "description": "'Current state of the token.'\n \nValid values:\n- ACTIVE\n- CLOSED\n" + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" }, "id": { "type": "string", @@ -30056,582 +30363,913 @@ } } } - }, - "merchantInformation": { + }, + "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.'\n\nValid values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + }, + "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." + } + } + } + } + } + } + } + } + } + } + } + }, + "PaymentInstrumentsArray": { + "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.'\n\nValid values:\n- paymentInstrument\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + }, + "bankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + }, + "type": { + "type": "string", + "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- 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", + "example": "driver license", + "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\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", + "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": { - "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." - } - } + "href": { + "type": "string", + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" } } }, - "metaData": { + "ancestor": { "type": "object", - "readOnly": true, "properties": { - "creator": { + "href": { "type": "string", - "example": "merchantName", - "description": "The creator of the token." + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" } } }, - "instrumentIdentifier": { + "successor": { "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.'\n\nValid values:\n- instrumentIdentifier\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n \nValid values:\n- ACTIVE\n- CLOSED\n" - }, - "id": { + "href": { "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." - } - } + "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" } } } } - } - } - } - } - } - }, - "PaymentInstrumentsArray": { - "description": "Array of Payment Instruments returned for the supplied Instrument Identifier.", - "type": "array", - "items": { - "type": "object", - "properties": { - "_links": { - "type": "object", - "readOnly": true, - "properties": { - "self": { + }, + "object": { + "type": "string", + "readOnly": true, + "example": "instrumentIdentifier", + "description": "'Describes type of token.'\n\nValid values:\n- instrumentIdentifier\n" + }, + "state": { + "type": "string", + "readOnly": true, + "example": "ACTIVE", + "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" + }, + "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": { - "href": { + "number": { "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." } } }, - "ancestor": { + "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": { - "href": { - "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + "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." + } + } + } + } + } + } } } }, - "successor": { + "metadata": { "type": "object", + "readOnly": true, "properties": { - "href": { + "creator": { "type": "string", - "example": "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789" + "example": "merchantName", + "description": "The creator of the token." } } } } - }, - "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.'\n\nValid values:\n- paymentInstrument\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n\nValid values:\n- ACTIVE\n- CLOSED\n" - }, - "bankAccount": { - "type": "object", - "properties": { - "type": { - "type": "string", - "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" - }, - "type": { - "type": "string", - "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- 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." - } + } + } + } + }, + "InstrumentIdentifierCard": { + "type": "object", + "properties": { + "number": { + "type": "string", + "example": "1234567890987654", + "minLength": 12, + "maxLength": 19, + "description": "Customer\u2019s credit card number." + } + } + }, + "ExistingInstrumentIdentifierId": { + "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." + }, + "PaymentInstrumentCard": { + "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + }, + "type": { + "type": "string", + "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- 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." + } + } + }, + "PaymentInstrumentBankAccount": { + "type": "object", + "properties": { + "type": { + "type": "string", + "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" + } + } + }, + "InstrumentIdentifierBankAccount": { + "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." + } + } + }, + "InstrumentIdentifierEnrollableCard": { + "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." } - }, - "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": { + } + }, + "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." + } + } + }, + "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." + } + } + } + } + }, + "InstrumentIdentifierProcessingInformation": { + "type": "object", + "properties": { + "authorizationOptions": { + "type": "object", + "properties": { + "initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { "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": { + "previousTransactionId": { "type": "string", - "example": "driver license", - "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\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" - } - } + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." } } } } } - }, - "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", - "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." + } + } + } + }, + "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." + } } } - }, - "instrumentIdentifier": { + } + } + } + }, + "Initiator": { + "type": "object", + "properties": { + "merchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + } + } + }, + "MerchantInitiatedTransaction": { + "type": "object", + "properties": { + "previousTransactionId": { + "type": "string", + "example": "123456789012345", + "maxLength": 15, + "description": "Previous Consumer Initiated Transaction Id." + } + } + }, + "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": { - "_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.'\n\nValid values:\n- instrumentIdentifier\n" - }, - "state": { - "type": "string", - "readOnly": true, - "example": "ACTIVE", - "description": "'Current state of the token.'\n \nValid values:\n- ACTIVE\n- CLOSED\n" - }, "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." - } - } + "example": "1234567890", + "description": "Customer's identification number.\n\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n" }, - "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." - } - } - } - } - } - } - } - } + "type": { + "type": "string", + "example": "driver license", + "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\n" }, - "metadata": { + "issuedBy": { "type": "object", - "readOnly": true, "properties": { - "creator": { + "administrativeArea": { "type": "string", - "example": "merchantName", - "description": "The creator of the token." + "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" } } } @@ -30640,230 +31278,513 @@ } } }, - "InstrumentIdentifierCard": { + "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", + "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": { - "number": { + "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." + } + } + } + } + }, + "TokenizeResult": { + "properties": { + "keyId": { "type": "string", - "example": "1234567890987654", - "minLength": 12, - "maxLength": 19, - "description": "Customer\u2019s credit card number." + "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" + } } } }, - "ExistingInstrumentIdentifierId": { - "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." + "TokenizeParameters": { + "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." + } + } + } + } }, - "PaymentInstrumentCard": { + "KeyParameters": { "type": "object", "required": [ - "type" + "encryptionType" ], "properties": { - "expirationMonth": { + "encryptionType": { "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" + "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." }, - "expirationYear": { + "use": { "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. For details, see [Relaxed Requirements for Address Data and Expiration Date.](https://www.cybersource.com/developers/integration_methods/relax_avs/).\n\n**Important** It is your responsibility to determine whether a field is required for the transaction you are requesting.'\n" + "description": "Defines whether to use the key for encryption (enc) or verifying a signature (sig). Always returned as enc." }, - "type": { + "kid": { "type": "string", - "description": "Type of credit card. Possible values:\n * **visa** -- Visa (001)\n * **mastercard** -- Mastercard (002) - Eurocard\u2014European regional brand of Mastercard\n * **american express** -- American Express (003)\n * **discover** -- Discover (004)\n * **diners club** -- Diners Club (005)\n * **carte blanche** -- Carte Blanche (006)\n * **jcb** -- JCB (007)\n * **optima** -- Optima (008)\n * **twinpay credit** -- Twinpay Credit (011)\n * **twinpay debit** -- Twinpay Debit (012)\n * **walmart** -- Walmart (013)\n * **enroute** -- EnRoute (014)\n * **lowes consumer** -- Lowes consumer (015)\n * **home depot consumer** -- Home Depot consumer (016)\n * **mbna** -- MBNA (017)\n * **dicks sportswear** -- Dicks Sportswear (018)\n * **casual corner** -- Casual Corner (019)\n * **sears** -- Sears (020)\n * **jal** -- JAL (021)\n * **disney** -- Disney (023)\n * **maestro uk domestic** -- Maestro (024) - UK Domestic\n * **sams club consumer** -- Sams Club consumer (025)\n * **sams club business** -- Sams Club business (026)\n * **bill me later** -- Bill me later (028)\n * **bebe** -- Bebe (029)\n * **restoration hardware** -- Restoration Hardware (030)\n * **delta online** -- Delta (031) \u2014 use this value only for Ingenico ePayments. For other processors, use 001 for all Visa card types.\n * **solo** -- Solo (032)\n * **visa electron** -- Visa Electron (033)\n * **dankort** -- Dankort (034)\n * **laser** -- Laser (035)\n * **carte bleue** -- Carte Bleue (036) \u2014 formerly Cartes Bancaires\n * **carta si** -- Carta Si (037)\n * **pinless debit** -- pinless debit (038)\n * **encoded account** -- encoded account (039)\n * **uatp** -- UATP (040)\n * **household** -- Household (041)\n * **maestro international** -- Maestro (042) - International\n * **ge money uk** -- GE Money UK (043)\n * **korean cards** -- Korean cards (044)\n * **style** -- Style (045)\n * **jcrew** -- JCrew (046)\n * **payease china processing ewallet** -- PayEase China processing eWallet (047)\n * **payease china processing bank transfer** -- PayEase China processing bank transfer (048)\n * **meijer private label** -- Meijer Private Label (049)\n * **hipercard** -- Hipercard (050) \u2014 supported only by the Comercio Latino processor.\n * **aura** -- Aura (051) \u2014 supported only by the Comercio Latino processor.\n * **redecard** -- Redecard (052)\n * **elo** -- Elo (054) \u2014 supported only by the Comercio Latino processor.\n * **capital one private label** -- Capital One Private Label (055)\n * **synchrony private label** -- Synchrony Private Label (056)\n * **costco private label** -- Costco Private Label (057)\n * **mada** -- mada (060)\n * **china union pay** -- China Union Pay (062)\n * **falabella private label** -- Falabella private label (063)\n" + "description": "The key ID in JWK format." }, - "issueNumber": { + "n": { "type": "string", - "example": "01", - "minLength": 1, - "maxLength": 2, - "description": "Number of times a Maestro (UK Domestic) card has been issued to the account holder." + "description": "JWK RSA Modulus" }, - "startMonth": { + "e": { "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" + "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." }, - "startYear": { + "algorithm": { "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" + "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", + "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" }, - "useAs": { + "cardExpirationYear": { "type": "string", - "example": "pinless debit", - "description": "Card Use As Field. Supported value of `pinless debit` only. Only for use with Pinless Debit tokens." + "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." } } }, - "PaymentInstrumentBankAccount": { - "type": "object", + "ResponseStatus": { "properties": { - "type": { + "status": { + "type": "number", + "description": "HTTP Status code." + }, + "reason": { "type": "string", - "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" + "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." + } + } + } } } }, - "InstrumentIdentifierBankAccount": { - "type": "object", + "ResponseStatusDetails": { "properties": { - "number": { + "location": { "type": "string", - "example": "1234567890123456800", - "minLength": 1, - "maxLength": 19, - "description": "Checking account number." + "description": "Field name referred to for validation issues." }, - "routingNumber": { + "message": { "type": "string", - "example": "123456789", - "minLength": 1, - "maxLength": 9, - "description": "Routing number." + "description": "Description or code of any error response." } } }, - "InstrumentIdentifierEnrollableCard": { + "ErrorLinks": { "type": "object", "properties": { - "type": { - "type": "string", - "example": "enrollable card", - "description": "Type of Card" + "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." + } + } + } }, - "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." + "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." + } } } }, - "billTo": { - "type": "object", + "self": { "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": { + "href": { "type": "string", - "example": "TX", - "description": "Administrative area registered with card." + "description": "URI of the linked resource." }, - "postalCode": { + "title": { "type": "string", - "example": "78731", - "description": "Postal code registered with card." + "description": "Label of the linked resource." }, - "country": { + "method": { "type": "string", - "example": "US", - "description": "Country registered with card." + "description": "HTTP method of the linked resource." } } } } }, - "InstrumentIdentifierProcessingInformation": { + "FileDetailsResponse": { "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." - } - } - } + "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'\n\nValid values:\n- 'application/xml'\n- 'text/csv'\n- 'application/pdf'\n- 'application/octet-stream'\n", + "example": "application/xml" + }, + "size": { + "type": "integer", + "description": "Size of the file in bytes", + "example": 2245397 } } } - } - } - }, - "AuthorizationOptions": { - "type": "object", - "properties": { - "initiator": { + }, + "_links": { "type": "object", "properties": { - "merchantInitiatedTransaction": { + "self": { "type": "object", "properties": { - "previousTransactionId": { + "href": { "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." + "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" + } } } } @@ -30871,193 +31792,147 @@ } } }, - "Initiator": { - "type": "object", - "properties": { - "merchantInitiatedTransaction": { - "type": "object", - "properties": { - "previousTransactionId": { - "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." - } - } - } - } - }, - "MerchantInitiatedTransaction": { + "FileDetail": { "type": "object", "properties": { - "previousTransactionId": { + "fileId": { "type": "string", - "example": "123456789012345", - "maxLength": 15, - "description": "Previous Consumer Initiated Transaction Id." + "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'\n\nValid values:\n- 'application/xml'\n- 'text/csv'\n- 'application/pdf'\n- 'application/octet-stream'\n", + "example": "application/xml" + }, + "size": { + "type": "integer", + "description": "Size of the file in bytes", + "example": 2245397 } } }, - "BuyerInformation": { + "ErrorBean": { "type": "object", + "required": [ + "code", + "message" + ], "properties": { - "companyTaxID": { + "code": { "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" + "description": "Error code" }, - "currency": { + "message": { "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." + "description": "Error message" }, - "dateOBirth": { + "localizationKey": { "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" + "description": "Localization Key Name" }, - "personalIdentification": { + "correlationId": { + "type": "string", + "description": "Correlation Id" + }, + "detail": { + "type": "string", + "description": "Error Detail" + }, + "fields": { "type": "array", + "description": "Error fields List", "items": { "type": "object", "properties": { - "id": { + "path": { "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" + "description": "Path of the failed property" }, - "type": { + "message": { "type": "string", - "example": "driver license", - "description": "Type of personal identification.\n**Important**:\nContact your TeleCheck representative to learn whether this field is required or optional.\n\nValid values:\n- driver license\n" + "description": "Error description about validation failed field" }, - "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" - } - } + "localizationKey": { + "type": "string", + "description": "Localized Key Name" } - } + }, + "description": "Provide validation failed input field details" } } - } + }, + "description": "Error Bean" }, - "BillTo": { + "ErrorFieldBean": { "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": { + "path": { "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" + "description": "Path of the failed property" }, - "email": { + "message": { "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" + "description": "Error description about validation failed field" }, - "phoneNumber": { + "localizationKey": { "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" + "description": "Localized Key Name" } - } + }, + "description": "Provide validation failed input field details" }, - "ProcessingInformation": { + "SelfLinkBean": { "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" + "href": { + "type": "string", + "example": "/sfs/v1/file-details?startDate=2018-01-01&endDate=2018-01-02" }, - "bankTransferOptions": { - "type": "object", - "properties": { - "SECCode": { - "type": "string", - "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" - } - } + "method": { + "type": "string", + "example": "GET" } } }, - "MerchantInformation": { + "FileBean": { "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." - } - } + "fileId": { + "type": "string", + "description": "Unique identifier for each file", + "example": "AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B" + }, + "href": { + "type": "string", + "example": "/sfs/v1/files/AC855F9F42C90361EC78202F47CDE98D70BEAA6FB00FB56AE83EE9A9DAEE077B" + }, + "method": { + "type": "string", + "example": "GET" } } } diff --git a/pom.xml b/pom.xml index 963cb0a0a..98b0e327d 100644 --- a/pom.xml +++ b/pom.xml @@ -258,7 +258,7 @@ com.cybersource AuthenticationSdk - 0.0.5 + 0.0.6 @@ -286,7 +286,7 @@ 1.0.0 4.12 0.3.1 - 2.9.9.1 + 2.9.9.3 UTF-8 diff --git a/src/main/java/Api/ConversionDetailsApi.java b/src/main/java/Api/ConversionDetailsApi.java index 89fc15406..8c56b731b 100644 --- a/src/main/java/Api/ConversionDetailsApi.java +++ b/src/main/java/Api/ConversionDetailsApi.java @@ -85,7 +85,7 @@ public com.squareup.okhttp.Call getConversionDetailCall(DateTime startTime, Date Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/hal+json" + "application/hal+json", "application/xml" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); diff --git a/src/main/java/Api/DownloadDTDApi.java b/src/main/java/Api/DownloadDTDApi.java new file mode 100644 index 000000000..122743235 --- /dev/null +++ b/src/main/java/Api/DownloadDTDApi.java @@ -0,0 +1,178 @@ +/* + * CyberSource Merged Spec + * All 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 java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class DownloadDTDApi { + private ApiClient apiClient; + + public DownloadDTDApi() { + this(Configuration.getDefaultApiClient()); + } + + public DownloadDTDApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + public ApiClient getApiClient() { + return apiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Build call for getDTDV2 + * @param reportDefinitionNameVersion 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) + * @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 getDTDV2Call(String reportDefinitionNameVersion, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/dtds/{reportDefinitionNameVersion}" + .replaceAll("\\{" + "reportDefinitionNameVersion" + "\\}", apiClient.escapeString(reportDefinitionNameVersion.toString())); + + List localVarQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "application/xml-dtd" + }; + 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 getDTDV2ValidateBeforeCall(String reportDefinitionNameVersion, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'reportDefinitionNameVersion' is set + if (reportDefinitionNameVersion == null) { + throw new ApiException("Missing the required parameter 'reportDefinitionNameVersion' when calling getDTDV2(Async)"); + } + + + com.squareup.okhttp.Call call = getDTDV2Call(reportDefinitionNameVersion, progressListener, progressRequestListener); + return call; + + + + + + } + + /** + * Used to download DTDs for reports + * Downloads DTDs for reports on no-auth. + * @param reportDefinitionNameVersion 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) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public void getDTDV2(String reportDefinitionNameVersion) throws ApiException { + getDTDV2WithHttpInfo(reportDefinitionNameVersion); + } + + /** + * Used to download DTDs for reports + * Downloads DTDs for reports on no-auth. + * @param reportDefinitionNameVersion 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) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getDTDV2WithHttpInfo(String reportDefinitionNameVersion) throws ApiException { + com.squareup.okhttp.Call call = getDTDV2ValidateBeforeCall(reportDefinitionNameVersion, null, null); + return apiClient.execute(call); + } + + /** + * Used to download DTDs for reports (asynchronously) + * Downloads DTDs for reports on no-auth. + * @param reportDefinitionNameVersion 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) + * @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 getDTDV2Async(String reportDefinitionNameVersion, 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 = getDTDV2ValidateBeforeCall(reportDefinitionNameVersion, progressListener, progressRequestListener); + apiClient.executeAsync(call, callback); + return call; + } +} diff --git a/src/main/java/Api/DownloadXSDApi.java b/src/main/java/Api/DownloadXSDApi.java new file mode 100644 index 000000000..811421789 --- /dev/null +++ b/src/main/java/Api/DownloadXSDApi.java @@ -0,0 +1,178 @@ +/* + * CyberSource Merged Spec + * All 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 java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; + +public class DownloadXSDApi { + private ApiClient apiClient; + + public DownloadXSDApi() { + this(Configuration.getDefaultApiClient()); + } + + public DownloadXSDApi(ApiClient apiClient) { + this.apiClient = apiClient; + } + + public ApiClient getApiClient() { + return apiClient; + } + + public void setApiClient(ApiClient apiClient) { + this.apiClient = apiClient; + } + + /** + * Build call for getXSDV2 + * @param reportDefinitionNameVersion 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) + * @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 getXSDV2Call(String reportDefinitionNameVersion, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + Object localVarPostBody = null; + + // create path and map variables + String localVarPath = "/xsds/{reportDefinitionNameVersion}" + .replaceAll("\\{" + "reportDefinitionNameVersion" + "\\}", apiClient.escapeString(reportDefinitionNameVersion.toString())); + + List localVarQueryParams = new ArrayList(); + + Map localVarHeaderParams = new HashMap(); + + Map localVarFormParams = new HashMap(); + + final String[] localVarAccepts = { + "text/xml" + }; + 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 getXSDV2ValidateBeforeCall(String reportDefinitionNameVersion, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException { + + // verify the required parameter 'reportDefinitionNameVersion' is set + if (reportDefinitionNameVersion == null) { + throw new ApiException("Missing the required parameter 'reportDefinitionNameVersion' when calling getXSDV2(Async)"); + } + + + com.squareup.okhttp.Call call = getXSDV2Call(reportDefinitionNameVersion, progressListener, progressRequestListener); + return call; + + + + + + } + + /** + * Used to download XSDs for reports + * Downloads XSDs for reports on no-auth. + * @param reportDefinitionNameVersion 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) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public void getXSDV2(String reportDefinitionNameVersion) throws ApiException { + getXSDV2WithHttpInfo(reportDefinitionNameVersion); + } + + /** + * Used to download XSDs for reports + * Downloads XSDs for reports on no-auth. + * @param reportDefinitionNameVersion 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) + * @return ApiResponse<Void> + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ApiResponse getXSDV2WithHttpInfo(String reportDefinitionNameVersion) throws ApiException { + com.squareup.okhttp.Call call = getXSDV2ValidateBeforeCall(reportDefinitionNameVersion, null, null); + return apiClient.execute(call); + } + + /** + * Used to download XSDs for reports (asynchronously) + * Downloads XSDs for reports on no-auth. + * @param reportDefinitionNameVersion 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) + * @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 getXSDV2Async(String reportDefinitionNameVersion, 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 = getXSDV2ValidateBeforeCall(reportDefinitionNameVersion, progressListener, progressRequestListener); + apiClient.executeAsync(call, callback); + return call; + } +} diff --git a/src/main/java/Api/InstrumentIdentifierApi.java b/src/main/java/Api/InstrumentIdentifierApi.java index 08d943018..b1744eda6 100644 --- a/src/main/java/Api/InstrumentIdentifierApi.java +++ b/src/main/java/Api/InstrumentIdentifierApi.java @@ -28,7 +28,7 @@ import Model.CreateInstrumentIdentifierRequest; -import Model.InlineResponse4001; +import Model.InlineResponse400; import Model.TmsV1InstrumentIdentifiersDelete409Response; import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response; import Model.TmsV1InstrumentIdentifiersPost200Response; diff --git a/src/main/java/Api/NetFundingsApi.java b/src/main/java/Api/NetFundingsApi.java index 80c36bf6c..4f7e448be 100644 --- a/src/main/java/Api/NetFundingsApi.java +++ b/src/main/java/Api/NetFundingsApi.java @@ -88,7 +88,7 @@ public com.squareup.okhttp.Call getNetFundingDetailsCall(DateTime startTime, Dat Map localVarFormParams = new HashMap(); final String[] localVarAccepts = { - "application/hal+json" + "application/hal+json", "application/xml" }; final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts); if (localVarAccept != null) localVarHeaderParams.put("Accept", localVarAccept); diff --git a/src/main/java/Api/PaymentBatchSummariesApi.java b/src/main/java/Api/PaymentBatchSummariesApi.java new file mode 100644 index 000000000..462ab39cc --- /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.ReportingV3PaymentBatchSummariesGet200Response; +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.[Rfc Date 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.[Rfc Date 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/all_merchant/selected_merchant. 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.[Rfc Date 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.[Rfc Date 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/all_merchant/selected_merchant. 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 ReportingV3PaymentBatchSummariesGet200Response + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public ReportingV3PaymentBatchSummariesGet200Response 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.[Rfc Date 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.[Rfc Date 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/all_merchant/selected_merchant. 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<ReportingV3PaymentBatchSummariesGet200Response> + * @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.[Rfc Date 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.[Rfc Date 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/all_merchant/selected_merchant. 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/PaymentInstrumentApi.java b/src/main/java/Api/PaymentInstrumentApi.java index 03ea5ff61..6378c2ae4 100644 --- a/src/main/java/Api/PaymentInstrumentApi.java +++ b/src/main/java/Api/PaymentInstrumentApi.java @@ -28,7 +28,7 @@ import Model.CreatePaymentInstrumentRequest; -import Model.InlineResponse4001; +import Model.InlineResponse400; import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments; import Model.UpdatePaymentInstrumentRequest; diff --git a/src/main/java/Api/ReportSubscriptionsApi.java b/src/main/java/Api/ReportSubscriptionsApi.java index 0009b764a..dcf40b787 100644 --- a/src/main/java/Api/ReportSubscriptionsApi.java +++ b/src/main/java/Api/ReportSubscriptionsApi.java @@ -27,7 +27,7 @@ import java.io.IOException; -import Model.InlineResponse400; +import Model.InlineResponse4001; import Model.ReportingV3ReportSubscriptionsGet200Response; import Model.ReportingV3ReportSubscriptionsGet200ResponseSubscriptions; import Model.Reportingv3ReportDownloadsGet400Response; diff --git a/src/main/java/Api/SecureFileShareApi.java b/src/main/java/Api/SecureFileShareApi.java index 7cace16d9..cef6a5a13 100644 --- a/src/main/java/Api/SecureFileShareApi.java +++ b/src/main/java/Api/SecureFileShareApi.java @@ -27,7 +27,7 @@ import java.io.IOException; -import Model.InlineResponse400; +import Model.InlineResponse4001; import org.joda.time.LocalDate; import Model.V1FileDetailsGet200Response; diff --git a/src/main/java/Api/TransactionBatchesApi.java b/src/main/java/Api/TransactionBatchesApi.java index dbd125103..dd719ab5b 100644 --- a/src/main/java/Api/TransactionBatchesApi.java +++ b/src/main/java/Api/TransactionBatchesApi.java @@ -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,140 @@ public void setApiClient(ApiClient apiClient) { this.apiClient = apiClient; } + /** + * Build call for getTransactionBatchDetails + * @param id The batch id assigned for the template. (required) + * @param uploadDate Date in which the original batch file was uploaded. Date must be in ISO-8601 format. Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd (optional) + * @param status Allows you to filter by rejected response. Valid values: - Rejected (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 id, 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/{id}" + .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString())); + + List localVarQueryParams = new ArrayList(); + 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/csv", "application/xml" + }; + 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 id, LocalDate uploadDate, String status, 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 getTransactionBatchDetails(Async)"); + } + + + com.squareup.okhttp.Call call = getTransactionBatchDetailsCall(id, uploadDate, status, progressListener, progressRequestListener); + return call; + + + + + + } + + /** + * Get transaction details for a given batch id + * Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service. + * @param id The batch id assigned for the template. (required) + * @param uploadDate Date in which the original batch file was uploaded. Date must be in ISO-8601 format. Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd (optional) + * @param status Allows you to filter by rejected response. Valid values: - Rejected (optional) + * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body + */ + public void getTransactionBatchDetails(String id, LocalDate uploadDate, String status) throws ApiException { + getTransactionBatchDetailsWithHttpInfo(id, uploadDate, status); + } + + /** + * Get transaction details for a given batch id + * Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service. + * @param id The batch id assigned for the template. (required) + * @param uploadDate Date in which the original batch file was uploaded. Date must be in ISO-8601 format. Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd (optional) + * @param status Allows you to filter by rejected response. Valid values: - Rejected (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 id, LocalDate uploadDate, String status) throws ApiException { + com.squareup.okhttp.Call call = getTransactionBatchDetailsValidateBeforeCall(id, uploadDate, status, null, null); + return apiClient.execute(call); + } + + /** + * Get transaction details for a given batch id (asynchronously) + * Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service. + * @param id The batch id assigned for the template. (required) + * @param uploadDate Date in which the original batch file was uploaded. Date must be in ISO-8601 format. Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd (optional) + * @param status Allows you to filter by rejected response. Valid values: - Rejected (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 id, 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(id, 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/Invokers/ApiException.java b/src/main/java/Invokers/ApiException.java index 43bed4a0b..113c98df2 100644 --- a/src/main/java/Invokers/ApiException.java +++ b/src/main/java/Invokers/ApiException.java @@ -16,7 +16,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ApiException extends Exception { private int code = 0; private Map> responseHeaders = null; diff --git a/src/main/java/Invokers/Configuration.java b/src/main/java/Invokers/Configuration.java index 2428eba49..23a6c31a7 100644 --- a/src/main/java/Invokers/Configuration.java +++ b/src/main/java/Invokers/Configuration.java @@ -13,7 +13,7 @@ package Invokers; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Configuration { private static ApiClient defaultApiClient = new ApiClient(); diff --git a/src/main/java/Invokers/Pair.java b/src/main/java/Invokers/Pair.java index 52cab2345..0dcec2359 100644 --- a/src/main/java/Invokers/Pair.java +++ b/src/main/java/Invokers/Pair.java @@ -13,7 +13,7 @@ package Invokers; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Pair { private String name = ""; private String value = ""; diff --git a/src/main/java/Invokers/StringUtil.java b/src/main/java/Invokers/StringUtil.java index fe5302458..e4c034d00 100644 --- a/src/main/java/Invokers/StringUtil.java +++ b/src/main/java/Invokers/StringUtil.java @@ -13,7 +13,7 @@ package Invokers; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 c3fd81ee0..8518b1fc8 100644 --- a/src/main/java/Invokers/auth/ApiKeyAuth.java +++ b/src/main/java/Invokers/auth/ApiKeyAuth.java @@ -18,7 +18,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ApiKeyAuth implements Authentication { private final String location; private final String paramName; diff --git a/src/main/java/Invokers/auth/OAuth.java b/src/main/java/Invokers/auth/OAuth.java index 444ea1c84..37a65d036 100644 --- a/src/main/java/Invokers/auth/OAuth.java +++ b/src/main/java/Invokers/auth/OAuth.java @@ -18,7 +18,7 @@ import java.util.Map; import java.util.List; -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class OAuth implements Authentication { private String accessToken; diff --git a/src/main/java/Model/AuthReversalRequest.java b/src/main/java/Model/AuthReversalRequest.java index 5d01b829b..d23999f67 100644 --- a/src/main/java/Model/AuthReversalRequest.java +++ b/src/main/java/Model/AuthReversalRequest.java @@ -31,7 +31,7 @@ /** * AuthReversalRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class AuthReversalRequest { @SerializedName("clientReferenceInformation") private Ptsv2paymentsidreversalsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/main/java/Model/AuthorizationOptions.java b/src/main/java/Model/AuthorizationOptions.java index ef5ae2b3e..6ca1cfff6 100644 --- a/src/main/java/Model/AuthorizationOptions.java +++ b/src/main/java/Model/AuthorizationOptions.java @@ -27,7 +27,7 @@ /** * AuthorizationOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class AuthorizationOptions { @SerializedName("initiator") private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator initiator = null; diff --git a/src/main/java/Model/BillTo.java b/src/main/java/Model/BillTo.java index 43fc3b0fc..fec1edc75 100644 --- a/src/main/java/Model/BillTo.java +++ b/src/main/java/Model/BillTo.java @@ -26,7 +26,7 @@ /** * BillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class BillTo { @SerializedName("firstName") private String firstName = null; diff --git a/src/main/java/Model/BuyerInformation.java b/src/main/java/Model/BuyerInformation.java index a48265192..755169e10 100644 --- a/src/main/java/Model/BuyerInformation.java +++ b/src/main/java/Model/BuyerInformation.java @@ -29,7 +29,7 @@ /** * BuyerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class BuyerInformation { @SerializedName("companyTaxID") private String companyTaxID = null; diff --git a/src/main/java/Model/CapturePaymentRequest.java b/src/main/java/Model/CapturePaymentRequest.java index 0fffed944..1eca1ab78 100644 --- a/src/main/java/Model/CapturePaymentRequest.java +++ b/src/main/java/Model/CapturePaymentRequest.java @@ -39,7 +39,7 @@ /** * CapturePaymentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 index 42dfd80de..e8f86ea7d 100644 --- a/src/main/java/Model/CardInfo.java +++ b/src/main/java/Model/CardInfo.java @@ -26,7 +26,7 @@ /** * CardInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class CardInfo { @SerializedName("cardNumber") private String cardNumber = null; diff --git a/src/main/java/Model/CreateCreditRequest.java b/src/main/java/Model/CreateCreditRequest.java index 514a02154..5a73f1ca1 100644 --- a/src/main/java/Model/CreateCreditRequest.java +++ b/src/main/java/Model/CreateCreditRequest.java @@ -38,7 +38,7 @@ /** * CreateCreditRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 index 2da626cfd..cfcbc44cc 100644 --- a/src/main/java/Model/CreateDecisionManagerCaseRequest.java +++ b/src/main/java/Model/CreateDecisionManagerCaseRequest.java @@ -38,7 +38,7 @@ /** * CreateDecisionManagerCaseRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class CreateDecisionManagerCaseRequest { @SerializedName("clientReferenceInformation") private Riskv1decisionsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/main/java/Model/CreateInstrumentIdentifierRequest.java b/src/main/java/Model/CreateInstrumentIdentifierRequest.java index 0474a477c..dd795e67f 100644 --- a/src/main/java/Model/CreateInstrumentIdentifierRequest.java +++ b/src/main/java/Model/CreateInstrumentIdentifierRequest.java @@ -14,6 +14,7 @@ package Model; import java.util.Objects; +import Model.Tmsv1instrumentidentifiersBankAccount; import Model.Tmsv1instrumentidentifiersBillTo; import Model.Tmsv1instrumentidentifiersCard; import com.google.gson.TypeAdapter; @@ -28,7 +29,7 @@ /** * CreateInstrumentIdentifierRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class CreateInstrumentIdentifierRequest { @SerializedName("type") private String type = null; @@ -36,6 +37,9 @@ public class CreateInstrumentIdentifierRequest { @SerializedName("card") private Tmsv1instrumentidentifiersCard card = null; + @SerializedName("BankAccount") + private Tmsv1instrumentidentifiersBankAccount bankAccount = null; + @SerializedName("billTo") private Tmsv1instrumentidentifiersBillTo billTo = null; @@ -75,6 +79,24 @@ public void setCard(Tmsv1instrumentidentifiersCard card) { this.card = card; } + public CreateInstrumentIdentifierRequest 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 CreateInstrumentIdentifierRequest billTo(Tmsv1instrumentidentifiersBillTo billTo) { this.billTo = billTo; return this; @@ -105,12 +127,13 @@ public boolean equals(java.lang.Object o) { CreateInstrumentIdentifierRequest createInstrumentIdentifierRequest = (CreateInstrumentIdentifierRequest) o; return Objects.equals(this.type, createInstrumentIdentifierRequest.type) && Objects.equals(this.card, createInstrumentIdentifierRequest.card) && + Objects.equals(this.bankAccount, createInstrumentIdentifierRequest.bankAccount) && Objects.equals(this.billTo, createInstrumentIdentifierRequest.billTo); } @Override public int hashCode() { - return Objects.hash(type, card, billTo); + return Objects.hash(type, card, bankAccount, billTo); } @@ -121,6 +144,7 @@ public String toString() { sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" card: ").append(toIndentedString(card)).append("\n"); + sb.append(" bankAccount: ").append(toIndentedString(bankAccount)).append("\n"); sb.append(" billTo: ").append(toIndentedString(billTo)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/Model/CreatePaymentInstrumentRequest.java b/src/main/java/Model/CreatePaymentInstrumentRequest.java index b3f15a7a7..f29df863c 100644 --- a/src/main/java/Model/CreatePaymentInstrumentRequest.java +++ b/src/main/java/Model/CreatePaymentInstrumentRequest.java @@ -35,7 +35,7 @@ /** * CreatePaymentInstrumentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class CreatePaymentInstrumentRequest { @SerializedName("_links") private TmsV1InstrumentIdentifiersPost200ResponseLinks links = null; diff --git a/src/main/java/Model/CreatePaymentRequest.java b/src/main/java/Model/CreatePaymentRequest.java index 28e45f02f..4359664bc 100644 --- a/src/main/java/Model/CreatePaymentRequest.java +++ b/src/main/java/Model/CreatePaymentRequest.java @@ -42,7 +42,7 @@ /** * CreatePaymentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class CreatePaymentRequest { @SerializedName("clientReferenceInformation") private Ptsv2paymentsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/main/java/Model/CreateSearchRequest.java b/src/main/java/Model/CreateSearchRequest.java index 003599e4c..500d74c5f 100644 --- a/src/main/java/Model/CreateSearchRequest.java +++ b/src/main/java/Model/CreateSearchRequest.java @@ -26,7 +26,7 @@ /** * CreateSearchRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class CreateSearchRequest { @SerializedName("save") private Boolean save = null; diff --git a/src/main/java/Model/DerPublicKey.java b/src/main/java/Model/DerPublicKey.java index e56676b6e..21ec285d0 100644 --- a/src/main/java/Model/DerPublicKey.java +++ b/src/main/java/Model/DerPublicKey.java @@ -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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class DerPublicKey { @SerializedName("format") private String format = null; diff --git a/src/main/java/Model/Detail.java b/src/main/java/Model/Detail.java index b906c0734..8acc692d9 100644 --- a/src/main/java/Model/Detail.java +++ b/src/main/java/Model/Detail.java @@ -26,7 +26,7 @@ /** * Detail */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Detail { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/EmbeddedInstrumentIdentifier.java b/src/main/java/Model/EmbeddedInstrumentIdentifier.java index 2562d151b..248a1c387 100644 --- a/src/main/java/Model/EmbeddedInstrumentIdentifier.java +++ b/src/main/java/Model/EmbeddedInstrumentIdentifier.java @@ -14,11 +14,11 @@ package Model; import java.util.Objects; -import Model.TmsV1InstrumentIdentifiersPost200ResponseBankAccount; import Model.TmsV1InstrumentIdentifiersPost200ResponseCard; import Model.TmsV1InstrumentIdentifiersPost200ResponseLinks; import Model.TmsV1InstrumentIdentifiersPost200ResponseMetadata; import Model.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation; +import Model.Tmsv1instrumentidentifiersBankAccount; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -31,7 +31,7 @@ /** * EmbeddedInstrumentIdentifier */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class EmbeddedInstrumentIdentifier { @SerializedName("_links") private TmsV1InstrumentIdentifiersPost200ResponseLinks links = null; @@ -49,7 +49,7 @@ public class EmbeddedInstrumentIdentifier { private TmsV1InstrumentIdentifiersPost200ResponseCard card = null; @SerializedName("bankAccount") - private TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount = null; + private Tmsv1instrumentidentifiersBankAccount bankAccount = null; @SerializedName("processingInformation") private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation = null; @@ -85,10 +85,10 @@ public String getObject() { } /** - * 'Current state of the token.' Valid values: - ACTIVE - CLOSED + * 'Current state of the token.' Valid values: - ACTIVE - CLOSED * @return state **/ - @ApiModelProperty(example = "ACTIVE", value = "'Current state of the token.' Valid values: - ACTIVE - CLOSED ") + @ApiModelProperty(example = "ACTIVE", value = "'Current state of the token.' Valid values: - ACTIVE - CLOSED ") public String getState() { return state; } @@ -129,7 +129,7 @@ public void setCard(TmsV1InstrumentIdentifiersPost200ResponseCard card) { this.card = card; } - public EmbeddedInstrumentIdentifier bankAccount(TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount) { + public EmbeddedInstrumentIdentifier bankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { this.bankAccount = bankAccount; return this; } @@ -139,11 +139,11 @@ public EmbeddedInstrumentIdentifier bankAccount(TmsV1InstrumentIdentifiersPost20 * @return bankAccount **/ @ApiModelProperty(value = "") - public TmsV1InstrumentIdentifiersPost200ResponseBankAccount getBankAccount() { + public Tmsv1instrumentidentifiersBankAccount getBankAccount() { return bankAccount; } - public void setBankAccount(TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount) { + public void setBankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { this.bankAccount = bankAccount; } diff --git a/src/main/java/Model/Error.java b/src/main/java/Model/Error.java index 765315f01..0751e4e33 100644 --- a/src/main/java/Model/Error.java +++ b/src/main/java/Model/Error.java @@ -14,7 +14,8 @@ package Model; import java.util.Objects; -import Model.Tmsv1instrumentidentifiersDetails; +import Model.ErrorLinks; +import Model.InlineResponseDefaultResponseStatus; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -27,69 +28,48 @@ /** * Error */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Error { - @SerializedName("type") - private String type = null; + @SerializedName("responseStatus") + private InlineResponseDefaultResponseStatus responseStatus = null; - @SerializedName("message") - private String message = null; + @SerializedName("_links") + private ErrorLinks links = null; - @SerializedName("details") - private Tmsv1instrumentidentifiersDetails details = null; - - public Error type(String type) { - this.type = type; + public Error responseStatus(InlineResponseDefaultResponseStatus responseStatus) { + this.responseStatus = responseStatus; return this; } /** - * Get type - * @return type + * Get responseStatus + * @return responseStatus **/ @ApiModelProperty(value = "") - public String getType() { - return type; - } - - public void setType(String type) { - this.type = type; - } - - public Error message(String message) { - this.message = message; - return this; - } - - /** - * The detailed message related to the type stated above. - * @return message - **/ - @ApiModelProperty(value = "The detailed message related to the type stated above.") - public String getMessage() { - return message; + public InlineResponseDefaultResponseStatus getResponseStatus() { + return responseStatus; } - public void setMessage(String message) { - this.message = message; + public void setResponseStatus(InlineResponseDefaultResponseStatus responseStatus) { + this.responseStatus = responseStatus; } - public Error details(Tmsv1instrumentidentifiersDetails details) { - this.details = details; + public Error links(ErrorLinks links) { + this.links = links; return this; } /** - * Get details - * @return details + * Get links + * @return links **/ @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersDetails getDetails() { - return details; + public ErrorLinks getLinks() { + return links; } - public void setDetails(Tmsv1instrumentidentifiersDetails details) { - this.details = details; + public void setLinks(ErrorLinks links) { + this.links = links; } @@ -102,14 +82,13 @@ public boolean equals(java.lang.Object o) { return false; } Error error = (Error) o; - return Objects.equals(this.type, error.type) && - Objects.equals(this.message, error.message) && - Objects.equals(this.details, error.details); + return Objects.equals(this.responseStatus, error.responseStatus) && + Objects.equals(this.links, error.links); } @Override public int hashCode() { - return Objects.hash(type, message, details); + return Objects.hash(responseStatus, links); } @@ -118,9 +97,8 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class Error {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); - sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append(" details: ").append(toIndentedString(details)).append("\n"); + sb.append(" responseStatus: ").append(toIndentedString(responseStatus)).append("\n"); + sb.append(" links: ").append(toIndentedString(links)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/ErrorBean.java b/src/main/java/Model/ErrorBean.java index 92d394713..f2d79d5b0 100644 --- a/src/main/java/Model/ErrorBean.java +++ b/src/main/java/Model/ErrorBean.java @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.InlineResponse400Fields; +import Model.InlineResponse4001Fields; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -30,7 +30,7 @@ * Error Bean */ @ApiModel(description = "Error Bean") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ErrorBean { @SerializedName("code") private String code = null; @@ -48,7 +48,7 @@ public class ErrorBean { private String detail = null; @SerializedName("fields") - private List fields = null; + private List fields = null; public ErrorBean code(String code) { this.code = code; @@ -140,14 +140,14 @@ public void setDetail(String detail) { this.detail = detail; } - public ErrorBean fields(List fields) { + public ErrorBean fields(List fields) { this.fields = fields; return this; } - public ErrorBean addFieldsItem(InlineResponse400Fields fieldsItem) { + public ErrorBean addFieldsItem(InlineResponse4001Fields fieldsItem) { if (this.fields == null) { - this.fields = new ArrayList(); + this.fields = new ArrayList(); } this.fields.add(fieldsItem); return this; @@ -158,11 +158,11 @@ public ErrorBean addFieldsItem(InlineResponse400Fields fieldsItem) { * @return fields **/ @ApiModelProperty(value = "Error fields List") - public List getFields() { + public List getFields() { return fields; } - public void setFields(List fields) { + public void setFields(List fields) { this.fields = fields; } diff --git a/src/main/java/Model/ErrorFieldBean.java b/src/main/java/Model/ErrorFieldBean.java index 9eaaa3996..2769dc032 100644 --- a/src/main/java/Model/ErrorFieldBean.java +++ b/src/main/java/Model/ErrorFieldBean.java @@ -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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ErrorFieldBean { @SerializedName("path") private String path = null; diff --git a/src/main/java/Model/ErrorLinks.java b/src/main/java/Model/ErrorLinks.java index d18afde38..c527d0394 100644 --- a/src/main/java/Model/ErrorLinks.java +++ b/src/main/java/Model/ErrorLinks.java @@ -29,41 +29,33 @@ /** * ErrorLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ErrorLinks { - @SerializedName("next") - private List next = null; + @SerializedName("self") + private InlineResponseDefaultLinksNext self = null; @SerializedName("documentation") private List documentation = null; - @SerializedName("self") - private InlineResponseDefaultLinksNext self = null; - - public ErrorLinks next(List next) { - this.next = next; - return this; - } + @SerializedName("next") + private List next = null; - public ErrorLinks addNextItem(InlineResponseDefaultLinksNext nextItem) { - if (this.next == null) { - this.next = new ArrayList(); - } - this.next.add(nextItem); + public ErrorLinks self(InlineResponseDefaultLinksNext self) { + this.self = self; return this; } /** - * Get next - * @return next + * Get self + * @return self **/ @ApiModelProperty(value = "") - public List getNext() { - return next; + public InlineResponseDefaultLinksNext getSelf() { + return self; } - public void setNext(List next) { - this.next = next; + public void setSelf(InlineResponseDefaultLinksNext self) { + this.self = self; } public ErrorLinks documentation(List documentation) { @@ -92,22 +84,30 @@ public void setDocumentation(List documentation) this.documentation = documentation; } - public ErrorLinks self(InlineResponseDefaultLinksNext self) { - this.self = self; + 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 self - * @return self + * Get next + * @return next **/ @ApiModelProperty(value = "") - public InlineResponseDefaultLinksNext getSelf() { - return self; + public List getNext() { + return next; } - public void setSelf(InlineResponseDefaultLinksNext self) { - this.self = self; + public void setNext(List next) { + this.next = next; } @@ -120,14 +120,14 @@ public boolean equals(java.lang.Object o) { return false; } ErrorLinks errorLinks = (ErrorLinks) o; - return Objects.equals(this.next, errorLinks.next) && + return Objects.equals(this.self, errorLinks.self) && Objects.equals(this.documentation, errorLinks.documentation) && - Objects.equals(this.self, errorLinks.self); + Objects.equals(this.next, errorLinks.next); } @Override public int hashCode() { - return Objects.hash(next, documentation, self); + return Objects.hash(self, documentation, next); } @@ -136,9 +136,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ErrorLinks {\n"); - sb.append(" next: ").append(toIndentedString(next)).append("\n"); - sb.append(" documentation: ").append(toIndentedString(documentation)).append("\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(); } diff --git a/src/main/java/Model/ErrorResponse.java b/src/main/java/Model/ErrorResponse.java index 1c8aeab78..66c223ad7 100644 --- a/src/main/java/Model/ErrorResponse.java +++ b/src/main/java/Model/ErrorResponse.java @@ -14,15 +14,64 @@ package Model; import java.util.Objects; -import Model.InlineResponse4001; -import java.util.ArrayList; -import java.util.List; +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-08-01T12:55:52.826+05:30") -public class ErrorResponse extends ArrayList { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") +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) { @@ -32,12 +81,14 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - return super.equals(o); + ErrorResponse errorResponse = (ErrorResponse) o; + return Objects.equals(this.responseStatus, errorResponse.responseStatus) && + Objects.equals(this.links, errorResponse.links); } @Override public int hashCode() { - return Objects.hash(super.hashCode()); + return Objects.hash(responseStatus, links); } @@ -45,7 +96,9 @@ public int hashCode() { public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ErrorResponse {\n"); - sb.append(" ").append(toIndentedString(super.toString())).append("\n"); + + sb.append(" responseStatus: ").append(toIndentedString(responseStatus)).append("\n"); + sb.append(" links: ").append(toIndentedString(links)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/ErrorResponseWithHAL.java b/src/main/java/Model/ErrorResponseWithHAL.java index 18cb43ea1..d2e96debb 100644 --- a/src/main/java/Model/ErrorResponseWithHAL.java +++ b/src/main/java/Model/ErrorResponseWithHAL.java @@ -14,15 +14,15 @@ package Model; import java.util.Objects; -import Model.InlineResponse4001; +import Model.InlineResponse400; import java.util.ArrayList; import java.util.List; /** * ErrorResponseWithHAL */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") -public class ErrorResponseWithHAL extends ArrayList { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") +public class ErrorResponseWithHAL extends ArrayList { @Override public boolean equals(java.lang.Object o) { diff --git a/src/main/java/Model/FileBean.java b/src/main/java/Model/FileBean.java index 358b196e7..38476a776 100644 --- a/src/main/java/Model/FileBean.java +++ b/src/main/java/Model/FileBean.java @@ -26,7 +26,7 @@ /** * FileBean */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class FileBean { @SerializedName("fileId") private String fileId = null; diff --git a/src/main/java/Model/FileDetail.java b/src/main/java/Model/FileDetail.java index 223e8215f..633b3fc8b 100644 --- a/src/main/java/Model/FileDetail.java +++ b/src/main/java/Model/FileDetail.java @@ -28,7 +28,7 @@ /** * FileDetail */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class FileDetail { @SerializedName("fileId") private String fileId = null; diff --git a/src/main/java/Model/FileDetailsResponse.java b/src/main/java/Model/FileDetailsResponse.java index 222530c48..4dfaa5de9 100644 --- a/src/main/java/Model/FileDetailsResponse.java +++ b/src/main/java/Model/FileDetailsResponse.java @@ -30,7 +30,7 @@ /** * FileDetailsResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class FileDetailsResponse { @SerializedName("fileDetails") private List fileDetails = null; diff --git a/src/main/java/Model/FlexV1KeysPost200Response.java b/src/main/java/Model/FlexV1KeysPost200Response.java index 7a370bbac..8fde3106b 100644 --- a/src/main/java/Model/FlexV1KeysPost200Response.java +++ b/src/main/java/Model/FlexV1KeysPost200Response.java @@ -28,7 +28,7 @@ /** * FlexV1KeysPost200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 3fb6fb9bf..f5486a036 100644 --- a/src/main/java/Model/FlexV1KeysPost200ResponseDer.java +++ b/src/main/java/Model/FlexV1KeysPost200ResponseDer.java @@ -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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 b8df3d3b2..aa9deeab6 100644 --- a/src/main/java/Model/FlexV1KeysPost200ResponseJwk.java +++ b/src/main/java/Model/FlexV1KeysPost200ResponseJwk.java @@ -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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 8d68567cb..1937c381d 100644 --- a/src/main/java/Model/FlexV1TokensPost200Response.java +++ b/src/main/java/Model/FlexV1TokensPost200Response.java @@ -29,7 +29,7 @@ /** * FlexV1TokensPost200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 c787ac380..561c25f99 100644 --- a/src/main/java/Model/Flexv1tokensCardInfo.java +++ b/src/main/java/Model/Flexv1tokensCardInfo.java @@ -26,7 +26,7 @@ /** * Flexv1tokensCardInfo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Flexv1tokensCardInfo { @SerializedName("cardNumber") private String cardNumber = null; diff --git a/src/main/java/Model/GeneratePublicKeyRequest.java b/src/main/java/Model/GeneratePublicKeyRequest.java index 47cf37606..b29b42c71 100644 --- a/src/main/java/Model/GeneratePublicKeyRequest.java +++ b/src/main/java/Model/GeneratePublicKeyRequest.java @@ -26,7 +26,7 @@ /** * GeneratePublicKeyRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class GeneratePublicKeyRequest { @SerializedName("encryptionType") private String encryptionType = null; diff --git a/src/main/java/Model/Initiator.java b/src/main/java/Model/Initiator.java index 1c50269df..393972bfc 100644 --- a/src/main/java/Model/Initiator.java +++ b/src/main/java/Model/Initiator.java @@ -27,7 +27,7 @@ /** * Initiator */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Initiator { @SerializedName("merchantInitiatedTransaction") private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction merchantInitiatedTransaction = null; diff --git a/src/main/java/Model/InlineResponse400.java b/src/main/java/Model/InlineResponse400.java index 6a153d16a..3e2c509c9 100644 --- a/src/main/java/Model/InlineResponse400.java +++ b/src/main/java/Model/InlineResponse400.java @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.InlineResponse400Fields; +import Model.Tmsv1instrumentidentifiersDetails; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -23,49 +23,37 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; -import java.util.ArrayList; -import java.util.List; /** - * Error Bean + * InlineResponse400 */ -@ApiModel(description = "Error Bean") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class InlineResponse400 { - @SerializedName("code") - private String code = null; + @SerializedName("type") + private String type = null; @SerializedName("message") private String message = null; - @SerializedName("localizationKey") - private String localizationKey = null; + @SerializedName("details") + private Tmsv1instrumentidentifiersDetails details = null; - @SerializedName("correlationId") - private String correlationId = null; - - @SerializedName("detail") - private String detail = null; - - @SerializedName("fields") - private List fields = null; - - public InlineResponse400 code(String code) { - this.code = code; + public InlineResponse400 type(String type) { + this.type = type; return this; } /** - * Error code - * @return code + * Get type + * @return type **/ - @ApiModelProperty(required = true, value = "Error code") - public String getCode() { - return code; + @ApiModelProperty(value = "") + public String getType() { + return type; } - public void setCode(String code) { - this.code = code; + public void setType(String type) { + this.type = type; } public InlineResponse400 message(String message) { @@ -74,10 +62,10 @@ public InlineResponse400 message(String message) { } /** - * Error message + * The detailed message related to the type stated above. * @return message **/ - @ApiModelProperty(required = true, value = "Error message") + @ApiModelProperty(value = "The detailed message related to the type stated above.") public String getMessage() { return message; } @@ -86,84 +74,22 @@ public void setMessage(String message) { this.message = message; } - public InlineResponse400 localizationKey(String localizationKey) { - this.localizationKey = localizationKey; - return this; - } - - /** - * Localization Key Name - * @return localizationKey - **/ - @ApiModelProperty(value = "Localization Key Name") - public String getLocalizationKey() { - return localizationKey; - } - - public void setLocalizationKey(String localizationKey) { - this.localizationKey = localizationKey; - } - - public InlineResponse400 correlationId(String correlationId) { - this.correlationId = correlationId; - return this; - } - - /** - * Correlation Id - * @return correlationId - **/ - @ApiModelProperty(value = "Correlation Id") - public String getCorrelationId() { - return correlationId; - } - - public void setCorrelationId(String correlationId) { - this.correlationId = correlationId; - } - - public InlineResponse400 detail(String detail) { - this.detail = detail; - return this; - } - - /** - * Error Detail - * @return detail - **/ - @ApiModelProperty(value = "Error Detail") - public String getDetail() { - return detail; - } - - public void setDetail(String detail) { - this.detail = detail; - } - - public InlineResponse400 fields(List fields) { - this.fields = fields; - return this; - } - - public InlineResponse400 addFieldsItem(InlineResponse400Fields fieldsItem) { - if (this.fields == null) { - this.fields = new ArrayList(); - } - this.fields.add(fieldsItem); + public InlineResponse400 details(Tmsv1instrumentidentifiersDetails details) { + this.details = details; return this; } /** - * Error fields List - * @return fields + * Get details + * @return details **/ - @ApiModelProperty(value = "Error fields List") - public List getFields() { - return fields; + @ApiModelProperty(value = "") + public Tmsv1instrumentidentifiersDetails getDetails() { + return details; } - public void setFields(List fields) { - this.fields = fields; + public void setDetails(Tmsv1instrumentidentifiersDetails details) { + this.details = details; } @@ -176,17 +102,14 @@ public boolean equals(java.lang.Object o) { return false; } InlineResponse400 inlineResponse400 = (InlineResponse400) o; - return Objects.equals(this.code, inlineResponse400.code) && + return Objects.equals(this.type, inlineResponse400.type) && Objects.equals(this.message, inlineResponse400.message) && - Objects.equals(this.localizationKey, inlineResponse400.localizationKey) && - Objects.equals(this.correlationId, inlineResponse400.correlationId) && - Objects.equals(this.detail, inlineResponse400.detail) && - Objects.equals(this.fields, inlineResponse400.fields); + Objects.equals(this.details, inlineResponse400.details); } @Override public int hashCode() { - return Objects.hash(code, message, localizationKey, correlationId, detail, fields); + return Objects.hash(type, message, details); } @@ -195,12 +118,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class InlineResponse400 {\n"); - sb.append(" code: ").append(toIndentedString(code)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append(" localizationKey: ").append(toIndentedString(localizationKey)).append("\n"); - sb.append(" correlationId: ").append(toIndentedString(correlationId)).append("\n"); - sb.append(" detail: ").append(toIndentedString(detail)).append("\n"); - sb.append(" fields: ").append(toIndentedString(fields)).append("\n"); + sb.append(" details: ").append(toIndentedString(details)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/InlineResponse4001.java b/src/main/java/Model/InlineResponse4001.java index cca4bcf6d..959e95953 100644 --- a/src/main/java/Model/InlineResponse4001.java +++ b/src/main/java/Model/InlineResponse4001.java @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.Tmsv1instrumentidentifiersDetails; +import Model.InlineResponse4001Fields; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -23,37 +23,49 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; +import java.util.ArrayList; +import java.util.List; /** - * InlineResponse4001 + * Error Bean */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@ApiModel(description = "Error Bean") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class InlineResponse4001 { - @SerializedName("type") - private String type = null; + @SerializedName("code") + private String code = null; @SerializedName("message") private String message = null; - @SerializedName("details") - private Tmsv1instrumentidentifiersDetails details = null; + @SerializedName("localizationKey") + private String localizationKey = null; - public InlineResponse4001 type(String type) { - this.type = type; + @SerializedName("correlationId") + private String correlationId = null; + + @SerializedName("detail") + private String detail = null; + + @SerializedName("fields") + private List fields = null; + + public InlineResponse4001 code(String code) { + this.code = code; return this; } /** - * Get type - * @return type + * Error code + * @return code **/ - @ApiModelProperty(value = "") - public String getType() { - return type; + @ApiModelProperty(required = true, value = "Error code") + public String getCode() { + return code; } - public void setType(String type) { - this.type = type; + public void setCode(String code) { + this.code = code; } public InlineResponse4001 message(String message) { @@ -62,10 +74,10 @@ public InlineResponse4001 message(String message) { } /** - * The detailed message related to the type stated above. + * Error message * @return message **/ - @ApiModelProperty(value = "The detailed message related to the type stated above.") + @ApiModelProperty(required = true, value = "Error message") public String getMessage() { return message; } @@ -74,22 +86,84 @@ public void setMessage(String message) { this.message = message; } - public InlineResponse4001 details(Tmsv1instrumentidentifiersDetails details) { - this.details = details; + public InlineResponse4001 localizationKey(String localizationKey) { + this.localizationKey = localizationKey; + return this; + } + + /** + * Localization Key Name + * @return localizationKey + **/ + @ApiModelProperty(value = "Localization Key Name") + public String getLocalizationKey() { + return localizationKey; + } + + public void setLocalizationKey(String localizationKey) { + this.localizationKey = localizationKey; + } + + public InlineResponse4001 correlationId(String correlationId) { + this.correlationId = correlationId; + return this; + } + + /** + * Correlation Id + * @return correlationId + **/ + @ApiModelProperty(value = "Correlation Id") + public String getCorrelationId() { + return correlationId; + } + + public void setCorrelationId(String correlationId) { + this.correlationId = correlationId; + } + + public InlineResponse4001 detail(String detail) { + this.detail = detail; + return this; + } + + /** + * Error Detail + * @return detail + **/ + @ApiModelProperty(value = "Error Detail") + public String getDetail() { + return detail; + } + + public void setDetail(String detail) { + this.detail = detail; + } + + public InlineResponse4001 fields(List fields) { + this.fields = fields; + return this; + } + + public InlineResponse4001 addFieldsItem(InlineResponse4001Fields fieldsItem) { + if (this.fields == null) { + this.fields = new ArrayList(); + } + this.fields.add(fieldsItem); return this; } /** - * Get details - * @return details + * Error fields List + * @return fields **/ - @ApiModelProperty(value = "") - public Tmsv1instrumentidentifiersDetails getDetails() { - return details; + @ApiModelProperty(value = "Error fields List") + public List getFields() { + return fields; } - public void setDetails(Tmsv1instrumentidentifiersDetails details) { - this.details = details; + public void setFields(List fields) { + this.fields = fields; } @@ -102,14 +176,17 @@ public boolean equals(java.lang.Object o) { return false; } InlineResponse4001 inlineResponse4001 = (InlineResponse4001) o; - return Objects.equals(this.type, inlineResponse4001.type) && + return Objects.equals(this.code, inlineResponse4001.code) && Objects.equals(this.message, inlineResponse4001.message) && - Objects.equals(this.details, inlineResponse4001.details); + Objects.equals(this.localizationKey, inlineResponse4001.localizationKey) && + Objects.equals(this.correlationId, inlineResponse4001.correlationId) && + Objects.equals(this.detail, inlineResponse4001.detail) && + Objects.equals(this.fields, inlineResponse4001.fields); } @Override public int hashCode() { - return Objects.hash(type, message, details); + return Objects.hash(code, message, localizationKey, correlationId, detail, fields); } @@ -118,9 +195,12 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class InlineResponse4001 {\n"); - sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append(" code: ").append(toIndentedString(code)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); - sb.append(" details: ").append(toIndentedString(details)).append("\n"); + sb.append(" localizationKey: ").append(toIndentedString(localizationKey)).append("\n"); + sb.append(" correlationId: ").append(toIndentedString(correlationId)).append("\n"); + sb.append(" detail: ").append(toIndentedString(detail)).append("\n"); + sb.append(" fields: ").append(toIndentedString(fields)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/InlineResponse400Fields.java b/src/main/java/Model/InlineResponse4001Fields.java similarity index 82% rename from src/main/java/Model/InlineResponse400Fields.java rename to src/main/java/Model/InlineResponse4001Fields.java index 94eb555d3..42db3a4c7 100644 --- a/src/main/java/Model/InlineResponse400Fields.java +++ b/src/main/java/Model/InlineResponse4001Fields.java @@ -27,8 +27,8 @@ * 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-08-01T12:55:52.826+05:30") -public class InlineResponse400Fields { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") +public class InlineResponse4001Fields { @SerializedName("path") private String path = null; @@ -38,7 +38,7 @@ public class InlineResponse400Fields { @SerializedName("localizationKey") private String localizationKey = null; - public InlineResponse400Fields path(String path) { + public InlineResponse4001Fields path(String path) { this.path = path; return this; } @@ -56,7 +56,7 @@ public void setPath(String path) { this.path = path; } - public InlineResponse400Fields message(String message) { + public InlineResponse4001Fields message(String message) { this.message = message; return this; } @@ -74,7 +74,7 @@ public void setMessage(String message) { this.message = message; } - public InlineResponse400Fields localizationKey(String localizationKey) { + public InlineResponse4001Fields localizationKey(String localizationKey) { this.localizationKey = localizationKey; return this; } @@ -101,10 +101,10 @@ public boolean equals(java.lang.Object o) { if (o == null || getClass() != o.getClass()) { return false; } - InlineResponse400Fields inlineResponse400Fields = (InlineResponse400Fields) o; - return Objects.equals(this.path, inlineResponse400Fields.path) && - Objects.equals(this.message, inlineResponse400Fields.message) && - Objects.equals(this.localizationKey, inlineResponse400Fields.localizationKey); + InlineResponse4001Fields inlineResponse4001Fields = (InlineResponse4001Fields) o; + return Objects.equals(this.path, inlineResponse4001Fields.path) && + Objects.equals(this.message, inlineResponse4001Fields.message) && + Objects.equals(this.localizationKey, inlineResponse4001Fields.localizationKey); } @Override @@ -116,7 +116,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class InlineResponse400Fields {\n"); + sb.append("class InlineResponse4001Fields {\n"); sb.append(" path: ").append(toIndentedString(path)).append("\n"); sb.append(" message: ").append(toIndentedString(message)).append("\n"); diff --git a/src/main/java/Model/InlineResponseDefault.java b/src/main/java/Model/InlineResponseDefault.java index c29233aa4..3e030f6e0 100644 --- a/src/main/java/Model/InlineResponseDefault.java +++ b/src/main/java/Model/InlineResponseDefault.java @@ -28,7 +28,7 @@ /** * InlineResponseDefault */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 7a94c148f..91203d111 100644 --- a/src/main/java/Model/InlineResponseDefaultLinks.java +++ b/src/main/java/Model/InlineResponseDefaultLinks.java @@ -29,7 +29,7 @@ /** * InlineResponseDefaultLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 e3a6aa1d6..dc968da12 100644 --- a/src/main/java/Model/InlineResponseDefaultLinksNext.java +++ b/src/main/java/Model/InlineResponseDefaultLinksNext.java @@ -26,7 +26,7 @@ /** * InlineResponseDefaultLinksNext */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 932d25ec9..2fcb2e5ab 100644 --- a/src/main/java/Model/InlineResponseDefaultResponseStatus.java +++ b/src/main/java/Model/InlineResponseDefaultResponseStatus.java @@ -30,7 +30,7 @@ /** * InlineResponseDefaultResponseStatus */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 0b847e9c2..dd91d9d59 100644 --- a/src/main/java/Model/InlineResponseDefaultResponseStatusDetails.java +++ b/src/main/java/Model/InlineResponseDefaultResponseStatusDetails.java @@ -26,7 +26,7 @@ /** * InlineResponseDefaultResponseStatusDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class InlineResponseDefaultResponseStatusDetails { @SerializedName("location") private String location = null; diff --git a/src/main/java/Model/InstrumentIdentifier.java b/src/main/java/Model/InstrumentIdentifier.java index 126f43391..dc929fd66 100644 --- a/src/main/java/Model/InstrumentIdentifier.java +++ b/src/main/java/Model/InstrumentIdentifier.java @@ -14,11 +14,11 @@ package Model; import java.util.Objects; -import Model.TmsV1InstrumentIdentifiersPost200ResponseBankAccount; import Model.TmsV1InstrumentIdentifiersPost200ResponseCard; import Model.TmsV1InstrumentIdentifiersPost200ResponseLinks; import Model.TmsV1InstrumentIdentifiersPost200ResponseMetadata; import Model.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation; +import Model.Tmsv1instrumentidentifiersBankAccount; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -31,7 +31,7 @@ /** * InstrumentIdentifier */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class InstrumentIdentifier { @SerializedName("_links") private TmsV1InstrumentIdentifiersPost200ResponseLinks links = null; @@ -49,7 +49,7 @@ public class InstrumentIdentifier { private TmsV1InstrumentIdentifiersPost200ResponseCard card = null; @SerializedName("bankAccount") - private TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount = null; + private Tmsv1instrumentidentifiersBankAccount bankAccount = null; @SerializedName("processingInformation") private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation = null; @@ -120,7 +120,7 @@ public void setCard(TmsV1InstrumentIdentifiersPost200ResponseCard card) { this.card = card; } - public InstrumentIdentifier bankAccount(TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount) { + public InstrumentIdentifier bankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { this.bankAccount = bankAccount; return this; } @@ -130,11 +130,11 @@ public InstrumentIdentifier bankAccount(TmsV1InstrumentIdentifiersPost200Respons * @return bankAccount **/ @ApiModelProperty(value = "") - public TmsV1InstrumentIdentifiersPost200ResponseBankAccount getBankAccount() { + public Tmsv1instrumentidentifiersBankAccount getBankAccount() { return bankAccount; } - public void setBankAccount(TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount) { + public void setBankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { this.bankAccount = bankAccount; } diff --git a/src/main/java/Model/InstrumentIdentifierBankAccount.java b/src/main/java/Model/InstrumentIdentifierBankAccount.java index 92c92980f..5a517b8f7 100644 --- a/src/main/java/Model/InstrumentIdentifierBankAccount.java +++ b/src/main/java/Model/InstrumentIdentifierBankAccount.java @@ -26,7 +26,7 @@ /** * InstrumentIdentifierBankAccount */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class InstrumentIdentifierBankAccount { @SerializedName("number") private String number = null; diff --git a/src/main/java/Model/InstrumentIdentifierCard.java b/src/main/java/Model/InstrumentIdentifierCard.java index 7075c4f30..7f9e5a824 100644 --- a/src/main/java/Model/InstrumentIdentifierCard.java +++ b/src/main/java/Model/InstrumentIdentifierCard.java @@ -26,7 +26,7 @@ /** * InstrumentIdentifierCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class InstrumentIdentifierCard { @SerializedName("number") private String number = null; diff --git a/src/main/java/Model/InstrumentIdentifierEnrollableCard.java b/src/main/java/Model/InstrumentIdentifierEnrollableCard.java index 32411acb7..ab8298b7f 100644 --- a/src/main/java/Model/InstrumentIdentifierEnrollableCard.java +++ b/src/main/java/Model/InstrumentIdentifierEnrollableCard.java @@ -14,6 +14,7 @@ package Model; import java.util.Objects; +import Model.Tmsv1instrumentidentifiersBankAccount; import Model.Tmsv1instrumentidentifiersBillTo; import Model.Tmsv1instrumentidentifiersCard; import com.google.gson.TypeAdapter; @@ -28,7 +29,7 @@ /** * InstrumentIdentifierEnrollableCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class InstrumentIdentifierEnrollableCard { @SerializedName("type") private String type = null; @@ -36,6 +37,9 @@ public class InstrumentIdentifierEnrollableCard { @SerializedName("card") private Tmsv1instrumentidentifiersCard card = null; + @SerializedName("BankAccount") + private Tmsv1instrumentidentifiersBankAccount bankAccount = null; + @SerializedName("billTo") private Tmsv1instrumentidentifiersBillTo billTo = null; @@ -75,6 +79,24 @@ public void setCard(Tmsv1instrumentidentifiersCard card) { this.card = card; } + public InstrumentIdentifierEnrollableCard 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 InstrumentIdentifierEnrollableCard billTo(Tmsv1instrumentidentifiersBillTo billTo) { this.billTo = billTo; return this; @@ -105,12 +127,13 @@ public boolean equals(java.lang.Object o) { InstrumentIdentifierEnrollableCard instrumentIdentifierEnrollableCard = (InstrumentIdentifierEnrollableCard) o; return Objects.equals(this.type, instrumentIdentifierEnrollableCard.type) && Objects.equals(this.card, instrumentIdentifierEnrollableCard.card) && + Objects.equals(this.bankAccount, instrumentIdentifierEnrollableCard.bankAccount) && Objects.equals(this.billTo, instrumentIdentifierEnrollableCard.billTo); } @Override public int hashCode() { - return Objects.hash(type, card, billTo); + return Objects.hash(type, card, bankAccount, billTo); } @@ -121,6 +144,7 @@ public String toString() { sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" card: ").append(toIndentedString(card)).append("\n"); + sb.append(" bankAccount: ").append(toIndentedString(bankAccount)).append("\n"); sb.append(" billTo: ").append(toIndentedString(billTo)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/Model/InstrumentIdentifierProcessingInformation.java b/src/main/java/Model/InstrumentIdentifierProcessingInformation.java index 9ddb15c87..8aee1ab6f 100644 --- a/src/main/java/Model/InstrumentIdentifierProcessingInformation.java +++ b/src/main/java/Model/InstrumentIdentifierProcessingInformation.java @@ -27,7 +27,7 @@ /** * InstrumentIdentifierProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class InstrumentIdentifierProcessingInformation { @SerializedName("authorizationOptions") private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions authorizationOptions = null; diff --git a/src/main/java/Model/InstrumentIdentifierUpdate.java b/src/main/java/Model/InstrumentIdentifierUpdate.java index 9c316e2fd..4d6a26122 100644 --- a/src/main/java/Model/InstrumentIdentifierUpdate.java +++ b/src/main/java/Model/InstrumentIdentifierUpdate.java @@ -27,7 +27,7 @@ /** * InstrumentIdentifierUpdate */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class InstrumentIdentifierUpdate { @SerializedName("processingInformation") private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation = null; diff --git a/src/main/java/Model/JsonWebKey.java b/src/main/java/Model/JsonWebKey.java index e6a26e383..c9f37cace 100644 --- a/src/main/java/Model/JsonWebKey.java +++ b/src/main/java/Model/JsonWebKey.java @@ -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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class JsonWebKey { @SerializedName("kty") private String kty = null; diff --git a/src/main/java/Model/KeyParameters.java b/src/main/java/Model/KeyParameters.java index c52682192..9e809c4f3 100644 --- a/src/main/java/Model/KeyParameters.java +++ b/src/main/java/Model/KeyParameters.java @@ -26,7 +26,7 @@ /** * KeyParameters */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class KeyParameters { @SerializedName("encryptionType") private String encryptionType = null; diff --git a/src/main/java/Model/KeyResult.java b/src/main/java/Model/KeyResult.java index 11e29826c..2a195e0af 100644 --- a/src/main/java/Model/KeyResult.java +++ b/src/main/java/Model/KeyResult.java @@ -28,7 +28,7 @@ /** * KeyResult */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class KeyResult { @SerializedName("keyId") private String keyId = null; diff --git a/src/main/java/Model/Link.java b/src/main/java/Model/Link.java index 859052ec3..aeb4bed5c 100644 --- a/src/main/java/Model/Link.java +++ b/src/main/java/Model/Link.java @@ -26,21 +26,27 @@ /** * Link */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") 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; } /** - * Get href + * URI of the linked resource. * @return href **/ - @ApiModelProperty(example = "https://api.cybersource.com/tms/v1/instrumentidentifiers/1234567890123456789", value = "") + @ApiModelProperty(value = "URI of the linked resource.") public String getHref() { return href; } @@ -49,6 +55,42 @@ 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) { @@ -59,12 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } Link link = (Link) o; - return Objects.equals(this.href, link.href); + 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); + return Objects.hash(href, title, method); } @@ -74,6 +118,8 @@ public String toString() { 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(); } diff --git a/src/main/java/Model/Links.java b/src/main/java/Model/Links.java index e0a82b16d..ba5af0c25 100644 --- a/src/main/java/Model/Links.java +++ b/src/main/java/Model/Links.java @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.TmsV1InstrumentIdentifiersPost200ResponseLinksSelf; +import Model.InlineResponseDefaultLinksNext; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -23,22 +23,24 @@ 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Links { @SerializedName("self") - private TmsV1InstrumentIdentifiersPost200ResponseLinksSelf self = null; + private InlineResponseDefaultLinksNext self = null; - @SerializedName("ancestor") - private TmsV1InstrumentIdentifiersPost200ResponseLinksSelf ancestor = null; + @SerializedName("documentation") + private List documentation = null; - @SerializedName("successor") - private TmsV1InstrumentIdentifiersPost200ResponseLinksSelf successor = null; + @SerializedName("next") + private List next = null; - public Links self(TmsV1InstrumentIdentifiersPost200ResponseLinksSelf self) { + public Links self(InlineResponseDefaultLinksNext self) { this.self = self; return this; } @@ -48,48 +50,64 @@ public Links self(TmsV1InstrumentIdentifiersPost200ResponseLinksSelf self) { * @return self **/ @ApiModelProperty(value = "") - public TmsV1InstrumentIdentifiersPost200ResponseLinksSelf getSelf() { + public InlineResponseDefaultLinksNext getSelf() { return self; } - public void setSelf(TmsV1InstrumentIdentifiersPost200ResponseLinksSelf self) { + public void setSelf(InlineResponseDefaultLinksNext self) { this.self = self; } - public Links ancestor(TmsV1InstrumentIdentifiersPost200ResponseLinksSelf ancestor) { - this.ancestor = ancestor; + 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 ancestor - * @return ancestor + * Get documentation + * @return documentation **/ @ApiModelProperty(value = "") - public TmsV1InstrumentIdentifiersPost200ResponseLinksSelf getAncestor() { - return ancestor; + public List getDocumentation() { + return documentation; } - public void setAncestor(TmsV1InstrumentIdentifiersPost200ResponseLinksSelf ancestor) { - this.ancestor = ancestor; + public void setDocumentation(List documentation) { + this.documentation = documentation; } - public Links successor(TmsV1InstrumentIdentifiersPost200ResponseLinksSelf successor) { - this.successor = successor; + 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 successor - * @return successor + * Get next + * @return next **/ @ApiModelProperty(value = "") - public TmsV1InstrumentIdentifiersPost200ResponseLinksSelf getSuccessor() { - return successor; + public List getNext() { + return next; } - public void setSuccessor(TmsV1InstrumentIdentifiersPost200ResponseLinksSelf successor) { - this.successor = successor; + public void setNext(List next) { + this.next = next; } @@ -103,13 +121,13 @@ public boolean equals(java.lang.Object o) { } Links links = (Links) o; return Objects.equals(this.self, links.self) && - Objects.equals(this.ancestor, links.ancestor) && - Objects.equals(this.successor, links.successor); + Objects.equals(this.documentation, links.documentation) && + Objects.equals(this.next, links.next); } @Override public int hashCode() { - return Objects.hash(self, ancestor, successor); + return Objects.hash(self, documentation, next); } @@ -119,8 +137,8 @@ public String toString() { sb.append("class Links {\n"); sb.append(" self: ").append(toIndentedString(self)).append("\n"); - sb.append(" ancestor: ").append(toIndentedString(ancestor)).append("\n"); - sb.append(" successor: ").append(toIndentedString(successor)).append("\n"); + sb.append(" documentation: ").append(toIndentedString(documentation)).append("\n"); + sb.append(" next: ").append(toIndentedString(next)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/MerchantInformation.java b/src/main/java/Model/MerchantInformation.java index 64c90ba2a..e81c17ada 100644 --- a/src/main/java/Model/MerchantInformation.java +++ b/src/main/java/Model/MerchantInformation.java @@ -27,7 +27,7 @@ /** * MerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class MerchantInformation { @SerializedName("merchantDescriptor") private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor merchantDescriptor = null; diff --git a/src/main/java/Model/MerchantInitiatedTransaction.java b/src/main/java/Model/MerchantInitiatedTransaction.java index 022e499f9..c048e5934 100644 --- a/src/main/java/Model/MerchantInitiatedTransaction.java +++ b/src/main/java/Model/MerchantInitiatedTransaction.java @@ -26,7 +26,7 @@ /** * MerchantInitiatedTransaction */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class MerchantInitiatedTransaction { @SerializedName("previousTransactionId") private String previousTransactionId = null; diff --git a/src/main/java/Model/Metadata.java b/src/main/java/Model/Metadata.java index 14fb61614..68819a4a6 100644 --- a/src/main/java/Model/Metadata.java +++ b/src/main/java/Model/Metadata.java @@ -26,7 +26,7 @@ /** * Metadata */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Metadata { @SerializedName("creator") private String creator = null; diff --git a/src/main/java/Model/Model409Link.java b/src/main/java/Model/Model409Link.java index adaf88b0f..e559d1bc7 100644 --- a/src/main/java/Model/Model409Link.java +++ b/src/main/java/Model/Model409Link.java @@ -26,7 +26,7 @@ /** * Model409Link */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Model409Link { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/Model409Links.java b/src/main/java/Model/Model409Links.java index 5b2113506..e6fa219fd 100644 --- a/src/main/java/Model/Model409Links.java +++ b/src/main/java/Model/Model409Links.java @@ -27,7 +27,7 @@ /** * Model409Links */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Model409Links { @SerializedName("paymentInstruments") private TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments paymentInstruments = null; diff --git a/src/main/java/Model/OctCreatePaymentRequest.java b/src/main/java/Model/OctCreatePaymentRequest.java index 59767bc7f..e07e747ff 100644 --- a/src/main/java/Model/OctCreatePaymentRequest.java +++ b/src/main/java/Model/OctCreatePaymentRequest.java @@ -33,7 +33,7 @@ /** * OctCreatePaymentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class OctCreatePaymentRequest { @SerializedName("clientReferenceInformation") private Ptsv2payoutsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/main/java/Model/PIForIILinkFirst.java b/src/main/java/Model/PIForIILinkFirst.java index 42e3d8766..4d7ed1dd5 100644 --- a/src/main/java/Model/PIForIILinkFirst.java +++ b/src/main/java/Model/PIForIILinkFirst.java @@ -26,7 +26,7 @@ /** * PIForIILinkFirst */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PIForIILinkFirst { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/PIForIILinkLast.java b/src/main/java/Model/PIForIILinkLast.java index 3bc933c4a..ebfebb56d 100644 --- a/src/main/java/Model/PIForIILinkLast.java +++ b/src/main/java/Model/PIForIILinkLast.java @@ -26,7 +26,7 @@ /** * PIForIILinkLast */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PIForIILinkLast { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/PIForIILinkNext.java b/src/main/java/Model/PIForIILinkNext.java index 7e7bf0f04..273d2b83d 100644 --- a/src/main/java/Model/PIForIILinkNext.java +++ b/src/main/java/Model/PIForIILinkNext.java @@ -26,7 +26,7 @@ /** * PIForIILinkNext */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PIForIILinkNext { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/PIForIILinkPrev.java b/src/main/java/Model/PIForIILinkPrev.java index 6afa9ee98..cb30c62be 100644 --- a/src/main/java/Model/PIForIILinkPrev.java +++ b/src/main/java/Model/PIForIILinkPrev.java @@ -27,7 +27,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PIForIILinkPrev { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/PIForIILinkSelf.java b/src/main/java/Model/PIForIILinkSelf.java index 1ab3308e9..0294f1414 100644 --- a/src/main/java/Model/PIForIILinkSelf.java +++ b/src/main/java/Model/PIForIILinkSelf.java @@ -26,7 +26,7 @@ /** * PIForIILinkSelf */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PIForIILinkSelf { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/PaymentInstrument.java b/src/main/java/Model/PaymentInstrument.java index 8939cf40e..1e61fdfaa 100644 --- a/src/main/java/Model/PaymentInstrument.java +++ b/src/main/java/Model/PaymentInstrument.java @@ -35,7 +35,7 @@ /** * PaymentInstrument */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PaymentInstrument { @SerializedName("_links") private TmsV1InstrumentIdentifiersPost200ResponseLinks links = null; diff --git a/src/main/java/Model/PaymentInstrumentBankAccount.java b/src/main/java/Model/PaymentInstrumentBankAccount.java index 3cf1f7c3b..747a2dcc7 100644 --- a/src/main/java/Model/PaymentInstrumentBankAccount.java +++ b/src/main/java/Model/PaymentInstrumentBankAccount.java @@ -26,7 +26,7 @@ /** * PaymentInstrumentBankAccount */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PaymentInstrumentBankAccount { @SerializedName("type") private String type = null; diff --git a/src/main/java/Model/PaymentInstrumentCard.java b/src/main/java/Model/PaymentInstrumentCard.java index 2cd52184f..e14bdd91d 100644 --- a/src/main/java/Model/PaymentInstrumentCard.java +++ b/src/main/java/Model/PaymentInstrumentCard.java @@ -26,7 +26,7 @@ /** * PaymentInstrumentCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PaymentInstrumentCard { @SerializedName("expirationMonth") private String expirationMonth = null; diff --git a/src/main/java/Model/PaymentInstrumentForInstrumentIdentifierLinks.java b/src/main/java/Model/PaymentInstrumentForInstrumentIdentifierLinks.java index b15624f2a..66edd0f29 100644 --- a/src/main/java/Model/PaymentInstrumentForInstrumentIdentifierLinks.java +++ b/src/main/java/Model/PaymentInstrumentForInstrumentIdentifierLinks.java @@ -31,7 +31,7 @@ /** * PaymentInstrumentForInstrumentIdentifierLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PaymentInstrumentForInstrumentIdentifierLinks { @SerializedName("self") private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf self = null; diff --git a/src/main/java/Model/PaymentInstrumentsArray.java b/src/main/java/Model/PaymentInstrumentsArray.java index 7e7d65c9e..f6869bdd6 100644 --- a/src/main/java/Model/PaymentInstrumentsArray.java +++ b/src/main/java/Model/PaymentInstrumentsArray.java @@ -23,7 +23,7 @@ * Array of Payment Instruments returned for the supplied Instrument Identifier. */ @ApiModel(description = "Array of Payment Instruments returned for the supplied Instrument Identifier.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PaymentInstrumentsArray extends ArrayList { @Override diff --git a/src/main/java/Model/PaymentInstrumentsForInstrumentIdentifier.java b/src/main/java/Model/PaymentInstrumentsForInstrumentIdentifier.java index b8619ba77..4a11bad5d 100644 --- a/src/main/java/Model/PaymentInstrumentsForInstrumentIdentifier.java +++ b/src/main/java/Model/PaymentInstrumentsForInstrumentIdentifier.java @@ -28,7 +28,7 @@ /** * PaymentInstrumentsForInstrumentIdentifier */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PaymentInstrumentsForInstrumentIdentifier { @SerializedName("_links") private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks links = null; diff --git a/src/main/java/Model/PersonalIdentification.java b/src/main/java/Model/PersonalIdentification.java index fc096c172..4a3485ae0 100644 --- a/src/main/java/Model/PersonalIdentification.java +++ b/src/main/java/Model/PersonalIdentification.java @@ -27,7 +27,7 @@ /** * PersonalIdentification */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PersonalIdentification { @SerializedName("id") private String id = null; diff --git a/src/main/java/Model/PersonalIdentificationArray.java b/src/main/java/Model/PersonalIdentificationArray.java index 20bdc0a95..b303c308f 100644 --- a/src/main/java/Model/PersonalIdentificationArray.java +++ b/src/main/java/Model/PersonalIdentificationArray.java @@ -21,7 +21,7 @@ /** * PersonalIdentificationArray */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PersonalIdentificationArray extends ArrayList { @Override diff --git a/src/main/java/Model/ProcessingInformation.java b/src/main/java/Model/ProcessingInformation.java index a17c4d4c4..dab0b2f8d 100644 --- a/src/main/java/Model/ProcessingInformation.java +++ b/src/main/java/Model/ProcessingInformation.java @@ -27,7 +27,7 @@ /** * ProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ProcessingInformation { @SerializedName("billPaymentProgramEnabled") private Boolean billPaymentProgramEnabled = false; diff --git a/src/main/java/Model/PtsV1TransactionBatchesGet200Response.java b/src/main/java/Model/PtsV1TransactionBatchesGet200Response.java index 4756fecb4..411f90cf1 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet200Response.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet200Response.java @@ -30,7 +30,7 @@ /** * PtsV1TransactionBatchesGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV1TransactionBatchesGet200Response { @SerializedName("transactionBatches") private List transactionBatches = null; diff --git a/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinks.java b/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinks.java index 7baf8d821..dc2c17773 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinks.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinks.java @@ -27,7 +27,7 @@ /** * PtsV1TransactionBatchesGet200ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 d3c3ddbd6..36806ed1b 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinksSelf.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseLinksSelf.java @@ -26,7 +26,7 @@ /** * PtsV1TransactionBatchesGet200ResponseLinksSelf */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 1c26703de..6b9db70f5 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet200ResponseTransactionBatches.java @@ -26,7 +26,7 @@ /** * PtsV1TransactionBatchesGet200ResponseTransactionBatches */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 f857b5536..2dd42a7f8 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet400Response.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet400Response.java @@ -27,7 +27,7 @@ /** * PtsV1TransactionBatchesGet400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV1TransactionBatchesGet400Response { @SerializedName("errorInformation") private PtsV1TransactionBatchesGet400ResponseErrorInformation errorInformation = null; diff --git a/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformation.java b/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformation.java index 90e344e95..c5c9fd4b6 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformation.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformation.java @@ -29,7 +29,7 @@ /** * PtsV1TransactionBatchesGet400ResponseErrorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 1d3c70464..94800cf26 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet400ResponseErrorInformationDetails.java @@ -26,7 +26,7 @@ /** * PtsV1TransactionBatchesGet400ResponseErrorInformationDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 7f6a9589e..0ffc1b03a 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet500Response.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet500Response.java @@ -27,7 +27,7 @@ /** * PtsV1TransactionBatchesGet500Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV1TransactionBatchesGet500Response { @SerializedName("errorInformation") private PtsV1TransactionBatchesGet500ResponseErrorInformation errorInformation = null; diff --git a/src/main/java/Model/PtsV1TransactionBatchesGet500ResponseErrorInformation.java b/src/main/java/Model/PtsV1TransactionBatchesGet500ResponseErrorInformation.java index 946e84fc5..f2ae174a1 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesGet500ResponseErrorInformation.java +++ b/src/main/java/Model/PtsV1TransactionBatchesGet500ResponseErrorInformation.java @@ -26,7 +26,7 @@ /** * PtsV1TransactionBatchesGet500ResponseErrorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 db92b80c0..caa0d6a4c 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesIdGet200Response.java +++ b/src/main/java/Model/PtsV1TransactionBatchesIdGet200Response.java @@ -27,7 +27,7 @@ /** * PtsV1TransactionBatchesIdGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 b60861c04..ea63ba2d5 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesIdGet200ResponseLinks.java +++ b/src/main/java/Model/PtsV1TransactionBatchesIdGet200ResponseLinks.java @@ -29,7 +29,7 @@ /** * PtsV1TransactionBatchesIdGet200ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 c94c511bc..6abc55d95 100644 --- a/src/main/java/Model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions.java +++ b/src/main/java/Model/PtsV1TransactionBatchesIdGet200ResponseLinksTransactions.java @@ -26,7 +26,7 @@ /** * PtsV1TransactionBatchesIdGet200ResponseLinksTransactions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV1TransactionBatchesIdGet200ResponseLinksTransactions { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/PtsV2CreditsPost201Response.java b/src/main/java/Model/PtsV2CreditsPost201Response.java index 096ae28c3..28eb6f945 100644 --- a/src/main/java/Model/PtsV2CreditsPost201Response.java +++ b/src/main/java/Model/PtsV2CreditsPost201Response.java @@ -33,7 +33,7 @@ /** * PtsV2CreditsPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2CreditsPost201Response { @SerializedName("_links") private PtsV2PaymentsRefundPost201ResponseLinks links = null; diff --git a/src/main/java/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.java b/src/main/java/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.java index 153849cf1..0440bcbc1 100644 --- a/src/main/java/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.java +++ b/src/main/java/Model/PtsV2CreditsPost201ResponseCreditAmountDetails.java @@ -26,7 +26,7 @@ /** * PtsV2CreditsPost201ResponseCreditAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 842ce3dad..365123d6f 100644 --- a/src/main/java/Model/PtsV2CreditsPost201ResponsePaymentInformation.java +++ b/src/main/java/Model/PtsV2CreditsPost201ResponsePaymentInformation.java @@ -27,7 +27,7 @@ /** * PtsV2CreditsPost201ResponsePaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 2ec4b03cc..461479db0 100644 --- a/src/main/java/Model/PtsV2CreditsPost201ResponseProcessingInformation.java +++ b/src/main/java/Model/PtsV2CreditsPost201ResponseProcessingInformation.java @@ -27,7 +27,7 @@ /** * PtsV2CreditsPost201ResponseProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 89ba630da..422820085 100644 --- a/src/main/java/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.java +++ b/src/main/java/Model/PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions.java @@ -26,7 +26,7 @@ /** * PtsV2CreditsPost201ResponseProcessingInformationBankTransferOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 3c4cba601..d6e865cae 100644 --- a/src/main/java/Model/PtsV2PaymentsCapturesPost201Response.java +++ b/src/main/java/Model/PtsV2PaymentsCapturesPost201Response.java @@ -30,7 +30,7 @@ /** * PtsV2PaymentsCapturesPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsCapturesPost201Response { @SerializedName("_links") private PtsV2PaymentsCapturesPost201ResponseLinks links = null; diff --git a/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseLinks.java b/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseLinks.java index a6ece7530..5ee7d4bcb 100644 --- a/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseLinks.java +++ b/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseLinks.java @@ -27,7 +27,7 @@ /** * PtsV2PaymentsCapturesPost201ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 4bd999867..f5f6c4e51 100644 --- a/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformation.java +++ b/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformation.java @@ -28,7 +28,7 @@ /** * PtsV2PaymentsCapturesPost201ResponseOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 0295921e3..359bc6548 100644 --- a/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.java +++ b/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsCapturesPost201ResponseOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 cd34a5741..a270cd699 100644 --- a/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation.java +++ b/src/main/java/Model/PtsV2PaymentsCapturesPost201ResponseProcessorInformation.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsCapturesPost201ResponseProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 85d7acb28..9f15b11d1 100644 --- a/src/main/java/Model/PtsV2PaymentsCapturesPost400Response.java +++ b/src/main/java/Model/PtsV2PaymentsCapturesPost400Response.java @@ -29,7 +29,7 @@ /** * PtsV2PaymentsCapturesPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsCapturesPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201Response.java b/src/main/java/Model/PtsV2PaymentsPost201Response.java index 06c25de71..facd09386 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201Response.java +++ b/src/main/java/Model/PtsV2PaymentsPost201Response.java @@ -36,7 +36,7 @@ /** * PtsV2PaymentsPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost201Response { @SerializedName("_links") private PtsV2PaymentsPost201ResponseLinks links = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseClientReferenceInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseClientReferenceInformation.java index 83dc48474..725f452a9 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseClientReferenceInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseClientReferenceInformation.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseClientReferenceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost201ResponseClientReferenceInformation { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformation.java index 0983e85f6..3e3834068 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformation.java @@ -29,7 +29,7 @@ /** * PtsV2PaymentsPost201ResponseErrorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost201ResponseErrorInformation { @SerializedName("reason") private String reason = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformationDetails.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformationDetails.java index 9eb4abbce..9d7913cdb 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformationDetails.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseErrorInformationDetails.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseErrorInformationDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 769e3accf..5f2c3b6d3 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseInstallmentInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseInstallmentInformation.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseInstallmentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 5c01b61bd..433e12858 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseIssuerInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseIssuerInformation.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseIssuerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost201ResponseIssuerInformation { @SerializedName("country") private String country = null; @@ -61,10 +61,10 @@ public PtsV2PaymentsPost201ResponseIssuerInformation discretionaryData(String di } /** - * 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 **Visa Platform Connect**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + * 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**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) * @return discretionaryData **/ - @ApiModelProperty(value = "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 **Visa Platform Connect**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") + @ApiModelProperty(value = "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**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") public String getDiscretionaryData() { return discretionaryData; } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseLinks.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseLinks.java index b29e17314..dbafe6e6a 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseLinks.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseLinks.java @@ -27,7 +27,7 @@ /** * PtsV2PaymentsPost201ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 9db1d5f92..eda009d5c 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseLinksSelf.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseLinksSelf.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseLinksSelf */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost201ResponseLinksSelf { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformation.java index 5911dca23..7243a9665 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformation.java @@ -28,7 +28,7 @@ /** * PtsV2PaymentsPost201ResponseOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 849d2a242..a8f8b94a5 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformationAmountDetails.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 e342b40a4..d1d0229ee 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseOrderInformationInvoiceDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 781e728a4..e4f30001d 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformation.java @@ -30,7 +30,7 @@ /** * PtsV2PaymentsPost201ResponsePaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 a1038ea98..137b5ab94 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures { @SerializedName("accountType") private String accountType = null; @@ -103,10 +103,10 @@ public PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures accountStat } /** - * Possible values: - `N`: Nonregulated - `R`: Regulated **Note** This field is returned only for Visa Platform Connect. + * Possible values: - `N`: Nonregulated - `R`: Regulated **Note** This field is returned only for CyberSource through VisaNet. * @return accountStatus **/ - @ApiModelProperty(value = "Possible values: - `N`: Nonregulated - `R`: Regulated **Note** This field is returned only for Visa Platform Connect. ") + @ApiModelProperty(value = "Possible values: - `N`: Nonregulated - `R`: Regulated **Note** This field is returned only for CyberSource through VisaNet. ") public String getAccountStatus() { return accountStatus; } @@ -247,10 +247,10 @@ public PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures group(Strin } /** - * Type of commercial card. This field is supported only for Visa Platform Connect. Possible values: - **B**: Business card - **R**: Corporate card - **S**: Purchasing card - **0**: Noncommercial card + * 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 * @return group **/ - @ApiModelProperty(value = "Type of commercial card. This field is supported only for Visa Platform Connect. Possible values: - **B**: Business card - **R**: Corporate card - **S**: Purchasing card - **0**: Noncommercial card ") + @ApiModelProperty(value = "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 ") public String getGroup() { return group; } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.java b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.java index 1d5eac1d9..14ae09d77 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBank.java @@ -27,7 +27,7 @@ /** * PtsV2PaymentsPost201ResponsePaymentInformationBank */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 855f08572..61c2cdd6c 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationBankAccount.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponsePaymentInformationBankAccount */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 4499d2394..05160404a 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationCard.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationCard.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponsePaymentInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 3096e1bae..e62ad7a0d 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard { @SerializedName("prefix") private String prefix = null; @@ -109,10 +109,10 @@ public PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard assuranceLeve } /** - * Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **Visa Platform Connect** and **FDC Nashville Global**. + * 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**. * @return assuranceLevel **/ - @ApiModelProperty(value = "Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **Visa Platform Connect** and **FDC Nashville Global**. ") + @ApiModelProperty(value = "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**. ") public String getAssuranceLevel() { return assuranceLevel; } @@ -163,10 +163,10 @@ public PtsV2PaymentsPost201ResponsePaymentInformationTokenizedCard requestorId(S } /** - * 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 **Visa Platform Connect** and **FDC Nashville Global**. + * 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**. * @return requestorId **/ - @ApiModelProperty(value = "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 **Visa Platform Connect** and **FDC Nashville Global**. ") + @ApiModelProperty(value = "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**. ") public String getRequestorId() { return requestorId; } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformation.java index 21cda58fd..c441800ac 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformation.java @@ -27,7 +27,7 @@ /** * PtsV2PaymentsPost201ResponsePointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 6750a319c..73f5a05cf 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv.java @@ -26,11 +26,17 @@ /** * PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv { @SerializedName("tags") private String tags = null; + @SerializedName("chipValidationType") + private String chipValidationType = null; + + @SerializedName("chipValidationResult") + private String chipValidationResult = null; + public PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv tags(String tags) { this.tags = tags; return this; @@ -49,6 +55,42 @@ public void setTags(String tags) { this.tags = tags; } + public PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv chipValidationType(String chipValidationType) { + this.chipValidationType = chipValidationType; + return this; + } + + /** + * Entity or service that provided the validation results returned in **chipValidationResult**. Possible values: - **02**: MasterCard on-behalf pre-validation service (The MasterCard authorization platform validated the M/Chip cryptogram before the authorization request reached the issuer.) - **03**: MasterCard on-behalf stand-in service (The MasterCard authorization platform validated the M/Chip cryptogram because the issuer was not available.) - **50**: Issuer - **90**: Chip fall-back transaction downgrade process (The chip could not be read.) This field is returned only for NFC payment network tokenization transactions with MasterCard. **Note** No CyberSource through VisaNet acquirers support EMV at this time. + * @return chipValidationType + **/ + @ApiModelProperty(value = "Entity or service that provided the validation results returned in **chipValidationResult**. Possible values: - **02**: MasterCard on-behalf pre-validation service (The MasterCard authorization platform validated the M/Chip cryptogram before the authorization request reached the issuer.) - **03**: MasterCard on-behalf stand-in service (The MasterCard authorization platform validated the M/Chip cryptogram because the issuer was not available.) - **50**: Issuer - **90**: Chip fall-back transaction downgrade process (The chip could not be read.) This field is returned only for NFC payment network tokenization transactions with MasterCard. **Note** No CyberSource through VisaNet acquirers support EMV at this time. ") + public String getChipValidationType() { + return chipValidationType; + } + + public void setChipValidationType(String chipValidationType) { + this.chipValidationType = chipValidationType; + } + + public PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv chipValidationResult(String chipValidationResult) { + this.chipValidationResult = chipValidationResult; + return this; + } + + /** + * Cryptogram validation results returned by the entity or service specified in **chipValidationType**. Possible values: - **A**: Application cryptogram is valid, but the application transaction counter (ATC) is outside allowed range. (A large jump in ATC values may indicate data copying or other fraud.) - **C**: Chip validation was completed successfully. - **E**: Application cryptogram is valid but the ATC indicates possible replay fraud. - **F**: Format error in the chip data. - **G**: Application cryptogram is valid but is not a valid authorization request cryptogram (ARQC). - **I**: Application cryptogram is invalid. - **T**: Application cryptogram is valid but terminal verification results (TVR) or card verification results (CVR) are invalid. - **U**: Application cryptogram could not be validated because of a technical error. This field is returned only for NFC payment network tokenization transactions with MasterCard. **Note** No CyberSource through VisaNet acquirers support EMV at this time. + * @return chipValidationResult + **/ + @ApiModelProperty(value = "Cryptogram validation results returned by the entity or service specified in **chipValidationType**. Possible values: - **A**: Application cryptogram is valid, but the application transaction counter (ATC) is outside allowed range. (A large jump in ATC values may indicate data copying or other fraud.) - **C**: Chip validation was completed successfully. - **E**: Application cryptogram is valid but the ATC indicates possible replay fraud. - **F**: Format error in the chip data. - **G**: Application cryptogram is valid but is not a valid authorization request cryptogram (ARQC). - **I**: Application cryptogram is invalid. - **T**: Application cryptogram is valid but terminal verification results (TVR) or card verification results (CVR) are invalid. - **U**: Application cryptogram could not be validated because of a technical error. This field is returned only for NFC payment network tokenization transactions with MasterCard. **Note** No CyberSource through VisaNet acquirers support EMV at this time. ") + public String getChipValidationResult() { + return chipValidationResult; + } + + public void setChipValidationResult(String chipValidationResult) { + this.chipValidationResult = chipValidationResult; + } + @Override public boolean equals(java.lang.Object o) { @@ -59,12 +101,14 @@ public boolean equals(java.lang.Object o) { return false; } PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv ptsV2PaymentsPost201ResponsePointOfSaleInformationEmv = (PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv) o; - return Objects.equals(this.tags, ptsV2PaymentsPost201ResponsePointOfSaleInformationEmv.tags); + return Objects.equals(this.tags, ptsV2PaymentsPost201ResponsePointOfSaleInformationEmv.tags) && + Objects.equals(this.chipValidationType, ptsV2PaymentsPost201ResponsePointOfSaleInformationEmv.chipValidationType) && + Objects.equals(this.chipValidationResult, ptsV2PaymentsPost201ResponsePointOfSaleInformationEmv.chipValidationResult); } @Override public int hashCode() { - return Objects.hash(tags); + return Objects.hash(tags, chipValidationType, chipValidationResult); } @@ -74,6 +118,8 @@ public String toString() { sb.append("class PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv {\n"); sb.append(" tags: ").append(toIndentedString(tags)).append("\n"); + sb.append(" chipValidationType: ").append(toIndentedString(chipValidationType)).append("\n"); + sb.append(" chipValidationResult: ").append(toIndentedString(chipValidationResult)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformation.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformation.java index e4611d2ba..1d16b2cf0 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformation.java @@ -27,7 +27,7 @@ /** * PtsV2PaymentsPost201ResponseProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 32038114e..a8baf5969 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessingInformationBankTransferOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 6df22d7e7..67293470e 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformation.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformation.java @@ -30,12 +30,11 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; -import java.math.BigDecimal; /** * PtsV2PaymentsPost201ResponseProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost201ResponseProcessorInformation { @SerializedName("authIndicator") private String authIndicator = null; @@ -101,7 +100,7 @@ public class PtsV2PaymentsPost201ResponseProcessorInformation { private String amexVerbalAuthReferenceNumber = null; @SerializedName("salesSlipNumber") - private BigDecimal salesSlipNumber = null; + private Integer salesSlipNumber = null; @SerializedName("masterCardServiceCode") private String masterCardServiceCode = null; @@ -163,10 +162,10 @@ public PtsV2PaymentsPost201ResponseProcessorInformation transactionId(String tra } /** - * 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. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### Visa Platform Connect and GPN For details about this value for Visa Platform Connect and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + * 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. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) * @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. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### Visa Platform Connect and GPN For details about this value for Visa Platform Connect and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") + @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. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") public String getTransactionId() { return transactionId; } @@ -433,10 +432,10 @@ public PtsV2PaymentsPost201ResponseProcessorInformation systemTraceAuditNumber(S } /** - * This field is returned only for **American Express Direct** and **Visa Platform Connect**. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### Visa Platform Connect System trace number that must be printed on the customer’s receipt. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + * 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. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) * @return systemTraceAuditNumber **/ - @ApiModelProperty(value = "This field is returned only for **American Express Direct** and **Visa Platform Connect**. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### Visa Platform Connect System trace number that must be printed on the customer’s receipt. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") + @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. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") public String getSystemTraceAuditNumber() { return systemTraceAuditNumber; } @@ -469,10 +468,10 @@ public PtsV2PaymentsPost201ResponseProcessorInformation transactionIntegrityCode } /** - * 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 **Visa Platform Connect**. 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. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file,<sup>1</sup>: - Record: CP01 TCR6 - Position: 136-137 - Field: Mastercard Transaction Integrity Classification <sup>1</sup> The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. Visa Platform Connect creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks. + * 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. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file,<sup>1</sup>: - Record: CP01 TCR6 - Position: 136-137 - Field: Mastercard Transaction Integrity Classification <sup>1</sup> 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’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks. * @return transactionIntegrityCode **/ - @ApiModelProperty(value = "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 **Visa Platform Connect**. 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. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file,1: - Record: CP01 TCR6 - Position: 136-137 - Field: Mastercard Transaction Integrity Classification 1 The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. Visa Platform Connect creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks. ") + @ApiModelProperty(value = "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. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file,1: - Record: CP01 TCR6 - Position: 136-137 - Field: Mastercard Transaction Integrity Classification 1 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’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment networks. ") public String getTransactionIntegrityCode() { return transactionIntegrityCode; } @@ -499,7 +498,7 @@ public void setAmexVerbalAuthReferenceNumber(String amexVerbalAuthReferenceNumbe this.amexVerbalAuthReferenceNumber = amexVerbalAuthReferenceNumber; } - public PtsV2PaymentsPost201ResponseProcessorInformation salesSlipNumber(BigDecimal salesSlipNumber) { + public PtsV2PaymentsPost201ResponseProcessorInformation salesSlipNumber(Integer salesSlipNumber) { this.salesSlipNumber = salesSlipNumber; return this; } @@ -510,11 +509,11 @@ public PtsV2PaymentsPost201ResponseProcessorInformation salesSlipNumber(BigDecim * @return salesSlipNumber **/ @ApiModelProperty(value = "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**. ") - public BigDecimal getSalesSlipNumber() { + public Integer getSalesSlipNumber() { return salesSlipNumber; } - public void setSalesSlipNumber(BigDecimal salesSlipNumber) { + public void setSalesSlipNumber(Integer salesSlipNumber) { this.salesSlipNumber = salesSlipNumber; } @@ -524,10 +523,10 @@ public PtsV2PaymentsPost201ResponseProcessorInformation masterCardServiceCode(St } /** - * Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for Visa Platform Connect. + * Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for CyberSource through VisaNet. * @return masterCardServiceCode **/ - @ApiModelProperty(value = "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for Visa Platform Connect. ") + @ApiModelProperty(value = "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for CyberSource through VisaNet. ") public String getMasterCardServiceCode() { return masterCardServiceCode; } @@ -542,10 +541,10 @@ public PtsV2PaymentsPost201ResponseProcessorInformation masterCardServiceReplyCo } /** - * 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 **Visa Platform Connect**. + * 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**. * @return masterCardServiceReplyCode **/ - @ApiModelProperty(value = "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 **Visa Platform Connect**. ") + @ApiModelProperty(value = "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**. ") public String getMasterCardServiceReplyCode() { return masterCardServiceReplyCode; } @@ -560,10 +559,10 @@ public PtsV2PaymentsPost201ResponseProcessorInformation masterCardAuthentication } /** - * 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. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 132 - Field: Mastercard Member Defined service. **Note** This field is returned only for Visa Platform Connect. + * 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. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 132 - Field: Mastercard Member Defined service. **Note** This field is returned only for CyberSource through VisaNet. * @return masterCardAuthenticationType **/ - @ApiModelProperty(value = "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. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 132 - Field: Mastercard Member Defined service. **Note** This field is returned only for Visa Platform Connect. ") + @ApiModelProperty(value = "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. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 132 - Field: Mastercard Member Defined service. **Note** This field is returned only for CyberSource through VisaNet. ") public String getMasterCardAuthenticationType() { return masterCardAuthenticationType; } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.java index 3fb2aaf33..ec14ad87f 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAchVerification.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationAchVerification */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 b5779ce9d..152373d66 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAvs.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationAvs.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationAvs */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 0f23ad068..c6037c64c 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationCardVerification.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationCardVerification */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost201ResponseProcessorInformationCardVerification { @SerializedName("resultCode") private String resultCode = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse.java index f6a74b6ee..79b9c535b 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationConsumerAuthenticationResponse */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 ad7d6ba6a..7629b58eb 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationCustomer.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationCustomer */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 bec9ccf35..167ac0b54 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationResults { @SerializedName("code") private String code = null; @@ -250,10 +250,10 @@ public PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationRes } /** - * The description for this field is not available. + * Mapped Electronic Verification response code for the customer’s name. * @return name **/ - @ApiModelProperty(value = "The description for this field is not available. ") + @ApiModelProperty(value = "Mapped Electronic Verification response code for the customer’s name. ") public String getName() { return name; } @@ -268,10 +268,10 @@ public PtsV2PaymentsPost201ResponseProcessorInformationElectronicVerificationRes } /** - * The description for this field is not available. + * Raw Electronic Verification response code from the processor for the customer’s name. * @return nameRaw **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "Raw Electronic Verification response code from the processor for the customer’s name. ") public String getNameRaw() { return nameRaw; } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.java index c0c8dc03b..697723593 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice { @SerializedName("code") private String code = null; @@ -58,10 +58,10 @@ public PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice codeRaw(St } /** - * Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code 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) + * Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code 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) * @return codeRaw **/ - @ApiModelProperty(value = "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code 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) ") + @ApiModelProperty(value = "Raw merchant advice code sent directly from the processor. This field is used only for Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR7 - Position: 96-99 - Field: Response Data-Merchant Advice Code 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) ") public String getCodeRaw() { return codeRaw; } diff --git a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationRouting.java b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationRouting.java index 0ca1b3aba..41e19b9f5 100644 --- a/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationRouting.java +++ b/src/main/java/Model/PtsV2PaymentsPost201ResponseProcessorInformationRouting.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost201ResponseProcessorInformationRouting */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 af94d3564..17ecf111e 100644 --- a/src/main/java/Model/PtsV2PaymentsPost400Response.java +++ b/src/main/java/Model/PtsV2PaymentsPost400Response.java @@ -29,7 +29,7 @@ /** * PtsV2PaymentsPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; diff --git a/src/main/java/Model/PtsV2PaymentsPost502Response.java b/src/main/java/Model/PtsV2PaymentsPost502Response.java index e99c21750..3259da7cb 100644 --- a/src/main/java/Model/PtsV2PaymentsPost502Response.java +++ b/src/main/java/Model/PtsV2PaymentsPost502Response.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsPost502Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsPost502Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; diff --git a/src/main/java/Model/PtsV2PaymentsRefundPost201Response.java b/src/main/java/Model/PtsV2PaymentsRefundPost201Response.java index 2fd7869e1..7dde587fc 100644 --- a/src/main/java/Model/PtsV2PaymentsRefundPost201Response.java +++ b/src/main/java/Model/PtsV2PaymentsRefundPost201Response.java @@ -31,7 +31,7 @@ /** * PtsV2PaymentsRefundPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsRefundPost201Response { @SerializedName("_links") private PtsV2PaymentsRefundPost201ResponseLinks links = null; diff --git a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseLinks.java b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseLinks.java index b38a60541..0c8f7b48f 100644 --- a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseLinks.java +++ b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseLinks.java @@ -27,7 +27,7 @@ /** * PtsV2PaymentsRefundPost201ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 aea6d177a..2e7054d2f 100644 --- a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseOrderInformation.java +++ b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseOrderInformation.java @@ -27,7 +27,7 @@ /** * PtsV2PaymentsRefundPost201ResponseOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 e0b3f1f2f..22ddb27f6 100644 --- a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.java +++ b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseProcessorInformation.java @@ -27,7 +27,7 @@ /** * PtsV2PaymentsRefundPost201ResponseProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 f8e990d0b..4b581462e 100644 --- a/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.java +++ b/src/main/java/Model/PtsV2PaymentsRefundPost201ResponseRefundAmountDetails.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsRefundPost201ResponseRefundAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 21ce76769..9214cb251 100644 --- a/src/main/java/Model/PtsV2PaymentsRefundPost400Response.java +++ b/src/main/java/Model/PtsV2PaymentsRefundPost400Response.java @@ -29,7 +29,7 @@ /** * PtsV2PaymentsRefundPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsRefundPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; diff --git a/src/main/java/Model/PtsV2PaymentsReversalsPost201Response.java b/src/main/java/Model/PtsV2PaymentsReversalsPost201Response.java index 55ff8eaf2..1d161f359 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost201Response.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost201Response.java @@ -33,7 +33,7 @@ /** * PtsV2PaymentsReversalsPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsReversalsPost201Response { @SerializedName("_links") private PtsV2PaymentsReversalsPost201ResponseLinks links = null; diff --git a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation.java b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation.java index 13136c134..76f5bba94 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsReversalsPost201ResponseAuthorizationInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 ec2292e76..d3951e244 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseIssuerInformation.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsReversalsPost201ResponseIssuerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 7823b7d8d..444f7aae9 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseLinks.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseLinks.java @@ -27,7 +27,7 @@ /** * PtsV2PaymentsReversalsPost201ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 3f0d3b259..d04e2e45f 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsReversalsPost201ResponseProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsReversalsPost201ResponseProcessorInformation { @SerializedName("transactionId") private String transactionId = null; @@ -124,10 +124,10 @@ public PtsV2PaymentsReversalsPost201ResponseProcessorInformation masterCardServi } /** - * Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for Visa Platform Connect. + * Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for CyberSource through VisaNet. * @return masterCardServiceCode **/ - @ApiModelProperty(value = "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for Visa Platform Connect. ") + @ApiModelProperty(value = "Mastercard service that was used for the transaction. Mastercard provides this value to CyberSource. Possible value: - 53: Mastercard card-on-file token service #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 133-134 - Field: Mastercard Merchant on-behalf service. **Note** This field is returned only for CyberSource through VisaNet. ") public String getMasterCardServiceCode() { return masterCardServiceCode; } @@ -142,10 +142,10 @@ public PtsV2PaymentsReversalsPost201ResponseProcessorInformation masterCardServi } /** - * 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 **Visa Platform Connect**. + * 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**. * @return masterCardServiceReplyCode **/ - @ApiModelProperty(value = "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 **Visa Platform Connect**. ") + @ApiModelProperty(value = "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**. ") public String getMasterCardServiceReplyCode() { return masterCardServiceReplyCode; } diff --git a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.java b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.java index 5a70f4206..01b8375e0 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsReversalsPost201ResponseReversalAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 043cf80a4..1c26c4b66 100644 --- a/src/main/java/Model/PtsV2PaymentsReversalsPost400Response.java +++ b/src/main/java/Model/PtsV2PaymentsReversalsPost400Response.java @@ -29,7 +29,7 @@ /** * PtsV2PaymentsReversalsPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsReversalsPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; diff --git a/src/main/java/Model/PtsV2PaymentsVoidsPost201Response.java b/src/main/java/Model/PtsV2PaymentsVoidsPost201Response.java index f283305d9..ead2f2adb 100644 --- a/src/main/java/Model/PtsV2PaymentsVoidsPost201Response.java +++ b/src/main/java/Model/PtsV2PaymentsVoidsPost201Response.java @@ -29,7 +29,7 @@ /** * PtsV2PaymentsVoidsPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsVoidsPost201Response { @SerializedName("_links") private PtsV2PaymentsReversalsPost201ResponseLinks links = null; diff --git a/src/main/java/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.java b/src/main/java/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.java index 60064d131..4afe38dff 100644 --- a/src/main/java/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.java +++ b/src/main/java/Model/PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails.java @@ -26,7 +26,7 @@ /** * PtsV2PaymentsVoidsPost201ResponseVoidAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 4727566d6..c258978c6 100644 --- a/src/main/java/Model/PtsV2PaymentsVoidsPost400Response.java +++ b/src/main/java/Model/PtsV2PaymentsVoidsPost400Response.java @@ -29,7 +29,7 @@ /** * PtsV2PaymentsVoidsPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PaymentsVoidsPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; diff --git a/src/main/java/Model/PtsV2PayoutsPost201Response.java b/src/main/java/Model/PtsV2PayoutsPost201Response.java index d66de570e..050281538 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201Response.java +++ b/src/main/java/Model/PtsV2PayoutsPost201Response.java @@ -33,7 +33,7 @@ /** * PtsV2PayoutsPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PayoutsPost201Response { @SerializedName("_links") private PtsV2PaymentsReversalsPost201ResponseLinks links = null; diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseErrorInformation.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseErrorInformation.java index efd66a357..4d6fbf24f 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseErrorInformation.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseErrorInformation.java @@ -29,7 +29,7 @@ /** * PtsV2PayoutsPost201ResponseErrorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PayoutsPost201ResponseErrorInformation { @SerializedName("reason") private String reason = null; diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformation.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformation.java index 24cb449e4..846c2596a 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformation.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformation.java @@ -27,7 +27,7 @@ /** * PtsV2PayoutsPost201ResponseMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 97f4af832..8f0ffffdf 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor.java @@ -26,7 +26,7 @@ /** * PtsV2PayoutsPost201ResponseMerchantInformationMerchantDescriptor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 b26f4cb1c..9f5c8555a 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseOrderInformation.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseOrderInformation.java @@ -27,7 +27,7 @@ /** * PtsV2PayoutsPost201ResponseOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 af1ba717a..7a7e0baa8 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseOrderInformationAmountDetails.java @@ -26,7 +26,7 @@ /** * PtsV2PayoutsPost201ResponseOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PayoutsPost201ResponseOrderInformationAmountDetails { @SerializedName("totalAmount") private String totalAmount = null; @@ -46,10 +46,10 @@ public PtsV2PayoutsPost201ResponseOrderInformationAmountDetails totalAmount(Stri } /** - * 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. + * 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. * @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. ") + @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. ") public String getTotalAmount() { return totalAmount; } diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseProcessorInformation.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseProcessorInformation.java index 84a4dad8a..ea79cbccb 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseProcessorInformation.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseProcessorInformation.java @@ -26,7 +26,7 @@ /** * PtsV2PayoutsPost201ResponseProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PayoutsPost201ResponseProcessorInformation { @SerializedName("approvalCode") private String approvalCode = null; @@ -103,10 +103,10 @@ public PtsV2PayoutsPost201ResponseProcessorInformation systemTraceAuditNumber(St } /** - * This field is returned only for **American Express Direct** and **Visa Platform Connect**. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### Visa Platform Connect System trace number that must be printed on the customer’s receipt. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + * 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. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) * @return systemTraceAuditNumber **/ - @ApiModelProperty(value = "This field is returned only for **American Express Direct** and **Visa Platform Connect**. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### Visa Platform Connect System trace number that must be printed on the customer’s receipt. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") + @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. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") public String getSystemTraceAuditNumber() { return systemTraceAuditNumber; } diff --git a/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformation.java b/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformation.java index 7a364cce5..ebae995f3 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformation.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformation.java @@ -27,7 +27,7 @@ /** * PtsV2PayoutsPost201ResponseRecipientInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 65f934995..c95653b6d 100644 --- a/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformationCard.java +++ b/src/main/java/Model/PtsV2PayoutsPost201ResponseRecipientInformationCard.java @@ -26,7 +26,7 @@ /** * PtsV2PayoutsPost201ResponseRecipientInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PayoutsPost201ResponseRecipientInformationCard { @SerializedName("balance") private String balance = null; diff --git a/src/main/java/Model/PtsV2PayoutsPost400Response.java b/src/main/java/Model/PtsV2PayoutsPost400Response.java index 6774c5e60..ea2da7b4c 100644 --- a/src/main/java/Model/PtsV2PayoutsPost400Response.java +++ b/src/main/java/Model/PtsV2PayoutsPost400Response.java @@ -29,7 +29,7 @@ /** * PtsV2PayoutsPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class PtsV2PayoutsPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; diff --git a/src/main/java/Model/Ptsv2creditsPointOfSaleInformation.java b/src/main/java/Model/Ptsv2creditsPointOfSaleInformation.java index 18c16a757..9401ca3a1 100644 --- a/src/main/java/Model/Ptsv2creditsPointOfSaleInformation.java +++ b/src/main/java/Model/Ptsv2creditsPointOfSaleInformation.java @@ -29,7 +29,7 @@ /** * Ptsv2creditsPointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 2ee565fcb..750bb83b5 100644 --- a/src/main/java/Model/Ptsv2creditsPointOfSaleInformationEmv.java +++ b/src/main/java/Model/Ptsv2creditsPointOfSaleInformationEmv.java @@ -22,12 +22,11 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; -import java.math.BigDecimal; /** * Ptsv2creditsPointOfSaleInformationEmv */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2creditsPointOfSaleInformationEmv { @SerializedName("tags") private String tags = null; @@ -36,7 +35,7 @@ public class Ptsv2creditsPointOfSaleInformationEmv { private Boolean fallback = false; @SerializedName("fallbackCondition") - private BigDecimal fallbackCondition = null; + private Integer fallbackCondition = null; public Ptsv2creditsPointOfSaleInformationEmv tags(String tags) { this.tags = tags; @@ -74,7 +73,7 @@ public void setFallback(Boolean fallback) { this.fallback = fallback; } - public Ptsv2creditsPointOfSaleInformationEmv fallbackCondition(BigDecimal fallbackCondition) { + public Ptsv2creditsPointOfSaleInformationEmv fallbackCondition(Integer fallbackCondition) { this.fallbackCondition = fallbackCondition; return this; } @@ -84,11 +83,11 @@ public Ptsv2creditsPointOfSaleInformationEmv fallbackCondition(BigDecimal fallba * @return fallbackCondition **/ @ApiModelProperty(value = "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**. **NOTE**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card. For details, see the `emv_request_fallback_condition` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") - public BigDecimal getFallbackCondition() { + public Integer getFallbackCondition() { return fallbackCondition; } - public void setFallbackCondition(BigDecimal fallbackCondition) { + public void setFallbackCondition(Integer fallbackCondition) { this.fallbackCondition = fallbackCondition; } diff --git a/src/main/java/Model/Ptsv2creditsProcessingInformation.java b/src/main/java/Model/Ptsv2creditsProcessingInformation.java index cfc0599cf..4f0fe6083 100644 --- a/src/main/java/Model/Ptsv2creditsProcessingInformation.java +++ b/src/main/java/Model/Ptsv2creditsProcessingInformation.java @@ -28,7 +28,7 @@ /** * Ptsv2creditsProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2creditsProcessingInformation { @SerializedName("commerceIndicator") private String commerceIndicator = null; @@ -54,6 +54,9 @@ public class Ptsv2creditsProcessingInformation { @SerializedName("purchaseLevel") private String purchaseLevel = null; + @SerializedName("industryDataType") + private String industryDataType = null; + @SerializedName("recurringOptions") private Ptsv2paymentsidrefundsProcessingInformationRecurringOptions recurringOptions = null; @@ -204,6 +207,24 @@ public void setPurchaseLevel(String purchaseLevel) { this.purchaseLevel = purchaseLevel; } + public Ptsv2creditsProcessingInformation industryDataType(String industryDataType) { + this.industryDataType = industryDataType; + return this; + } + + /** + * Flag that indicates that the transaction includes airline data or restaurant data. This field must be set to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to restaurant or is not included in the request, CyberSource does not send restaurant data to the processor. Possible Values: - **airline** - **restaurant** + * @return industryDataType + **/ + @ApiModelProperty(value = "Flag that indicates that the transaction includes airline data or restaurant data. This field must be set to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to restaurant or is not included in the request, CyberSource does not send restaurant data to the processor. Possible Values: - **airline** - **restaurant** ") + public String getIndustryDataType() { + return industryDataType; + } + + public void setIndustryDataType(String industryDataType) { + this.industryDataType = industryDataType; + } + public Ptsv2creditsProcessingInformation recurringOptions(Ptsv2paymentsidrefundsProcessingInformationRecurringOptions recurringOptions) { this.recurringOptions = recurringOptions; return this; @@ -258,13 +279,14 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.reportGroup, ptsv2creditsProcessingInformation.reportGroup) && Objects.equals(this.visaCheckoutId, ptsv2creditsProcessingInformation.visaCheckoutId) && Objects.equals(this.purchaseLevel, ptsv2creditsProcessingInformation.purchaseLevel) && + Objects.equals(this.industryDataType, ptsv2creditsProcessingInformation.industryDataType) && Objects.equals(this.recurringOptions, ptsv2creditsProcessingInformation.recurringOptions) && Objects.equals(this.bankTransferOptions, ptsv2creditsProcessingInformation.bankTransferOptions); } @Override public int hashCode() { - return Objects.hash(commerceIndicator, processorId, paymentSolution, reconciliationId, linkId, reportGroup, visaCheckoutId, purchaseLevel, recurringOptions, bankTransferOptions); + return Objects.hash(commerceIndicator, processorId, paymentSolution, reconciliationId, linkId, reportGroup, visaCheckoutId, purchaseLevel, industryDataType, recurringOptions, bankTransferOptions); } @@ -281,6 +303,7 @@ public String toString() { sb.append(" reportGroup: ").append(toIndentedString(reportGroup)).append("\n"); sb.append(" visaCheckoutId: ").append(toIndentedString(visaCheckoutId)).append("\n"); sb.append(" purchaseLevel: ").append(toIndentedString(purchaseLevel)).append("\n"); + sb.append(" industryDataType: ").append(toIndentedString(industryDataType)).append("\n"); sb.append(" recurringOptions: ").append(toIndentedString(recurringOptions)).append("\n"); sb.append(" bankTransferOptions: ").append(toIndentedString(bankTransferOptions)).append("\n"); sb.append("}"); diff --git a/src/main/java/Model/Ptsv2creditsProcessingInformationBankTransferOptions.java b/src/main/java/Model/Ptsv2creditsProcessingInformationBankTransferOptions.java index 393a382b3..63293de93 100644 --- a/src/main/java/Model/Ptsv2creditsProcessingInformationBankTransferOptions.java +++ b/src/main/java/Model/Ptsv2creditsProcessingInformationBankTransferOptions.java @@ -26,7 +26,7 @@ /** * Ptsv2creditsProcessingInformationBankTransferOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 977e3ad1d..88190ce2e 100644 --- a/src/main/java/Model/Ptsv2paymentsAggregatorInformation.java +++ b/src/main/java/Model/Ptsv2paymentsAggregatorInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsAggregatorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsAggregatorInformation { @SerializedName("aggregatorId") private String aggregatorId = null; @@ -44,10 +44,10 @@ public Ptsv2paymentsAggregatorInformation aggregatorId(String aggregatorId) { } /** - * Value that identifies you as a payment aggregator. Get this value from the processor. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. 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) + * Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. 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) * @return aggregatorId **/ - @ApiModelProperty(value = "Value that identifies you as a payment aggregator. Get this value from the processor. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. 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) ") + @ApiModelProperty(value = "Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. 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) ") public String getAggregatorId() { return aggregatorId; } @@ -62,10 +62,10 @@ public Ptsv2paymentsAggregatorInformation name(String name) { } /** - * Your payment aggregator business name. **American Express Direct**\\ 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.\\ #### Visa Platform Connect With 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. **FDC Compass**\\ This value must consist of uppercase characters. 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) + * Your payment aggregator business name. **American Express Direct**\\ 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.\\ #### CyberSource through VisaNet With 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. **FDC Compass**\\ This value must consist of uppercase characters. 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) * @return name **/ - @ApiModelProperty(value = "Your payment aggregator business name. **American Express Direct**\\ 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.\\ #### Visa Platform Connect With 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. **FDC Compass**\\ This value must consist of uppercase characters. 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) ") + @ApiModelProperty(value = "Your payment aggregator business name. **American Express Direct**\\ 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.\\ #### CyberSource through VisaNet With 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. **FDC Compass**\\ This value must consist of uppercase characters. 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) ") public String getName() { return name; } diff --git a/src/main/java/Model/Ptsv2paymentsAggregatorInformationSubMerchant.java b/src/main/java/Model/Ptsv2paymentsAggregatorInformationSubMerchant.java index 27eb1a36e..1b23cdf30 100644 --- a/src/main/java/Model/Ptsv2paymentsAggregatorInformationSubMerchant.java +++ b/src/main/java/Model/Ptsv2paymentsAggregatorInformationSubMerchant.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsAggregatorInformationSubMerchant */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsAggregatorInformationSubMerchant { @SerializedName("cardAcceptorId") private String cardAcceptorId = null; @@ -82,10 +82,10 @@ public Ptsv2paymentsAggregatorInformationSubMerchant name(String name) { } /** - * Sub-merchant’s business name. #### American Express Direct 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. #### Visa Platform Connect With 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. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. + * Sub-merchant’s business name. #### American Express Direct 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. #### CyberSource through VisaNet With 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. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. * @return name **/ - @ApiModelProperty(value = "Sub-merchant’s business name. #### American Express Direct 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. #### Visa Platform Connect With 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. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. ") + @ApiModelProperty(value = "Sub-merchant’s business name. #### American Express Direct 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. #### CyberSource through VisaNet With 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. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. ") public String getName() { return name; } @@ -100,10 +100,10 @@ public Ptsv2paymentsAggregatorInformationSubMerchant address1(String address1) { } /** - * First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + * First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. * @return address1 **/ - @ApiModelProperty(value = "First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") + @ApiModelProperty(value = "First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") public String getAddress1() { return address1; } @@ -118,10 +118,10 @@ public Ptsv2paymentsAggregatorInformationSubMerchant locality(String locality) { } /** - * Sub-merchant’s city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + * Sub-merchant’s city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. * @return locality **/ - @ApiModelProperty(value = "Sub-merchant’s city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") + @ApiModelProperty(value = "Sub-merchant’s city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") public String getLocality() { return locality; } @@ -136,10 +136,10 @@ public Ptsv2paymentsAggregatorInformationSubMerchant administrativeArea(String a } /** - * Sub-merchant’s state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + * Sub-merchant’s state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. * @return administrativeArea **/ - @ApiModelProperty(value = "Sub-merchant’s state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") + @ApiModelProperty(value = "Sub-merchant’s state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") public String getAdministrativeArea() { return administrativeArea; } @@ -172,10 +172,10 @@ public Ptsv2paymentsAggregatorInformationSubMerchant postalCode(String postalCod } /** - * Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + * Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. * @return postalCode **/ - @ApiModelProperty(value = "Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") + @ApiModelProperty(value = "Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") public String getPostalCode() { return postalCode; } @@ -190,10 +190,10 @@ public Ptsv2paymentsAggregatorInformationSubMerchant country(String country) { } /** - * Sub-merchant’s country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. See \"Aggregator Support,\" page 101. + * Sub-merchant’s country. Use the two-character ISO Standard Country Codes. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. See \"Aggregator Support,\" page 101. * @return country **/ - @ApiModelProperty(value = "Sub-merchant’s country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. See \"Aggregator Support,\" page 101. ") + @ApiModelProperty(value = "Sub-merchant’s country. Use the two-character ISO Standard Country Codes. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. See \"Aggregator Support,\" page 101. ") public String getCountry() { return country; } @@ -208,10 +208,10 @@ public Ptsv2paymentsAggregatorInformationSubMerchant email(String email) { } /** - * Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - Visa Platform Connect: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### Visa Platform Connect With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. Visa Platform Connect creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + * Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - CyberSource through VisaNet: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **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’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. * @return email **/ - @ApiModelProperty(value = "Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - Visa Platform Connect: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### Visa Platform Connect With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. Visa Platform Connect creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. ") + @ApiModelProperty(value = "Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - CyberSource through VisaNet: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **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’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. ") public String getEmail() { return email; } @@ -226,10 +226,10 @@ public Ptsv2paymentsAggregatorInformationSubMerchant phoneNumber(String phoneNum } /** - * Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - Visa Platform Connect: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### Visa Platform Connect With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` + * Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - CyberSource through VisaNet: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` * @return phoneNumber **/ - @ApiModelProperty(value = "Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - Visa Platform Connect: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### Visa Platform Connect With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` ") + @ApiModelProperty(value = "Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - CyberSource through VisaNet: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` ") public String getPhoneNumber() { return phoneNumber; } diff --git a/src/main/java/Model/Ptsv2paymentsBuyerInformation.java b/src/main/java/Model/Ptsv2paymentsBuyerInformation.java index fd6b44bc5..bbf2f8189 100644 --- a/src/main/java/Model/Ptsv2paymentsBuyerInformation.java +++ b/src/main/java/Model/Ptsv2paymentsBuyerInformation.java @@ -29,7 +29,7 @@ /** * Ptsv2paymentsBuyerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 dbe214004..62a13c37e 100644 --- a/src/main/java/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.java +++ b/src/main/java/Model/Ptsv2paymentsBuyerInformationPersonalIdentification.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsBuyerInformationPersonalIdentification */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsBuyerInformationPersonalIdentification { @SerializedName("type") private String type = null; @@ -43,10 +43,10 @@ public Ptsv2paymentsBuyerInformationPersonalIdentification type(String type) { } /** - * 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. + * 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. 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) * @return type **/ - @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. ") + @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. 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) ") public String getType() { return type; } diff --git a/src/main/java/Model/Ptsv2paymentsClientReferenceInformation.java b/src/main/java/Model/Ptsv2paymentsClientReferenceInformation.java index 26f545c8f..8f7d312fc 100644 --- a/src/main/java/Model/Ptsv2paymentsClientReferenceInformation.java +++ b/src/main/java/Model/Ptsv2paymentsClientReferenceInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsClientReferenceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsClientReferenceInformation { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/Ptsv2paymentsClientReferenceInformationPartner.java b/src/main/java/Model/Ptsv2paymentsClientReferenceInformationPartner.java index db731e39e..e7db39c0e 100644 --- a/src/main/java/Model/Ptsv2paymentsClientReferenceInformationPartner.java +++ b/src/main/java/Model/Ptsv2paymentsClientReferenceInformationPartner.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsClientReferenceInformationPartner */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 63c8197f3..f4ca0c0ee 100644 --- a/src/main/java/Model/Ptsv2paymentsConsumerAuthenticationInformation.java +++ b/src/main/java/Model/Ptsv2paymentsConsumerAuthenticationInformation.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsConsumerAuthenticationInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 b5b463638..660ecd287 100644 --- a/src/main/java/Model/Ptsv2paymentsDeviceInformation.java +++ b/src/main/java/Model/Ptsv2paymentsDeviceInformation.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsDeviceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsDeviceInformation { @SerializedName("hostName") private String hostName = null; diff --git a/src/main/java/Model/Ptsv2paymentsInstallmentInformation.java b/src/main/java/Model/Ptsv2paymentsInstallmentInformation.java index 97a011650..612d7dfbe 100644 --- a/src/main/java/Model/Ptsv2paymentsInstallmentInformation.java +++ b/src/main/java/Model/Ptsv2paymentsInstallmentInformation.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsInstallmentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 66ba90957..3f8aaaa7b 100644 --- a/src/main/java/Model/Ptsv2paymentsIssuerInformation.java +++ b/src/main/java/Model/Ptsv2paymentsIssuerInformation.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsIssuerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsIssuerInformation { @SerializedName("discretionaryData") private String discretionaryData = null; @@ -37,10 +37,10 @@ public Ptsv2paymentsIssuerInformation discretionaryData(String discretionaryData } /** - * 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 **Visa Platform Connect**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + * 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**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) * @return discretionaryData **/ - @ApiModelProperty(value = "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 **Visa Platform Connect**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") + @ApiModelProperty(value = "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**. For details, see `issuer_additional_data` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") public String getDiscretionaryData() { return discretionaryData; } diff --git a/src/main/java/Model/Ptsv2paymentsMerchantDefinedInformation.java b/src/main/java/Model/Ptsv2paymentsMerchantDefinedInformation.java index d1cdad8ce..b0017860c 100644 --- a/src/main/java/Model/Ptsv2paymentsMerchantDefinedInformation.java +++ b/src/main/java/Model/Ptsv2paymentsMerchantDefinedInformation.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsMerchantDefinedInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsMerchantDefinedInformation { @SerializedName("key") private String key = null; @@ -40,10 +40,10 @@ public Ptsv2paymentsMerchantDefinedInformation key(String key) { } /** - * The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### Visa Platform Connect For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. For details, see \"Installment Payments on Visa Platform Connect\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + * The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. For details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) * @return key **/ - @ApiModelProperty(value = "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### Visa Platform Connect For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. For details, see \"Installment Payments on Visa Platform Connect\" in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") + @ApiModelProperty(value = "The number you assign for as the key for your merchant-defined data field. Valid values are 0 to 100. For example, to set or access the key for the 2nd merchant-defined data field in the array, you would reference `merchantDefinedInformation[1].key`. #### CyberSource through VisaNet For installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].key` and `merchantDefinedInformation[1].key` for data that you want to provide to the issuer to identify the transaction. For details, see the `merchant_defined_data1` request-level field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") public String getKey() { return key; } diff --git a/src/main/java/Model/Ptsv2paymentsMerchantInformation.java b/src/main/java/Model/Ptsv2paymentsMerchantInformation.java index 961620db3..a3f32744d 100644 --- a/src/main/java/Model/Ptsv2paymentsMerchantInformation.java +++ b/src/main/java/Model/Ptsv2paymentsMerchantInformation.java @@ -28,7 +28,7 @@ /** * Ptsv2paymentsMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsMerchantInformation { @SerializedName("merchantDescriptor") private Ptsv2paymentsMerchantInformationMerchantDescriptor merchantDescriptor = null; @@ -81,10 +81,10 @@ public Ptsv2paymentsMerchantInformation salesOrganizationId(String salesOrganiza } /** - * Company ID assigned to an independent sales organization. Get this value from Mastercard. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Mastercard Independent Sales Organization ID **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. Visa Platform Connect creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the `sales_organization_ID` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Mastercard Independent Sales Organization ID **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’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the `sales_organization_ID` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return salesOrganizationId **/ - @ApiModelProperty(value = "Company ID assigned to an independent sales organization. Get this value from Mastercard. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Mastercard Independent Sales Organization ID **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. Visa Platform Connect creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the `sales_organization_ID` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Company ID assigned to an independent sales organization. Get this value from Mastercard. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR6 - Position: 106-116 - Field: Mastercard Independent Sales Organization ID **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’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. For processor-specific information, see the `sales_organization_ID` field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") public String getSalesOrganizationId() { return salesOrganizationId; } diff --git a/src/main/java/Model/Ptsv2paymentsMerchantInformationMerchantDescriptor.java b/src/main/java/Model/Ptsv2paymentsMerchantInformationMerchantDescriptor.java index 739c1e905..7d6d8dcbb 100644 --- a/src/main/java/Model/Ptsv2paymentsMerchantInformationMerchantDescriptor.java +++ b/src/main/java/Model/Ptsv2paymentsMerchantInformationMerchantDescriptor.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsMerchantInformationMerchantDescriptor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 0b9976adb..ef706b632 100644 --- a/src/main/java/Model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor.java +++ b/src/main/java/Model/Ptsv2paymentsMerchantInformationServiceFeeDescriptor.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsMerchantInformationServiceFeeDescriptor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 379f05d9b..828848a1e 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformation.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformation.java @@ -34,7 +34,7 @@ /** * Ptsv2paymentsOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 fad9d7efd..1cf5a426f 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetails.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetails.java @@ -31,7 +31,7 @@ /** * Ptsv2paymentsOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsOrderInformationAmountDetails { @SerializedName("totalAmount") private String totalAmount = null; @@ -45,6 +45,9 @@ public class Ptsv2paymentsOrderInformationAmountDetails { @SerializedName("dutyAmount") private String dutyAmount = null; + @SerializedName("gratuityAmount") + private String gratuityAmount = null; + @SerializedName("taxAmount") private String taxAmount = null; @@ -105,10 +108,10 @@ public Ptsv2paymentsOrderInformationAmountDetails totalAmount(String totalAmount } /** - * 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. + * 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. * @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. ") + @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. ") public String getTotalAmount() { return totalAmount; } @@ -171,6 +174,24 @@ public void setDutyAmount(String dutyAmount) { this.dutyAmount = dutyAmount; } + public Ptsv2paymentsOrderInformationAmountDetails gratuityAmount(String gratuityAmount) { + this.gratuityAmount = gratuityAmount; + return this; + } + + /** + * Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. For information about partial authorizations, see Credit Card Services Using the SCMP API. Restaurant data is supported only on CyberSource through VisaNet. + * @return gratuityAmount + **/ + @ApiModelProperty(value = "Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. For information about partial authorizations, see Credit Card Services Using the SCMP API. Restaurant data is supported only on CyberSource through VisaNet. ") + public String getGratuityAmount() { + return gratuityAmount; + } + + public void setGratuityAmount(String gratuityAmount) { + this.gratuityAmount = gratuityAmount; + } + public Ptsv2paymentsOrderInformationAmountDetails taxAmount(String taxAmount) { this.taxAmount = taxAmount; return this; @@ -525,6 +546,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.currency, ptsv2paymentsOrderInformationAmountDetails.currency) && Objects.equals(this.discountAmount, ptsv2paymentsOrderInformationAmountDetails.discountAmount) && Objects.equals(this.dutyAmount, ptsv2paymentsOrderInformationAmountDetails.dutyAmount) && + Objects.equals(this.gratuityAmount, ptsv2paymentsOrderInformationAmountDetails.gratuityAmount) && Objects.equals(this.taxAmount, ptsv2paymentsOrderInformationAmountDetails.taxAmount) && Objects.equals(this.nationalTaxIncluded, ptsv2paymentsOrderInformationAmountDetails.nationalTaxIncluded) && Objects.equals(this.taxAppliedAfterDiscount, ptsv2paymentsOrderInformationAmountDetails.taxAppliedAfterDiscount) && @@ -547,7 +569,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(totalAmount, currency, discountAmount, dutyAmount, taxAmount, nationalTaxIncluded, taxAppliedAfterDiscount, taxAppliedLevel, taxTypeCode, freightAmount, foreignAmount, foreignCurrency, exchangeRate, exchangeRateTimeStamp, surcharge, settlementAmount, settlementCurrency, amexAdditionalAmounts, taxDetails, serviceFeeAmount, originalAmount, originalCurrency); + return Objects.hash(totalAmount, currency, discountAmount, dutyAmount, gratuityAmount, taxAmount, nationalTaxIncluded, taxAppliedAfterDiscount, taxAppliedLevel, taxTypeCode, freightAmount, foreignAmount, foreignCurrency, exchangeRate, exchangeRateTimeStamp, surcharge, settlementAmount, settlementCurrency, amexAdditionalAmounts, taxDetails, serviceFeeAmount, originalAmount, originalCurrency); } @@ -560,6 +582,7 @@ public String toString() { sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); sb.append(" discountAmount: ").append(toIndentedString(discountAmount)).append("\n"); sb.append(" dutyAmount: ").append(toIndentedString(dutyAmount)).append("\n"); + sb.append(" gratuityAmount: ").append(toIndentedString(gratuityAmount)).append("\n"); sb.append(" taxAmount: ").append(toIndentedString(taxAmount)).append("\n"); sb.append(" nationalTaxIncluded: ").append(toIndentedString(nationalTaxIncluded)).append("\n"); sb.append(" taxAppliedAfterDiscount: ").append(toIndentedString(taxAppliedAfterDiscount)).append("\n"); diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.java b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.java index fa0eeec3e..bd5e65f3b 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 e3ab8a8b2..d3fc8155f 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsSurcharge.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsOrderInformationAmountDetailsSurcharge */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsOrderInformationAmountDetailsSurcharge { @SerializedName("amount") private String amount = null; @@ -40,10 +40,10 @@ public Ptsv2paymentsOrderInformationAmountDetailsSurcharge 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. 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 Visa Platform Connect (VPC) 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) + * 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. 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 Visa Platform Connect (VPC) 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) ") + @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/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.java b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.java index 5a9ee0aca..0eda5e405 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationAmountDetailsTaxDetails.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsOrderInformationAmountDetailsTaxDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsOrderInformationAmountDetailsTaxDetails { @SerializedName("type") private String type = null; diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationBillTo.java b/src/main/java/Model/Ptsv2paymentsOrderInformationBillTo.java index 9c93fc593..ab2721539 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationBillTo.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationBillTo.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsOrderInformationBillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsOrderInformationBillTo { @SerializedName("firstName") private String firstName = null; @@ -181,10 +181,10 @@ public Ptsv2paymentsOrderInformationBillTo company(String company) { } /** - * Name of the customer’s company. **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 company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Name of the customer’s company. #### 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 company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return company **/ - @ApiModelProperty(value = "Name of the customer’s company. **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 company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Name of the customer’s company. #### 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 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() { return company; } @@ -199,10 +199,10 @@ public Ptsv2paymentsOrderInformationBillTo address1(String address1) { } /** - * Payment card 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, Visa Platform Connect 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card 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. **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` request-level field description 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 = "Payment card 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, Visa Platform Connect 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card 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. **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` request-level field description 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; } @@ -217,10 +217,10 @@ public Ptsv2paymentsOrderInformationBillTo address2(String address2) { } /** - * 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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 description 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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 description 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; } @@ -271,10 +271,10 @@ public Ptsv2paymentsOrderInformationBillTo locality(String locality) { } /** - * Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card billing city. #### 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 description 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 = "Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card billing city. #### 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 description 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; } @@ -289,10 +289,10 @@ public Ptsv2paymentsOrderInformationBillTo administrativeArea(String administrat } /** - * 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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 description 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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 description 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; } @@ -325,10 +325,10 @@ public Ptsv2paymentsOrderInformationBillTo country(String country) { } /** - * Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card billing country. 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. **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 description 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 = "Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card billing country. 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. **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 description 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; } @@ -379,10 +379,10 @@ public Ptsv2paymentsOrderInformationBillTo email(String email) { } /** - * 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. **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` request-level field description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. * @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. **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` request-level field description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. ") public String getEmail() { return email; } @@ -397,10 +397,10 @@ public Ptsv2paymentsOrderInformationBillTo 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. + * 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. ") + @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/Ptsv2paymentsOrderInformationInvoiceDetails.java b/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetails.java index a027b55d9..e106e5c42 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetails.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetails.java @@ -23,14 +23,13 @@ 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; /** * Ptsv2paymentsOrderInformationInvoiceDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsOrderInformationInvoiceDetails { @SerializedName("invoiceNumber") private String invoiceNumber = null; @@ -60,7 +59,7 @@ public class Ptsv2paymentsOrderInformationInvoiceDetails { private String commodityCode = null; @SerializedName("merchandiseCode") - private BigDecimal merchandiseCode = null; + private Integer merchandiseCode = null; @SerializedName("transactionAdviceAddendum") private List transactionAdviceAddendum = null; @@ -233,7 +232,7 @@ public void setCommodityCode(String commodityCode) { this.commodityCode = commodityCode; } - public Ptsv2paymentsOrderInformationInvoiceDetails merchandiseCode(BigDecimal merchandiseCode) { + public Ptsv2paymentsOrderInformationInvoiceDetails merchandiseCode(Integer merchandiseCode) { this.merchandiseCode = merchandiseCode; return this; } @@ -243,11 +242,11 @@ public Ptsv2paymentsOrderInformationInvoiceDetails merchandiseCode(BigDecimal me * @return merchandiseCode **/ @ApiModelProperty(value = "Identifier for the merchandise. Possible value: - 1000: Gift card This field is supported only for **American Express Direct**. ") - public BigDecimal getMerchandiseCode() { + public Integer getMerchandiseCode() { return merchandiseCode; } - public void setMerchandiseCode(BigDecimal merchandiseCode) { + public void setMerchandiseCode(Integer merchandiseCode) { this.merchandiseCode = merchandiseCode; } diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.java b/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.java index b3a8cb329..1922b40ee 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsOrderInformationInvoiceDetailsTransactionAdviceAddendum */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 5dd80d39b..ff0cd88f6 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationLineItems.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationLineItems.java @@ -30,7 +30,7 @@ /** * Ptsv2paymentsOrderInformationLineItems */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsOrderInformationLineItems { @SerializedName("productCode") private String productCode = null; diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationShipTo.java b/src/main/java/Model/Ptsv2paymentsOrderInformationShipTo.java index 584b3a1d1..4261f8654 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationShipTo.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationShipTo.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsOrderInformationShipTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsOrderInformationShipTo { @SerializedName("firstName") private String firstName = null; diff --git a/src/main/java/Model/Ptsv2paymentsOrderInformationShippingDetails.java b/src/main/java/Model/Ptsv2paymentsOrderInformationShippingDetails.java index 1b3ce0106..20ff7795e 100644 --- a/src/main/java/Model/Ptsv2paymentsOrderInformationShippingDetails.java +++ b/src/main/java/Model/Ptsv2paymentsOrderInformationShippingDetails.java @@ -27,7 +27,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsOrderInformationShippingDetails { @SerializedName("giftWrap") private Boolean giftWrap = null; diff --git a/src/main/java/Model/Ptsv2paymentsPaymentInformation.java b/src/main/java/Model/Ptsv2paymentsPaymentInformation.java index 99e5a79bd..25e38ed91 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformation.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformation.java @@ -31,7 +31,7 @@ /** * Ptsv2paymentsPaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 65363997a..513607ef9 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformationBank.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformationBank.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsPaymentInformationBank */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 1d5fdaca2..8f0b403e6 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformationBankAccount.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformationBankAccount.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsPaymentInformationBankAccount */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 606799e0f..f5038e6ff 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformationCard.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformationCard.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsPaymentInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsPaymentInformationCard { @SerializedName("number") private String number = null; @@ -163,10 +163,10 @@ public Ptsv2paymentsPaymentInformationCard sourceAccountType(String sourceAccoun } /** - * 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 + * 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 CyberSource through VisaNet (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 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 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 ") + @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 CyberSource through VisaNet (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 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/Ptsv2paymentsPaymentInformationCustomer.java b/src/main/java/Model/Ptsv2paymentsPaymentInformationCustomer.java index 3512e558b..cc97875bd 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformationCustomer.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformationCustomer.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsPaymentInformationCustomer */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 79b461526..cc4e2e8ac 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformationFluidData.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformationFluidData.java @@ -26,10 +26,10 @@ /** * Ptsv2paymentsPaymentInformationFluidData */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsPaymentInformationFluidData { - @SerializedName("key") - private String key = null; + @SerializedName("keySerialNumber") + private String keySerialNumber = null; @SerializedName("descriptor") private String descriptor = null; @@ -40,22 +40,22 @@ public class Ptsv2paymentsPaymentInformationFluidData { @SerializedName("encoding") private String encoding = null; - public Ptsv2paymentsPaymentInformationFluidData key(String key) { - this.key = key; + public Ptsv2paymentsPaymentInformationFluidData keySerialNumber(String keySerialNumber) { + this.keySerialNumber = keySerialNumber; return this; } /** * The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html) - * @return key + * @return keySerialNumber **/ @ApiModelProperty(value = "The encoded or encrypted value that a payment solution returns for an authorization request. For details about the valid values for a key, see [Creating an Online Authorization](https://developer.cybersource.com/api/developer-guides/dita-payments/CreatingOnlineAuth.html) ") - public String getKey() { - return key; + public String getKeySerialNumber() { + return keySerialNumber; } - public void setKey(String key) { - this.key = key; + public void setKeySerialNumber(String keySerialNumber) { + this.keySerialNumber = keySerialNumber; } public Ptsv2paymentsPaymentInformationFluidData descriptor(String descriptor) { @@ -122,7 +122,7 @@ public boolean equals(java.lang.Object o) { return false; } Ptsv2paymentsPaymentInformationFluidData ptsv2paymentsPaymentInformationFluidData = (Ptsv2paymentsPaymentInformationFluidData) o; - return Objects.equals(this.key, ptsv2paymentsPaymentInformationFluidData.key) && + return Objects.equals(this.keySerialNumber, ptsv2paymentsPaymentInformationFluidData.keySerialNumber) && Objects.equals(this.descriptor, ptsv2paymentsPaymentInformationFluidData.descriptor) && Objects.equals(this.value, ptsv2paymentsPaymentInformationFluidData.value) && Objects.equals(this.encoding, ptsv2paymentsPaymentInformationFluidData.encoding); @@ -130,7 +130,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(key, descriptor, value, encoding); + return Objects.hash(keySerialNumber, descriptor, value, encoding); } @@ -139,7 +139,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class Ptsv2paymentsPaymentInformationFluidData {\n"); - sb.append(" key: ").append(toIndentedString(key)).append("\n"); + sb.append(" keySerialNumber: ").append(toIndentedString(keySerialNumber)).append("\n"); sb.append(" descriptor: ").append(toIndentedString(descriptor)).append("\n"); sb.append(" value: ").append(toIndentedString(value)).append("\n"); sb.append(" encoding: ").append(toIndentedString(encoding)).append("\n"); diff --git a/src/main/java/Model/Ptsv2paymentsPaymentInformationTokenizedCard.java b/src/main/java/Model/Ptsv2paymentsPaymentInformationTokenizedCard.java index d420b70e3..02e042d30 100644 --- a/src/main/java/Model/Ptsv2paymentsPaymentInformationTokenizedCard.java +++ b/src/main/java/Model/Ptsv2paymentsPaymentInformationTokenizedCard.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsPaymentInformationTokenizedCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsPaymentInformationTokenizedCard { @SerializedName("number") private String number = null; @@ -154,10 +154,10 @@ public Ptsv2paymentsPaymentInformationTokenizedCard requestorId(String requestor } /** - * 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 **Visa Platform Connect** and **FDC Nashville Global**. + * 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**. * @return requestorId **/ - @ApiModelProperty(value = "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 **Visa Platform Connect** and **FDC Nashville Global**. ") + @ApiModelProperty(value = "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**. ") public String getRequestorId() { return requestorId; } @@ -190,10 +190,10 @@ public Ptsv2paymentsPaymentInformationTokenizedCard assuranceLevel(String assura } /** - * Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **Visa Platform Connect** and **FDC Nashville Global**. + * 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**. * @return assuranceLevel **/ - @ApiModelProperty(value = "Confidence level of the tokenization. This value is assigned by the token service provider. **Note** This field is supported only for **Visa Platform Connect** and **FDC Nashville Global**. ") + @ApiModelProperty(value = "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**. ") public String getAssuranceLevel() { return assuranceLevel; } diff --git a/src/main/java/Model/Ptsv2paymentsPointOfSaleInformation.java b/src/main/java/Model/Ptsv2paymentsPointOfSaleInformation.java index 65b94e5d8..2385dfb24 100644 --- a/src/main/java/Model/Ptsv2paymentsPointOfSaleInformation.java +++ b/src/main/java/Model/Ptsv2paymentsPointOfSaleInformation.java @@ -29,7 +29,7 @@ /** * Ptsv2paymentsPointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 1ab38a4df..0d8b16c1c 100644 --- a/src/main/java/Model/Ptsv2paymentsPointOfSaleInformationEmv.java +++ b/src/main/java/Model/Ptsv2paymentsPointOfSaleInformationEmv.java @@ -22,18 +22,17 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; -import java.math.BigDecimal; /** * Ptsv2paymentsPointOfSaleInformationEmv */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsPointOfSaleInformationEmv { @SerializedName("tags") private String tags = null; @SerializedName("cardholderVerificationMethodUsed") - private BigDecimal cardholderVerificationMethodUsed = null; + private Integer cardholderVerificationMethodUsed = null; @SerializedName("cardSequenceNumber") private String cardSequenceNumber = null; @@ -42,7 +41,7 @@ public class Ptsv2paymentsPointOfSaleInformationEmv { private Boolean fallback = false; @SerializedName("fallbackCondition") - private BigDecimal fallbackCondition = null; + private Integer fallbackCondition = null; public Ptsv2paymentsPointOfSaleInformationEmv tags(String tags) { this.tags = tags; @@ -62,7 +61,7 @@ public void setTags(String tags) { this.tags = tags; } - public Ptsv2paymentsPointOfSaleInformationEmv cardholderVerificationMethodUsed(BigDecimal cardholderVerificationMethodUsed) { + public Ptsv2paymentsPointOfSaleInformationEmv cardholderVerificationMethodUsed(Integer cardholderVerificationMethodUsed) { this.cardholderVerificationMethodUsed = cardholderVerificationMethodUsed; return this; } @@ -72,11 +71,11 @@ public Ptsv2paymentsPointOfSaleInformationEmv cardholderVerificationMethodUsed(B * @return cardholderVerificationMethodUsed **/ @ApiModelProperty(value = "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**. ") - public BigDecimal getCardholderVerificationMethodUsed() { + public Integer getCardholderVerificationMethodUsed() { return cardholderVerificationMethodUsed; } - public void setCardholderVerificationMethodUsed(BigDecimal cardholderVerificationMethodUsed) { + public void setCardholderVerificationMethodUsed(Integer cardholderVerificationMethodUsed) { this.cardholderVerificationMethodUsed = cardholderVerificationMethodUsed; } @@ -116,7 +115,7 @@ public void setFallback(Boolean fallback) { this.fallback = fallback; } - public Ptsv2paymentsPointOfSaleInformationEmv fallbackCondition(BigDecimal fallbackCondition) { + public Ptsv2paymentsPointOfSaleInformationEmv fallbackCondition(Integer fallbackCondition) { this.fallbackCondition = fallbackCondition; return this; } @@ -126,11 +125,11 @@ public Ptsv2paymentsPointOfSaleInformationEmv fallbackCondition(BigDecimal fallb * @return fallbackCondition **/ @ApiModelProperty(value = "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**. **NOTE**: This field is required when an EMV transaction fails for a technical reason. Do not include this field when the EMV terminal does not have any applications in common with the EMV card. For details, see the `emv_request_fallback_condition` field description in the [Card-Present Processing Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") - public BigDecimal getFallbackCondition() { + public Integer getFallbackCondition() { return fallbackCondition; } - public void setFallbackCondition(BigDecimal fallbackCondition) { + public void setFallbackCondition(Integer fallbackCondition) { this.fallbackCondition = fallbackCondition; } diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformation.java b/src/main/java/Model/Ptsv2paymentsProcessingInformation.java index 05754a5d8..dc5e8b0e1 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformation.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformation.java @@ -30,7 +30,7 @@ /** * Ptsv2paymentsProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsProcessingInformation { @SerializedName("capture") private Boolean capture = false; @@ -62,6 +62,9 @@ public class Ptsv2paymentsProcessingInformation { @SerializedName("visaCheckoutId") private String visaCheckoutId = null; + @SerializedName("industryDataType") + private String industryDataType = null; + @SerializedName("authorizationOptions") private Ptsv2paymentsProcessingInformationAuthorizationOptions authorizationOptions = null; @@ -254,6 +257,24 @@ public void setVisaCheckoutId(String visaCheckoutId) { this.visaCheckoutId = visaCheckoutId; } + public Ptsv2paymentsProcessingInformation industryDataType(String industryDataType) { + this.industryDataType = industryDataType; + return this; + } + + /** + * Flag that indicates that the transaction includes airline data or restaurant data. This field must be set to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to restaurant or is not included in the request, CyberSource does not send restaurant data to the processor. Possible Values: - **airline** - **restaurant** + * @return industryDataType + **/ + @ApiModelProperty(value = "Flag that indicates that the transaction includes airline data or restaurant data. This field must be set to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to restaurant or is not included in the request, CyberSource does not send restaurant data to the processor. Possible Values: - **airline** - **restaurant** ") + public String getIndustryDataType() { + return industryDataType; + } + + public void setIndustryDataType(String industryDataType) { + this.industryDataType = industryDataType; + } + public Ptsv2paymentsProcessingInformation authorizationOptions(Ptsv2paymentsProcessingInformationAuthorizationOptions authorizationOptions) { this.authorizationOptions = authorizationOptions; return this; @@ -346,6 +367,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.purchaseLevel, ptsv2paymentsProcessingInformation.purchaseLevel) && Objects.equals(this.reportGroup, ptsv2paymentsProcessingInformation.reportGroup) && Objects.equals(this.visaCheckoutId, ptsv2paymentsProcessingInformation.visaCheckoutId) && + Objects.equals(this.industryDataType, ptsv2paymentsProcessingInformation.industryDataType) && Objects.equals(this.authorizationOptions, ptsv2paymentsProcessingInformation.authorizationOptions) && Objects.equals(this.captureOptions, ptsv2paymentsProcessingInformation.captureOptions) && Objects.equals(this.recurringOptions, ptsv2paymentsProcessingInformation.recurringOptions) && @@ -354,7 +376,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(capture, processorId, businessApplicationId, commerceIndicator, paymentSolution, reconciliationId, linkId, purchaseLevel, reportGroup, visaCheckoutId, authorizationOptions, captureOptions, recurringOptions, bankTransferOptions); + return Objects.hash(capture, processorId, businessApplicationId, commerceIndicator, paymentSolution, reconciliationId, linkId, purchaseLevel, reportGroup, visaCheckoutId, industryDataType, authorizationOptions, captureOptions, recurringOptions, bankTransferOptions); } @@ -373,6 +395,7 @@ public String toString() { sb.append(" purchaseLevel: ").append(toIndentedString(purchaseLevel)).append("\n"); sb.append(" reportGroup: ").append(toIndentedString(reportGroup)).append("\n"); sb.append(" visaCheckoutId: ").append(toIndentedString(visaCheckoutId)).append("\n"); + sb.append(" industryDataType: ").append(toIndentedString(industryDataType)).append("\n"); sb.append(" authorizationOptions: ").append(toIndentedString(authorizationOptions)).append("\n"); sb.append(" captureOptions: ").append(toIndentedString(captureOptions)).append("\n"); sb.append(" recurringOptions: ").append(toIndentedString(recurringOptions)).append("\n"); diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.java b/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.java index cfc319edd..aae15ca2b 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptions.java @@ -29,7 +29,7 @@ /** * Ptsv2paymentsProcessingInformationAuthorizationOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsProcessingInformationAuthorizationOptions { @SerializedName("authType") private String authType = null; @@ -127,10 +127,10 @@ public Ptsv2paymentsProcessingInformationAuthorizationOptions authIndicator(Stri } /** - * Flag that specifies the purpose of the authorization. Possible values: - **0**: Preauthorization - **1**: Final authorization To set the default for this field, contact CyberSource Customer Support. For details, see \"Final Authorization Indicator\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). #### Barclays and Elavon The default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support. #### Visa Platform Connect When the value for this field is 0, it corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators When the value for this field is 1, it does not correspond to any data in the TC 33 capture file. 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). + * Flag that specifies the purpose of the authorization. Possible values: - **0**: Preauthorization - **1**: Final authorization To set the default for this field, contact CyberSource Customer Support. For details, see \"Final Authorization Indicator\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). #### Barclays and Elavon The default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support. #### CyberSource through VisaNet When the value for this field is 0, it corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators When the value for this field is 1, it does not correspond to any data in the TC 33 capture file. 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). * @return authIndicator **/ - @ApiModelProperty(value = "Flag that specifies the purpose of the authorization. Possible values: - **0**: Preauthorization - **1**: Final authorization To set the default for this field, contact CyberSource Customer Support. For details, see \"Final Authorization Indicator\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). #### Barclays and Elavon The default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support. #### Visa Platform Connect When the value for this field is 0, it corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators When the value for this field is 1, it does not correspond to any data in the TC 33 capture file. 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). ") + @ApiModelProperty(value = "Flag that specifies the purpose of the authorization. Possible values: - **0**: Preauthorization - **1**: Final authorization To set the default for this field, contact CyberSource Customer Support. For details, see \"Final Authorization Indicator\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). #### Barclays and Elavon The default for Barclays and Elavon is 1 (final authorization). To change the default for this field, contact CyberSource Customer Support. #### CyberSource through VisaNet When the value for this field is 0, it corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators When the value for this field is 1, it does not correspond to any data in the TC 33 capture file. 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). ") public String getAuthIndicator() { return authIndicator; } @@ -145,10 +145,10 @@ public Ptsv2paymentsProcessingInformationAuthorizationOptions partialAuthIndicat } /** - * 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) #### Visa Platform Connect To set the default for this field, contact CyberSource Customer Support. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators Possible values: - **true** Enable the transaction for partial authorization. - **false** Do not enable the transaction for partial authorization. + * 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) #### CyberSource through VisaNet To set the default for this field, contact CyberSource Customer Support. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators Possible values: - **true** Enable the transaction for partial authorization. - **false** Do not enable the transaction for partial authorization. * @return partialAuthIndicator **/ - @ApiModelProperty(value = "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) #### Visa Platform Connect To set the default for this field, contact CyberSource Customer Support. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators Possible values: - **true** Enable the transaction for partial authorization. - **false** Do not enable the transaction for partial authorization. ") + @ApiModelProperty(value = "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) #### CyberSource through VisaNet To set the default for this field, contact CyberSource Customer Support. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 164 - Field: Additional Authorization Indicators Possible values: - **true** Enable the transaction for partial authorization. - **false** Do not enable the transaction for partial authorization. ") public Boolean getPartialAuthIndicator() { return partialAuthIndicator; } @@ -207,10 +207,10 @@ public Ptsv2paymentsProcessingInformationAuthorizationOptions addDeclineAvsFlags } /** - * Comma-separated list of AVS flags that cause the reply flag `DAVSNO` to be returned. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the comma-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **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 section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For Visa Platform Connect, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type.<br/><br/> _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer's payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member’s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member’s name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member’s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member’s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member’s name, street address, and postal code do not match.| |O|Partial match: card member’s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member’s name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member’s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| + * Comma-separated list of AVS flags that cause the reply flag `DAVSNO` to be returned. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the comma-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **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 section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For CyberSource through VisaNet, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type.<br/><br/> _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer's payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member’s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member’s name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member’s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member’s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member’s name, street address, and postal code do not match.| |O|Partial match: card member’s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member’s name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member’s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| * @return declineAvsFlags **/ - @ApiModelProperty(value = "Comma-separated list of AVS flags that cause the reply flag `DAVSNO` to be returned. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the comma-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **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 section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For Visa Platform Connect, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type.

_American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer's payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member’s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member’s name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member’s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member’s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member’s name, street address, and postal code do not match.| |O|Partial match: card member’s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member’s name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member’s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| ") + @ApiModelProperty(value = "Comma-separated list of AVS flags that cause the reply flag `DAVSNO` to be returned. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the comma-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **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 section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For CyberSource through VisaNet, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type.

_American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer's payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member’s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member’s name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member’s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member’s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member’s name, street address, and postal code do not match.| |O|Partial match: card member’s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member’s name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member’s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| ") public List getDeclineAvsFlags() { return declineAvsFlags; } @@ -279,10 +279,10 @@ public Ptsv2paymentsProcessingInformationAuthorizationOptions billPaymentType(St } /** - * Reason for the payment. Possible values: - 001: Utility payment - 002: Government services - 003: Mobile phone top-up - 004: Coupon payment The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 48-50 - Field: Bill Payment Transaction Type Identifier This field is supported only for bill payments in Brazil with Mastercard on Visa Platform Connect. **Note** For details about Mastercard bill payments or bill payments with Visa, see `bill_payment_type` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + * Reason for the payment. Possible values: - 001: Utility payment - 002: Government services - 003: Mobile phone top-up - 004: Coupon payment The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 48-50 - Field: Bill Payment Transaction Type Identifier This field is supported only for bill payments in Brazil with Mastercard on CyberSource through VisaNet. **Note** For details about Mastercard bill payments or bill payments with Visa, see `bill_payment_type` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) * @return billPaymentType **/ - @ApiModelProperty(value = "Reason for the payment. Possible values: - 001: Utility payment - 002: Government services - 003: Mobile phone top-up - 004: Coupon payment The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 48-50 - Field: Bill Payment Transaction Type Identifier This field is supported only for bill payments in Brazil with Mastercard on Visa Platform Connect. **Note** For details about Mastercard bill payments or bill payments with Visa, see `bill_payment_type` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") + @ApiModelProperty(value = "Reason for the payment. Possible values: - 001: Utility payment - 002: Government services - 003: Mobile phone top-up - 004: Coupon payment The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR0 - Position: 48-50 - Field: Bill Payment Transaction Type Identifier This field is supported only for bill payments in Brazil with Mastercard on CyberSource through VisaNet. **Note** For details about Mastercard bill payments or bill payments with Visa, see `bill_payment_type` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") public String getBillPaymentType() { return billPaymentType; } diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.java b/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.java index 0be5d1114..3bce735f2 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator { @SerializedName("type") private String type = null; @@ -65,10 +65,10 @@ public Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator credentia } /** - * Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder’s credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant’s file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. For details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on Visa Platform Connect. + * Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder’s credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant’s file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. For details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. * @return credentialStoredOnFile **/ - @ApiModelProperty(value = "Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder’s credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant’s file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. For details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on Visa Platform Connect. ") + @ApiModelProperty(value = "Indicates to the issuing bank two things: - The merchant has received consent from the cardholder to store their card details on file - The merchant wants the issuing bank to check out the card details before the merchant initiates their first transaction for this cardholder. The purpose of the merchant-initiated transaction is to ensure that the cardholder’s credentials are valid (that the card is not stolen or has restrictions) and that the card details are good to be stored on the merchant’s file for future transactions. Valid values: - `true` means merchant will use this transaction to store payment credentials for follow-up merchant-initiated transactions. - `false` means merchant will not use this transaction to store payment credentials for follow-up merchant-initiated transactions. For details, see `subsequent_auth_first` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **NOTE:** The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. ") public Boolean getCredentialStoredOnFile() { return credentialStoredOnFile; } diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java b/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java index 7a022083e..7260d9f3b 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction { @SerializedName("reason") private String reason = null; @@ -34,16 +34,19 @@ public class Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerc @SerializedName("previousTransactionId") private String previousTransactionId = null; + @SerializedName("originalAuthorizedAmount") + private String originalAuthorizedAmount = null; + public Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction reason(String reason) { this.reason = reason; return this; } /** - * Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + * Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) * @return reason **/ - @ApiModelProperty(value = "Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") + @ApiModelProperty(value = "Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code #### All Processors For details, see `subsequent_auth_reason` field description in the [Credit Card Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") public String getReason() { return reason; } @@ -58,10 +61,10 @@ public Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantIn } /** - * Network 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. 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. **NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on Visa Platform Connect. + * Network 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. 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. **NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. * @return previousTransactionId **/ - @ApiModelProperty(value = "Network 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. 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. **NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on Visa Platform Connect. ") + @ApiModelProperty(value = "Network 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. 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. **NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. ") public String getPreviousTransactionId() { return previousTransactionId; } @@ -70,6 +73,24 @@ public void setPreviousTransactionId(String previousTransactionId) { this.previousTransactionId = previousTransactionId; } + public Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction originalAuthorizedAmount(String originalAuthorizedAmount) { + this.originalAuthorizedAmount = originalAuthorizedAmount; + return this; + } + + /** + * Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. See \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + * @return originalAuthorizedAmount + **/ + @ApiModelProperty(value = "Amount of the original authorization. This field is supported only for Apple Pay, Google Pay, and Samsung Pay transactions with Discover on FDC Nashville Global and Chase Paymentech. See \"Recurring Payments,\" and \"Subsequent Authorizations,\" field description in the [Payment Network Tokenization Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/tokenization_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") + public String getOriginalAuthorizedAmount() { + return originalAuthorizedAmount; + } + + public void setOriginalAuthorizedAmount(String originalAuthorizedAmount) { + this.originalAuthorizedAmount = originalAuthorizedAmount; + } + @Override public boolean equals(java.lang.Object o) { @@ -81,12 +102,13 @@ public boolean equals(java.lang.Object o) { } Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction = (Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction) o; return Objects.equals(this.reason, ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.reason) && - Objects.equals(this.previousTransactionId, ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.previousTransactionId); + Objects.equals(this.previousTransactionId, ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.previousTransactionId) && + Objects.equals(this.originalAuthorizedAmount, ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.originalAuthorizedAmount); } @Override public int hashCode() { - return Objects.hash(reason, previousTransactionId); + return Objects.hash(reason, previousTransactionId, originalAuthorizedAmount); } @@ -97,6 +119,7 @@ public String toString() { sb.append(" reason: ").append(toIndentedString(reason)).append("\n"); sb.append(" previousTransactionId: ").append(toIndentedString(previousTransactionId)).append("\n"); + sb.append(" originalAuthorizedAmount: ").append(toIndentedString(originalAuthorizedAmount)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.java b/src/main/java/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.java index d8030665a..224285604 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformationBankTransferOptions.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsProcessingInformationBankTransferOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsProcessingInformationBankTransferOptions { @SerializedName("declineAvsFlags") private String declineAvsFlags = null; @@ -64,10 +64,10 @@ public Ptsv2paymentsProcessingInformationBankTransferOptions declineAvsFlags(Str } /** - * Space-separated list of AVS flags that cause the request to be declined for AVS reasons. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the space-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **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 section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For Visa Platform Connect, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type. _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer’s payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member’s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member’s name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member’s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member’s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member’s name, street address, and postal code do not match.| |O|Partial match: card member’s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member’s name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member’s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| + * Space-separated list of AVS flags that cause the request to be declined for AVS reasons. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the space-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **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 section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For CyberSource through VisaNet, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type. _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer’s payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member’s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member’s name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member’s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member’s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member’s name, street address, and postal code do not match.| |O|Partial match: card member’s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member’s name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member’s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| * @return declineAvsFlags **/ - @ApiModelProperty(value = "Space-separated list of AVS flags that cause the request to be declined for AVS reasons. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the space-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **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 section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For Visa Platform Connect, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type. _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer’s payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member’s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member’s name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member’s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member’s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member’s name, street address, and postal code do not match.| |O|Partial match: card member’s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member’s name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member’s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| ") + @ApiModelProperty(value = "Space-separated list of AVS flags that cause the request to be declined for AVS reasons. **Important** To receive declines for the AVS code `N`, you must include the value `N` in the space-separated list. ### AVS Codes for Cielo 3.0 and CyberSource Latin American Processing **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 section is for the specific processing connection called CyberSource Latin American Processing. It is not for any other Latin American processors that CyberSource supports. |AVS Code|Description| |--- |--- | |D|Partial match: postal code and address match.| |E|Not supported: AVS is not supported for this card type. _or_ Invalid: the acquirer returned an unrecognized value for the AVS response.| |F|Partial match: postal code matches, but CPF and address do not match.*| |G|Not supported: AVS not supported or not verified.| |I|No match: AVS information is not available.| |K|Partial match: CPF matches, but postal code and address do not match.*| |L|Partial match: postal code and CPF match, but address does not match.*| |N|No match: postal code, CPF, and address do not match.*| |O|Partial match: CPF and address match, but postal code does not match.*| |R|Not supported: your implementation does not support AVS _or_ System unavailable.| |T|Partial match: address matches, but postal code and CPF do not match.*| |V|Match: postal code, CPF, and address match.*| |* CPF (Cadastro de Pessoas Fisicas) is required only for Redecard in Brazil.|| ### AVS Codes for All Other Processors **Note** The list of AVS codes for all other processors follows these descriptions of the processor-specific information for these codes. #### American Express Cards For American Express cards only, you can receive Visa and CyberSource AVS codes in addition to the American Express AVS codes. **Note** For CyberSource through VisaNet, the American Express AVS codes are converted to Visa AVS codes before they are returned to you. As a result, you will not receive American Express AVS codes for the American Express card type. _American Express Card codes_: `F`, `H`, `K`, `L`, `O`, `T`, `V` #### Domestic and International Visa Cards The international and domestic alphabetic AVS codes are the Visa standard AVS codes. CyberSource maps the standard AVS return codes for other types of payment cards, including American Express cards, to the Visa standard AVS codes. AVS is considered either domestic or international, depending on the location of the bank that issued the customer’s payment card: - When the bank is in the U.S., the AVS is domestic. - When the bank is outside the U.S., the AVS is international. You should be prepared to handle both domestic and international AVS result codes: - For international cards, you can receive domestic AVS codes in addition to the international AVS codes. - For domestic cards, you can receive international AVS codes in addition to the domestic AVS codes. _International Visa Codes_: `B`, `C`, `D`, `G`, `I`, `M`, `P` _Domestic Visa Codes_: `A`, `E`,`N`, `R`, `S`, `U`, `W`, `X`, `Y`, `Z` #### CyberSource Codes The numeric AVS codes are created by CyberSource and are not standard Visa codes. These AVS codes can be returned for any card type. _CyberSource Codes_: `1`, `2`, `3`, `4` ### Table of AVS Codes for All Other Processors |AVS Code|Description| |--- |--- | |A|Partial match: street address matches, but 5-digit and 9-digit postal codes do not match.| |B|Partial match: street address matches, but postal code is not verified. Returned only for Visa cards not issued in the U.S.| |C|No match: street address and postal code do not match. Returned only for Visa cards not issued in the U.S.| |D & M|Match: street address and postal code match. Returned only for Visa cards not issued in the U.S.| |E|Invalid: AVS data is invalid or AVS is not allowed for this card type.| |F|Partial match: card member’s name does not match, but billing postal code matches.| |G|Not supported: issuing bank outside the U.S. does not support AVS.| |H|Partial match: card member’s name does not match, but street address and postal code match. Returned only for the American Express card type.| |I|No match: address not verified. Returned only for Visa cards not issued in the U.S.| |K|Partial match: card member’s name matches, but billing address and billing postal code do not match. Returned only for the American Express card type.| |L|Partial match: card member’s name and billing postal code match, but billing address does not match. Returned only for the American Express card type.| |M|See the entry for D & M.| |N|No match: one of the following: street address and postal code do not match _or_ (American Express card type only) card member’s name, street address, and postal code do not match.| |O|Partial match: card member’s name and billing address match, but billing postal code does not match. Returned only for the American Express card type.| |P|Partial match: postal code matches, but street address not verified. Returned only for Visa cards not issued in the U.S.| |R|System unavailable.| |S|Not supported: issuing bank in the U.S. does not support AVS.| |T|Partial match: card member’s name does not match, but street address matches. Returned only for the American Express card type.| |U|System unavailable: address information unavailable for one of these reasons: The U.S. bank does not support AVS outside the U.S. _or_ The AVS in a U.S. bank is not functioning properly.| |V|Match: card member’s name, billing address, and billing postal code match. Returned only for the American Express card type.| |W|Partial match: street address does not match, but 9-digit postal code matches.| |X|Match: street address and 9-digit postal code match.| |Y|Match: street address and 5-digit postal code match.| |Z|Partial match: street address does not match, but 5-digit postal code matches.| |1|Not supported: one of the following: AVS is not supported for this processor or card type _or_ AVS is disabled for your CyberSource account. To enable AVS, contact CyberSource Customer Support.| |2|Unrecognized: the processor returned an unrecognized value for the AVS response.| |3|Match: address is confirmed. Returned only for PayPal Express Checkout.| |4|No match: address is not confirmed. Returned only for PayPal Express Checkout.| |5|No match: no AVS code was returned by the processor.| ") public String getDeclineAvsFlags() { return declineAvsFlags; } diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformationCaptureOptions.java b/src/main/java/Model/Ptsv2paymentsProcessingInformationCaptureOptions.java index 878d0c00c..baf98b608 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformationCaptureOptions.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformationCaptureOptions.java @@ -22,23 +22,22 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; -import java.math.BigDecimal; /** * Ptsv2paymentsProcessingInformationCaptureOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsProcessingInformationCaptureOptions { @SerializedName("captureSequenceNumber") - private BigDecimal captureSequenceNumber = null; + private Integer captureSequenceNumber = null; @SerializedName("totalCaptureCount") - private BigDecimal totalCaptureCount = null; + private Integer totalCaptureCount = null; @SerializedName("dateToCapture") private String dateToCapture = null; - public Ptsv2paymentsProcessingInformationCaptureOptions captureSequenceNumber(BigDecimal captureSequenceNumber) { + public Ptsv2paymentsProcessingInformationCaptureOptions captureSequenceNumber(Integer captureSequenceNumber) { this.captureSequenceNumber = captureSequenceNumber; return this; } @@ -50,15 +49,15 @@ public Ptsv2paymentsProcessingInformationCaptureOptions captureSequenceNumber(Bi * @return captureSequenceNumber **/ @ApiModelProperty(value = "Capture number when requesting multiple partial captures for one authorization. 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` ") - public BigDecimal getCaptureSequenceNumber() { + public Integer getCaptureSequenceNumber() { return captureSequenceNumber; } - public void setCaptureSequenceNumber(BigDecimal captureSequenceNumber) { + public void setCaptureSequenceNumber(Integer captureSequenceNumber) { this.captureSequenceNumber = captureSequenceNumber; } - public Ptsv2paymentsProcessingInformationCaptureOptions totalCaptureCount(BigDecimal totalCaptureCount) { + public Ptsv2paymentsProcessingInformationCaptureOptions totalCaptureCount(Integer totalCaptureCount) { this.totalCaptureCount = totalCaptureCount; return this; } @@ -70,11 +69,11 @@ public Ptsv2paymentsProcessingInformationCaptureOptions totalCaptureCount(BigDec * @return totalCaptureCount **/ @ApiModelProperty(value = "Total number of captures when requesting multiple partial captures for one payment. Used along with `captureSequenceNumber` field 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` ") - public BigDecimal getTotalCaptureCount() { + public Integer getTotalCaptureCount() { return totalCaptureCount; } - public void setTotalCaptureCount(BigDecimal totalCaptureCount) { + public void setTotalCaptureCount(Integer totalCaptureCount) { this.totalCaptureCount = totalCaptureCount; } @@ -84,10 +83,10 @@ public Ptsv2paymentsProcessingInformationCaptureOptions dateToCapture(String dat } /** - * Date on which you want the capture to occur. This field is supported only for Visa Platform Connect.\\ `Format: MMDD` + * Date on which you want the capture to occur. This field is supported only for CyberSource through VisaNet.\\ `Format: MMDD` * @return dateToCapture **/ - @ApiModelProperty(value = "Date on which you want the capture to occur. This field is supported only for Visa Platform Connect.\\ `Format: MMDD` ") + @ApiModelProperty(value = "Date on which you want the capture to occur. This field is supported only for CyberSource through VisaNet.\\ `Format: MMDD` ") public String getDateToCapture() { return dateToCapture; } diff --git a/src/main/java/Model/Ptsv2paymentsProcessingInformationRecurringOptions.java b/src/main/java/Model/Ptsv2paymentsProcessingInformationRecurringOptions.java index 25c509e77..5c4928ff5 100644 --- a/src/main/java/Model/Ptsv2paymentsProcessingInformationRecurringOptions.java +++ b/src/main/java/Model/Ptsv2paymentsProcessingInformationRecurringOptions.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsProcessingInformationRecurringOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 b3f6afcc2..49cc621f2 100644 --- a/src/main/java/Model/Ptsv2paymentsRecipientInformation.java +++ b/src/main/java/Model/Ptsv2paymentsRecipientInformation.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsRecipientInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 c04856ed3..6fc68f980 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidcapturesAggregatorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsidcapturesAggregatorInformation { @SerializedName("aggregatorId") private String aggregatorId = null; @@ -44,10 +44,10 @@ public Ptsv2paymentsidcapturesAggregatorInformation aggregatorId(String aggregat } /** - * Value that identifies you as a payment aggregator. Get this value from the processor. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. 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) + * Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. 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) * @return aggregatorId **/ - @ApiModelProperty(value = "Value that identifies you as a payment aggregator. Get this value from the processor. #### Visa Platform Connect The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. 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) ") + @ApiModelProperty(value = "Value that identifies you as a payment aggregator. Get this value from the processor. #### CyberSource through VisaNet The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR6 - Position: 95-105 - Field: MasterCard Payment Facilitator ID **FDC Compass**\\ This value must consist of uppercase characters. 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) ") public String getAggregatorId() { return aggregatorId; } @@ -62,10 +62,10 @@ public Ptsv2paymentsidcapturesAggregatorInformation name(String name) { } /** - * Your payment aggregator business name. **American Express Direct**\\ 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.\\ #### Visa Platform Connect With 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. **FDC Compass**\\ This value must consist of uppercase characters. 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) + * Your payment aggregator business name. **American Express Direct**\\ 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.\\ #### CyberSource through VisaNet With 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. **FDC Compass**\\ This value must consist of uppercase characters. 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) * @return name **/ - @ApiModelProperty(value = "Your payment aggregator business name. **American Express Direct**\\ 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.\\ #### Visa Platform Connect With 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. **FDC Compass**\\ This value must consist of uppercase characters. 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) ") + @ApiModelProperty(value = "Your payment aggregator business name. **American Express Direct**\\ 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.\\ #### CyberSource through VisaNet With 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. **FDC Compass**\\ This value must consist of uppercase characters. 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) ") public String getName() { return name; } diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.java b/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.java index 3781257c1..c6964775e 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesAggregatorInformationSubMerchant.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesAggregatorInformationSubMerchant */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsidcapturesAggregatorInformationSubMerchant { @SerializedName("name") private String name = null; @@ -58,10 +58,10 @@ public Ptsv2paymentsidcapturesAggregatorInformationSubMerchant name(String name) } /** - * Sub-merchant’s business name. #### American Express Direct 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. #### Visa Platform Connect With 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. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. + * Sub-merchant’s business name. #### American Express Direct 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. #### CyberSource through VisaNet With 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. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. * @return name **/ - @ApiModelProperty(value = "Sub-merchant’s business name. #### American Express Direct 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. #### Visa Platform Connect With 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. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. ") + @ApiModelProperty(value = "Sub-merchant’s business name. #### American Express Direct 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. #### CyberSource through VisaNet With 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. #### FDC Compass This value must consist of uppercase characters. #### FDC Nashville Global With Mastercard, the maximum length of the sub-merchant name depends on the length of the aggregator name: - If aggregator name length is 1 through 3, maximum sub-merchant name length is 21. - If aggregator name length is 4 through 7, maximum sub-merchant name length is 17. - If aggregator name length is 8 through 12, maximum sub-merchant name length is 12. ") public String getName() { return name; } @@ -76,10 +76,10 @@ public Ptsv2paymentsidcapturesAggregatorInformationSubMerchant address1(String a } /** - * First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + * First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. * @return address1 **/ - @ApiModelProperty(value = "First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") + @ApiModelProperty(value = "First line of the sub-merchant’s street address. For processor-specific details, see `submerchant_street` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") public String getAddress1() { return address1; } @@ -94,10 +94,10 @@ public Ptsv2paymentsidcapturesAggregatorInformationSubMerchant locality(String l } /** - * Sub-merchant’s city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + * Sub-merchant’s city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. * @return locality **/ - @ApiModelProperty(value = "Sub-merchant’s city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") + @ApiModelProperty(value = "Sub-merchant’s city. For processor-specific details, see `submerchant_city` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") public String getLocality() { return locality; } @@ -112,10 +112,10 @@ public Ptsv2paymentsidcapturesAggregatorInformationSubMerchant administrativeAre } /** - * Sub-merchant’s state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + * Sub-merchant’s state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. * @return administrativeArea **/ - @ApiModelProperty(value = "Sub-merchant’s state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") + @ApiModelProperty(value = "Sub-merchant’s state or province. For possible values and also aggregator support, see `submerchant_state` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") public String getAdministrativeArea() { return administrativeArea; } @@ -130,10 +130,10 @@ public Ptsv2paymentsidcapturesAggregatorInformationSubMerchant postalCode(String } /** - * Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. + * Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. * @return postalCode **/ - @ApiModelProperty(value = "Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### Visa Platform Connect The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") + @ApiModelProperty(value = "Partial postal code for the sub-merchant’s address. For processor-specific details, see `submerchant_postal_code` request field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file5. #### FDC Compass This value must consist of uppercase characters. ") public String getPostalCode() { return postalCode; } @@ -148,10 +148,10 @@ public Ptsv2paymentsidcapturesAggregatorInformationSubMerchant country(String co } /** - * Sub-merchant’s country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. See \"Aggregator Support,\" page 101. + * Sub-merchant’s country. Use the two-character ISO Standard Country Codes. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. See \"Aggregator Support,\" page 101. * @return country **/ - @ApiModelProperty(value = "Sub-merchant’s country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. See \"Aggregator Support,\" page 101. ") + @ApiModelProperty(value = "Sub-merchant’s country. Use the two-character ISO Standard Country Codes. #### CyberSource through VisaNet The value for this field does not map to the TC 33 capture file. #### FDC Compass This value must consist of uppercase characters. See \"Aggregator Support,\" page 101. ") public String getCountry() { return country; } @@ -166,10 +166,10 @@ public Ptsv2paymentsidcapturesAggregatorInformationSubMerchant email(String emai } /** - * Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - Visa Platform Connect: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### Visa Platform Connect With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. Visa Platform Connect creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. + * Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - CyberSource through VisaNet: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **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’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. * @return email **/ - @ApiModelProperty(value = "Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - Visa Platform Connect: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### Visa Platform Connect With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. Visa Platform Connect creates the TC 33 Capture file at the end of the day and sends it to the merchant’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. ") + @ApiModelProperty(value = "Sub-merchant’s email address. **Maximum length for processors** - American Express Direct: 40 - CyberSource through VisaNet: 40 - FDC Compass: 40 - FDC Nashville Global: 19 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCRB - Position: 25-64 - Field: American Express Seller E-mail Address **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’s acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. ") public String getEmail() { return email; } @@ -184,10 +184,10 @@ public Ptsv2paymentsidcapturesAggregatorInformationSubMerchant phoneNumber(Strin } /** - * Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - Visa Platform Connect: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### Visa Platform Connect With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` + * Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - CyberSource through VisaNet: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` * @return phoneNumber **/ - @ApiModelProperty(value = "Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - Visa Platform Connect: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### Visa Platform Connect With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` ") + @ApiModelProperty(value = "Sub-merchant’s telephone number. **Maximum length for procesors** - American Express Direct: 20 - CyberSource through VisaNet: 20 - FDC Compass: 13 - FDC Nashville Global: 10 #### CyberSource through VisaNet With American Express, the value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCRB - Position: 5-24 - Field: American Express Seller Telephone Number **FDC Compass**\\ This value must consist of uppercase characters. Use one of these recommended formats:\\ `NNN-NNN-NNNN`\\ `NNN-AAAAAAA` ") public String getPhoneNumber() { return phoneNumber; } diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesBuyerInformation.java b/src/main/java/Model/Ptsv2paymentsidcapturesBuyerInformation.java index 35bf17adb..e9a7d326e 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesBuyerInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesBuyerInformation.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesBuyerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 a4700cb81..59eaef841 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesInstallmentInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesInstallmentInformation.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesInstallmentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 558ed0dd6..9f541af97 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesMerchantInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesMerchantInformation.java @@ -28,7 +28,7 @@ /** * Ptsv2paymentsidcapturesMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 7f8a01e71..c64760613 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformation.java @@ -34,7 +34,7 @@ /** * Ptsv2paymentsidcapturesOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 b5733adfb..83e67f0b6 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationAmountDetails.java @@ -30,7 +30,7 @@ /** * Ptsv2paymentsidcapturesOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsidcapturesOrderInformationAmountDetails { @SerializedName("totalAmount") private String totalAmount = null; @@ -44,6 +44,9 @@ public class Ptsv2paymentsidcapturesOrderInformationAmountDetails { @SerializedName("dutyAmount") private String dutyAmount = null; + @SerializedName("gratuityAmount") + private String gratuityAmount = null; + @SerializedName("taxAmount") private String taxAmount = null; @@ -92,10 +95,10 @@ public Ptsv2paymentsidcapturesOrderInformationAmountDetails totalAmount(String t } /** - * 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. + * 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. * @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. ") + @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. ") public String getTotalAmount() { return totalAmount; } @@ -158,6 +161,24 @@ public void setDutyAmount(String dutyAmount) { this.dutyAmount = dutyAmount; } + public Ptsv2paymentsidcapturesOrderInformationAmountDetails gratuityAmount(String gratuityAmount) { + this.gratuityAmount = gratuityAmount; + return this; + } + + /** + * Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. For information about partial authorizations, see Credit Card Services Using the SCMP API. Restaurant data is supported only on CyberSource through VisaNet. + * @return gratuityAmount + **/ + @ApiModelProperty(value = "Gratuity or tip amount for restaurants when the card is present. Allowed only when `industryDatatype=restaurant`. When your customer uses a debit card or prepaid card, and you receive a partial authorization, the payment networks recommend that you do not submit a capture amount that is higher than the authorized amount. When the capture amount exceeds the partial amount that was approved, the issuer has chargeback rights for the excess amount. For information about partial authorizations, see Credit Card Services Using the SCMP API. Restaurant data is supported only on CyberSource through VisaNet. ") + public String getGratuityAmount() { + return gratuityAmount; + } + + public void setGratuityAmount(String gratuityAmount) { + this.gratuityAmount = gratuityAmount; + } + public Ptsv2paymentsidcapturesOrderInformationAmountDetails taxAmount(String taxAmount) { this.taxAmount = taxAmount; return this; @@ -440,6 +461,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.currency, ptsv2paymentsidcapturesOrderInformationAmountDetails.currency) && Objects.equals(this.discountAmount, ptsv2paymentsidcapturesOrderInformationAmountDetails.discountAmount) && Objects.equals(this.dutyAmount, ptsv2paymentsidcapturesOrderInformationAmountDetails.dutyAmount) && + Objects.equals(this.gratuityAmount, ptsv2paymentsidcapturesOrderInformationAmountDetails.gratuityAmount) && Objects.equals(this.taxAmount, ptsv2paymentsidcapturesOrderInformationAmountDetails.taxAmount) && Objects.equals(this.nationalTaxIncluded, ptsv2paymentsidcapturesOrderInformationAmountDetails.nationalTaxIncluded) && Objects.equals(this.taxAppliedAfterDiscount, ptsv2paymentsidcapturesOrderInformationAmountDetails.taxAppliedAfterDiscount) && @@ -458,7 +480,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(totalAmount, currency, discountAmount, dutyAmount, taxAmount, nationalTaxIncluded, taxAppliedAfterDiscount, taxAppliedLevel, taxTypeCode, freightAmount, foreignAmount, foreignCurrency, exchangeRate, exchangeRateTimeStamp, amexAdditionalAmounts, taxDetails, serviceFeeAmount, originalCurrency); + return Objects.hash(totalAmount, currency, discountAmount, dutyAmount, gratuityAmount, taxAmount, nationalTaxIncluded, taxAppliedAfterDiscount, taxAppliedLevel, taxTypeCode, freightAmount, foreignAmount, foreignCurrency, exchangeRate, exchangeRateTimeStamp, amexAdditionalAmounts, taxDetails, serviceFeeAmount, originalCurrency); } @@ -471,6 +493,7 @@ public String toString() { sb.append(" currency: ").append(toIndentedString(currency)).append("\n"); sb.append(" discountAmount: ").append(toIndentedString(discountAmount)).append("\n"); sb.append(" dutyAmount: ").append(toIndentedString(dutyAmount)).append("\n"); + sb.append(" gratuityAmount: ").append(toIndentedString(gratuityAmount)).append("\n"); sb.append(" taxAmount: ").append(toIndentedString(taxAmount)).append("\n"); sb.append(" nationalTaxIncluded: ").append(toIndentedString(nationalTaxIncluded)).append("\n"); sb.append(" taxAppliedAfterDiscount: ").append(toIndentedString(taxAppliedAfterDiscount)).append("\n"); diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationBillTo.java b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationBillTo.java index 286155c55..27f8b3faf 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationBillTo.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationBillTo.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesOrderInformationBillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsidcapturesOrderInformationBillTo { @SerializedName("firstName") private String firstName = null; @@ -103,10 +103,10 @@ public Ptsv2paymentsidcapturesOrderInformationBillTo company(String company) { } /** - * Name of the customer’s company. **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 company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Name of the customer’s company. #### 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 company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return company **/ - @ApiModelProperty(value = "Name of the customer’s company. **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 company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Name of the customer’s company. #### 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 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() { return company; } @@ -121,10 +121,10 @@ public Ptsv2paymentsidcapturesOrderInformationBillTo address1(String address1) { } /** - * Payment card 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, Visa Platform Connect 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card 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. **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` request-level field description 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 = "Payment card 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, Visa Platform Connect 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card 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. **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` request-level field description 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; } @@ -139,10 +139,10 @@ public Ptsv2paymentsidcapturesOrderInformationBillTo address2(String address2) { } /** - * 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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 description 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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 description 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; } @@ -157,10 +157,10 @@ public Ptsv2paymentsidcapturesOrderInformationBillTo locality(String locality) { } /** - * Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card billing city. #### 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 description 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 = "Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card billing city. #### 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 description 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; } @@ -175,10 +175,10 @@ public Ptsv2paymentsidcapturesOrderInformationBillTo administrativeArea(String a } /** - * 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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 description 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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 description 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; } @@ -211,10 +211,10 @@ public Ptsv2paymentsidcapturesOrderInformationBillTo country(String country) { } /** - * Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card billing country. 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. **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 description 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 = "Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card billing country. 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. **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 description 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; } @@ -229,10 +229,10 @@ public Ptsv2paymentsidcapturesOrderInformationBillTo email(String email) { } /** - * 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. **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` request-level field description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. * @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. **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` request-level field description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. ") public String getEmail() { return email; } @@ -247,10 +247,10 @@ public Ptsv2paymentsidcapturesOrderInformationBillTo phoneNumber(String phoneNum } /** - * 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. + * 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. ") + @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/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails.java b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails.java index 25673ad17..63ac9cebb 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationInvoiceDetails.java @@ -29,7 +29,7 @@ /** * Ptsv2paymentsidcapturesOrderInformationInvoiceDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 a8c7a53eb..0932bfcf1 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShipTo.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShipTo.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesOrderInformationShipTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsidcapturesOrderInformationShipTo { @SerializedName("administrativeArea") private String administrativeArea = null; diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShippingDetails.java b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShippingDetails.java index 88a307b1c..523691b70 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShippingDetails.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesOrderInformationShippingDetails.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesOrderInformationShippingDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 e93ee6982..f61d81b69 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesPaymentInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesPaymentInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidcapturesPaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 0246da1b4..2c92e7eb6 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesPointOfSaleInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesPointOfSaleInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidcapturesPointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 c1625b9ea..4ff447827 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesPointOfSaleInformationEmv.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesPointOfSaleInformationEmv */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 d298a4f14..25fa93bad 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformation.java @@ -29,7 +29,7 @@ /** * Ptsv2paymentsidcapturesProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsidcapturesProcessingInformation { @SerializedName("paymentSolution") private String paymentSolution = null; @@ -49,6 +49,9 @@ public class Ptsv2paymentsidcapturesProcessingInformation { @SerializedName("purchaseLevel") private String purchaseLevel = null; + @SerializedName("industryDataType") + private String industryDataType = null; + @SerializedName("issuer") private Ptsv2paymentsIssuerInformation issuer = null; @@ -166,6 +169,24 @@ public void setPurchaseLevel(String purchaseLevel) { this.purchaseLevel = purchaseLevel; } + public Ptsv2paymentsidcapturesProcessingInformation industryDataType(String industryDataType) { + this.industryDataType = industryDataType; + return this; + } + + /** + * Flag that indicates that the transaction includes airline data or restaurant data. This field must be set to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to restaurant or is not included in the request, CyberSource does not send restaurant data to the processor. Possible Values: - **airline** - **restaurant** + * @return industryDataType + **/ + @ApiModelProperty(value = "Flag that indicates that the transaction includes airline data or restaurant data. This field must be set to `airline` in order for airline data to be sent to the processor. For example, if this field is not set to airline or is not included in the request, CyberSource does not send airline data to the processor. You must set this field to `restaurant` in order for restaurant data to be sent to the processor. When this field is not set to restaurant or is not included in the request, CyberSource does not send restaurant data to the processor. Possible Values: - **airline** - **restaurant** ") + public String getIndustryDataType() { + return industryDataType; + } + + public void setIndustryDataType(String industryDataType) { + this.industryDataType = industryDataType; + } + public Ptsv2paymentsidcapturesProcessingInformation issuer(Ptsv2paymentsIssuerInformation issuer) { this.issuer = issuer; return this; @@ -236,6 +257,7 @@ public boolean equals(java.lang.Object o) { Objects.equals(this.reportGroup, ptsv2paymentsidcapturesProcessingInformation.reportGroup) && Objects.equals(this.visaCheckoutId, ptsv2paymentsidcapturesProcessingInformation.visaCheckoutId) && Objects.equals(this.purchaseLevel, ptsv2paymentsidcapturesProcessingInformation.purchaseLevel) && + Objects.equals(this.industryDataType, ptsv2paymentsidcapturesProcessingInformation.industryDataType) && Objects.equals(this.issuer, ptsv2paymentsidcapturesProcessingInformation.issuer) && Objects.equals(this.authorizationOptions, ptsv2paymentsidcapturesProcessingInformation.authorizationOptions) && Objects.equals(this.captureOptions, ptsv2paymentsidcapturesProcessingInformation.captureOptions); @@ -243,7 +265,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(paymentSolution, reconciliationId, linkId, reportGroup, visaCheckoutId, purchaseLevel, issuer, authorizationOptions, captureOptions); + return Objects.hash(paymentSolution, reconciliationId, linkId, reportGroup, visaCheckoutId, purchaseLevel, industryDataType, issuer, authorizationOptions, captureOptions); } @@ -258,6 +280,7 @@ public String toString() { sb.append(" reportGroup: ").append(toIndentedString(reportGroup)).append("\n"); sb.append(" visaCheckoutId: ").append(toIndentedString(visaCheckoutId)).append("\n"); sb.append(" purchaseLevel: ").append(toIndentedString(purchaseLevel)).append("\n"); + sb.append(" industryDataType: ").append(toIndentedString(industryDataType)).append("\n"); sb.append(" issuer: ").append(toIndentedString(issuer)).append("\n"); sb.append(" authorizationOptions: ").append(toIndentedString(authorizationOptions)).append("\n"); sb.append(" captureOptions: ").append(toIndentedString(captureOptions)).append("\n"); diff --git a/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.java b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.java index 2b7f299b9..3da898a58 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidcapturesProcessingInformationAuthorizationOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 83adc18d2..049250a53 100644 --- a/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.java +++ b/src/main/java/Model/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.java @@ -22,20 +22,19 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; -import java.math.BigDecimal; /** * Ptsv2paymentsidcapturesProcessingInformationCaptureOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsidcapturesProcessingInformationCaptureOptions { @SerializedName("captureSequenceNumber") - private BigDecimal captureSequenceNumber = null; + private Integer captureSequenceNumber = null; @SerializedName("totalCaptureCount") - private BigDecimal totalCaptureCount = null; + private Integer totalCaptureCount = null; - public Ptsv2paymentsidcapturesProcessingInformationCaptureOptions captureSequenceNumber(BigDecimal captureSequenceNumber) { + public Ptsv2paymentsidcapturesProcessingInformationCaptureOptions captureSequenceNumber(Integer captureSequenceNumber) { this.captureSequenceNumber = captureSequenceNumber; return this; } @@ -47,15 +46,15 @@ public Ptsv2paymentsidcapturesProcessingInformationCaptureOptions captureSequenc * @return captureSequenceNumber **/ @ApiModelProperty(value = "Capture number when requesting multiple partial captures for one authorization. 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` ") - public BigDecimal getCaptureSequenceNumber() { + public Integer getCaptureSequenceNumber() { return captureSequenceNumber; } - public void setCaptureSequenceNumber(BigDecimal captureSequenceNumber) { + public void setCaptureSequenceNumber(Integer captureSequenceNumber) { this.captureSequenceNumber = captureSequenceNumber; } - public Ptsv2paymentsidcapturesProcessingInformationCaptureOptions totalCaptureCount(BigDecimal totalCaptureCount) { + public Ptsv2paymentsidcapturesProcessingInformationCaptureOptions totalCaptureCount(Integer totalCaptureCount) { this.totalCaptureCount = totalCaptureCount; return this; } @@ -67,11 +66,11 @@ public Ptsv2paymentsidcapturesProcessingInformationCaptureOptions totalCaptureCo * @return totalCaptureCount **/ @ApiModelProperty(value = "Total number of captures when requesting multiple partial captures for one payment. Used along with `captureSequenceNumber` field 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` ") - public BigDecimal getTotalCaptureCount() { + public Integer getTotalCaptureCount() { return totalCaptureCount; } - public void setTotalCaptureCount(BigDecimal totalCaptureCount) { + public void setTotalCaptureCount(Integer totalCaptureCount) { this.totalCaptureCount = totalCaptureCount; } diff --git a/src/main/java/Model/Ptsv2paymentsidrefundsMerchantInformation.java b/src/main/java/Model/Ptsv2paymentsidrefundsMerchantInformation.java index 555964edb..b2b254739 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsMerchantInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsMerchantInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidrefundsMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 64ad40993..6186ffc29 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsOrderInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsOrderInformation.java @@ -34,7 +34,7 @@ /** * Ptsv2paymentsidrefundsOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 2f8c08088..7162513d2 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsOrderInformationLineItems.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsOrderInformationLineItems.java @@ -30,7 +30,7 @@ /** * Ptsv2paymentsidrefundsOrderInformationLineItems */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsidrefundsOrderInformationLineItems { @SerializedName("productCode") private String productCode = null; diff --git a/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformation.java b/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformation.java index ddccd0310..00c452a00 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformation.java @@ -29,7 +29,7 @@ /** * Ptsv2paymentsidrefundsPaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 432bbdf1a..48a462acd 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformationCard.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsPaymentInformationCard.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidrefundsPaymentInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsidrefundsPaymentInformationCard { @SerializedName("number") private String number = null; diff --git a/src/main/java/Model/Ptsv2paymentsidrefundsPointOfSaleInformation.java b/src/main/java/Model/Ptsv2paymentsidrefundsPointOfSaleInformation.java index 9699a4130..de85b7943 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsPointOfSaleInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsPointOfSaleInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidrefundsPointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 312666618..588641026 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsProcessingInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsProcessingInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidrefundsProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 ef16b9e15..35be3b03b 100644 --- a/src/main/java/Model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions.java +++ b/src/main/java/Model/Ptsv2paymentsidrefundsProcessingInformationRecurringOptions.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidrefundsProcessingInformationRecurringOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 fd06c5fb2..aa5a5893d 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidreversalsClientReferenceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsidreversalsClientReferenceInformation { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformationPartner.java b/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformationPartner.java index 0f80a261c..1a1e94a8c 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformationPartner.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsClientReferenceInformationPartner.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidreversalsClientReferenceInformationPartner */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 1e863a9ca..050569618 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformation.java @@ -30,7 +30,7 @@ /** * Ptsv2paymentsidreversalsOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 3b9db7f7c..d2aa81c9a 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformationAmountDetails.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformationAmountDetails.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidreversalsOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 54ee7477b..91a35581f 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformationLineItems.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsOrderInformationLineItems.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidreversalsOrderInformationLineItems */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsidreversalsOrderInformationLineItems { @SerializedName("quantity") private BigDecimal quantity = null; diff --git a/src/main/java/Model/Ptsv2paymentsidreversalsPointOfSaleInformation.java b/src/main/java/Model/Ptsv2paymentsidreversalsPointOfSaleInformation.java index 29b6cdafe..eede65a64 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsPointOfSaleInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsPointOfSaleInformation.java @@ -14,7 +14,7 @@ package Model; import java.util.Objects; -import Model.PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv; +import Model.Ptsv2paymentsidreversalsPointOfSaleInformationEmv; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -27,12 +27,12 @@ /** * Ptsv2paymentsidreversalsPointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsidreversalsPointOfSaleInformation { @SerializedName("emv") - private PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv emv = null; + private Ptsv2paymentsidreversalsPointOfSaleInformationEmv emv = null; - public Ptsv2paymentsidreversalsPointOfSaleInformation emv(PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv emv) { + public Ptsv2paymentsidreversalsPointOfSaleInformation emv(Ptsv2paymentsidreversalsPointOfSaleInformationEmv emv) { this.emv = emv; return this; } @@ -42,11 +42,11 @@ public Ptsv2paymentsidreversalsPointOfSaleInformation emv(PtsV2PaymentsPost201Re * @return emv **/ @ApiModelProperty(value = "") - public PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv getEmv() { + public Ptsv2paymentsidreversalsPointOfSaleInformationEmv getEmv() { return emv; } - public void setEmv(PtsV2PaymentsPost201ResponsePointOfSaleInformationEmv emv) { + public void setEmv(Ptsv2paymentsidreversalsPointOfSaleInformationEmv emv) { this.emv = emv; } diff --git a/src/main/java/Model/Ptsv2paymentsidreversalsPointOfSaleInformationEmv.java b/src/main/java/Model/Ptsv2paymentsidreversalsPointOfSaleInformationEmv.java new file mode 100644 index 000000000..e00670789 --- /dev/null +++ b/src/main/java/Model/Ptsv2paymentsidreversalsPointOfSaleInformationEmv.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; + +/** + * Ptsv2paymentsidreversalsPointOfSaleInformationEmv + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") +public class Ptsv2paymentsidreversalsPointOfSaleInformationEmv { + @SerializedName("tags") + private String tags = null; + + public Ptsv2paymentsidreversalsPointOfSaleInformationEmv tags(String tags) { + this.tags = tags; + return this; + } + + /** + * 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. For details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **Note** The information about EMV applies to credit card processing and PIN debit processing. All other information in this guide applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Note** For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **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, and 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 + * @return tags + **/ + @ApiModelProperty(value = "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. For details, see the `emv_request_combined_tags` field description in [Card-Present Processing Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/Retail_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) **Note** The information about EMV applies to credit card processing and PIN debit processing. All other information in this guide applies only to credit card processing. PIN debit processing is available only on FDC Nashville Global. **Note** For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com **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, and 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 ") + public String getTags() { + return tags; + } + + public void setTags(String tags) { + this.tags = tags; + } + + + @Override + public boolean equals(java.lang.Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Ptsv2paymentsidreversalsPointOfSaleInformationEmv ptsv2paymentsidreversalsPointOfSaleInformationEmv = (Ptsv2paymentsidreversalsPointOfSaleInformationEmv) o; + return Objects.equals(this.tags, ptsv2paymentsidreversalsPointOfSaleInformationEmv.tags); + } + + @Override + public int hashCode() { + return Objects.hash(tags); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Ptsv2paymentsidreversalsPointOfSaleInformationEmv {\n"); + + sb.append(" tags: ").append(toIndentedString(tags)).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/Ptsv2paymentsidreversalsProcessingInformation.java b/src/main/java/Model/Ptsv2paymentsidreversalsProcessingInformation.java index 1bcc006b1..12667cf7d 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsProcessingInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsProcessingInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidreversalsProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 578a8ac94..e4e84ad04 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsReversalInformation.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsReversalInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2paymentsidreversalsReversalInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 5e640655a..fb84b79e7 100644 --- a/src/main/java/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.java +++ b/src/main/java/Model/Ptsv2paymentsidreversalsReversalInformationAmountDetails.java @@ -26,7 +26,7 @@ /** * Ptsv2paymentsidreversalsReversalInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2paymentsidreversalsReversalInformationAmountDetails { @SerializedName("totalAmount") private String totalAmount = null; @@ -40,10 +40,10 @@ public Ptsv2paymentsidreversalsReversalInformationAmountDetails totalAmount(Stri } /** - * 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. + * 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. * @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. ") + @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. ") public String getTotalAmount() { return totalAmount; } diff --git a/src/main/java/Model/Ptsv2payoutsClientReferenceInformation.java b/src/main/java/Model/Ptsv2payoutsClientReferenceInformation.java index 20aab77ac..7f2ddacf1 100644 --- a/src/main/java/Model/Ptsv2payoutsClientReferenceInformation.java +++ b/src/main/java/Model/Ptsv2payoutsClientReferenceInformation.java @@ -26,7 +26,7 @@ /** * Ptsv2payoutsClientReferenceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2payoutsClientReferenceInformation { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/Ptsv2payoutsMerchantInformation.java b/src/main/java/Model/Ptsv2payoutsMerchantInformation.java index d24eb2ca1..d74957dce 100644 --- a/src/main/java/Model/Ptsv2payoutsMerchantInformation.java +++ b/src/main/java/Model/Ptsv2payoutsMerchantInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2payoutsMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2payoutsMerchantInformation { @SerializedName("categoryCode") private Integer categoryCode = null; diff --git a/src/main/java/Model/Ptsv2payoutsMerchantInformationMerchantDescriptor.java b/src/main/java/Model/Ptsv2payoutsMerchantInformationMerchantDescriptor.java index 2f10581ec..a5c9f014c 100644 --- a/src/main/java/Model/Ptsv2payoutsMerchantInformationMerchantDescriptor.java +++ b/src/main/java/Model/Ptsv2payoutsMerchantInformationMerchantDescriptor.java @@ -26,7 +26,7 @@ /** * Ptsv2payoutsMerchantInformationMerchantDescriptor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 7dfa83c45..11ae05fa6 100644 --- a/src/main/java/Model/Ptsv2payoutsOrderInformation.java +++ b/src/main/java/Model/Ptsv2payoutsOrderInformation.java @@ -28,7 +28,7 @@ /** * Ptsv2payoutsOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 1115377dc..56ea9fcb7 100644 --- a/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetails.java +++ b/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetails.java @@ -27,7 +27,7 @@ /** * Ptsv2payoutsOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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. 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. + * 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. * @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. ") + @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. ") public String getTotalAmount() { return totalAmount; } diff --git a/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.java b/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.java index cdd33f71f..8019f38a1 100644 --- a/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.java +++ b/src/main/java/Model/Ptsv2payoutsOrderInformationAmountDetailsSurcharge.java @@ -26,7 +26,7 @@ /** * Ptsv2payoutsOrderInformationAmountDetailsSurcharge */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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. 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 Visa Platform Connect (VPC) 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) + * 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. 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 Visa Platform Connect (VPC) 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) ") + @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 3f4be5c66..70aeb883a 100644 --- a/src/main/java/Model/Ptsv2payoutsOrderInformationBillTo.java +++ b/src/main/java/Model/Ptsv2payoutsOrderInformationBillTo.java @@ -26,7 +26,7 @@ /** * Ptsv2payoutsOrderInformationBillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2payoutsOrderInformationBillTo { @SerializedName("firstName") private String firstName = null; @@ -100,10 +100,10 @@ public Ptsv2payoutsOrderInformationBillTo address1(String address1) { } /** - * Payment card 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, Visa Platform Connect 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card 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. **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` request-level field description 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 = "Payment card 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, Visa Platform Connect 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card 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. **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` request-level field description 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; } @@ -118,10 +118,10 @@ public Ptsv2payoutsOrderInformationBillTo address2(String address2) { } /** - * 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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 description 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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 description 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; } @@ -136,10 +136,10 @@ public Ptsv2payoutsOrderInformationBillTo country(String country) { } /** - * Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card billing country. 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. **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 description 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 = "Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card billing country. 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. **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 description 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; } @@ -154,10 +154,10 @@ public Ptsv2payoutsOrderInformationBillTo locality(String locality) { } /** - * Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card billing city. #### 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 description 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 = "Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card billing city. #### 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 description 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; } @@ -172,10 +172,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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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 description 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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 description 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; } @@ -208,10 +208,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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. + * 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. ") + @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 e8747cb61..740ab9ea4 100644 --- a/src/main/java/Model/Ptsv2payoutsPaymentInformation.java +++ b/src/main/java/Model/Ptsv2payoutsPaymentInformation.java @@ -28,7 +28,7 @@ /** * Ptsv2payoutsPaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2payoutsPaymentInformation { @SerializedName("card") private Ptsv2payoutsPaymentInformationCard card = null; diff --git a/src/main/java/Model/Ptsv2payoutsPaymentInformationCard.java b/src/main/java/Model/Ptsv2payoutsPaymentInformationCard.java index aab9dbd5c..0046b3bd7 100644 --- a/src/main/java/Model/Ptsv2payoutsPaymentInformationCard.java +++ b/src/main/java/Model/Ptsv2payoutsPaymentInformationCard.java @@ -26,7 +26,7 @@ /** * Ptsv2payoutsPaymentInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2payoutsPaymentInformationCard { @SerializedName("type") private String type = null; @@ -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 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 + * 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 CyberSource through VisaNet (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 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 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 ") + @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 CyberSource through VisaNet (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 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 e81c52df2..dc556ecee 100644 --- a/src/main/java/Model/Ptsv2payoutsProcessingInformation.java +++ b/src/main/java/Model/Ptsv2payoutsProcessingInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2payoutsProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2payoutsProcessingInformation { @SerializedName("businessApplicationId") private String businessApplicationId = null; diff --git a/src/main/java/Model/Ptsv2payoutsProcessingInformationPayoutsOptions.java b/src/main/java/Model/Ptsv2payoutsProcessingInformationPayoutsOptions.java index 9c43116de..77d7a9b6e 100644 --- a/src/main/java/Model/Ptsv2payoutsProcessingInformationPayoutsOptions.java +++ b/src/main/java/Model/Ptsv2payoutsProcessingInformationPayoutsOptions.java @@ -26,7 +26,7 @@ /** * Ptsv2payoutsProcessingInformationPayoutsOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Ptsv2payoutsProcessingInformationPayoutsOptions { @SerializedName("acquirerMerchantId") private String acquirerMerchantId = null; @@ -82,10 +82,10 @@ public Ptsv2payoutsProcessingInformationPayoutsOptions retrievalReferenceNumber( } /** - * 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. + * 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. Format: Positions 1-4: The yddd equivalent of the date, where y = 0-9 and ddd = 001 – 366. Positions 5-12: A unique identification number generated by the merchant * Applicable only for CTV for Payouts. * @return retrievalReferenceNumber **/ - @ApiModelProperty(value = "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. ") + @ApiModelProperty(value = "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. Format: Positions 1-4: The yddd equivalent of the date, where y = 0-9 and ddd = 001 – 366. Positions 5-12: A unique identification number generated by the merchant * Applicable only for CTV for Payouts. ") public String getRetrievalReferenceNumber() { return retrievalReferenceNumber; } diff --git a/src/main/java/Model/Ptsv2payoutsRecipientInformation.java b/src/main/java/Model/Ptsv2payoutsRecipientInformation.java index b7e8456c0..15984fd08 100644 --- a/src/main/java/Model/Ptsv2payoutsRecipientInformation.java +++ b/src/main/java/Model/Ptsv2payoutsRecipientInformation.java @@ -26,7 +26,7 @@ /** * Ptsv2payoutsRecipientInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 725310591..9d3324b65 100644 --- a/src/main/java/Model/Ptsv2payoutsSenderInformation.java +++ b/src/main/java/Model/Ptsv2payoutsSenderInformation.java @@ -27,7 +27,7 @@ /** * Ptsv2payoutsSenderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 e84600ea0..8e5d08173 100644 --- a/src/main/java/Model/Ptsv2payoutsSenderInformationAccount.java +++ b/src/main/java/Model/Ptsv2payoutsSenderInformationAccount.java @@ -26,7 +26,7 @@ /** * Ptsv2payoutsSenderInformationAccount */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 74458a757..50c67b322 100644 --- a/src/main/java/Model/RefundCaptureRequest.java +++ b/src/main/java/Model/RefundCaptureRequest.java @@ -38,7 +38,7 @@ /** * RefundCaptureRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 ef023264d..1f3359053 100644 --- a/src/main/java/Model/RefundPaymentRequest.java +++ b/src/main/java/Model/RefundPaymentRequest.java @@ -38,7 +38,7 @@ /** * RefundPaymentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 67969b07a..0c5906041 100644 --- a/src/main/java/Model/ReportingV3ConversionDetailsGet200Response.java +++ b/src/main/java/Model/ReportingV3ConversionDetailsGet200Response.java @@ -30,7 +30,7 @@ /** * ReportingV3ConversionDetailsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 7f1e19925..1930d8094 100644 --- a/src/main/java/Model/ReportingV3ConversionDetailsGet200ResponseConversionDetails.java +++ b/src/main/java/Model/ReportingV3ConversionDetailsGet200ResponseConversionDetails.java @@ -30,7 +30,7 @@ /** * ReportingV3ConversionDetailsGet200ResponseConversionDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 de5c5baed..c56b72909 100644 --- a/src/main/java/Model/ReportingV3ConversionDetailsGet200ResponseNotes.java +++ b/src/main/java/Model/ReportingV3ConversionDetailsGet200ResponseNotes.java @@ -27,7 +27,7 @@ /** * ReportingV3ConversionDetailsGet200ResponseNotes */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 37ebe934f..e57c2c278 100644 --- a/src/main/java/Model/ReportingV3NetFundingsGet200Response.java +++ b/src/main/java/Model/ReportingV3NetFundingsGet200Response.java @@ -31,7 +31,7 @@ /** * ReportingV3NetFundingsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 d065a1270..0427cd699 100644 --- a/src/main/java/Model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.java +++ b/src/main/java/Model/ReportingV3NetFundingsGet200ResponseNetFundingSummaries.java @@ -26,7 +26,7 @@ /** * ReportingV3NetFundingsGet200ResponseNetFundingSummaries */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ReportingV3NetFundingsGet200ResponseNetFundingSummaries { @SerializedName("type") private String type = null; diff --git a/src/main/java/Model/ReportingV3NetFundingsGet200ResponseTotalPurchases.java b/src/main/java/Model/ReportingV3NetFundingsGet200ResponseTotalPurchases.java index 81dfc9d2b..06ccf7e7d 100644 --- a/src/main/java/Model/ReportingV3NetFundingsGet200ResponseTotalPurchases.java +++ b/src/main/java/Model/ReportingV3NetFundingsGet200ResponseTotalPurchases.java @@ -26,7 +26,7 @@ /** * ReportingV3NetFundingsGet200ResponseTotalPurchases */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 245558594..0163036ba 100644 --- a/src/main/java/Model/ReportingV3NotificationofChangesGet200Response.java +++ b/src/main/java/Model/ReportingV3NotificationofChangesGet200Response.java @@ -29,7 +29,7 @@ /** * ReportingV3NotificationofChangesGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 48aa7f11d..51ce51f3e 100644 --- a/src/main/java/Model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.java +++ b/src/main/java/Model/ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges.java @@ -28,7 +28,7 @@ * Notification Of Change */ @ApiModel(description = "Notification Of Change") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ReportingV3NotificationofChangesGet200ResponseNotificationOfChanges { @SerializedName("merchantReferenceNumber") private String merchantReferenceNumber = null; diff --git a/src/main/java/Model/ReportingV3PaymentBatchSummariesGet200Response.java b/src/main/java/Model/ReportingV3PaymentBatchSummariesGet200Response.java new file mode 100644 index 000000000..6769aa0b8 --- /dev/null +++ b/src/main/java/Model/ReportingV3PaymentBatchSummariesGet200Response.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.ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries; +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; + +/** + * ReportingV3PaymentBatchSummariesGet200Response + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") +public class ReportingV3PaymentBatchSummariesGet200Response { + @SerializedName("startTime") + private DateTime startTime = null; + + @SerializedName("endTime") + private DateTime endTime = null; + + @SerializedName("paymentBatchSummaries") + private List paymentBatchSummaries = null; + + public ReportingV3PaymentBatchSummariesGet200Response 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 ReportingV3PaymentBatchSummariesGet200Response 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 ReportingV3PaymentBatchSummariesGet200Response paymentBatchSummaries(List paymentBatchSummaries) { + this.paymentBatchSummaries = paymentBatchSummaries; + return this; + } + + public ReportingV3PaymentBatchSummariesGet200Response addPaymentBatchSummariesItem(ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries 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; + } + ReportingV3PaymentBatchSummariesGet200Response reportingV3PaymentBatchSummariesGet200Response = (ReportingV3PaymentBatchSummariesGet200Response) o; + return Objects.equals(this.startTime, reportingV3PaymentBatchSummariesGet200Response.startTime) && + Objects.equals(this.endTime, reportingV3PaymentBatchSummariesGet200Response.endTime) && + Objects.equals(this.paymentBatchSummaries, reportingV3PaymentBatchSummariesGet200Response.paymentBatchSummaries); + } + + @Override + public int hashCode() { + return Objects.hash(startTime, endTime, paymentBatchSummaries); + } + + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ReportingV3PaymentBatchSummariesGet200Response {\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/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.java b/src/main/java/Model/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.java new file mode 100644 index 000000000..72b73691c --- /dev/null +++ b/src/main/java/Model/ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.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; + +/** + * ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries + */ +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") +public class ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries { + @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 ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries 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 ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries 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 ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries 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 ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries 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 ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries 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 ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries 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 ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries 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 ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries 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 ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries 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 ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries 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 ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries 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 ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries 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; + } + ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries reportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries = (ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries) o; + return Objects.equals(this.currencyCode, reportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.currencyCode) && + Objects.equals(this.paymentSubTypeDescription, reportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.paymentSubTypeDescription) && + Objects.equals(this.startTime, reportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.startTime) && + Objects.equals(this.endTime, reportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.endTime) && + Objects.equals(this.salesCount, reportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.salesCount) && + Objects.equals(this.salesAmount, reportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.salesAmount) && + Objects.equals(this.creditCount, reportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.creditCount) && + Objects.equals(this.creditAmount, reportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.creditAmount) && + Objects.equals(this.accountName, reportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.accountName) && + Objects.equals(this.accountId, reportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.accountId) && + Objects.equals(this.merchantId, reportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.merchantId) && + Objects.equals(this.merchantName, reportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries.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 ReportingV3PaymentBatchSummariesGet200ResponsePaymentBatchSummaries {\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/ReportingV3PurchaseRefundDetailsGet200Response.java b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200Response.java index 53a073409..a5fcd2ffc 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200Response.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200Response.java @@ -34,7 +34,7 @@ /** * ReportingV3PurchaseRefundDetailsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 ac1299fea..5466d2a64 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseAuthorizations.java @@ -28,7 +28,7 @@ * Authorization Info Values */ @ApiModel(description = "Authorization Info Values") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 bb238a4f7..fb6b63f39 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.java @@ -27,7 +27,7 @@ * Fee Funding Section */ @ApiModel(description = "Fee Funding Section") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails { @SerializedName("requestId") private String requestId = null; @@ -35,6 +35,15 @@ public class ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails @SerializedName("interchangePerItemFee") private String interchangePerItemFee = null; + @SerializedName("interchangeDescription") + private String interchangeDescription = null; + + @SerializedName("interchangePercentage") + private String interchangePercentage = null; + + @SerializedName("interchangePercentageAmount") + private String interchangePercentageAmount = null; + @SerializedName("discountPercentage") private String discountPercentage = null; @@ -95,6 +104,60 @@ public void setInterchangePerItemFee(String interchangePerItemFee) { this.interchangePerItemFee = interchangePerItemFee; } + public ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails interchangeDescription(String interchangeDescription) { + this.interchangeDescription = interchangeDescription; + return this; + } + + /** + * interchange Description + * @return interchangeDescription + **/ + @ApiModelProperty(example = "Visa International Assessments (Enhanced)", value = "interchange Description") + public String getInterchangeDescription() { + return interchangeDescription; + } + + public void setInterchangeDescription(String interchangeDescription) { + this.interchangeDescription = interchangeDescription; + } + + public ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails interchangePercentage(String interchangePercentage) { + this.interchangePercentage = interchangePercentage; + return this; + } + + /** + * interchange Percentage + * @return interchangePercentage + **/ + @ApiModelProperty(example = "0.25", value = "interchange Percentage") + public String getInterchangePercentage() { + return interchangePercentage; + } + + public void setInterchangePercentage(String interchangePercentage) { + this.interchangePercentage = interchangePercentage; + } + + public ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails interchangePercentageAmount(String interchangePercentageAmount) { + this.interchangePercentageAmount = interchangePercentageAmount; + return this; + } + + /** + * interchange Percentage Amount + * @return interchangePercentageAmount + **/ + @ApiModelProperty(example = "-3.7500", value = "interchange Percentage Amount") + public String getInterchangePercentageAmount() { + return interchangePercentageAmount; + } + + public void setInterchangePercentageAmount(String interchangePercentageAmount) { + this.interchangePercentageAmount = interchangePercentageAmount; + } + public ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails discountPercentage(String discountPercentage) { this.discountPercentage = discountPercentage; return this; @@ -251,6 +314,9 @@ public boolean equals(java.lang.Object o) { ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails reportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails = (ReportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails) o; return Objects.equals(this.requestId, reportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.requestId) && Objects.equals(this.interchangePerItemFee, reportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.interchangePerItemFee) && + Objects.equals(this.interchangeDescription, reportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.interchangeDescription) && + Objects.equals(this.interchangePercentage, reportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.interchangePercentage) && + Objects.equals(this.interchangePercentageAmount, reportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.interchangePercentageAmount) && Objects.equals(this.discountPercentage, reportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.discountPercentage) && Objects.equals(this.discountAmount, reportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.discountAmount) && Objects.equals(this.discountPerItemFee, reportingV3PurchaseRefundDetailsGet200ResponseFeeAndFundingDetails.discountPerItemFee) && @@ -263,7 +329,7 @@ public boolean equals(java.lang.Object o) { @Override public int hashCode() { - return Objects.hash(requestId, interchangePerItemFee, discountPercentage, discountAmount, discountPerItemFee, totalFee, feeCurrency, duesAssessments, fundingAmount, fundingCurrency); + return Objects.hash(requestId, interchangePerItemFee, interchangeDescription, interchangePercentage, interchangePercentageAmount, discountPercentage, discountAmount, discountPerItemFee, totalFee, feeCurrency, duesAssessments, fundingAmount, fundingCurrency); } @@ -274,6 +340,9 @@ public String toString() { sb.append(" requestId: ").append(toIndentedString(requestId)).append("\n"); sb.append(" interchangePerItemFee: ").append(toIndentedString(interchangePerItemFee)).append("\n"); + sb.append(" interchangeDescription: ").append(toIndentedString(interchangeDescription)).append("\n"); + sb.append(" interchangePercentage: ").append(toIndentedString(interchangePercentage)).append("\n"); + sb.append(" interchangePercentageAmount: ").append(toIndentedString(interchangePercentageAmount)).append("\n"); sb.append(" discountPercentage: ").append(toIndentedString(discountPercentage)).append("\n"); sb.append(" discountAmount: ").append(toIndentedString(discountAmount)).append("\n"); sb.append(" discountPerItemFee: ").append(toIndentedString(discountPerItemFee)).append("\n"); diff --git a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.java b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.java index 2ecc084b3..997d72791 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseOthers.java @@ -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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 fc65b93f6..9a8c8a8d5 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseRequestDetails.java @@ -27,7 +27,7 @@ * Request Info Section */ @ApiModel(description = "Request Info Section") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 883ebba14..8c7c36c61 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlementStatuses.java @@ -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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 e8f26bac1..505921be8 100644 --- a/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.java +++ b/src/main/java/Model/ReportingV3PurchaseRefundDetailsGet200ResponseSettlements.java @@ -27,7 +27,7 @@ /** * ReportingV3PurchaseRefundDetailsGet200ResponseSettlements */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 c0c18881e..932f6fbb7 100644 --- a/src/main/java/Model/ReportingV3ReportDefinitionsGet200Response.java +++ b/src/main/java/Model/ReportingV3ReportDefinitionsGet200Response.java @@ -29,7 +29,7 @@ /** * ReportingV3ReportDefinitionsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 26f7c9132..47fa34cd7 100644 --- a/src/main/java/Model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.java +++ b/src/main/java/Model/ReportingV3ReportDefinitionsGet200ResponseReportDefinitions.java @@ -28,7 +28,7 @@ /** * ReportingV3ReportDefinitionsGet200ResponseReportDefinitions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 bc38dc2e9..7a48cb452 100644 --- a/src/main/java/Model/ReportingV3ReportDefinitionsNameGet200Response.java +++ b/src/main/java/Model/ReportingV3ReportDefinitionsNameGet200Response.java @@ -29,7 +29,7 @@ /** * ReportingV3ReportDefinitionsNameGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 33f49bdd7..e96df39f5 100644 --- a/src/main/java/Model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.java +++ b/src/main/java/Model/ReportingV3ReportDefinitionsNameGet200ResponseAttributes.java @@ -26,7 +26,7 @@ /** * ReportingV3ReportDefinitionsNameGet200ResponseAttributes */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 69161f82e..c75e9c436 100644 --- a/src/main/java/Model/ReportingV3ReportSubscriptionsGet200Response.java +++ b/src/main/java/Model/ReportingV3ReportSubscriptionsGet200Response.java @@ -29,7 +29,7 @@ /** * ReportingV3ReportSubscriptionsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 e1ac5530a..86a0b5137 100644 --- a/src/main/java/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.java +++ b/src/main/java/Model/ReportingV3ReportSubscriptionsGet200ResponseSubscriptions.java @@ -33,7 +33,7 @@ * Subscription Details */ @ApiModel(description = "Subscription Details") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ReportingV3ReportSubscriptionsGet200ResponseSubscriptions { @SerializedName("organizationId") private String organizationId = null; diff --git a/src/main/java/Model/ReportingV3ReportsGet200Response.java b/src/main/java/Model/ReportingV3ReportsGet200Response.java index 55bf16de7..ba9b4e862 100644 --- a/src/main/java/Model/ReportingV3ReportsGet200Response.java +++ b/src/main/java/Model/ReportingV3ReportsGet200Response.java @@ -29,7 +29,7 @@ /** * ReportingV3ReportsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ReportingV3ReportsGet200Response { @SerializedName("reportSearchResults") private List reportSearchResults = null; diff --git a/src/main/java/Model/ReportingV3ReportsGet200ResponseReportSearchResults.java b/src/main/java/Model/ReportingV3ReportsGet200ResponseReportSearchResults.java index 7ed83b84b..f3bad8000 100644 --- a/src/main/java/Model/ReportingV3ReportsGet200ResponseReportSearchResults.java +++ b/src/main/java/Model/ReportingV3ReportsGet200ResponseReportSearchResults.java @@ -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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ReportingV3ReportsGet200ResponseReportSearchResults { @SerializedName("reportDefinitionId") private String reportDefinitionId = null; diff --git a/src/main/java/Model/ReportingV3ReportsIdGet200Response.java b/src/main/java/Model/ReportingV3ReportsIdGet200Response.java index 1734df016..a602b2663 100644 --- a/src/main/java/Model/ReportingV3ReportsIdGet200Response.java +++ b/src/main/java/Model/ReportingV3ReportsIdGet200Response.java @@ -33,7 +33,7 @@ * Report Log */ @ApiModel(description = "Report Log") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ReportingV3ReportsIdGet200Response { @SerializedName("organizationId") private String organizationId = null; diff --git a/src/main/java/Model/Reportingv3ReportDownloadsGet400Response.java b/src/main/java/Model/Reportingv3ReportDownloadsGet400Response.java index 41a5ec376..029d50f0c 100644 --- a/src/main/java/Model/Reportingv3ReportDownloadsGet400Response.java +++ b/src/main/java/Model/Reportingv3ReportDownloadsGet400Response.java @@ -31,7 +31,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Reportingv3ReportDownloadsGet400Response { @SerializedName("submitTimeUtc") private DateTime submitTimeUtc = null; diff --git a/src/main/java/Model/Reportingv3ReportDownloadsGet400ResponseDetails.java b/src/main/java/Model/Reportingv3ReportDownloadsGet400ResponseDetails.java index 403be51f4..d2b65d0fd 100644 --- a/src/main/java/Model/Reportingv3ReportDownloadsGet400ResponseDetails.java +++ b/src/main/java/Model/Reportingv3ReportDownloadsGet400ResponseDetails.java @@ -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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 17a939f42..3a576bde3 100644 --- a/src/main/java/Model/Reportingv3reportsReportPreferences.java +++ b/src/main/java/Model/Reportingv3reportsReportPreferences.java @@ -27,7 +27,7 @@ * Report Preferences */ @ApiModel(description = "Report Preferences") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 86bffd297..54ec73d2b 100644 --- a/src/main/java/Model/RequestBody.java +++ b/src/main/java/Model/RequestBody.java @@ -32,7 +32,7 @@ /** * RequestBody */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 423ffe0f4..dc3864fe3 100644 --- a/src/main/java/Model/RequestBody1.java +++ b/src/main/java/Model/RequestBody1.java @@ -31,7 +31,7 @@ /** * RequestBody1 */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RequestBody1 { @SerializedName("organizationId") private String organizationId = null; diff --git a/src/main/java/Model/ResponseStatus.java b/src/main/java/Model/ResponseStatus.java index 4a08ba36e..54434adf7 100644 --- a/src/main/java/Model/ResponseStatus.java +++ b/src/main/java/Model/ResponseStatus.java @@ -30,7 +30,7 @@ /** * ResponseStatus */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ResponseStatus { @SerializedName("status") private BigDecimal status = null; diff --git a/src/main/java/Model/ResponseStatusDetails.java b/src/main/java/Model/ResponseStatusDetails.java index 69bad1f00..73b226d32 100644 --- a/src/main/java/Model/ResponseStatusDetails.java +++ b/src/main/java/Model/ResponseStatusDetails.java @@ -26,7 +26,7 @@ /** * ResponseStatusDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class ResponseStatusDetails { @SerializedName("location") private String location = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201Response.java b/src/main/java/Model/RiskV1DecisionsPost201Response.java index b05910b28..347c1bb9f 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201Response.java +++ b/src/main/java/Model/RiskV1DecisionsPost201Response.java @@ -30,7 +30,7 @@ /** * RiskV1DecisionsPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201Response { @SerializedName("_links") private PtsV2PaymentsPost201ResponseLinks links = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponsePaymentInformation.java b/src/main/java/Model/RiskV1DecisionsPost201ResponsePaymentInformation.java index 831eb5324..3438ea11e 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponsePaymentInformation.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponsePaymentInformation.java @@ -27,7 +27,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponsePaymentInformation { @SerializedName("binCountry") private String binCountry = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformation.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformation.java index bf6f8c929..7f4320e86 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformation.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformation.java @@ -37,7 +37,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformation { @SerializedName("profile") private RiskV1DecisionsPost201ResponseRiskInformationProfile profile = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.java index f73e728d5..18e6306c1 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationInfoCodes.java @@ -28,7 +28,7 @@ /** * RiskV1DecisionsPost201ResponseRiskInformationInfoCodes */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationInfoCodes { @SerializedName("velocity") private List velocity = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationIpAddress.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationIpAddress.java index 24be2f439..e610ea374 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationIpAddress.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationIpAddress.java @@ -27,7 +27,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationIpAddress { @SerializedName("anonymizerStatus") private String anonymizerStatus = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProfile.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProfile.java index 16e4c9844..af47a33df 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProfile.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProfile.java @@ -26,7 +26,7 @@ /** * RiskV1DecisionsPost201ResponseRiskInformationProfile */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationProfile { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProviders.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProviders.java index 4cd0291f6..5934296e9 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProviders.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProviders.java @@ -29,7 +29,7 @@ /** * RiskV1DecisionsPost201ResponseRiskInformationProviders */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationProviders { @SerializedName("providerName") private List providerName = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.java index 554daaf01..fda16863a 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName.java @@ -29,7 +29,7 @@ * Name of the 3rd party provider, for example, Emailage. For all possible values, see the `decision_provider_#_name` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). */ @ApiModel(description = "Name of the 3rd party provider, for example, Emailage. For all possible values, see the `decision_provider_#_name` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](https://ebc2.cybersource.com/ebc2/) Click **Decision Manager** > **Documentation** > **Guides** > _Decision Manager Using the SCMP API Developer Guide_ (PDF link). ") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationProvidersProviderName { @SerializedName("fieldName") private List fieldName = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationRules.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationRules.java index f5a8a1929..5045c0c7a 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationRules.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationRules.java @@ -26,7 +26,7 @@ /** * RiskV1DecisionsPost201ResponseRiskInformationRules */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationRules { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationScore.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationScore.java index 4e9904436..3806314c8 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationScore.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationScore.java @@ -28,7 +28,7 @@ /** * RiskV1DecisionsPost201ResponseRiskInformationScore */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationScore { @SerializedName("factorCodes") private List factorCodes = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravel.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravel.java index 147a6143b..ebece6b8f 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravel.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravel.java @@ -30,7 +30,7 @@ /** * RiskV1DecisionsPost201ResponseRiskInformationTravel */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationTravel { @SerializedName("actualFinalDestination") private RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination actualFinalDestination = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination.java index 587c5b730..d58fbc1ca 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination.java @@ -26,7 +26,7 @@ /** * RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationTravelActualFinalDestination { @SerializedName("country") private String country = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture.java index 033631a71..5dab5f967 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture.java @@ -26,7 +26,7 @@ /** * RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDeparture { @SerializedName("country") private String country = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination.java index 0501c8873..9edc3b404 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination.java @@ -26,7 +26,7 @@ /** * RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationTravelFirstDestination { @SerializedName("country") private String country = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination.java index 59af57032..991b8fce8 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination.java @@ -26,7 +26,7 @@ /** * RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationTravelLastDestination { @SerializedName("country") private String country = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocity.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocity.java index 2fc66f1a3..61ef04a34 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocity.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocity.java @@ -29,7 +29,7 @@ /** * RiskV1DecisionsPost201ResponseRiskInformationVelocity */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationVelocity { @SerializedName("morphing") private List morphing = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.java b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.java index 25a1dc627..96c41021f 100644 --- a/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.java +++ b/src/main/java/Model/RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing.java @@ -26,7 +26,7 @@ /** * RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost201ResponseRiskInformationVelocityMorphing { @SerializedName("count") private Integer count = null; diff --git a/src/main/java/Model/RiskV1DecisionsPost400Response.java b/src/main/java/Model/RiskV1DecisionsPost400Response.java index a236b7065..27391639e 100644 --- a/src/main/java/Model/RiskV1DecisionsPost400Response.java +++ b/src/main/java/Model/RiskV1DecisionsPost400Response.java @@ -29,7 +29,7 @@ /** * RiskV1DecisionsPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class RiskV1DecisionsPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; diff --git a/src/main/java/Model/Riskv1decisionsBuyerInformation.java b/src/main/java/Model/Riskv1decisionsBuyerInformation.java index 8874ff24c..0aaa4643e 100644 --- a/src/main/java/Model/Riskv1decisionsBuyerInformation.java +++ b/src/main/java/Model/Riskv1decisionsBuyerInformation.java @@ -30,7 +30,7 @@ * Contains information about the buyer. */ @ApiModel(description = "Contains information about the buyer.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsBuyerInformation { @SerializedName("username") private String username = null; diff --git a/src/main/java/Model/Riskv1decisionsCardVerification.java b/src/main/java/Model/Riskv1decisionsCardVerification.java index 6fa03539e..e534e5980 100644 --- a/src/main/java/Model/Riskv1decisionsCardVerification.java +++ b/src/main/java/Model/Riskv1decisionsCardVerification.java @@ -26,7 +26,7 @@ /** * Riskv1decisionsCardVerification */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsCardVerification { @SerializedName("resultCode") private String resultCode = null; diff --git a/src/main/java/Model/Riskv1decisionsClientReferenceInformation.java b/src/main/java/Model/Riskv1decisionsClientReferenceInformation.java index 3b617a8e1..f0c333cf8 100644 --- a/src/main/java/Model/Riskv1decisionsClientReferenceInformation.java +++ b/src/main/java/Model/Riskv1decisionsClientReferenceInformation.java @@ -26,7 +26,7 @@ /** * Riskv1decisionsClientReferenceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsClientReferenceInformation { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/Riskv1decisionsDeviceInformation.java b/src/main/java/Model/Riskv1decisionsDeviceInformation.java index 3e5bf239d..6c93c00f2 100644 --- a/src/main/java/Model/Riskv1decisionsDeviceInformation.java +++ b/src/main/java/Model/Riskv1decisionsDeviceInformation.java @@ -26,7 +26,7 @@ /** * Riskv1decisionsDeviceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsDeviceInformation { @SerializedName("cookiesAccepted") private String cookiesAccepted = null; diff --git a/src/main/java/Model/Riskv1decisionsMerchantDefinedInformation.java b/src/main/java/Model/Riskv1decisionsMerchantDefinedInformation.java index 5b5869639..9f921b2ae 100644 --- a/src/main/java/Model/Riskv1decisionsMerchantDefinedInformation.java +++ b/src/main/java/Model/Riskv1decisionsMerchantDefinedInformation.java @@ -27,7 +27,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsMerchantDefinedInformation { @SerializedName("key") private String key = null; diff --git a/src/main/java/Model/Riskv1decisionsOrderInformation.java b/src/main/java/Model/Riskv1decisionsOrderInformation.java index c7c020653..ce44d61bc 100644 --- a/src/main/java/Model/Riskv1decisionsOrderInformation.java +++ b/src/main/java/Model/Riskv1decisionsOrderInformation.java @@ -34,7 +34,7 @@ * Contains detailed order-level information. */ @ApiModel(description = "Contains detailed order-level information.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsOrderInformation { @SerializedName("amountDetails") private Riskv1decisionsOrderInformationAmountDetails amountDetails = null; diff --git a/src/main/java/Model/Riskv1decisionsOrderInformationAmountDetails.java b/src/main/java/Model/Riskv1decisionsOrderInformationAmountDetails.java index c4d293097..0b2f11780 100644 --- a/src/main/java/Model/Riskv1decisionsOrderInformationAmountDetails.java +++ b/src/main/java/Model/Riskv1decisionsOrderInformationAmountDetails.java @@ -27,7 +27,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsOrderInformationAmountDetails { @SerializedName("currency") private String currency = null; @@ -59,10 +59,10 @@ public Riskv1decisionsOrderInformationAmountDetails totalAmount(String totalAmou } /** - * 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. + * 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. * @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. ") + @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. ") public String getTotalAmount() { return totalAmount; } diff --git a/src/main/java/Model/Riskv1decisionsOrderInformationBillTo.java b/src/main/java/Model/Riskv1decisionsOrderInformationBillTo.java index 9877a1ff7..a131658c5 100644 --- a/src/main/java/Model/Riskv1decisionsOrderInformationBillTo.java +++ b/src/main/java/Model/Riskv1decisionsOrderInformationBillTo.java @@ -26,7 +26,7 @@ /** * Riskv1decisionsOrderInformationBillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsOrderInformationBillTo { @SerializedName("address1") private String address1 = null; @@ -64,10 +64,10 @@ public Riskv1decisionsOrderInformationBillTo address1(String address1) { } /** - * Payment card 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, Visa Platform Connect 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card 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. **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` request-level field description 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 = "Payment card 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, Visa Platform Connect 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card 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. **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` request-level field description 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; } @@ -82,10 +82,10 @@ public Riskv1decisionsOrderInformationBillTo address2(String address2) { } /** - * 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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 description 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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 description 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; } @@ -100,10 +100,10 @@ public Riskv1decisionsOrderInformationBillTo administrativeArea(String administr } /** - * 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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 description 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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 description 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; } @@ -118,10 +118,10 @@ public Riskv1decisionsOrderInformationBillTo country(String country) { } /** - * Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card billing country. 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. **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 description 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 = "Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card billing country. 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. **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 description 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; } @@ -136,10 +136,10 @@ public Riskv1decisionsOrderInformationBillTo locality(String locality) { } /** - * Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card billing city. #### 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 description 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 = "Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card billing city. #### 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 description 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; } @@ -190,10 +190,10 @@ public Riskv1decisionsOrderInformationBillTo 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. + * 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. ") + @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; } @@ -208,10 +208,10 @@ public Riskv1decisionsOrderInformationBillTo email(String email) { } /** - * 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. **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` request-level field description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. * @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. **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` request-level field description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. ") public String getEmail() { return email; } diff --git a/src/main/java/Model/Riskv1decisionsOrderInformationLineItems.java b/src/main/java/Model/Riskv1decisionsOrderInformationLineItems.java index 500e7a3a2..6dbf75be7 100644 --- a/src/main/java/Model/Riskv1decisionsOrderInformationLineItems.java +++ b/src/main/java/Model/Riskv1decisionsOrderInformationLineItems.java @@ -28,7 +28,7 @@ /** * Riskv1decisionsOrderInformationLineItems */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsOrderInformationLineItems { @SerializedName("unitPrice") private String unitPrice = null; diff --git a/src/main/java/Model/Riskv1decisionsOrderInformationPassenger.java b/src/main/java/Model/Riskv1decisionsOrderInformationPassenger.java index 758fd8f37..11742d0f8 100644 --- a/src/main/java/Model/Riskv1decisionsOrderInformationPassenger.java +++ b/src/main/java/Model/Riskv1decisionsOrderInformationPassenger.java @@ -27,7 +27,7 @@ * Contains travel-related passenger details. */ @ApiModel(description = "Contains travel-related passenger details.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsOrderInformationPassenger { @SerializedName("type") private String type = null; diff --git a/src/main/java/Model/Riskv1decisionsOrderInformationShipTo.java b/src/main/java/Model/Riskv1decisionsOrderInformationShipTo.java index bc4cbad3e..53aabb7af 100644 --- a/src/main/java/Model/Riskv1decisionsOrderInformationShipTo.java +++ b/src/main/java/Model/Riskv1decisionsOrderInformationShipTo.java @@ -27,7 +27,7 @@ * Contains recipient shipping information. */ @ApiModel(description = "Contains recipient shipping information.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsOrderInformationShipTo { @SerializedName("address1") private String address1 = null; diff --git a/src/main/java/Model/Riskv1decisionsOrderInformationShippingDetails.java b/src/main/java/Model/Riskv1decisionsOrderInformationShippingDetails.java index a37a6ba45..695ceadf9 100644 --- a/src/main/java/Model/Riskv1decisionsOrderInformationShippingDetails.java +++ b/src/main/java/Model/Riskv1decisionsOrderInformationShippingDetails.java @@ -27,7 +27,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsOrderInformationShippingDetails { @SerializedName("giftWrap") private Boolean giftWrap = null; diff --git a/src/main/java/Model/Riskv1decisionsPaymentInformation.java b/src/main/java/Model/Riskv1decisionsPaymentInformation.java index dc0397c4c..85e5ca131 100644 --- a/src/main/java/Model/Riskv1decisionsPaymentInformation.java +++ b/src/main/java/Model/Riskv1decisionsPaymentInformation.java @@ -29,7 +29,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsPaymentInformation { @SerializedName("card") private Riskv1decisionsPaymentInformationCard card = null; diff --git a/src/main/java/Model/Riskv1decisionsPaymentInformationCard.java b/src/main/java/Model/Riskv1decisionsPaymentInformationCard.java index b7a45bfbf..3cbbcd8bc 100644 --- a/src/main/java/Model/Riskv1decisionsPaymentInformationCard.java +++ b/src/main/java/Model/Riskv1decisionsPaymentInformationCard.java @@ -27,7 +27,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsPaymentInformationCard { @SerializedName("number") private String number = null; diff --git a/src/main/java/Model/Riskv1decisionsPaymentInformationTokenizedCard.java b/src/main/java/Model/Riskv1decisionsPaymentInformationTokenizedCard.java index 7fd5f5e1c..9b12146f2 100644 --- a/src/main/java/Model/Riskv1decisionsPaymentInformationTokenizedCard.java +++ b/src/main/java/Model/Riskv1decisionsPaymentInformationTokenizedCard.java @@ -27,7 +27,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsPaymentInformationTokenizedCard { @SerializedName("type") private String type = null; diff --git a/src/main/java/Model/Riskv1decisionsProcessorInformation.java b/src/main/java/Model/Riskv1decisionsProcessorInformation.java index 3ca4077ed..c60560539 100644 --- a/src/main/java/Model/Riskv1decisionsProcessorInformation.java +++ b/src/main/java/Model/Riskv1decisionsProcessorInformation.java @@ -28,7 +28,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsProcessorInformation { @SerializedName("avs") private Riskv1decisionsProcessorInformationAvs avs = null; diff --git a/src/main/java/Model/Riskv1decisionsProcessorInformationAvs.java b/src/main/java/Model/Riskv1decisionsProcessorInformationAvs.java index e0dce5e1f..40964bda0 100644 --- a/src/main/java/Model/Riskv1decisionsProcessorInformationAvs.java +++ b/src/main/java/Model/Riskv1decisionsProcessorInformationAvs.java @@ -27,7 +27,7 @@ * Address Verification Service */ @ApiModel(description = "Address Verification Service") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsProcessorInformationAvs { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/Riskv1decisionsRiskInformation.java b/src/main/java/Model/Riskv1decisionsRiskInformation.java index bdeaa1351..b82a5d976 100644 --- a/src/main/java/Model/Riskv1decisionsRiskInformation.java +++ b/src/main/java/Model/Riskv1decisionsRiskInformation.java @@ -27,7 +27,7 @@ /** * Riskv1decisionsRiskInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsRiskInformation { @SerializedName("profile") private Riskv1decisionsRiskInformationProfile profile = null; diff --git a/src/main/java/Model/Riskv1decisionsRiskInformationProfile.java b/src/main/java/Model/Riskv1decisionsRiskInformationProfile.java index 520ce61c4..2da6ca438 100644 --- a/src/main/java/Model/Riskv1decisionsRiskInformationProfile.java +++ b/src/main/java/Model/Riskv1decisionsRiskInformationProfile.java @@ -27,7 +27,7 @@ * Identifies a risk profile. */ @ApiModel(description = "Identifies a risk profile.") -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsRiskInformationProfile { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/Riskv1decisionsTravelInformation.java b/src/main/java/Model/Riskv1decisionsTravelInformation.java index a8a6a128b..b90d5ed2c 100644 --- a/src/main/java/Model/Riskv1decisionsTravelInformation.java +++ b/src/main/java/Model/Riskv1decisionsTravelInformation.java @@ -29,7 +29,7 @@ /** * Riskv1decisionsTravelInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsTravelInformation { @SerializedName("actualFinalDestination") private String actualFinalDestination = null; diff --git a/src/main/java/Model/Riskv1decisionsTravelInformationLegs.java b/src/main/java/Model/Riskv1decisionsTravelInformationLegs.java index cfea51b58..17e18ce49 100644 --- a/src/main/java/Model/Riskv1decisionsTravelInformationLegs.java +++ b/src/main/java/Model/Riskv1decisionsTravelInformationLegs.java @@ -26,7 +26,7 @@ /** * Riskv1decisionsTravelInformationLegs */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Riskv1decisionsTravelInformationLegs { @SerializedName("origination") private String origination = null; diff --git a/src/main/java/Model/SelfLinkBean.java b/src/main/java/Model/SelfLinkBean.java index e88fa7a11..45233ab17 100644 --- a/src/main/java/Model/SelfLinkBean.java +++ b/src/main/java/Model/SelfLinkBean.java @@ -26,7 +26,7 @@ /** * SelfLinkBean */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class SelfLinkBean { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409Response.java b/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409Response.java index 04780259b..5c5266f69 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409Response.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409Response.java @@ -27,7 +27,7 @@ /** * TmsV1InstrumentIdentifiersDelete409Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersDelete409Response { @SerializedName("_links") private TmsV1InstrumentIdentifiersDelete409ResponseLinks links = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinks.java b/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinks.java index 3caf61618..6fddc2850 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinks.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinks.java @@ -27,7 +27,7 @@ /** * TmsV1InstrumentIdentifiersDelete409ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersDelete409ResponseLinks { @SerializedName("paymentInstruments") private TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments paymentInstruments = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments.java b/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments.java index f4fd9af28..daf3fe729 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersDelete409ResponseLinksPaymentInstruments { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.java index 38484a55b..b132f74db 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response.java @@ -28,7 +28,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response { @SerializedName("_links") private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks links = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded.java index 4eecf7eaa..6da928ec7 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded.java @@ -29,7 +29,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbedded { @SerializedName("paymentInstruments") private List paymentInstruments = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.java index 7ab024846..bd24df1f5 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBankAccount { @SerializedName("type") private String type = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.java index 55a29fa80..3ae15f6ca 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBillTo { @SerializedName("firstName") private String firstName = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.java index 4ba7628fe..924cc757c 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation.java @@ -29,7 +29,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation { @SerializedName("companyTaxID") private String companyTaxID = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy.java index dd70c0704..7c9c20cf1 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationIssuedBy { @SerializedName("administrativeArea") private String administrativeArea = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.java index 3f9f1d136..f3b1ea086 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification.java @@ -27,7 +27,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification { @SerializedName("id") private String id = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.java index a1d29c546..fbb8eadf7 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedCard { @SerializedName("expirationMonth") private String expirationMonth = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.java index 1b9551cc9..a2bc0d93c 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier.java @@ -14,11 +14,11 @@ package Model; import java.util.Objects; -import Model.TmsV1InstrumentIdentifiersPost200ResponseBankAccount; import Model.TmsV1InstrumentIdentifiersPost200ResponseCard; import Model.TmsV1InstrumentIdentifiersPost200ResponseLinks; import Model.TmsV1InstrumentIdentifiersPost200ResponseMetadata; import Model.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation; +import Model.Tmsv1instrumentidentifiersBankAccount; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -31,7 +31,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier { @SerializedName("_links") private TmsV1InstrumentIdentifiersPost200ResponseLinks links = null; @@ -49,7 +49,7 @@ public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedI private TmsV1InstrumentIdentifiersPost200ResponseCard card = null; @SerializedName("bankAccount") - private TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount = null; + private Tmsv1instrumentidentifiersBankAccount bankAccount = null; @SerializedName("processingInformation") private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation = null; @@ -85,10 +85,10 @@ public String getObject() { } /** - * 'Current state of the token.' Valid values: - ACTIVE - CLOSED + * 'Current state of the token.' Valid values: - ACTIVE - CLOSED * @return state **/ - @ApiModelProperty(example = "ACTIVE", value = "'Current state of the token.' Valid values: - ACTIVE - CLOSED ") + @ApiModelProperty(example = "ACTIVE", value = "'Current state of the token.' Valid values: - ACTIVE - CLOSED ") public String getState() { return state; } @@ -129,7 +129,7 @@ public void setCard(TmsV1InstrumentIdentifiersPost200ResponseCard card) { this.card = card; } - public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier bankAccount(TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount) { + public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrumentIdentifier bankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { this.bankAccount = bankAccount; return this; } @@ -139,11 +139,11 @@ public TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedInstrum * @return bankAccount **/ @ApiModelProperty(value = "") - public TmsV1InstrumentIdentifiersPost200ResponseBankAccount getBankAccount() { + public Tmsv1instrumentidentifiersBankAccount getBankAccount() { return bankAccount; } - public void setBankAccount(TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount) { + public void setBankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { this.bankAccount = bankAccount; } diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.java index e7b255f2a..f3e692306 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation.java @@ -27,7 +27,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformation { @SerializedName("merchantDescriptor") private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor merchantDescriptor = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor.java index 07f349ff0..8f7ecc98f 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedMerchantInformationMerchantDescriptor { @SerializedName("alternateName") private String alternateName = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.java index be100ecbf..a5e02e7c3 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments.java @@ -35,7 +35,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments { @SerializedName("_links") private TmsV1InstrumentIdentifiersPost200ResponseLinks links = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.java index adf30e63d..805306141 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation.java @@ -27,7 +27,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformation { @SerializedName("billPaymentProgramEnabled") private Boolean billPaymentProgramEnabled = false; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions.java index e4bd31983..6e32357ee 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedProcessingInformationBankTransferOptions { @SerializedName("SECCode") private String seCCode = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.java index 43aa8b4c6..005cc3f68 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks.java @@ -31,7 +31,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinks { @SerializedName("self") private TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf self = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst.java index aaad115b2..9becf2c3c 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksFirst { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast.java index 7bc8051eb..0cbb30cf1 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksLast { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext.java index 8e84b3afd..2d4f34d8c 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksNext { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev.java index f97e0b90c..6de1e3a27 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev.java @@ -27,7 +27,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksPrev { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf.java index efec37fb2..5341f4a0a 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseLinksSelf { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200Response.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200Response.java index 3fe2867b4..7c5e1b9ba 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200Response.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200Response.java @@ -14,11 +14,11 @@ package Model; import java.util.Objects; -import Model.TmsV1InstrumentIdentifiersPost200ResponseBankAccount; import Model.TmsV1InstrumentIdentifiersPost200ResponseCard; import Model.TmsV1InstrumentIdentifiersPost200ResponseLinks; import Model.TmsV1InstrumentIdentifiersPost200ResponseMetadata; import Model.TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation; +import Model.Tmsv1instrumentidentifiersBankAccount; import com.google.gson.TypeAdapter; import com.google.gson.annotations.JsonAdapter; import com.google.gson.annotations.SerializedName; @@ -31,7 +31,7 @@ /** * TmsV1InstrumentIdentifiersPost200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPost200Response { @SerializedName("_links") private TmsV1InstrumentIdentifiersPost200ResponseLinks links = null; @@ -49,7 +49,7 @@ public class TmsV1InstrumentIdentifiersPost200Response { private TmsV1InstrumentIdentifiersPost200ResponseCard card = null; @SerializedName("bankAccount") - private TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount = null; + private Tmsv1instrumentidentifiersBankAccount bankAccount = null; @SerializedName("processingInformation") private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation = null; @@ -120,7 +120,7 @@ public void setCard(TmsV1InstrumentIdentifiersPost200ResponseCard card) { this.card = card; } - public TmsV1InstrumentIdentifiersPost200Response bankAccount(TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount) { + public TmsV1InstrumentIdentifiersPost200Response bankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { this.bankAccount = bankAccount; return this; } @@ -130,11 +130,11 @@ public TmsV1InstrumentIdentifiersPost200Response bankAccount(TmsV1InstrumentIden * @return bankAccount **/ @ApiModelProperty(value = "") - public TmsV1InstrumentIdentifiersPost200ResponseBankAccount getBankAccount() { + public Tmsv1instrumentidentifiersBankAccount getBankAccount() { return bankAccount; } - public void setBankAccount(TmsV1InstrumentIdentifiersPost200ResponseBankAccount bankAccount) { + public void setBankAccount(Tmsv1instrumentidentifiersBankAccount bankAccount) { this.bankAccount = bankAccount; } diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseCard.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseCard.java index 0ff9dafd6..d43c52e21 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseCard.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseCard.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPost200ResponseCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPost200ResponseCard { @SerializedName("number") private String number = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinks.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinks.java index 62024c9e0..c7a5d352d 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinks.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinks.java @@ -27,7 +27,7 @@ /** * TmsV1InstrumentIdentifiersPost200ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPost200ResponseLinks { @SerializedName("self") private TmsV1InstrumentIdentifiersPost200ResponseLinksSelf self = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.java index 3acbc196f..62b021aba 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseLinksSelf.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPost200ResponseLinksSelf */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPost200ResponseLinksSelf { @SerializedName("href") private String href = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseMetadata.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseMetadata.java index 23575e07c..87edf78ca 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseMetadata.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseMetadata.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPost200ResponseMetadata */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPost200ResponseMetadata { @SerializedName("creator") private String creator = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.java index 7e2754031..04fb20f33 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation.java @@ -27,7 +27,7 @@ /** * TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation { @SerializedName("authorizationOptions") private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions authorizationOptions = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions.java index a78d4de29..d097a3f62 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions.java @@ -27,7 +27,7 @@ /** * TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptions { @SerializedName("initiator") private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator initiator = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.java index d7153ef8d..911345ac9 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator.java @@ -27,7 +27,7 @@ /** * TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiator { @SerializedName("merchantInitiatedTransaction") private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction merchantInitiatedTransaction = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java index c09926550..637542d61 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java +++ b/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.java @@ -26,7 +26,7 @@ /** * TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TmsV1InstrumentIdentifiersPost200ResponseProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction { @SerializedName("previousTransactionId") private String previousTransactionId = null; diff --git a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount.java b/src/main/java/Model/Tmsv1instrumentidentifiersBankAccount.java similarity index 75% rename from src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount.java rename to src/main/java/Model/Tmsv1instrumentidentifiersBankAccount.java index 02e73f3da..d24b91b39 100644 --- a/src/main/java/Model/TmsV1InstrumentIdentifiersPost200ResponseBankAccount.java +++ b/src/main/java/Model/Tmsv1instrumentidentifiersBankAccount.java @@ -24,17 +24,17 @@ import java.io.IOException; /** - * TmsV1InstrumentIdentifiersPost200ResponseBankAccount + * Tmsv1instrumentidentifiersBankAccount */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") -public class TmsV1InstrumentIdentifiersPost200ResponseBankAccount { +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") +public class Tmsv1instrumentidentifiersBankAccount { @SerializedName("number") private String number = null; @SerializedName("routingNumber") private String routingNumber = null; - public TmsV1InstrumentIdentifiersPost200ResponseBankAccount number(String number) { + public Tmsv1instrumentidentifiersBankAccount number(String number) { this.number = number; return this; } @@ -52,7 +52,7 @@ public void setNumber(String number) { this.number = number; } - public TmsV1InstrumentIdentifiersPost200ResponseBankAccount routingNumber(String routingNumber) { + public Tmsv1instrumentidentifiersBankAccount 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; } - TmsV1InstrumentIdentifiersPost200ResponseBankAccount tmsV1InstrumentIdentifiersPost200ResponseBankAccount = (TmsV1InstrumentIdentifiersPost200ResponseBankAccount) o; - return Objects.equals(this.number, tmsV1InstrumentIdentifiersPost200ResponseBankAccount.number) && - Objects.equals(this.routingNumber, tmsV1InstrumentIdentifiersPost200ResponseBankAccount.routingNumber); + Tmsv1instrumentidentifiersBankAccount tmsv1instrumentidentifiersBankAccount = (Tmsv1instrumentidentifiersBankAccount) o; + return Objects.equals(this.number, tmsv1instrumentidentifiersBankAccount.number) && + Objects.equals(this.routingNumber, tmsv1instrumentidentifiersBankAccount.routingNumber); } @Override @@ -93,7 +93,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class TmsV1InstrumentIdentifiersPost200ResponseBankAccount {\n"); + sb.append("class Tmsv1instrumentidentifiersBankAccount {\n"); sb.append(" number: ").append(toIndentedString(number)).append("\n"); sb.append(" routingNumber: ").append(toIndentedString(routingNumber)).append("\n"); diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersBillTo.java b/src/main/java/Model/Tmsv1instrumentidentifiersBillTo.java index 05a29097a..e876d0287 100644 --- a/src/main/java/Model/Tmsv1instrumentidentifiersBillTo.java +++ b/src/main/java/Model/Tmsv1instrumentidentifiersBillTo.java @@ -26,7 +26,7 @@ /** * Tmsv1instrumentidentifiersBillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Tmsv1instrumentidentifiersBillTo { @SerializedName("address1") private String address1 = null; diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersCard.java b/src/main/java/Model/Tmsv1instrumentidentifiersCard.java index 3efb970c0..6a2c74695 100644 --- a/src/main/java/Model/Tmsv1instrumentidentifiersCard.java +++ b/src/main/java/Model/Tmsv1instrumentidentifiersCard.java @@ -26,7 +26,7 @@ /** * Tmsv1instrumentidentifiersCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Tmsv1instrumentidentifiersCard { @SerializedName("number") private String number = null; diff --git a/src/main/java/Model/Tmsv1instrumentidentifiersDetails.java b/src/main/java/Model/Tmsv1instrumentidentifiersDetails.java index babe9cb77..e0185186f 100644 --- a/src/main/java/Model/Tmsv1instrumentidentifiersDetails.java +++ b/src/main/java/Model/Tmsv1instrumentidentifiersDetails.java @@ -26,7 +26,7 @@ /** * Tmsv1instrumentidentifiersDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class Tmsv1instrumentidentifiersDetails { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/TokenizeParameters.java b/src/main/java/Model/TokenizeParameters.java index 70905ceb3..95b014e86 100644 --- a/src/main/java/Model/TokenizeParameters.java +++ b/src/main/java/Model/TokenizeParameters.java @@ -27,7 +27,7 @@ /** * TokenizeParameters */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TokenizeParameters { @SerializedName("keyId") private String keyId = null; diff --git a/src/main/java/Model/TokenizeRequest.java b/src/main/java/Model/TokenizeRequest.java index 9f8882408..ed312329f 100644 --- a/src/main/java/Model/TokenizeRequest.java +++ b/src/main/java/Model/TokenizeRequest.java @@ -27,7 +27,7 @@ /** * TokenizeRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TokenizeRequest { @SerializedName("keyId") private String keyId = null; diff --git a/src/main/java/Model/TokenizeResult.java b/src/main/java/Model/TokenizeResult.java index 4e5117554..b253522ad 100644 --- a/src/main/java/Model/TokenizeResult.java +++ b/src/main/java/Model/TokenizeResult.java @@ -29,7 +29,7 @@ /** * TokenizeResult */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TokenizeResult { @SerializedName("keyId") private String keyId = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200Response.java b/src/main/java/Model/TssV2TransactionsGet200Response.java index b630e60f7..ca5d31c9a 100644 --- a/src/main/java/Model/TssV2TransactionsGet200Response.java +++ b/src/main/java/Model/TssV2TransactionsGet200Response.java @@ -46,7 +46,7 @@ /** * TssV2TransactionsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200Response { @SerializedName("id") private String id = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformation.java index 5e282ca4e..74aa76a20 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformation.java @@ -29,7 +29,7 @@ /** * TssV2TransactionsGet200ResponseApplicationInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 ecf37f513..a75c03899 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformationApplications.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseApplicationInformationApplications.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseApplicationInformationApplications */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 5a9297ef4..4ba5a0135 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseBuyerInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseBuyerInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseBuyerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseBuyerInformation { @SerializedName("merchantCustomerId") private String merchantCustomerId = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseClientReferenceInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseClientReferenceInformation.java index e652a7b82..bb3ba585b 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseClientReferenceInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseClientReferenceInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseClientReferenceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseClientReferenceInformation { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.java index 6c2816177..8e32f5495 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseConsumerAuthenticationInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseConsumerAuthenticationInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseConsumerAuthenticationInformation { @SerializedName("eciRaw") private String eciRaw = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseDeviceInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseDeviceInformation.java index 525a5a2c2..e3bf42236 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseDeviceInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseDeviceInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseDeviceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseDeviceInformation { @SerializedName("ipAddress") private String ipAddress = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseErrorInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseErrorInformation.java index 5d79f2ea4..e81236b42 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseErrorInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseErrorInformation.java @@ -29,7 +29,7 @@ /** * TssV2TransactionsGet200ResponseErrorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseErrorInformation { @SerializedName("reason") private String reason = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseFraudMarkingInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseFraudMarkingInformation.java index 7dbf93d14..793b662a6 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseFraudMarkingInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseFraudMarkingInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseFraudMarkingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 914b6dc8a..ba2527cc7 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseInstallmentInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseInstallmentInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseInstallmentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 index 7ca588159..cb37fb554 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseLinks.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseLinks.java @@ -29,7 +29,7 @@ /** * TssV2TransactionsGet200ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseLinks { @SerializedName("self") private PtsV2PaymentsPost201ResponseLinksSelf self = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformation.java index 18506a662..4c7404cf0 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformation.java @@ -27,7 +27,7 @@ /** * TssV2TransactionsGet200ResponseMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 006498045..0086424e1 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseMerchantInformationMerchantDescriptor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 7fc8cf6bc..4c79c55b2 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformation.java @@ -33,7 +33,7 @@ /** * TssV2TransactionsGet200ResponseOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 7aebbf384..3d7125fb9 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationAmountDetails.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseOrderInformationAmountDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseOrderInformationAmountDetails { @SerializedName("totalAmount") private String totalAmount = null; @@ -52,10 +52,10 @@ public TssV2TransactionsGet200ResponseOrderInformationAmountDetails totalAmount( } /** - * 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. + * 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. * @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. ") + @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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). 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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### 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 the 1st line item in the order and the specific line-order amount in your request. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) #### DCC for First Data Not used. #### Invoicing Grand total for the order, this is required for creating a new invoice. ") public String getTotalAmount() { return totalAmount; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.java b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.java index f2eaa70cd..32e257625 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationBillTo.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseOrderInformationBillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseOrderInformationBillTo { @SerializedName("firstName") private String firstName = null; @@ -148,10 +148,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo address1(String add } /** - * Payment card 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, Visa Platform Connect 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card 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. **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` request-level field description 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 = "Payment card 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, Visa Platform Connect 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card 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. **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` request-level field description 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 +166,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo address2(String add } /** - * 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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 description 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. #### Visa Platform Connect **Important** When you populate billing street address 1 and billing street address 2, Visa Platform Connect 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. Visa Platform Connect 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 description 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 description 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 +184,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo locality(String loc } /** - * Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card billing city. #### 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 description 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 = "Payment card billing city. #### Atos This field must not contain colons (:). #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card billing city. #### 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 description 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 +202,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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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 description 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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 description 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; } @@ -238,10 +238,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo company(String comp } /** - * Name of the customer’s company. **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 company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Name of the customer’s company. #### 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 company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) * @return company **/ - @ApiModelProperty(value = "Name of the customer’s company. **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 company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Name of the customer’s company. #### 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 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() { return company; } @@ -256,10 +256,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo email(String email) } /** - * 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. **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` request-level field description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. * @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. **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` request-level field description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. ") public String getEmail() { return email; } @@ -274,10 +274,10 @@ public TssV2TransactionsGet200ResponseOrderInformationBillTo country(String coun } /** - * Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card billing country. 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. **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 description 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 = "Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card billing country. 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. **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 description 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 +310,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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. + * 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. ") + @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 c64829d36..2247fc8ea 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationLineItems.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationLineItems.java @@ -22,12 +22,11 @@ import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.IOException; -import java.math.BigDecimal; /** * TssV2TransactionsGet200ResponseOrderInformationLineItems */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseOrderInformationLineItems { @SerializedName("productCode") private String productCode = null; @@ -42,7 +41,7 @@ public class TssV2TransactionsGet200ResponseOrderInformationLineItems { private String taxAmount = null; @SerializedName("quantity") - private BigDecimal quantity = null; + private Integer quantity = null; @SerializedName("unitPrice") private String unitPrice = null; @@ -122,7 +121,7 @@ public void setTaxAmount(String taxAmount) { this.taxAmount = taxAmount; } - public TssV2TransactionsGet200ResponseOrderInformationLineItems quantity(BigDecimal quantity) { + public TssV2TransactionsGet200ResponseOrderInformationLineItems quantity(Integer quantity) { this.quantity = quantity; return this; } @@ -130,15 +129,15 @@ public TssV2TransactionsGet200ResponseOrderInformationLineItems quantity(BigDeci /** * For a payment or capture, this field is required when _productCode_ is not **default** or one of the values related to shipping and handling. * minimum: 1 - * maximum: 9999999999 + * maximum: 999999999 * @return quantity **/ @ApiModelProperty(value = "For a payment or capture, this field is required when _productCode_ is not **default** or one of the values related to shipping and handling. ") - public BigDecimal getQuantity() { + public Integer getQuantity() { return quantity; } - public void setQuantity(BigDecimal quantity) { + public void setQuantity(Integer quantity) { this.quantity = quantity; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShipTo.java b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShipTo.java index f239a7166..51340ab2d 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShipTo.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShipTo.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseOrderInformationShipTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseOrderInformationShipTo { @SerializedName("firstName") private String firstName = null; @@ -154,10 +154,10 @@ public TssV2TransactionsGet200ResponseOrderInformationShipTo 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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 description 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. ##### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description 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. **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 description 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; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.java b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.java index d4a0de99f..ce85cb9d8 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseOrderInformationShippingDetails.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseOrderInformationShippingDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseOrderInformationShippingDetails { @SerializedName("giftWrap") private Boolean giftWrap = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformation.java index 250b1b95f..c3a13f2dc 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformation.java @@ -32,7 +32,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponsePaymentInformation { @SerializedName("paymentType") private TssV2TransactionsGet200ResponsePaymentInformationPaymentType paymentType = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.java index 45a6a8b3a..f86439fec 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationAccountFeatures */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 84c9b3234..cc9f7380a 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBank.java @@ -28,7 +28,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationBank */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 87c8afcdc..31311c491 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankAccount.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationBankAccount */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponsePaymentInformationBankAccount { @SerializedName("suffix") private String suffix = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.java index 3a54391d6..fe14a80cf 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationBankMandate.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationBankMandate */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 7f9681fd4..ec26cb5dd 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationCard.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationCard.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponsePaymentInformationCard { @SerializedName("suffix") private String suffix = null; @@ -82,10 +82,10 @@ public TssV2TransactionsGet200ResponsePaymentInformationCard prefix(String prefi } /** - * The description for this field is not available. + * Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. * @return prefix **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. ") public String getPrefix() { return prefix; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationInvoice.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationInvoice.java index b5fd8c2c4..ea3a37d4a 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationInvoice.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationInvoice.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationInvoice */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 50cea8ae6..064ee0d67 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationPaymentType.java @@ -27,7 +27,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationPaymentType */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponsePaymentInformationPaymentType { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationPaymentTypeFundingSource.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationPaymentTypeFundingSource.java index 680792420..48b892e59 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationPaymentTypeFundingSource.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePaymentInformationPaymentTypeFundingSource.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePaymentInformationPaymentTypeFundingSource */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponsePaymentInformationPaymentTypeFundingSource { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponsePointOfSaleInformation.java b/src/main/java/Model/TssV2TransactionsGet200ResponsePointOfSaleInformation.java index c6bf7f82d..e229a0652 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponsePointOfSaleInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponsePointOfSaleInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponsePointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 12dfa1caf..2e8ac8c05 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformation.java @@ -28,7 +28,7 @@ /** * TssV2TransactionsGet200ResponseProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseProcessingInformation { @SerializedName("paymentSolution") private String paymentSolution = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.java b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.java index af3839390..f6536e42d 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions { @SerializedName("authType") private String authType = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.java b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.java index 203ec3593..b2489c5bc 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseProcessingInformationBankTransferOptions */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 6471b07b2..a7dd86bc8 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformation.java @@ -31,7 +31,7 @@ /** * TssV2TransactionsGet200ResponseProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseProcessorInformation { @SerializedName("processor") private TssV2TransactionsGet200ResponseProcessorInformationProcessor processor = null; @@ -96,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. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### Visa Platform Connect and GPN For details about this value for Visa Platform Connect and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + * 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. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) * @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. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### Visa Platform Connect and GPN For details about this value for Visa Platform Connect and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") + @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. #### Cielo For Cielo, this value is the non-sequential unit (NSU) and is supported for all transactions. The value is generated by Cielo or the issuing bank. #### Comercio Latino For Comercio Latino, this value is the proof of sale or non-sequential unit (NSU) number generated by the acquirers Cielo and Rede, or the issuing bank. #### CyberSource through VisaNet and GPN For details about this value for CyberSource through VisaNet and GPN, see \"Network Transaction Identifiers\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") public String getTransactionId() { return transactionId; } @@ -276,10 +276,10 @@ public TssV2TransactionsGet200ResponseProcessorInformation systemTraceAuditNumbe } /** - * This field is returned only for **American Express Direct** and **Visa Platform Connect**. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### Visa Platform Connect System trace number that must be printed on the customer’s receipt. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) + * 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. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) * @return systemTraceAuditNumber **/ - @ApiModelProperty(value = "This field is returned only for **American Express Direct** and **Visa Platform Connect**. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### Visa Platform Connect System trace number that must be printed on the customer’s receipt. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") + @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. For details, see `receipt_number` field description in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm) ") public String getSystemTraceAuditNumber() { return systemTraceAuditNumber; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.java b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.java index e8b5952a7..571f50da8 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseProcessorInformationElectronicVerificationResults { @SerializedName("email") private String email = null; @@ -100,10 +100,10 @@ public TssV2TransactionsGet200ResponseProcessorInformationElectronicVerification } /** - * The description for this field is not available. + * Mapped Electronic Verification response code for the customer’s name. * @return name **/ - @ApiModelProperty(value = "The description for this field is not available. ") + @ApiModelProperty(value = "Mapped Electronic Verification response code for the customer’s name. ") public String getName() { return name; } @@ -118,10 +118,10 @@ public TssV2TransactionsGet200ResponseProcessorInformationElectronicVerification } /** - * The description for this field is not available. + * Raw Electronic Verification response code from the processor for the customer’s name. * @return nameRaw **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "Raw Electronic Verification response code from the processor for the customer’s name. ") public String getNameRaw() { return nameRaw; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationProcessor.java b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationProcessor.java index 1901f6033..80767dc39 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationProcessor.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseProcessorInformationProcessor.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseProcessorInformationProcessor */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 0a9ccbe3f..b89c523c3 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformation.java @@ -31,7 +31,7 @@ /** * TssV2TransactionsGet200ResponseRiskInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseRiskInformation { @SerializedName("profile") private TssV2TransactionsGet200ResponseRiskInformationProfile profile = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationProfile.java b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationProfile.java index 00fb156a4..9e5e3e161 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationProfile.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationProfile.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseRiskInformationProfile */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseRiskInformationProfile { @SerializedName("name") private String name = null; @@ -40,10 +40,10 @@ public TssV2TransactionsGet200ResponseRiskInformationProfile name(String name) { } /** - * The description for this field is not available. + * The name of the profile. * @return name **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "The name of the profile. ") public String getName() { return name; } @@ -58,10 +58,10 @@ public TssV2TransactionsGet200ResponseRiskInformationProfile decision(String dec } /** - * The description for this field is not available. + * Decision returned by the profile; this field contains one of these values: - ACCEPT - REJECT - REVIEW * @return decision **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "Decision returned by the profile; this field contains one of these values: - ACCEPT - REJECT - REVIEW ") public String getDecision() { return decision; } diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationRules.java b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationRules.java index 9137e6663..c524c792c 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationRules.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationRules.java @@ -27,7 +27,7 @@ * 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-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsGet200ResponseRiskInformationRules { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationScore.java b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationScore.java index 8291334e9..5f37a4160 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationScore.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseRiskInformationScore.java @@ -28,7 +28,7 @@ /** * TssV2TransactionsGet200ResponseRiskInformationScore */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 6688f931c..e4c9163fc 100644 --- a/src/main/java/Model/TssV2TransactionsGet200ResponseSenderInformation.java +++ b/src/main/java/Model/TssV2TransactionsGet200ResponseSenderInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsGet200ResponseSenderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 f92c20a29..19b42249b 100644 --- a/src/main/java/Model/TssV2TransactionsPost201Response.java +++ b/src/main/java/Model/TssV2TransactionsPost201Response.java @@ -28,7 +28,7 @@ /** * TssV2TransactionsPost201Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201Response { @SerializedName("searchId") private String searchId = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201Response1.java b/src/main/java/Model/TssV2TransactionsPost201Response1.java deleted file mode 100644 index 056cdf9c5..000000000 --- a/src/main/java/Model/TssV2TransactionsPost201Response1.java +++ /dev/null @@ -1,394 +0,0 @@ -/* - * CyberSource Merged Spec - * All 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.PtsV2PaymentsReversalsPost201ResponseLinks; -import Model.TssV2TransactionsPost201Response1Embedded; -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; - -/** - * TssV2TransactionsPost201Response1 - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-07-30T13:25:59.510+05:30") -public class TssV2TransactionsPost201Response1 { - @SerializedName("searchId") - private String searchId = null; - - @SerializedName("save") - private Boolean save = null; - - @SerializedName("name") - private String name = null; - - @SerializedName("timezone") - private String timezone = null; - - @SerializedName("query") - private String query = null; - - @SerializedName("offset") - private Integer offset = null; - - @SerializedName("limit") - private Integer limit = null; - - @SerializedName("sort") - private String sort = null; - - @SerializedName("count") - private Integer count = null; - - @SerializedName("totalCount") - private Integer totalCount = null; - - @SerializedName("status") - private String status = null; - - @SerializedName("submitTimeUtc") - private String submitTimeUtc = null; - - @SerializedName("_embedded") - private TssV2TransactionsPost201Response1Embedded embedded = null; - - @SerializedName("_links") - private PtsV2PaymentsReversalsPost201ResponseLinks links = null; - - public TssV2TransactionsPost201Response1 searchId(String searchId) { - this.searchId = searchId; - return this; - } - - /** - * 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 each Search request.") - public String getSearchId() { - return searchId; - } - - public void setSearchId(String searchId) { - this.searchId = searchId; - } - - public TssV2TransactionsPost201Response1 save(Boolean save) { - this.save = save; - return this; - } - - /** - * save or not save. - * @return save - **/ - @ApiModelProperty(value = "save or not save.") - public Boolean getSave() { - return save; - } - - public void setSave(Boolean save) { - this.save = save; - } - - public TssV2TransactionsPost201Response1 name(String name) { - this.name = name; - return this; - } - - /** - * The description for this field is not available. - * @return name - **/ - @ApiModelProperty(value = "The description for this field is not available. ") - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - - public TssV2TransactionsPost201Response1 timezone(String timezone) { - this.timezone = timezone; - return this; - } - - /** - * Time Zone in ISO format. - * @return timezone - **/ - @ApiModelProperty(value = "Time Zone in ISO format.") - public String getTimezone() { - return timezone; - } - - public void setTimezone(String timezone) { - this.timezone = timezone; - } - - public TssV2TransactionsPost201Response1 query(String query) { - this.query = query; - return this; - } - - /** - * transaction search query string. - * @return query - **/ - @ApiModelProperty(value = "transaction search query string.") - public String getQuery() { - return query; - } - - public void setQuery(String query) { - this.query = query; - } - - public TssV2TransactionsPost201Response1 offset(Integer offset) { - this.offset = offset; - return this; - } - - /** - * offset. - * @return offset - **/ - @ApiModelProperty(value = "offset.") - public Integer getOffset() { - return offset; - } - - public void setOffset(Integer offset) { - this.offset = offset; - } - - public TssV2TransactionsPost201Response1 limit(Integer limit) { - this.limit = limit; - return this; - } - - /** - * Limit on number of results. - * @return limit - **/ - @ApiModelProperty(value = "Limit on number of results.") - public Integer getLimit() { - return limit; - } - - public void setLimit(Integer limit) { - this.limit = limit; - } - - public TssV2TransactionsPost201Response1 sort(String sort) { - this.sort = sort; - return this; - } - - /** - * A comma separated list of the following form - fieldName1 asc or desc, fieldName2 asc or desc, etc. - * @return sort - **/ - @ApiModelProperty(value = "A comma separated list of the following form - fieldName1 asc or desc, fieldName2 asc or desc, etc.") - public String getSort() { - return sort; - } - - public void setSort(String sort) { - this.sort = sort; - } - - public TssV2TransactionsPost201Response1 count(Integer count) { - this.count = count; - return this; - } - - /** - * Results for this page, this could be below the limit. - * @return count - **/ - @ApiModelProperty(value = "Results for this page, this could be below the limit.") - public Integer getCount() { - return count; - } - - public void setCount(Integer count) { - this.count = count; - } - - public TssV2TransactionsPost201Response1 totalCount(Integer totalCount) { - this.totalCount = totalCount; - return this; - } - - /** - * Total number of results. - * @return totalCount - **/ - @ApiModelProperty(value = "Total number of results.") - public Integer getTotalCount() { - return totalCount; - } - - public void setTotalCount(Integer totalCount) { - this.totalCount = totalCount; - } - - public TssV2TransactionsPost201Response1 status(String status) { - this.status = status; - return this; - } - - /** - * The status of the submitted transaction. - * @return status - **/ - @ApiModelProperty(value = "The status of the submitted transaction.") - public String getStatus() { - return status; - } - - public void setStatus(String status) { - this.status = status; - } - - public TssV2TransactionsPost201Response1 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 TssV2TransactionsPost201Response1 embedded(TssV2TransactionsPost201Response1Embedded embedded) { - this.embedded = embedded; - return this; - } - - /** - * Get embedded - * @return embedded - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201Response1Embedded getEmbedded() { - return embedded; - } - - public void setEmbedded(TssV2TransactionsPost201Response1Embedded embedded) { - this.embedded = embedded; - } - - public TssV2TransactionsPost201Response1 links(PtsV2PaymentsReversalsPost201ResponseLinks links) { - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @ApiModelProperty(value = "") - public PtsV2PaymentsReversalsPost201ResponseLinks getLinks() { - return links; - } - - public void setLinks(PtsV2PaymentsReversalsPost201ResponseLinks 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; - } - TssV2TransactionsPost201Response1 tssV2TransactionsPost201Response1 = (TssV2TransactionsPost201Response1) o; - return Objects.equals(this.searchId, tssV2TransactionsPost201Response1.searchId) && - Objects.equals(this.save, tssV2TransactionsPost201Response1.save) && - Objects.equals(this.name, tssV2TransactionsPost201Response1.name) && - Objects.equals(this.timezone, tssV2TransactionsPost201Response1.timezone) && - Objects.equals(this.query, tssV2TransactionsPost201Response1.query) && - Objects.equals(this.offset, tssV2TransactionsPost201Response1.offset) && - Objects.equals(this.limit, tssV2TransactionsPost201Response1.limit) && - Objects.equals(this.sort, tssV2TransactionsPost201Response1.sort) && - Objects.equals(this.count, tssV2TransactionsPost201Response1.count) && - Objects.equals(this.totalCount, tssV2TransactionsPost201Response1.totalCount) && - Objects.equals(this.status, tssV2TransactionsPost201Response1.status) && - Objects.equals(this.submitTimeUtc, tssV2TransactionsPost201Response1.submitTimeUtc) && - Objects.equals(this.embedded, tssV2TransactionsPost201Response1.embedded) && - Objects.equals(this.links, tssV2TransactionsPost201Response1.links); - } - - @Override - public int hashCode() { - return Objects.hash(searchId, save, name, timezone, query, offset, limit, sort, count, totalCount, status, submitTimeUtc, embedded, links); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsPost201Response1 {\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"); - sb.append(" query: ").append(toIndentedString(query)).append("\n"); - sb.append(" offset: ").append(toIndentedString(offset)).append("\n"); - sb.append(" limit: ").append(toIndentedString(limit)).append("\n"); - sb.append(" sort: ").append(toIndentedString(sort)).append("\n"); - sb.append(" count: ").append(toIndentedString(count)).append("\n"); - sb.append(" totalCount: ").append(toIndentedString(totalCount)).append("\n"); - sb.append(" status: ").append(toIndentedString(status)).append("\n"); - sb.append(" submitTimeUtc: ").append(toIndentedString(submitTimeUtc)).append("\n"); - sb.append(" embedded: ").append(toIndentedString(embedded)).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/TssV2TransactionsPost201Response1Embedded.java b/src/main/java/Model/TssV2TransactionsPost201Response1Embedded.java deleted file mode 100644 index df1582790..000000000 --- a/src/main/java/Model/TssV2TransactionsPost201Response1Embedded.java +++ /dev/null @@ -1,104 +0,0 @@ -/* - * CyberSource Merged Spec - * All 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.TssV2TransactionsPost201Response1EmbeddedTransactionSummaries; -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; - -/** - * TssV2TransactionsPost201Response1Embedded - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-07-30T13:25:59.510+05:30") -public class TssV2TransactionsPost201Response1Embedded { - @SerializedName("transactionSummaries") - private List transactionSummaries = null; - - public TssV2TransactionsPost201Response1Embedded transactionSummaries(List transactionSummaries) { - this.transactionSummaries = transactionSummaries; - return this; - } - - public TssV2TransactionsPost201Response1Embedded addTransactionSummariesItem(TssV2TransactionsPost201Response1EmbeddedTransactionSummaries transactionSummariesItem) { - if (this.transactionSummaries == null) { - this.transactionSummaries = new ArrayList(); - } - this.transactionSummaries.add(transactionSummariesItem); - return this; - } - - /** - * transaction search summary - * @return transactionSummaries - **/ - @ApiModelProperty(value = "transaction search summary") - public List getTransactionSummaries() { - return transactionSummaries; - } - - public void setTransactionSummaries(List transactionSummaries) { - this.transactionSummaries = transactionSummaries; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TssV2TransactionsPost201Response1Embedded tssV2TransactionsPost201Response1Embedded = (TssV2TransactionsPost201Response1Embedded) o; - return Objects.equals(this.transactionSummaries, tssV2TransactionsPost201Response1Embedded.transactionSummaries); - } - - @Override - public int hashCode() { - return Objects.hash(transactionSummaries); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsPost201Response1Embedded {\n"); - - sb.append(" transactionSummaries: ").append(toIndentedString(transactionSummaries)).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/TssV2TransactionsPost201Response1EmbeddedPaymentInformation.java b/src/main/java/Model/TssV2TransactionsPost201Response1EmbeddedPaymentInformation.java deleted file mode 100644 index c6fe8c177..000000000 --- a/src/main/java/Model/TssV2TransactionsPost201Response1EmbeddedPaymentInformation.java +++ /dev/null @@ -1,142 +0,0 @@ -/* - * CyberSource Merged Spec - * All 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.Ptsv2paymentsPaymentInformationCustomer; -import Model.TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType; -import Model.TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard; -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; - -/** - * TssV2TransactionsPost201Response1EmbeddedPaymentInformation - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-07-30T13:25:59.510+05:30") -public class TssV2TransactionsPost201Response1EmbeddedPaymentInformation { - @SerializedName("paymentType") - private TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType paymentType = null; - - @SerializedName("customer") - private Ptsv2paymentsPaymentInformationCustomer customer = null; - - @SerializedName("card") - private TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard card = null; - - public TssV2TransactionsPost201Response1EmbeddedPaymentInformation paymentType(TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType paymentType) { - this.paymentType = paymentType; - return this; - } - - /** - * Get paymentType - * @return paymentType - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType getPaymentType() { - return paymentType; - } - - public void setPaymentType(TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType paymentType) { - this.paymentType = paymentType; - } - - public TssV2TransactionsPost201Response1EmbeddedPaymentInformation 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; - } - - public TssV2TransactionsPost201Response1EmbeddedPaymentInformation card(TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard card) { - this.card = card; - return this; - } - - /** - * Get card - * @return card - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard getCard() { - return card; - } - - public void setCard(TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard card) { - this.card = card; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TssV2TransactionsPost201Response1EmbeddedPaymentInformation tssV2TransactionsPost201Response1EmbeddedPaymentInformation = (TssV2TransactionsPost201Response1EmbeddedPaymentInformation) o; - return Objects.equals(this.paymentType, tssV2TransactionsPost201Response1EmbeddedPaymentInformation.paymentType) && - Objects.equals(this.customer, tssV2TransactionsPost201Response1EmbeddedPaymentInformation.customer) && - Objects.equals(this.card, tssV2TransactionsPost201Response1EmbeddedPaymentInformation.card); - } - - @Override - public int hashCode() { - return Objects.hash(paymentType, customer, card); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsPost201Response1EmbeddedPaymentInformation {\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("}"); - 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/TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType.java b/src/main/java/Model/TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType.java deleted file mode 100644 index 90ef53c84..000000000 --- a/src/main/java/Model/TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType.java +++ /dev/null @@ -1,117 +0,0 @@ -/* - * CyberSource Merged Spec - * All 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.TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod; -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; - -/** - * TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-07-30T13:25:59.510+05:30") -public class TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType { - @SerializedName("name") - private String name = null; - - @SerializedName("method") - private TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod method = null; - - public TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType name(String name) { - this.name = name; - return this; - } - - /** - * A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. - * @return name - **/ - @ApiModelProperty(value = "A Payment Type is an agreed means for a payee to receive legal tender from a payer. The way one pays for a commercial financial transaction. Examples: Card, Bank Transfer, Digital, Direct Debit. ") - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - - public TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType method(TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod method) { - this.method = method; - return this; - } - - /** - * Get method - * @return method - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod getMethod() { - return method; - } - - public void setMethod(TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod 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; - } - TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType tssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType = (TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType) o; - return Objects.equals(this.name, tssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType.name) && - Objects.equals(this.method, tssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType.method); - } - - @Override - public int hashCode() { - return Objects.hash(name, method); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentType {\n"); - - sb.append(" name: ").append(toIndentedString(name)).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/TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod.java b/src/main/java/Model/TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod.java deleted file mode 100644 index 1bd720981..000000000 --- a/src/main/java/Model/TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod.java +++ /dev/null @@ -1,162 +0,0 @@ -/* - * CyberSource Merged Spec - * All 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; - -/** - * TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-07-30T13:25:59.510+05:30") -public class TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod { - @SerializedName("name") - private String name = null; - - @SerializedName("operator") - private String operator = null; - - @SerializedName("schemeName") - private String schemeName = null; - - @SerializedName("schemeOperator") - private String schemeOperator = null; - - public TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod name(String name) { - this.name = name; - return this; - } - - /** - * A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal - * @return name - **/ - @ApiModelProperty(value = "A Payment Type is enabled through a Method. Examples: Visa, Master Card, ApplePay, iDeal ") - public String getName() { - return name; - } - - public void setName(String name) { - this.name = name; - } - - public TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod operator(String operator) { - this.operator = operator; - return this; - } - - /** - * An operator of the Payment Type Method. Examples: Visa, PayPal, Google, Apple - * @return operator - **/ - @ApiModelProperty(value = "An operator of the Payment Type Method. Examples: Visa, PayPal, Google, Apple ") - public String getOperator() { - return operator; - } - - public void setOperator(String operator) { - this.operator = operator; - } - - public TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod schemeName(String schemeName) { - this.schemeName = schemeName; - return this; - } - - /** - * A Payment Scheme is a formal, commercial relationship amongst payment ecosystem players (banks and merchants, typically, extended to include merchants payment service providers, banks processors, etc.), whereby the participants agree to an organizational, legal, and operational framework necessary for the functioning of the services these entities provide. Examples: Visa, Master Card, ApplePay, iDeal - * @return schemeName - **/ - @ApiModelProperty(value = "A Payment Scheme is a formal, commercial relationship amongst payment ecosystem players (banks and merchants, typically, extended to include merchants payment service providers, banks processors, etc.), whereby the participants agree to an organizational, legal, and operational framework necessary for the functioning of the services these entities provide. Examples: Visa, Master Card, ApplePay, iDeal ") - public String getSchemeName() { - return schemeName; - } - - public void setSchemeName(String schemeName) { - this.schemeName = schemeName; - } - - public TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod schemeOperator(String schemeOperator) { - this.schemeOperator = schemeOperator; - return this; - } - - /** - * Operator of the Scheme. Examples European Payment Council, Visa, Currence Ideal B.V - * @return schemeOperator - **/ - @ApiModelProperty(value = "Operator of the Scheme. Examples European Payment Council, Visa, Currence Ideal B.V ") - public String getSchemeOperator() { - return schemeOperator; - } - - public void setSchemeOperator(String schemeOperator) { - this.schemeOperator = schemeOperator; - } - - - @Override - public boolean equals(java.lang.Object o) { - if (this == o) { - return true; - } - if (o == null || getClass() != o.getClass()) { - return false; - } - TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod tssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod = (TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod) o; - return Objects.equals(this.name, tssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod.name) && - Objects.equals(this.operator, tssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod.operator) && - Objects.equals(this.schemeName, tssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod.schemeName) && - Objects.equals(this.schemeOperator, tssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod.schemeOperator); - } - - @Override - public int hashCode() { - return Objects.hash(name, operator, schemeName, schemeOperator); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsPost201Response1EmbeddedPaymentInformationPaymentTypeMethod {\n"); - - sb.append(" name: ").append(toIndentedString(name)).append("\n"); - sb.append(" operator: ").append(toIndentedString(operator)).append("\n"); - sb.append(" schemeName: ").append(toIndentedString(schemeName)).append("\n"); - sb.append(" schemeOperator: ").append(toIndentedString(schemeOperator)).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/TssV2TransactionsPost201Response1EmbeddedTransactionSummaries.java b/src/main/java/Model/TssV2TransactionsPost201Response1EmbeddedTransactionSummaries.java deleted file mode 100644 index 9bf7f6140..000000000 --- a/src/main/java/Model/TssV2TransactionsPost201Response1EmbeddedTransactionSummaries.java +++ /dev/null @@ -1,509 +0,0 @@ -/* - * CyberSource Merged Spec - * All 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.Ptsv2paymentsMerchantDefinedInformation; -import Model.TssV2TransactionsGet200ResponseApplicationInformation; -import Model.TssV2TransactionsGet200ResponseFraudMarkingInformation; -import Model.TssV2TransactionsPost201Response1EmbeddedPaymentInformation; -import Model.TssV2TransactionsPost201ResponseEmbeddedBuyerInformation; -import Model.TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation; -import Model.TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation; -import Model.TssV2TransactionsPost201ResponseEmbeddedDeviceInformation; -import Model.TssV2TransactionsPost201ResponseEmbeddedLinks; -import Model.TssV2TransactionsPost201ResponseEmbeddedMerchantInformation; -import Model.TssV2TransactionsPost201ResponseEmbeddedOrderInformation; -import Model.TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation; -import Model.TssV2TransactionsPost201ResponseEmbeddedProcessingInformation; -import Model.TssV2TransactionsPost201ResponseEmbeddedProcessorInformation; -import Model.TssV2TransactionsPost201ResponseEmbeddedRiskInformation; -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; - -/** - * TssV2TransactionsPost201Response1EmbeddedTransactionSummaries - */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-07-30T13:25:59.510+05:30") -public class TssV2TransactionsPost201Response1EmbeddedTransactionSummaries { - @SerializedName("id") - private String id = null; - - @SerializedName("submitTimeUtc") - private String submitTimeUtc = null; - - @SerializedName("merchantId") - private String merchantId = null; - - @SerializedName("applicationInformation") - private TssV2TransactionsGet200ResponseApplicationInformation applicationInformation = null; - - @SerializedName("buyerInformation") - private TssV2TransactionsPost201ResponseEmbeddedBuyerInformation buyerInformation = null; - - @SerializedName("clientReferenceInformation") - private TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation clientReferenceInformation = null; - - @SerializedName("consumerAuthenticationInformation") - private TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation consumerAuthenticationInformation = null; - - @SerializedName("deviceInformation") - private TssV2TransactionsPost201ResponseEmbeddedDeviceInformation deviceInformation = null; - - @SerializedName("fraudMarkingInformation") - private TssV2TransactionsGet200ResponseFraudMarkingInformation fraudMarkingInformation = null; - - @SerializedName("merchantDefinedInformation") - private List merchantDefinedInformation = null; - - @SerializedName("merchantInformation") - private TssV2TransactionsPost201ResponseEmbeddedMerchantInformation merchantInformation = null; - - @SerializedName("orderInformation") - private TssV2TransactionsPost201ResponseEmbeddedOrderInformation orderInformation = null; - - @SerializedName("paymentInformation") - private TssV2TransactionsPost201Response1EmbeddedPaymentInformation paymentInformation = null; - - @SerializedName("processingInformation") - private TssV2TransactionsPost201ResponseEmbeddedProcessingInformation processingInformation = null; - - @SerializedName("processorInformation") - private TssV2TransactionsPost201ResponseEmbeddedProcessorInformation processorInformation = null; - - @SerializedName("pointOfSaleInformation") - private TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation pointOfSaleInformation = null; - - @SerializedName("riskInformation") - private TssV2TransactionsPost201ResponseEmbeddedRiskInformation riskInformation = null; - - @SerializedName("_links") - private TssV2TransactionsPost201ResponseEmbeddedLinks links = null; - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries 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 TssV2TransactionsPost201Response1EmbeddedTransactionSummaries 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 TssV2TransactionsPost201Response1EmbeddedTransactionSummaries merchantId(String merchantId) { - this.merchantId = merchantId; - return this; - } - - /** - * Your CyberSource merchant ID. - * @return merchantId - **/ - @ApiModelProperty(value = "Your CyberSource merchant ID.") - public String getMerchantId() { - return merchantId; - } - - public void setMerchantId(String merchantId) { - this.merchantId = merchantId; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries applicationInformation(TssV2TransactionsGet200ResponseApplicationInformation applicationInformation) { - this.applicationInformation = applicationInformation; - return this; - } - - /** - * Get applicationInformation - * @return applicationInformation - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsGet200ResponseApplicationInformation getApplicationInformation() { - return applicationInformation; - } - - public void setApplicationInformation(TssV2TransactionsGet200ResponseApplicationInformation applicationInformation) { - this.applicationInformation = applicationInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries buyerInformation(TssV2TransactionsPost201ResponseEmbeddedBuyerInformation buyerInformation) { - this.buyerInformation = buyerInformation; - return this; - } - - /** - * Get buyerInformation - * @return buyerInformation - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedBuyerInformation getBuyerInformation() { - return buyerInformation; - } - - public void setBuyerInformation(TssV2TransactionsPost201ResponseEmbeddedBuyerInformation buyerInformation) { - this.buyerInformation = buyerInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries clientReferenceInformation(TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation clientReferenceInformation) { - this.clientReferenceInformation = clientReferenceInformation; - return this; - } - - /** - * Get clientReferenceInformation - * @return clientReferenceInformation - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation getClientReferenceInformation() { - return clientReferenceInformation; - } - - public void setClientReferenceInformation(TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation clientReferenceInformation) { - this.clientReferenceInformation = clientReferenceInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries consumerAuthenticationInformation(TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation consumerAuthenticationInformation) { - this.consumerAuthenticationInformation = consumerAuthenticationInformation; - return this; - } - - /** - * Get consumerAuthenticationInformation - * @return consumerAuthenticationInformation - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation getConsumerAuthenticationInformation() { - return consumerAuthenticationInformation; - } - - public void setConsumerAuthenticationInformation(TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation consumerAuthenticationInformation) { - this.consumerAuthenticationInformation = consumerAuthenticationInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries deviceInformation(TssV2TransactionsPost201ResponseEmbeddedDeviceInformation deviceInformation) { - this.deviceInformation = deviceInformation; - return this; - } - - /** - * Get deviceInformation - * @return deviceInformation - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedDeviceInformation getDeviceInformation() { - return deviceInformation; - } - - public void setDeviceInformation(TssV2TransactionsPost201ResponseEmbeddedDeviceInformation deviceInformation) { - this.deviceInformation = deviceInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries fraudMarkingInformation(TssV2TransactionsGet200ResponseFraudMarkingInformation fraudMarkingInformation) { - this.fraudMarkingInformation = fraudMarkingInformation; - return this; - } - - /** - * Get fraudMarkingInformation - * @return fraudMarkingInformation - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsGet200ResponseFraudMarkingInformation getFraudMarkingInformation() { - return fraudMarkingInformation; - } - - public void setFraudMarkingInformation(TssV2TransactionsGet200ResponseFraudMarkingInformation fraudMarkingInformation) { - this.fraudMarkingInformation = fraudMarkingInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries merchantDefinedInformation(List merchantDefinedInformation) { - this.merchantDefinedInformation = merchantDefinedInformation; - return this; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries addMerchantDefinedInformationItem(Ptsv2paymentsMerchantDefinedInformation merchantDefinedInformationItem) { - if (this.merchantDefinedInformation == null) { - this.merchantDefinedInformation = new ArrayList(); - } - this.merchantDefinedInformation.add(merchantDefinedInformationItem); - return this; - } - - /** - * The object containing the custom data that the merchant defines. - * @return merchantDefinedInformation - **/ - @ApiModelProperty(value = "The object containing the custom data that the merchant defines. ") - public List getMerchantDefinedInformation() { - return merchantDefinedInformation; - } - - public void setMerchantDefinedInformation(List merchantDefinedInformation) { - this.merchantDefinedInformation = merchantDefinedInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries merchantInformation(TssV2TransactionsPost201ResponseEmbeddedMerchantInformation merchantInformation) { - this.merchantInformation = merchantInformation; - return this; - } - - /** - * Get merchantInformation - * @return merchantInformation - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedMerchantInformation getMerchantInformation() { - return merchantInformation; - } - - public void setMerchantInformation(TssV2TransactionsPost201ResponseEmbeddedMerchantInformation merchantInformation) { - this.merchantInformation = merchantInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries orderInformation(TssV2TransactionsPost201ResponseEmbeddedOrderInformation orderInformation) { - this.orderInformation = orderInformation; - return this; - } - - /** - * Get orderInformation - * @return orderInformation - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedOrderInformation getOrderInformation() { - return orderInformation; - } - - public void setOrderInformation(TssV2TransactionsPost201ResponseEmbeddedOrderInformation orderInformation) { - this.orderInformation = orderInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries paymentInformation(TssV2TransactionsPost201Response1EmbeddedPaymentInformation paymentInformation) { - this.paymentInformation = paymentInformation; - return this; - } - - /** - * Get paymentInformation - * @return paymentInformation - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201Response1EmbeddedPaymentInformation getPaymentInformation() { - return paymentInformation; - } - - public void setPaymentInformation(TssV2TransactionsPost201Response1EmbeddedPaymentInformation paymentInformation) { - this.paymentInformation = paymentInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries processingInformation(TssV2TransactionsPost201ResponseEmbeddedProcessingInformation processingInformation) { - this.processingInformation = processingInformation; - return this; - } - - /** - * Get processingInformation - * @return processingInformation - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedProcessingInformation getProcessingInformation() { - return processingInformation; - } - - public void setProcessingInformation(TssV2TransactionsPost201ResponseEmbeddedProcessingInformation processingInformation) { - this.processingInformation = processingInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries processorInformation(TssV2TransactionsPost201ResponseEmbeddedProcessorInformation processorInformation) { - this.processorInformation = processorInformation; - return this; - } - - /** - * Get processorInformation - * @return processorInformation - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedProcessorInformation getProcessorInformation() { - return processorInformation; - } - - public void setProcessorInformation(TssV2TransactionsPost201ResponseEmbeddedProcessorInformation processorInformation) { - this.processorInformation = processorInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries pointOfSaleInformation(TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation pointOfSaleInformation) { - this.pointOfSaleInformation = pointOfSaleInformation; - return this; - } - - /** - * Get pointOfSaleInformation - * @return pointOfSaleInformation - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation getPointOfSaleInformation() { - return pointOfSaleInformation; - } - - public void setPointOfSaleInformation(TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation pointOfSaleInformation) { - this.pointOfSaleInformation = pointOfSaleInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries riskInformation(TssV2TransactionsPost201ResponseEmbeddedRiskInformation riskInformation) { - this.riskInformation = riskInformation; - return this; - } - - /** - * Get riskInformation - * @return riskInformation - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedRiskInformation getRiskInformation() { - return riskInformation; - } - - public void setRiskInformation(TssV2TransactionsPost201ResponseEmbeddedRiskInformation riskInformation) { - this.riskInformation = riskInformation; - } - - public TssV2TransactionsPost201Response1EmbeddedTransactionSummaries links(TssV2TransactionsPost201ResponseEmbeddedLinks links) { - this.links = links; - return this; - } - - /** - * Get links - * @return links - **/ - @ApiModelProperty(value = "") - public TssV2TransactionsPost201ResponseEmbeddedLinks getLinks() { - return links; - } - - public void setLinks(TssV2TransactionsPost201ResponseEmbeddedLinks 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; - } - TssV2TransactionsPost201Response1EmbeddedTransactionSummaries tssV2TransactionsPost201Response1EmbeddedTransactionSummaries = (TssV2TransactionsPost201Response1EmbeddedTransactionSummaries) o; - return Objects.equals(this.id, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.id) && - Objects.equals(this.submitTimeUtc, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.submitTimeUtc) && - Objects.equals(this.merchantId, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.merchantId) && - Objects.equals(this.applicationInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.applicationInformation) && - Objects.equals(this.buyerInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.buyerInformation) && - Objects.equals(this.clientReferenceInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.clientReferenceInformation) && - Objects.equals(this.consumerAuthenticationInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.consumerAuthenticationInformation) && - Objects.equals(this.deviceInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.deviceInformation) && - Objects.equals(this.fraudMarkingInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.fraudMarkingInformation) && - Objects.equals(this.merchantDefinedInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.merchantDefinedInformation) && - Objects.equals(this.merchantInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.merchantInformation) && - Objects.equals(this.orderInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.orderInformation) && - Objects.equals(this.paymentInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.paymentInformation) && - Objects.equals(this.processingInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.processingInformation) && - Objects.equals(this.processorInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.processorInformation) && - Objects.equals(this.pointOfSaleInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.pointOfSaleInformation) && - Objects.equals(this.riskInformation, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.riskInformation) && - Objects.equals(this.links, tssV2TransactionsPost201Response1EmbeddedTransactionSummaries.links); - } - - @Override - public int hashCode() { - return Objects.hash(id, submitTimeUtc, merchantId, applicationInformation, buyerInformation, clientReferenceInformation, consumerAuthenticationInformation, deviceInformation, fraudMarkingInformation, merchantDefinedInformation, merchantInformation, orderInformation, paymentInformation, processingInformation, processorInformation, pointOfSaleInformation, riskInformation, links); - } - - - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class TssV2TransactionsPost201Response1EmbeddedTransactionSummaries {\n"); - - sb.append(" id: ").append(toIndentedString(id)).append("\n"); - sb.append(" submitTimeUtc: ").append(toIndentedString(submitTimeUtc)).append("\n"); - sb.append(" merchantId: ").append(toIndentedString(merchantId)).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"); - sb.append(" consumerAuthenticationInformation: ").append(toIndentedString(consumerAuthenticationInformation)).append("\n"); - sb.append(" deviceInformation: ").append(toIndentedString(deviceInformation)).append("\n"); - sb.append(" fraudMarkingInformation: ").append(toIndentedString(fraudMarkingInformation)).append("\n"); - sb.append(" merchantDefinedInformation: ").append(toIndentedString(merchantDefinedInformation)).append("\n"); - sb.append(" merchantInformation: ").append(toIndentedString(merchantInformation)).append("\n"); - sb.append(" orderInformation: ").append(toIndentedString(orderInformation)).append("\n"); - sb.append(" paymentInformation: ").append(toIndentedString(paymentInformation)).append("\n"); - sb.append(" processingInformation: ").append(toIndentedString(processingInformation)).append("\n"); - sb.append(" processorInformation: ").append(toIndentedString(processorInformation)).append("\n"); - sb.append(" pointOfSaleInformation: ").append(toIndentedString(pointOfSaleInformation)).append("\n"); - sb.append(" riskInformation: ").append(toIndentedString(riskInformation)).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/TssV2TransactionsPost201ResponseEmbedded.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbedded.java index ce406e8c9..abfe55f92 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbedded.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbedded.java @@ -29,7 +29,7 @@ /** * TssV2TransactionsPost201ResponseEmbedded */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 763ffba4c..89db1097f 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedBuyerInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedBuyerInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedBuyerInformation { @SerializedName("merchantCustomerId") private String merchantCustomerId = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.java index 77e3f873b..75b4a10a6 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedClientReferenceInformation { @SerializedName("code") private String code = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.java index 76959803d..5813f95a1 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedConsumerAuthenticationInformation { @SerializedName("xid") private String xid = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.java index 9c7c05384..880fd0649 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedDeviceInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedDeviceInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedDeviceInformation { @SerializedName("ipAddress") private String ipAddress = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedLinks.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedLinks.java index 3aa04450b..5876e6a19 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedLinks.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedLinks.java @@ -27,7 +27,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 2ee833929..22d29ba5f 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedMerchantInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedMerchantInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedMerchantInformation { @SerializedName("resellerId") private String resellerId = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.java index 26cd9f19a..1fb5ac55f 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformation.java @@ -29,7 +29,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedOrderInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedOrderInformation { @SerializedName("billTo") private TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo billTo = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.java index cb71fa006..ff3e6517a 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo { @SerializedName("firstName") private String firstName = null; @@ -85,10 +85,10 @@ public TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo email(Stri } /** - * 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. **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` request-level field description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. * @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. **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` request-level field description 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. **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` request-level field description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) #### Invoicing Email address for the customer for sending the invoice. If the invoice is in SENT status and email is updated, the old email customer payment link won't work and you must resend the invoice with the new payment link. ") public String getEmail() { return email; } @@ -103,10 +103,10 @@ public TssV2TransactionsPost201ResponseEmbeddedOrderInformationBillTo country(St } /** - * Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) + * Payment card billing country. 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. **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 description 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 = "Payment card billing country. Use the two-character ISO Standard Country Codes. #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. **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 description in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) ") + @ApiModelProperty(value = "Payment card billing country. 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. **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 description 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. + * 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) #### Visa Platform Connect Credit card networks cannot process transactions that contain non-ASCII characters. Visa Platform Connect 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. ") + @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 a7a8d6921..89700c12d 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedOrderInformationShipTo { @SerializedName("firstName") private String firstName = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.java index 0a6c88bd8..1ee97719f 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformation.java @@ -29,7 +29,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedPaymentInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedPaymentInformation { @SerializedName("paymentType") private TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType paymentType = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.java index 2ffe11411..7d27e03eb 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard { @SerializedName("suffix") private String suffix = null; @@ -61,10 +61,10 @@ public TssV2TransactionsPost201ResponseEmbeddedPaymentInformationCard prefix(Str } /** - * The description for this field is not available. + * Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. * @return prefix **/ - @ApiModelProperty(value = "The description for this field is not available.") + @ApiModelProperty(value = "Bank Identification Number (BIN). This is the initial four to six numbers on a credit card account number. ") public String getPrefix() { return prefix; } diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.java index 5b61fcb82..10d1d7325 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedPaymentInformationPaymentType { @SerializedName("name") private String name = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.java index ba07d1841..6d2de42e4 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation.java @@ -27,7 +27,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformation { @SerializedName("terminalId") private String terminalId = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.java index 9b0bff285..9d04deb7a 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedPointOfSaleInformationPartner { @SerializedName("originalTransactionId") private String originalTransactionId = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.java index caaf16665..bf278e80c 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessingInformation.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedProcessingInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedProcessingInformation { @SerializedName("paymentSolution") private String paymentSolution = null; diff --git a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.java b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.java index b49605e93..39f68cc83 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedProcessorInformation.java @@ -27,7 +27,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedProcessorInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 79623154a..bce9477f3 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformation.java @@ -27,7 +27,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedRiskInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 86d31fd8a..7a0c47b85 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders.java @@ -27,7 +27,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedRiskInformationProviders */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 5bfcab5db..9fa296f01 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint.java @@ -26,7 +26,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedRiskInformationProvidersFingerprint */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 775018ad1..939a9a92c 100644 --- a/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.java +++ b/src/main/java/Model/TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries.java @@ -43,7 +43,7 @@ /** * TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost201ResponseEmbeddedTransactionSummaries { @SerializedName("id") private String id = null; diff --git a/src/main/java/Model/TssV2TransactionsPost400Response.java b/src/main/java/Model/TssV2TransactionsPost400Response.java index 50d08ed63..0cc1e56c9 100644 --- a/src/main/java/Model/TssV2TransactionsPost400Response.java +++ b/src/main/java/Model/TssV2TransactionsPost400Response.java @@ -29,7 +29,7 @@ /** * TssV2TransactionsPost400Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class TssV2TransactionsPost400Response { @SerializedName("submitTimeUtc") private String submitTimeUtc = null; diff --git a/src/main/java/Model/UmsV1UsersGet200Response.java b/src/main/java/Model/UmsV1UsersGet200Response.java index ef29fce0c..84a3e1d07 100644 --- a/src/main/java/Model/UmsV1UsersGet200Response.java +++ b/src/main/java/Model/UmsV1UsersGet200Response.java @@ -29,7 +29,7 @@ /** * UmsV1UsersGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 acf27912e..01dbc09ea 100644 --- a/src/main/java/Model/UmsV1UsersGet200ResponseAccountInformation.java +++ b/src/main/java/Model/UmsV1UsersGet200ResponseAccountInformation.java @@ -29,7 +29,7 @@ /** * UmsV1UsersGet200ResponseAccountInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 c0bfe57f2..3e87d3800 100644 --- a/src/main/java/Model/UmsV1UsersGet200ResponseContactInformation.java +++ b/src/main/java/Model/UmsV1UsersGet200ResponseContactInformation.java @@ -26,7 +26,7 @@ /** * UmsV1UsersGet200ResponseContactInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 cdc6ed23f..6e15cbfb0 100644 --- a/src/main/java/Model/UmsV1UsersGet200ResponseOrganizationInformation.java +++ b/src/main/java/Model/UmsV1UsersGet200ResponseOrganizationInformation.java @@ -26,7 +26,7 @@ /** * UmsV1UsersGet200ResponseOrganizationInformation */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 b7e97060d..5f87bf849 100644 --- a/src/main/java/Model/UmsV1UsersGet200ResponseUsers.java +++ b/src/main/java/Model/UmsV1UsersGet200ResponseUsers.java @@ -29,7 +29,7 @@ /** * UmsV1UsersGet200ResponseUsers */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class UmsV1UsersGet200ResponseUsers { @SerializedName("accountInformation") private UmsV1UsersGet200ResponseAccountInformation accountInformation = null; diff --git a/src/main/java/Model/UpdateInstrumentIdentifierRequest.java b/src/main/java/Model/UpdateInstrumentIdentifierRequest.java index 2c6aaa524..fd343ca5e 100644 --- a/src/main/java/Model/UpdateInstrumentIdentifierRequest.java +++ b/src/main/java/Model/UpdateInstrumentIdentifierRequest.java @@ -27,7 +27,7 @@ /** * UpdateInstrumentIdentifierRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class UpdateInstrumentIdentifierRequest { @SerializedName("processingInformation") private TmsV1InstrumentIdentifiersPost200ResponseProcessingInformation processingInformation = null; diff --git a/src/main/java/Model/UpdatePaymentInstrumentRequest.java b/src/main/java/Model/UpdatePaymentInstrumentRequest.java index ed9cc95c4..0ea5c1a1e 100644 --- a/src/main/java/Model/UpdatePaymentInstrumentRequest.java +++ b/src/main/java/Model/UpdatePaymentInstrumentRequest.java @@ -35,7 +35,7 @@ /** * UpdatePaymentInstrumentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class UpdatePaymentInstrumentRequest { @SerializedName("_links") private TmsV1InstrumentIdentifiersPost200ResponseLinks links = null; diff --git a/src/main/java/Model/V1FileDetailsGet200Response.java b/src/main/java/Model/V1FileDetailsGet200Response.java index 4260c668b..5b5aafa09 100644 --- a/src/main/java/Model/V1FileDetailsGet200Response.java +++ b/src/main/java/Model/V1FileDetailsGet200Response.java @@ -30,7 +30,7 @@ /** * V1FileDetailsGet200Response */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 f738a721b..f1f5ce9b2 100644 --- a/src/main/java/Model/V1FileDetailsGet200ResponseFileDetails.java +++ b/src/main/java/Model/V1FileDetailsGet200ResponseFileDetails.java @@ -28,7 +28,7 @@ /** * V1FileDetailsGet200ResponseFileDetails */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 f92fdf28c..4af5a4fd8 100644 --- a/src/main/java/Model/V1FileDetailsGet200ResponseLinks.java +++ b/src/main/java/Model/V1FileDetailsGet200ResponseLinks.java @@ -30,7 +30,7 @@ /** * V1FileDetailsGet200ResponseLinks */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 353a503cd..f09a306eb 100644 --- a/src/main/java/Model/V1FileDetailsGet200ResponseLinksFiles.java +++ b/src/main/java/Model/V1FileDetailsGet200ResponseLinksFiles.java @@ -26,7 +26,7 @@ /** * V1FileDetailsGet200ResponseLinksFiles */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 8cf7e292e..166fdf10b 100644 --- a/src/main/java/Model/V1FileDetailsGet200ResponseLinksSelf.java +++ b/src/main/java/Model/V1FileDetailsGet200ResponseLinksSelf.java @@ -26,7 +26,7 @@ /** * V1FileDetailsGet200ResponseLinksSelf */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 3cbcfc449..f5a1bbf14 100644 --- a/src/main/java/Model/VoidCaptureRequest.java +++ b/src/main/java/Model/VoidCaptureRequest.java @@ -27,7 +27,7 @@ /** * VoidCaptureRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 29c281e25..f68fa3c49 100644 --- a/src/main/java/Model/VoidCreditRequest.java +++ b/src/main/java/Model/VoidCreditRequest.java @@ -27,7 +27,7 @@ /** * VoidCreditRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 4e44309f9..5f5b6af02 100644 --- a/src/main/java/Model/VoidPaymentRequest.java +++ b/src/main/java/Model/VoidPaymentRequest.java @@ -27,7 +27,7 @@ /** * VoidPaymentRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+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 f25415787..015e2cf83 100644 --- a/src/main/java/Model/VoidRefundRequest.java +++ b/src/main/java/Model/VoidRefundRequest.java @@ -27,7 +27,7 @@ /** * VoidRefundRequest */ -@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-01T12:55:52.826+05:30") +@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-08-26T18:32:32.437+05:30") public class VoidRefundRequest { @SerializedName("clientReferenceInformation") private Ptsv2paymentsidreversalsClientReferenceInformation clientReferenceInformation = null; diff --git a/src/test/java/Api/DownloadDTDApiTest.java b/src/test/java/Api/DownloadDTDApiTest.java new file mode 100644 index 000000000..75b279183 --- /dev/null +++ b/src/test/java/Api/DownloadDTDApiTest.java @@ -0,0 +1,50 @@ +/* + * CyberSource Merged Spec + * All 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.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 DownloadDTDApi + */ +@Ignore +public class DownloadDTDApiTest { + + private final DownloadDTDApi api = new DownloadDTDApi(); + + + /** + * Used to download DTDs for reports + * + * Downloads DTDs for reports on no-auth. + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getDTDV2Test() throws ApiException { + String reportDefinitionNameVersion = null; + api.getDTDV2(reportDefinitionNameVersion); + + // TODO: test validations + } + +} diff --git a/src/test/java/Api/DownloadXSDApiTest.java b/src/test/java/Api/DownloadXSDApiTest.java new file mode 100644 index 000000000..8cd683c94 --- /dev/null +++ b/src/test/java/Api/DownloadXSDApiTest.java @@ -0,0 +1,50 @@ +/* + * CyberSource Merged Spec + * All 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.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 DownloadXSDApi + */ +@Ignore +public class DownloadXSDApiTest { + + private final DownloadXSDApi api = new DownloadXSDApi(); + + + /** + * Used to download XSDs for reports + * + * Downloads XSDs for reports on no-auth. + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getXSDV2Test() throws ApiException { + String reportDefinitionNameVersion = null; + api.getXSDV2(reportDefinitionNameVersion); + + // TODO: test validations + } + +} diff --git a/src/test/java/Api/InstrumentIdentifierApiTest.java b/src/test/java/Api/InstrumentIdentifierApiTest.java index bf71c63c8..6b0f51ea0 100644 --- a/src/test/java/Api/InstrumentIdentifierApiTest.java +++ b/src/test/java/Api/InstrumentIdentifierApiTest.java @@ -15,7 +15,7 @@ import Invokers.ApiException; import Model.CreateInstrumentIdentifierRequest; -import Model.InlineResponse4001; +import Model.InlineResponse400; import Model.TmsV1InstrumentIdentifiersDelete409Response; import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response; import Model.TmsV1InstrumentIdentifiersPost200Response; diff --git a/src/test/java/Api/PaymentBatchSummariesApiTest.java b/src/test/java/Api/PaymentBatchSummariesApiTest.java new file mode 100644 index 000000000..33da08340 --- /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.ReportingV3PaymentBatchSummariesGet200Response; +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; + ReportingV3PaymentBatchSummariesGet200Response 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 index bba14dd32..48d85b8b0 100644 --- a/src/test/java/Api/PaymentInstrumentApiTest.java +++ b/src/test/java/Api/PaymentInstrumentApiTest.java @@ -15,7 +15,7 @@ import Invokers.ApiException; import Model.CreatePaymentInstrumentRequest; -import Model.InlineResponse4001; +import Model.InlineResponse400; import Model.TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedPaymentInstruments; import Model.UpdatePaymentInstrumentRequest; import org.junit.Test; diff --git a/src/test/java/Api/ReportSubscriptionsApiTest.java b/src/test/java/Api/ReportSubscriptionsApiTest.java index a676281c7..e5326623c 100644 --- a/src/test/java/Api/ReportSubscriptionsApiTest.java +++ b/src/test/java/Api/ReportSubscriptionsApiTest.java @@ -14,7 +14,7 @@ package Api; import Invokers.ApiException; -import Model.InlineResponse400; +import Model.InlineResponse4001; import Model.ReportingV3ReportSubscriptionsGet200Response; import Model.ReportingV3ReportSubscriptionsGet200ResponseSubscriptions; import Model.Reportingv3ReportDownloadsGet400Response; diff --git a/src/test/java/Api/SecureFileShareApiTest.java b/src/test/java/Api/SecureFileShareApiTest.java index 4c4078c9d..d0b57b592 100644 --- a/src/test/java/Api/SecureFileShareApiTest.java +++ b/src/test/java/Api/SecureFileShareApiTest.java @@ -14,7 +14,7 @@ package Api; import Invokers.ApiException; -import Model.InlineResponse400; +import Model.InlineResponse4001; import org.joda.time.LocalDate; import Model.V1FileDetailsGet200Response; import org.junit.Test; diff --git a/src/test/java/Api/TransactionBatchesApiTest.java b/src/test/java/Api/TransactionBatchesApiTest.java index a11f87f66..9c69769fd 100644 --- a/src/test/java/Api/TransactionBatchesApiTest.java +++ b/src/test/java/Api/TransactionBatchesApiTest.java @@ -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(); + /** + * Get transaction details for a given batch id + * + * Provides real-time detailed status information about the transactions that you previously uploaded in the Business Center or processed with the Offline Transaction File Submission service. + * + * @throws ApiException + * if the Api call fails + */ + @Test + public void getTransactionBatchDetailsTest() throws ApiException { + String id = null; + LocalDate uploadDate = null; + String status = null; + api.getTransactionBatchDetails(id, uploadDate, status); + + // TODO: test validations + } + /** * Get individual batch file *