diff --git a/docs/CreatePaymentRequest.md b/docs/CreatePaymentRequest.md
index b40ba2cdd..5a33a40cc 100644
--- a/docs/CreatePaymentRequest.md
+++ b/docs/CreatePaymentRequest.md
@@ -30,6 +30,7 @@ Name | Type | Description | Notes
**riskInformation** | [**Ptsv2paymentsRiskInformation**](Ptsv2paymentsRiskInformation.md) | | [optional]
**acquirerInformation** | [**Ptsv2paymentsAcquirerInformation**](Ptsv2paymentsAcquirerInformation.md) | | [optional]
**recurringPaymentInformation** | [**Ptsv2paymentsRecurringPaymentInformation**](Ptsv2paymentsRecurringPaymentInformation.md) | | [optional]
+**unscheduledPaymentInformation** | [**Ptsv2paymentsUnscheduledPaymentInformation**](Ptsv2paymentsUnscheduledPaymentInformation.md) | | [optional]
**hostedPaymentInformation** | [**Ptsv2paymentsHostedPaymentInformation**](Ptsv2paymentsHostedPaymentInformation.md) | | [optional]
**watchlistScreeningInformation** | [**Ptsv2paymentsWatchlistScreeningInformation**](Ptsv2paymentsWatchlistScreeningInformation.md) | | [optional]
diff --git a/docs/GenerateCaptureContextRequest.md b/docs/GenerateCaptureContextRequest.md
index 54667cfe0..0c96ff38d 100644
--- a/docs/GenerateCaptureContextRequest.md
+++ b/docs/GenerateCaptureContextRequest.md
@@ -6,8 +6,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**clientVersion** | **String** | Specify the version of Microform that you want to use. | [optional]
**targetOrigins** | **List<String>** | The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Microform is defined by the scheme (protocol), hostname (domain) and port number (if used). You must use https://hostname (unless you use http://localhost) Wildcards are NOT supported. Ensure that subdomains are included. Any valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc) Examples: - https://example.com - https://subdomain.example.com - https://example.com:8080<br><br> If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example: targetOrigins: [ \"https://example.com\", \"https://basket.example.com\", \"https://ecom.example.com\" ] | [optional]
-**allowedCardNetworks** | **List<String>** | The list of card networks you want to use for this Microform transaction. Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA | [optional]
-**checkoutApiInitialization** | [**Microformv2sessionsCheckoutApiInitialization**](Microformv2sessionsCheckoutApiInitialization.md) | | [optional]
+**allowedCardNetworks** | **List<String>** | The list of card networks you want to use for this Microform transaction. Microform currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA **Important:** - When integrating Microform (Accept Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request. - When integrating Microform (Accept Check) the allowedCardNetworks field is not required in the capture context request. - When integrating both Microform (Accept Card) and Microform (Accept Check) at least one card network should be specified in the allowedCardNetworks field in the capture context request. | [optional]
+**allowedPaymentTypes** | **List<String>** | The payment types that are allowed for the merchant. Possible values when launching Microform: - CARD - CHECK <br><br> | [optional]
diff --git a/docs/GenerateUnifiedCheckoutCaptureContextRequest.md b/docs/GenerateUnifiedCheckoutCaptureContextRequest.md
index 293828011..75ce3f1fa 100644
--- a/docs/GenerateUnifiedCheckoutCaptureContextRequest.md
+++ b/docs/GenerateUnifiedCheckoutCaptureContextRequest.md
@@ -7,12 +7,11 @@ Name | Type | Description | Notes
**clientVersion** | **String** | Specify the version of Unified Checkout that you want to use. | [optional]
**targetOrigins** | **List<String>** | The [target origin](https://developer.mozilla.org/en-US/docs/Glossary/Origin) of the website on which you will be launching Unified Checkout is defined by the scheme (protocol), hostname (domain) and port number (if used). You must use https://hostname (unless you use http://localhost) Wildcards are NOT supported. Ensure that subdomains are included. Any valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc) Examples: - https://example.com - https://subdomain.example.com - https://example.com:8080<br><br> If you are embedding within multiple nested iframes you need to specify the origins of all the browser contexts used, for example: targetOrigins: [ \"https://example.com\", \"https://basket.example.com\", \"https://ecom.example.com\" ] | [optional]
**allowedCardNetworks** | **List<String>** | The list of card networks you want to use for this Unified Checkout transaction. Unified Checkout currently supports the following card networks: - VISA - MASTERCARD - AMEX - CARNET - CARTESBANCAIRES - CUP - DINERSCLUB - DISCOVER - EFTPOS - ELO - JCB - JCREW - MADA - MAESTRO - MEEZA | [optional]
-**allowedPaymentTypes** | **List<String>** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - PANENTRY - GOOGLEPAY - SRC - CHECK <br><br> Possible values when launching Unified Checkout with Checkout API: - PANENTRY - SRC <br><br> Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <br><br> **Important:** - SRC and CLICKTOPAY are only available for Visa, Mastercard and AMEX. | [optional]
+**allowedPaymentTypes** | **List<String>** | The payment types that are allowed for the merchant. Possible values when launching Unified Checkout: - APPLEPAY - CHECK - CLICKTOPAY - GOOGLEPAY - PANENTRY - PAZE <br><br> Possible values when launching Click To Pay Drop-In UI: - CLICKTOPAY <br><br> **Important:** - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards. - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester. - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field. | [optional]
**country** | **String** | Country the purchase is originating from (e.g. country of the merchant). Use the two-character ISO Standard | [optional]
**locale** | **String** | Localization of the User experience conforming to the ISO 639-1 language standards and two-character ISO Standard Country Code. Please refer to list of [supported locales through Unified Checkout](https://developer.cybersource.com/docs/cybs/en-us/unified-checkout/developer/all/rest/unified-checkout/uc-appendix-languages.html) | [optional]
**captureMandate** | [**Upv1capturecontextsCaptureMandate**](Upv1capturecontextsCaptureMandate.md) | | [optional]
**orderInformation** | [**Upv1capturecontextsOrderInformation**](Upv1capturecontextsOrderInformation.md) | | [optional]
-**checkoutApiInitialization** | [**Upv1capturecontextsCheckoutApiInitialization**](Upv1capturecontextsCheckoutApiInitialization.md) | | [optional]
diff --git a/docs/InlineResponse2011.md b/docs/InlineResponse2011.md
index f5174e109..4534dcae1 100644
--- a/docs/InlineResponse2011.md
+++ b/docs/InlineResponse2011.md
@@ -7,8 +7,8 @@ Name | Type | Description | Notes
**id** | **String** | An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. | [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. Returned by Cybersource for all services. | [optional]
**status** | **String** | The status of the submitted transaction. Possible values: - COMPLETED - MULTIPLE - NO MATCH | [optional]
-**paymentAccountInformation** | [**InlineResponse2011PaymentAccountInformation**](InlineResponse2011PaymentAccountInformation.md) | | [optional]
-**issuerInformation** | [**InlineResponse2011IssuerInformation**](InlineResponse2011IssuerInformation.md) | | [optional]
+**paymentAccountInformation** | [**TmsBinLookupPaymentAccountInformation**](TmsBinLookupPaymentAccountInformation.md) | | [optional]
+**issuerInformation** | [**TmsBinLookupIssuerInformation**](TmsBinLookupIssuerInformation.md) | | [optional]
**payoutInformation** | [**InlineResponse2011PayoutInformation**](InlineResponse2011PayoutInformation.md) | | [optional]
diff --git a/docs/InlineResponse2011PaymentAccountInformation.md b/docs/InlineResponse2011PaymentAccountInformation.md
deleted file mode 100644
index 85df8899b..000000000
--- a/docs/InlineResponse2011PaymentAccountInformation.md
+++ /dev/null
@@ -1,12 +0,0 @@
-
-# InlineResponse2011PaymentAccountInformation
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**card** | [**InlineResponse2011PaymentAccountInformationCard**](InlineResponse2011PaymentAccountInformationCard.md) | | [optional]
-**features** | [**InlineResponse2011PaymentAccountInformationFeatures**](InlineResponse2011PaymentAccountInformationFeatures.md) | | [optional]
-**network** | [**InlineResponse2011PaymentAccountInformationNetwork**](InlineResponse2011PaymentAccountInformationNetwork.md) | | [optional]
-
-
-
diff --git a/docs/InstrumentIdentifierApi.md b/docs/InstrumentIdentifierApi.md
index 45d8c3853..a9c683ba1 100644
--- a/docs/InstrumentIdentifierApi.md
+++ b/docs/InstrumentIdentifierApi.md
@@ -60,7 +60,7 @@ No authorization required
# **getInstrumentIdentifier**
-> PostInstrumentIdentifierRequest getInstrumentIdentifier(instrumentIdentifierId, profileId)
+> PostInstrumentIdentifierRequest getInstrumentIdentifier(instrumentIdentifierId, profileId, retrieveBinDetails)
Retrieve an Instrument Identifier
@@ -76,8 +76,9 @@ Retrieve an Instrument Identifier
InstrumentIdentifierApi apiInstance = new InstrumentIdentifierApi();
String instrumentIdentifierId = "instrumentIdentifierId_example"; // String | The Id of an Instrument Identifier.
String profileId = "profileId_example"; // String | The Id of a profile containing user specific TMS configuration.
+Boolean retrieveBinDetails = true; // Boolean | Retrieve the Bin Details of PAN or network token
try {
- PostInstrumentIdentifierRequest result = apiInstance.getInstrumentIdentifier(instrumentIdentifierId, profileId);
+ PostInstrumentIdentifierRequest result = apiInstance.getInstrumentIdentifier(instrumentIdentifierId, profileId, retrieveBinDetails);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InstrumentIdentifierApi#getInstrumentIdentifier");
@@ -91,6 +92,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**instrumentIdentifierId** | **String**| The Id of an Instrument Identifier. |
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
### Return type
@@ -107,7 +109,7 @@ No authorization required
# **getInstrumentIdentifierPaymentInstrumentsList**
-> PaymentInstrumentList1 getInstrumentIdentifierPaymentInstrumentsList(instrumentIdentifierId, profileId, offset, limit)
+> PaymentInstrumentList1 getInstrumentIdentifierPaymentInstrumentsList(instrumentIdentifierId, profileId, retrieveBinDetails, offset, limit)
List Payment Instruments for an Instrument Identifier
@@ -123,10 +125,11 @@ List Payment Instruments for an Instrument Identifier
InstrumentIdentifierApi apiInstance = new InstrumentIdentifierApi();
String instrumentIdentifierId = "instrumentIdentifierId_example"; // String | The Id of an Instrument Identifier.
String profileId = "profileId_example"; // String | The Id of a profile containing user specific TMS configuration.
+Boolean retrieveBinDetails = true; // Boolean | Retrieve the Bin Details of PAN or network token
Long offset = 0L; // Long | Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0.
Long limit = 20L; // Long | The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100.
try {
- PaymentInstrumentList1 result = apiInstance.getInstrumentIdentifierPaymentInstrumentsList(instrumentIdentifierId, profileId, offset, limit);
+ PaymentInstrumentList1 result = apiInstance.getInstrumentIdentifierPaymentInstrumentsList(instrumentIdentifierId, profileId, retrieveBinDetails, offset, limit);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InstrumentIdentifierApi#getInstrumentIdentifierPaymentInstrumentsList");
@@ -140,6 +143,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**instrumentIdentifierId** | **String**| The Id of an Instrument Identifier. |
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
**offset** | **Long**| Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. | [optional] [default to 0]
**limit** | **Long**| The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. | [optional] [default to 20]
@@ -158,7 +162,7 @@ No authorization required
# **patchInstrumentIdentifier**
-> PatchInstrumentIdentifierRequest patchInstrumentIdentifier(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, ifMatch)
+> PatchInstrumentIdentifierRequest patchInstrumentIdentifier(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, retrieveBinDetails, ifMatch)
Update an Instrument Identifier
@@ -175,9 +179,10 @@ InstrumentIdentifierApi apiInstance = new InstrumentIdentifierApi();
String instrumentIdentifierId = "instrumentIdentifierId_example"; // String | The Id of an Instrument Identifier.
PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest = new PatchInstrumentIdentifierRequest(); // PatchInstrumentIdentifierRequest | Specify the previous transaction Id to update.
String profileId = "profileId_example"; // String | The Id of a profile containing user specific TMS configuration.
+Boolean retrieveBinDetails = true; // Boolean | Retrieve the Bin Details of PAN or network token
String ifMatch = "ifMatch_example"; // String | Contains an ETag value from a GET request to make the request conditional.
try {
- PatchInstrumentIdentifierRequest result = apiInstance.patchInstrumentIdentifier(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, ifMatch);
+ PatchInstrumentIdentifierRequest result = apiInstance.patchInstrumentIdentifier(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, retrieveBinDetails, ifMatch);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InstrumentIdentifierApi#patchInstrumentIdentifier");
@@ -192,6 +197,7 @@ Name | Type | Description | Notes
**instrumentIdentifierId** | **String**| The Id of an Instrument Identifier. |
**patchInstrumentIdentifierRequest** | [**PatchInstrumentIdentifierRequest**](PatchInstrumentIdentifierRequest.md)| Specify the previous transaction Id to update. |
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
**ifMatch** | **String**| Contains an ETag value from a GET request to make the request conditional. | [optional]
### Return type
@@ -209,7 +215,7 @@ No authorization required
# **postInstrumentIdentifier**
-> PostInstrumentIdentifierRequest postInstrumentIdentifier(postInstrumentIdentifierRequest, profileId)
+> PostInstrumentIdentifierRequest postInstrumentIdentifier(postInstrumentIdentifierRequest, profileId, retrieveBinDetails)
Create an Instrument Identifier
@@ -225,8 +231,9 @@ Create an Instrument Identifier
InstrumentIdentifierApi apiInstance = new InstrumentIdentifierApi();
PostInstrumentIdentifierRequest postInstrumentIdentifierRequest = new PostInstrumentIdentifierRequest(); // PostInstrumentIdentifierRequest | Specify either a Card, Bank Account or Enrollable Card
String profileId = "profileId_example"; // String | The Id of a profile containing user specific TMS configuration.
+Boolean retrieveBinDetails = true; // Boolean | Retrieve the Bin Details of PAN or network token
try {
- PostInstrumentIdentifierRequest result = apiInstance.postInstrumentIdentifier(postInstrumentIdentifierRequest, profileId);
+ PostInstrumentIdentifierRequest result = apiInstance.postInstrumentIdentifier(postInstrumentIdentifierRequest, profileId, retrieveBinDetails);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling InstrumentIdentifierApi#postInstrumentIdentifier");
@@ -240,6 +247,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**postInstrumentIdentifierRequest** | [**PostInstrumentIdentifierRequest**](PostInstrumentIdentifierRequest.md)| Specify either a Card, Bank Account or Enrollable Card |
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
### Return type
diff --git a/docs/Microformv2sessionsCheckoutApiInitialization.md b/docs/Microformv2sessionsCheckoutApiInitialization.md
deleted file mode 100644
index bdc5d1b45..000000000
--- a/docs/Microformv2sessionsCheckoutApiInitialization.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-# Microformv2sessionsCheckoutApiInitialization
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**profileId** | **String** | | [optional]
-**accessKey** | **String** | | [optional]
-**referenceNumber** | **String** | | [optional]
-**transactionUuid** | **String** | | [optional]
-**transactionType** | **String** | | [optional]
-**currency** | **String** | | [optional]
-**amount** | **String** | | [optional]
-**locale** | **String** | Locale where application is being used. This field controls aspects of the application such as the language it will be rendered in. | [optional]
-**overrideCustomReceiptPage** | **String** | | [optional]
-**unsignedFieldNames** | **String** | | [optional]
-
-
-
diff --git a/docs/OctCreatePaymentRequest.md b/docs/OctCreatePaymentRequest.md
index fcf39dd45..01bd1827c 100644
--- a/docs/OctCreatePaymentRequest.md
+++ b/docs/OctCreatePaymentRequest.md
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
**senderInformation** | [**Ptsv2payoutsSenderInformation**](Ptsv2payoutsSenderInformation.md) | | [optional]
**processingInformation** | [**Ptsv2payoutsProcessingInformation**](Ptsv2payoutsProcessingInformation.md) | | [optional]
**paymentInformation** | [**Ptsv2payoutsPaymentInformation**](Ptsv2payoutsPaymentInformation.md) | | [optional]
+**aggregatorInformation** | [**Ptsv2payoutsAggregatorInformation**](Ptsv2payoutsAggregatorInformation.md) | | [optional]
diff --git a/docs/PatchInstrumentIdentifierRequest.md b/docs/PatchInstrumentIdentifierRequest.md
index 2b0c6e100..e0cee8e46 100644
--- a/docs/PatchInstrumentIdentifierRequest.md
+++ b/docs/PatchInstrumentIdentifierRequest.md
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
**processingInformation** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) | | [optional]
**billTo** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) | | [optional]
**metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) | | [optional]
+**embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) | | [optional]
diff --git a/docs/PaymentInstrumentApi.md b/docs/PaymentInstrumentApi.md
index 08e5f12ed..0049bcdcd 100644
--- a/docs/PaymentInstrumentApi.md
+++ b/docs/PaymentInstrumentApi.md
@@ -58,7 +58,7 @@ No authorization required
# **getPaymentInstrument**
-> PostPaymentInstrumentRequest getPaymentInstrument(paymentInstrumentId, profileId)
+> PostPaymentInstrumentRequest getPaymentInstrument(paymentInstrumentId, profileId, retrieveBinDetails)
Retrieve a Payment Instrument
@@ -74,8 +74,9 @@ Retrieve a Payment Instrument
PaymentInstrumentApi apiInstance = new PaymentInstrumentApi();
String paymentInstrumentId = "paymentInstrumentId_example"; // String | The Id of a payment instrument.
String profileId = "profileId_example"; // String | The Id of a profile containing user specific TMS configuration.
+Boolean retrieveBinDetails = true; // Boolean | Retrieve the Bin Details of PAN or network token
try {
- PostPaymentInstrumentRequest result = apiInstance.getPaymentInstrument(paymentInstrumentId, profileId);
+ PostPaymentInstrumentRequest result = apiInstance.getPaymentInstrument(paymentInstrumentId, profileId, retrieveBinDetails);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentInstrumentApi#getPaymentInstrument");
@@ -89,6 +90,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**paymentInstrumentId** | **String**| The Id of a payment instrument. |
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
### Return type
@@ -105,7 +107,7 @@ No authorization required
# **patchPaymentInstrument**
-> PatchPaymentInstrumentRequest patchPaymentInstrument(paymentInstrumentId, patchPaymentInstrumentRequest, profileId, ifMatch)
+> PatchPaymentInstrumentRequest patchPaymentInstrument(paymentInstrumentId, patchPaymentInstrumentRequest, profileId, retrieveBinDetails, ifMatch)
Update a Payment Instrument
@@ -122,9 +124,10 @@ PaymentInstrumentApi apiInstance = new PaymentInstrumentApi();
String paymentInstrumentId = "paymentInstrumentId_example"; // String | The Id of a payment instrument.
PatchPaymentInstrumentRequest patchPaymentInstrumentRequest = new PatchPaymentInstrumentRequest(); // PatchPaymentInstrumentRequest |
String profileId = "profileId_example"; // String | The Id of a profile containing user specific TMS configuration.
+Boolean retrieveBinDetails = true; // Boolean | Retrieve the Bin Details of PAN or network token
String ifMatch = "ifMatch_example"; // String | Contains an ETag value from a GET request to make the request conditional.
try {
- PatchPaymentInstrumentRequest result = apiInstance.patchPaymentInstrument(paymentInstrumentId, patchPaymentInstrumentRequest, profileId, ifMatch);
+ PatchPaymentInstrumentRequest result = apiInstance.patchPaymentInstrument(paymentInstrumentId, patchPaymentInstrumentRequest, profileId, retrieveBinDetails, ifMatch);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentInstrumentApi#patchPaymentInstrument");
@@ -139,6 +142,7 @@ Name | Type | Description | Notes
**paymentInstrumentId** | **String**| The Id of a payment instrument. |
**patchPaymentInstrumentRequest** | [**PatchPaymentInstrumentRequest**](PatchPaymentInstrumentRequest.md)| |
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
**ifMatch** | **String**| Contains an ETag value from a GET request to make the request conditional. | [optional]
### Return type
@@ -156,7 +160,7 @@ No authorization required
# **postPaymentInstrument**
-> PostPaymentInstrumentRequest postPaymentInstrument(postPaymentInstrumentRequest, profileId)
+> PostPaymentInstrumentRequest postPaymentInstrument(postPaymentInstrumentRequest, profileId, retrieveBinDetails)
Create a Payment Instrument
@@ -172,8 +176,9 @@ Create a Payment Instrument
PaymentInstrumentApi apiInstance = new PaymentInstrumentApi();
PostPaymentInstrumentRequest postPaymentInstrumentRequest = new PostPaymentInstrumentRequest(); // PostPaymentInstrumentRequest |
String profileId = "profileId_example"; // String | The Id of a profile containing user specific TMS configuration.
+Boolean retrieveBinDetails = true; // Boolean | Retrieve the Bin Details of PAN or network token
try {
- PostPaymentInstrumentRequest result = apiInstance.postPaymentInstrument(postPaymentInstrumentRequest, profileId);
+ PostPaymentInstrumentRequest result = apiInstance.postPaymentInstrument(postPaymentInstrumentRequest, profileId, retrieveBinDetails);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling PaymentInstrumentApi#postPaymentInstrument");
@@ -187,6 +192,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**postPaymentInstrumentRequest** | [**PostPaymentInstrumentRequest**](PostPaymentInstrumentRequest.md)| |
**profileId** | **String**| The Id of a profile containing user specific TMS configuration. | [optional]
+ **retrieveBinDetails** | **Boolean**| Retrieve the Bin Details of PAN or network token | [optional]
### Return type
diff --git a/docs/PostInstrumentIdentifierEnrollmentRequest.md b/docs/PostInstrumentIdentifierEnrollmentRequest.md
index 370a8c2d9..6fcbdaf23 100644
--- a/docs/PostInstrumentIdentifierEnrollmentRequest.md
+++ b/docs/PostInstrumentIdentifierEnrollmentRequest.md
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
**processingInformation** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) | | [optional]
**billTo** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) | | [optional]
**metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) | | [optional]
+**embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) | | [optional]
diff --git a/docs/PostInstrumentIdentifierRequest.md b/docs/PostInstrumentIdentifierRequest.md
index 44c552215..6c920f7ab 100644
--- a/docs/PostInstrumentIdentifierRequest.md
+++ b/docs/PostInstrumentIdentifierRequest.md
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
**processingInformation** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) | | [optional]
**billTo** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) | | [optional]
**metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) | | [optional]
+**embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) | | [optional]
diff --git a/docs/PostPaymentCredentialsRequest.md b/docs/PostPaymentCredentialsRequest.md
index f573e42b0..e0c86ae53 100644
--- a/docs/PostPaymentCredentialsRequest.md
+++ b/docs/PostPaymentCredentialsRequest.md
@@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**paymentCredentialType** | **String** | The type of payment credentials to be returned. By default, payment credentials include network token and cryptogram or dynamic CVV. If \"NETWORK_TOKEN\" is supplied then only network token will be returned and cryptogram or dynamic CVV will be excluded. Possible Values: - NETWORK_TOKEN | [optional]
+**paymentCredentialType** | **String** | The type of payment credentials to be returned. By default, payment credentials include network token and cryptogram or dynamic CVV. If \"NETWORK_TOKEN\" is supplied then only network token card number will be returned and no cryptogram or dynamic CVV will be requested. If \"SECURITY_CODE\" is supplied then dynamic CVV will be requested and returned with the network token card number. Dynamic CVV is only supported for Amex and SCOF. If \"CRYPTOGRAM\" is supplied then cryptogram will be requested and returned with the network token card number. Cryptogram is NOT supported for Amex. Possible Values: - NETWORK_TOKEN - SECURITY_CODE - CRYPTOGRAM | [optional]
diff --git a/docs/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation.md b/docs/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation.md
index 4de9fd1bb..5fa372e24 100644
--- a/docs/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation.md
+++ b/docs/PtsV2IncrementalAuthorizationPatch201ResponseProcessorInformation.md
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
**systemTraceAuditNumber** | **String** | This field is returned only for **American Express Direct** and **CyberSource through VisaNet**. Returned by authorization and incremental authorization services. #### American Express Direct System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute. #### CyberSource through VisaNet System trace number that must be printed on the customer's receipt. | [optional]
**responseDetails** | **String** | This field might contain information about a decline. This field is supported only for **CyberSource through VisaNet**. | [optional]
**merchantAdvice** | [**PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice**](PtsV2PaymentsPost201ResponseProcessorInformationMerchantAdvice.md) | | [optional]
+**merchantRiskPrediction** | **String** | Mastercard is introducing the Merchant Risk Predict Service in the middle East/Africa Region. A newly launched service comprised of seven independent artificial intelligence (AI)-powered scores intended to augment existing merchant risk management practices. | [optional]
**sellerProtection** | [**PtsV2PaymentsPost201ResponseProcessorInformationSellerProtection**](PtsV2PaymentsPost201ResponseProcessorInformationSellerProtection.md) | | [optional]
diff --git a/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md b/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md
index 1cd84b8e8..c0487a9b4 100644
--- a/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md
+++ b/docs/PtsV2PaymentsPost201ResponseConsumerAuthenticationInformation.md
@@ -41,6 +41,7 @@ Name | Type | Description | Notes
**whiteListStatusSource** | **String** | This data element will be populated by the system setting Whitelist Status. Possible Values: 01 - 3DS/ Server/ 02 – DS/03 - ACS | [optional]
**xid** | **String** | Transaction identifier generated by CyberSource for successful enrollment or validation checks. Use this value, which is in base64, to match an outgoing PAReq with an incoming PARes. CyberSource forwards the XID with the card authorization service to these payment processors in these cases: - Barclays - Streamline (when the **ecommerceIndicator**`=spa`) | [optional]
**directoryServerTransactionId** | **String** | The Directory Server Transaction ID is generated by the Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results. For Cybersource Through Visanet Gateway: The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 114-149, Field: MC AVV Verification—Directory Server Transaction ID | [optional]
+**dataQualityIndicator** | **String** | The field is used to indicate that a transaction does not meet the Visa Secure authentication data quality requirements. | [optional]
**authenticationResult** | **String** | Raw authentication data that comes from the cardissuing bank. Primary authentication field that indicates if authentication was successful and if liability shift occurred. You should examine first the result of this field. This field contains one of these values: - `-1`: Invalid PARes. - `0`: Successful validation. - `1`: Cardholder is not participating, but the attempt to authenticate was recorded. - `6`: Issuer unable to perform authentication. - `9`: Cardholder did not complete authentication. | [optional]
**authenticationStatusMsg** | **String** | Message that explains the authenticationResult reply field. | [optional]
**indicator** | **String** | Indicator used to differentiate Internet transactions from other types. The authentication failed if this field is not returned. For Visa, if your payment processor is Streamline, Barclays, AIBMS, or FDC Germany, you receive the value vbv_failure instead of internet when eci is 07. The value of this field is passed automatically to the authorization service if you request the services together. This field contains one of these values: - `aesk`: American Express SafeKey authentication verified successfully. - `aesk_attempted`: Card not enrolled in American Express SafeKey, but the attempt to authenticate was recorded. - `dipb`: Discover ProtectBuy authentication verified successfully. - `dipb_attempted`: Card not enrolled in Discover ProtectBuy, but the attempt to authenticate was recorded. - `internet`: Authentication was not verified successfully. - `js`: J/Secure authentication verified successfully. - `js_attempted`: Card not enrolled in J/Secure, but the attempt to authenticate was recorded. - `moto`: Mail or telephone order. - `pb_attempted`: Card not enrolled in Diners Club ProtectBuy, but the attempt to authenticate was recorded. - `recurring`: Recurring transaction. - `spa`: Mastercard Identity Check authentication verified successfully. - `spa_failure`: Mastercard Identity Check failed authentication. - `vbv`: Visa Secure authentication verified successfully. - `vbv_attempted`: Card not enrolled in Visa Secure, but the attempt to authenticate was recorded. - `vbv_failure`: Visa Secure authentication unavailable. | [optional]
diff --git a/docs/PtsV2PaymentsPost201ResponseEmbeddedActions.md b/docs/PtsV2PaymentsPost201ResponseEmbeddedActions.md
index 36cc0ab64..70e51c40f 100644
--- a/docs/PtsV2PaymentsPost201ResponseEmbeddedActions.md
+++ b/docs/PtsV2PaymentsPost201ResponseEmbeddedActions.md
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
**CONSUMER_AUTHENTICATION** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION**](PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION.md) | | [optional]
**VALIDATE_CONSUMER_AUTHENTICATION** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION**](PtsV2PaymentsPost201ResponseEmbeddedActionsCONSUMERAUTHENTICATION.md) | | [optional]
**WATCHLIST_SCREENING** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING**](PtsV2PaymentsPost201ResponseEmbeddedActionsWATCHLISTSCREENING.md) | | [optional]
+**TOKEN_CREATE** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENCREATE**](PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENCREATE.md) | | [optional]
+**TOKEN_UPDATE** | [**PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENUPDATE**](PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENUPDATE.md) | | [optional]
diff --git a/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENCREATE.md b/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENCREATE.md
new file mode 100644
index 000000000..f0fd6a64f
--- /dev/null
+++ b/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENCREATE.md
@@ -0,0 +1,12 @@
+
+# PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENCREATE
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | The status of the token create. Possible value is: - SUCCESS - SERVER_ERROR - INVALID_REQUEST | [optional]
+**reason** | **String** | The reason of the status. Possible values: - INVALID_DATA - SYSTEM_ERROR - MISSING_FIELD | [optional]
+**message** | **String** | The detail message related to the status and reason listed above. | [optional]
+
+
+
diff --git a/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENUPDATE.md b/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENUPDATE.md
new file mode 100644
index 000000000..2edc3e067
--- /dev/null
+++ b/docs/PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENUPDATE.md
@@ -0,0 +1,12 @@
+
+# PtsV2PaymentsPost201ResponseEmbeddedActionsTOKENUPDATE
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | The status of the token update. Possible value is: - SUCCESS - SERVER_ERROR - INVALID_REQUEST | [optional]
+**reason** | **String** | The reason of the status. Possible values: - INVALID_DATA - SYSTEM_ERROR - MISSING_FIELD | [optional]
+**message** | **String** | The detail message related to the status and reason listed above. | [optional]
+
+
+
diff --git a/docs/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.md b/docs/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.md
index 2f2adcf23..006f1c955 100644
--- a/docs/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.md
+++ b/docs/PtsV2PaymentsPost201ResponsePaymentInformationAccountFeatures.md
@@ -22,6 +22,7 @@ Name | Type | Description | Notes
**signatureDebit** | **String** | Indicates whether the card is a signature debit card. This information enables you to alter the way an order is processed. For example, you might not want to reauthorize a transaction for a signature debit card, or you might want to perform reversals promptly for a signature debit card. This field is supported for Visa, Mastercard, and Maestro (International) on Chase Paymentech Solutions. Possible values: - `Y`: Yes - `N`: No - `X`: Not applicable / Unknown | [optional]
**prepaid** | **String** | Indicates whether the card is a prepaid card. This information enables you to determine when a gift card or prepaid card is presented for use when establishing a new recurring, installment, or deferred billing relationship. This field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions. Possible values: - `Y`: Yes - `N`: No - `X`: Not applicable / Unknown | [optional]
**regulated** | **String** | Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card issuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover, Diners Club, and JCB on Chase Paymentech Solutions. Possible values: - `Y`: Yes - `N`: No - `X`: Not applicable / Unknown | [optional]
+**accountHolderType** | **String** | This is the account owner information, valid values are: - `01` : primary account holder - `02` : secondary account holder This is returned in the response of an account verification transaction by the Issuer. | [optional]
diff --git a/docs/PtsV2PaymentsPost201ResponseProcessingInformation.md b/docs/PtsV2PaymentsPost201ResponseProcessingInformation.md
index 03bba4b5d..2ef40e262 100644
--- a/docs/PtsV2PaymentsPost201ResponseProcessingInformation.md
+++ b/docs/PtsV2PaymentsPost201ResponseProcessingInformation.md
@@ -8,6 +8,8 @@ Name | Type | Description | Notes
**paymentSolution** | **String** | Type of digital payment solution for the transaction. Possible Values: - `visacheckout`: Visa Checkout. This value is required for Visa Checkout transactions. For details, see `payment_solution` field description in [Visa Checkout Using the REST API.](https://developer.cybersource.com/content/dam/docs/cybs/en-us/apifields/reference/all/rest/api-fields.pdf) - `001`: Apple Pay. - `004`: Cybersource In-App Solution. - `005`: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. - `006`: Android Pay. - `007`: Chase Pay. - `008`: Samsung Pay. - `012`: Google Pay. - `013`: Cybersource P2PE Decryption - `014`: Mastercard credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `015`: Visa credential on file (COF) payment network token. Returned in authorizations that use a payment network token associated with a TMS token. - `027`: Click to Pay. | [optional]
**enhancedDataEnabled** | **Boolean** | The possible values for the reply field are: - `true` : the airline data was included in the request to the processor. - `false` : the airline data was not included in the request to the processor. Returned by authorization, capture, or credit services. | [optional]
**captureOptions** | [**PtsV2PaymentsPost201ResponseProcessingInformationCaptureOptions**](PtsV2PaymentsPost201ResponseProcessingInformationCaptureOptions.md) | | [optional]
+**authorizationOptions** | [**PtsV2PaymentsPost201ResponseProcessingInformationAuthorizationOptions**](PtsV2PaymentsPost201ResponseProcessingInformationAuthorizationOptions.md) | | [optional]
+**purchaseOptions** | [**PtsV2PaymentsPost201ResponseProcessingInformationPurchaseOptions**](PtsV2PaymentsPost201ResponseProcessingInformationPurchaseOptions.md) | | [optional]
diff --git a/docs/PtsV2PaymentsPost201ResponseProcessingInformationAuthorizationOptions.md b/docs/PtsV2PaymentsPost201ResponseProcessingInformationAuthorizationOptions.md
new file mode 100644
index 000000000..949d5d96a
--- /dev/null
+++ b/docs/PtsV2PaymentsPost201ResponseProcessingInformationAuthorizationOptions.md
@@ -0,0 +1,10 @@
+
+# PtsV2PaymentsPost201ResponseProcessingInformationAuthorizationOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**serviceType** | **String** | Field is used for back-to-back funding transaction and can be defined as a payment flow that automatically transfers funds through a real-time funding or a live-load. This type of transaction can also be connected to a purchase. In back-to-back funding of general purpose card that is used to make a purchase, two separate accounts are involved: - account one is used to make the purchase - account two is used to automatically fund or reimburse account one Possible values: - 0B = back to back funding transaction - 00 = normal transaction - 01 = originator hold - 02 = Visa deferred OCT hold, default interval - 03 = Visa deferred OCT hold, user-defined interval - 09 = Cancel pending deferred OCT request - 0I = Visa Direct custom program 1 - 0Q = uery the status of the deferred OCT - A0 = Alias Directory 2 | [optional]
+
+
+
diff --git a/docs/PtsV2PaymentsPost201ResponseProcessingInformationPurchaseOptions.md b/docs/PtsV2PaymentsPost201ResponseProcessingInformationPurchaseOptions.md
new file mode 100644
index 000000000..a237a7377
--- /dev/null
+++ b/docs/PtsV2PaymentsPost201ResponseProcessingInformationPurchaseOptions.md
@@ -0,0 +1,13 @@
+
+# PtsV2PaymentsPost201ResponseProcessingInformationPurchaseOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**eligibilityIndicator** | **String** | This field contains installment data defined by MasterCard. Possible values: - Y = eligible - N = not eligile | [optional]
+**type** | **String** | Data mapped received in response from MasterCard. Possible values: - 01 = Meal Voucher - Employee Nutrition Program - 02 = Food Voucher - Employee Nutrition Program - 03 = Culture Voucher - Worker's Culture Program - 04 = Meal Voucher - Consolidation of Labor Laws - 05 = Food Voucher - Consolidation of Labor Laws | [optional]
+**benefitAmount** | **String** | Workplace benefit amount. | [optional]
+**benefitType** | **String** | Workplace benefit type. Possible values: - 70 = employee benefit - 4T = transportation / transit - 52 = general benefit - 53 = meal voucher - 54 = fuel - 55 = ecological / sustainability - 58 = philanthropy / patronage / consumption - 59 = gift - 5S = sport / culture - 5T = book / education | [optional]
+
+
+
diff --git a/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md b/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md
index f190b8562..f551dc6be 100644
--- a/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md
+++ b/docs/PtsV2PaymentsPost201ResponseProcessorInformation.md
@@ -48,6 +48,7 @@ Name | Type | Description | Notes
**expirationTimeUtc** | **String** | The date and time when the authorized payment expires, in Internet date and time format. | [optional]
**orderId** | **String** | The id of the order | [optional]
**orderStatus** | **String** | The order status. Possible values: - `CREATED` - `VOIDED` - `COMPLETED` - `PAYER_ACTION_REQUIRED` | [optional]
+**merchantRiskPrediction** | **String** | Mastercard is introducing the Merchant Risk Predict Service in the middle East/Africa Region. A newly launched service comprised of seven independent artificial intelligence (AI)-powered scores intended to augment existing merchant risk management practices. | [optional]
diff --git a/docs/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.md b/docs/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.md
index 3e01d79f6..990cd0585 100644
--- a/docs/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.md
+++ b/docs/PtsV2PaymentsReversalsPost201ResponseProcessorInformation.md
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**transactionId** | **String** | Processor transaction ID. This value identifies the transaction on a host system. This value is supported only for Moneris. It contains this information: - Terminal used to process the transaction - Shift during which the transaction took place - Batch number - Transaction number within the batch You must store this value. If you give the customer a receipt, display this value on the receipt. Example For the value 66012345001069003: - Terminal ID = 66012345 - Shift number = 001 - Batch number = 069 - Transaction number = 003 | [optional]
**responseCode** | **String** | For most processors, this is the error message sent directly from the bank. Returned only when the processor returns this value. **Important** Do not use this field to evaluate the result of the authorization. #### PIN debit Response value that is returned by the processor or bank. **Important** Do not use this field to evaluate the results of the transaction request. Returned by PIN debit credit, PIN debit purchase, and PIN debit reversal. #### 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 `processorInformation.responseCategoryCode` field. String (3) #### paypalgateway Processor generated ID for the itemized detail. | [optional]
+**networkTransactionId** | **String** | Same value as `processorInformation.transactionId` | [optional]
**responseCategoryCode** | **String** | Processor-defined response category code. The associated detail error code is in the `processorInformation.responseCode` or `issuerInformation.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: 36 - 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 #### 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]
diff --git a/docs/PtsV2PayoutsPost201Response.md b/docs/PtsV2PayoutsPost201Response.md
index 7909ea2e3..e6343970f 100644
--- a/docs/PtsV2PayoutsPost201Response.md
+++ b/docs/PtsV2PayoutsPost201Response.md
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
**recipientInformation** | [**PtsV2PayoutsPost201ResponseRecipientInformation**](PtsV2PayoutsPost201ResponseRecipientInformation.md) | | [optional]
**issuerInformation** | [**PtsV2PayoutsPost201ResponseIssuerInformation**](PtsV2PayoutsPost201ResponseIssuerInformation.md) | | [optional]
**tokenInformation** | [**PtsV2PaymentsPost201ResponseTokenInformation**](PtsV2PaymentsPost201ResponseTokenInformation.md) | | [optional]
+**processingInformation** | [**PtsV2PayoutsPost201ResponseProcessingInformation**](PtsV2PayoutsPost201ResponseProcessingInformation.md) | | [optional]
diff --git a/docs/PtsV2PayoutsPost201ResponseProcessingInformation.md b/docs/PtsV2PayoutsPost201ResponseProcessingInformation.md
new file mode 100644
index 000000000..dfec6dd72
--- /dev/null
+++ b/docs/PtsV2PayoutsPost201ResponseProcessingInformation.md
@@ -0,0 +1,10 @@
+
+# PtsV2PayoutsPost201ResponseProcessingInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**purchaseOptions** | [**Ptsv2payoutsProcessingInformationPurchaseOptions**](Ptsv2payoutsProcessingInformationPurchaseOptions.md) | | [optional]
+
+
+
diff --git a/docs/Ptsv2billingagreementsInstallmentInformation.md b/docs/Ptsv2billingagreementsInstallmentInformation.md
index 292c253cf..bdfd5e624 100644
--- a/docs/Ptsv2billingagreementsInstallmentInformation.md
+++ b/docs/Ptsv2billingagreementsInstallmentInformation.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
**lastInstallmentDate** | **String** | End date of the SI transactions. Cannot be later than card expiry date. Ideally this can be set to expiry date. Required in case the authentication is initiated for SI registration. | [optional]
**maxAmount** | **String** | Maximum Amount for which SI can be initiated. Required in case the authentication is initiated for SI registration. | [optional]
**minAmount** | **String** | Minimum Amount for which SI can be initiated. Required in case the authentication is initiated for SI registration. | [optional]
-**paymentType** | **String** | Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information | [optional]
+**paymentType** | **String** | Payment plan for the installments. This field is supported only for installment payments on Visa Platform Connect, RuPay and SPG-KSA seamless flow. Possible values for a standing-instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card: - 1: SI with a fixed amount. - 2: SI with a maximum amount. - 3: Other kind of SI. Possible values for a type of Installment transaction for on-soil transaction in Kingdom of Saudi Arabia - 1: Registration or first transaction. - 2: Subsequent transaction. Possible values for other kinds of installment payments: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. - 6: SI de-registration on RuPay for the payer authentication seamless flow. | [optional]
**preferredDay** | **String** | Preferred date for initiating the SI transaction every month. This field need not be sent in case the SI has to be initiated as and when required, e.g., topping up the wallet, etc. | [optional]
**sequence** | **Integer** | Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor. For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number * 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]
diff --git a/docs/Ptsv2paymentsAggregatorInformation.md b/docs/Ptsv2paymentsAggregatorInformation.md
index 06392814f..d2ebf0022 100644
--- a/docs/Ptsv2paymentsAggregatorInformation.md
+++ b/docs/Ptsv2paymentsAggregatorInformation.md
@@ -7,6 +7,11 @@ Name | Type | Description | Notes
**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: Payment Facilitator ID This field is supported for Visa, Mastercard and Discover Transactions. **FDC Compass**\\ This value must consist of uppercase characters. | [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. | [optional]
**subMerchant** | [**Ptsv2paymentsAggregatorInformationSubMerchant**](Ptsv2paymentsAggregatorInformationSubMerchant.md) | | [optional]
+**streetAddress** | **String** | Acquirer street name. | [optional]
+**city** | **String** | Acquirer city. | [optional]
+**state** | **String** | Acquirer state. | [optional]
+**postalCode** | **String** | Acquirer postal code. | [optional]
+**country** | **String** | Acquirer country. | [optional]
diff --git a/docs/Ptsv2paymentsConsumerAuthenticationInformation.md b/docs/Ptsv2paymentsConsumerAuthenticationInformation.md
index 74b87e3fb..396f47745 100644
--- a/docs/Ptsv2paymentsConsumerAuthenticationInformation.md
+++ b/docs/Ptsv2paymentsConsumerAuthenticationInformation.md
@@ -58,9 +58,12 @@ Name | Type | Description | Notes
**secureCorporatePaymentIndicator** | **String** | Indicates dedicated payment processes and procedures were used, potential secure corporate payment exemption applies. Possible Values : 0/1 | [optional]
**transactionMode** | **String** | Transaction mode identifier. Identifies the channel from which the transaction originates. Possible values: - `M`: MOTO (Mail Order Telephone Order) - `R`: Retail - `S`: eCommerce - `P`: Mobile Device - `T`: Tablet | [optional]
**whiteListStatus** | **String** | Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor. Possible Values: Y - 3DS Requestor is whitelisted by cardholder N - 3DS Requestor is not whitelisted by cardholder | [optional]
+**authenticationBrand** | **String** | Indicates which directory server was used while authentication process, this data is useful in case of scenarios when domestic scheme directory server is not present and authentication fallbacks to global scheme directory server. Possible values: - VISA - Returned for Mada VISA Co-badged cards, when authentication falls back to VISA Directory Server - MASTERCARD - Returned for Mada MasterCard Co-badged cards, when authentication falls back to MasterCard Directory Server | [optional]
**effectiveAuthenticationType** | **String** | This field describes the type of 3DS transaction flow that took place. It can be one of three possible flows; CH - Challenge FR - Frictionless FD - Frictionless with delegation, (challenge not generated by the issuer but by the scheme on behalf of the issuer). | [optional]
**signedParesStatusReason** | **String** | Provides additional information as to why the PAResStatus has a specific value. | [optional]
**signedPares** | **String** | Payer authentication result (PARes) message returned by the card-issuing bank. If you need to show proof of enrollment checking, you may need to decrypt and parse the string for the information required by the payment card company. For more information, see \"Storing Payer Authentication Data,\" page 160. Important The value is in base64. You must remove all carriage returns and line feeds before adding the PARes to the request. | [optional]
+**acsReferenceNumber** | **String** | Unique identifier assigned by the EMVCo Secretariat upon Testing and Approval. | [optional]
+**dsReferenceNumber** | **String** | EMVCo-assigned unique identifier. This field is required in Cardholder Initiated 3DS fully authenticated mada transactions. When you request the payer authentication and authorization services separately, get the value for this field from the payerAuthEnrollReply_dsReferenceNumber or payerAuthValidateReply_dsReferenceNumber response field. | [optional]
diff --git a/docs/Ptsv2paymentsInstallmentInformation.md b/docs/Ptsv2paymentsInstallmentInformation.md
index 17a2114da..88795e5df 100644
--- a/docs/Ptsv2paymentsInstallmentInformation.md
+++ b/docs/Ptsv2paymentsInstallmentInformation.md
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
**totalCount** | **Integer** | Total number of installments when making payments in installments. #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors. #### American Express Direct, Cielo, and Comercio Latino This value is the total number of installments you approved. #### CyberSource Latin American Processing in Brazil This value is the total number of installments that you approved. The default is 1. #### All Other Processors This value is used along with _sequence_ to track which payment is being processed. For example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5. #### CyberSource through VisaNet For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 23-25 - Field: Number of Installments For installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR3 - Position: 7-8 - Field: Number of Installments For installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP07 TCR1 - Position: 7-8 - Field: Number of Installments For all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR5 - Position: 20-22 - Field: Installment Total Count **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]
**firstInstallmentDate** | **String** | Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment | [optional]
**invoiceData** | **String** | Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification | [optional]
-**paymentType** | **String** | Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information | [optional]
+**paymentType** | **String** | Payment plan for the installments. This field is supported only for installment payments on Visa Platform Connect, RuPay and SPG-KSA seamless flow. Possible values for a standing-instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card: - 1: SI with a fixed amount. - 2: SI with a maximum amount. - 3: Other kind of SI. Possible values for a type of Installment transaction for on-soil transaction in Kingdom of Saudi Arabia - 1: Registration or first transaction. - 2: Subsequent transaction. Possible values for other kinds of installment payments: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. - 6: SI de-registration on RuPay for the payer authentication seamless flow. | [optional]
**eligibilityInquiry** | **String** | Indicates whether the authorization request is a Crediario eligibility inquiry. Set the value for this field to `Crediario`. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. | [optional]
**gracePeriodDuration** | **String** | Grace period requested by the customer before the first installment payment is due. When you include this field in a request, you must also include the grace period duration type field. The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR5, Position: 100-101, Field: Mastercard Grace Period Details. This field is supported only for Mastercard installment payments in Brazil and Greece. | [optional]
**gracePeriodDurationType** | **String** | Unit for the requested grace period duration. Possible values: - `D`: Days - `W`: Weeks - `M`: Months The value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR5, Position: 99, Field: Mastercard Grace Period Details This field is supported only for Mastercard installment payments in Brazil and Greece on CyberSource through VisaNet. | [optional]
diff --git a/docs/Ptsv2paymentsPointOfSaleInformation.md b/docs/Ptsv2paymentsPointOfSaleInformation.md
index e83d96f4e..8add4db81 100644
--- a/docs/Ptsv2paymentsPointOfSaleInformation.md
+++ b/docs/Ptsv2paymentsPointOfSaleInformation.md
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**terminalId** | **String** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. #### CyberSource through VisaNet A list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support. When you do not include this field in a request, CyberSource uses the default value that is defined in your CyberSource account. #### FDC Nashville Global To have your account configured to support this field, contact CyberSource Customer Support. This value must be a value that FDC Nashville Global issued to you. #### For Payouts This field is applicable for CyberSource through VisaNet. #### GPX Identifier for the terminal at your retail location. A list of all possible values is stored in your account. If terminal ID validation is enabled for your account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact customer support. When you do not include this field in a request, the default value that is defined in your account is used. Optional for authorizations. #### Used by **Authorization** Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX - Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include `pointOfSaleInformation.catLevel`. - FDMS Nashville: The default value that is defined in your account is used. - GPX - OmniPay Direct: Optional field. For the following processors, this field is not used. - GPN - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions - Worldpay VAP #### Card Present reply Terminal identifier assigned by the acquirer. This value must be printed on the receipt. | [optional]
**terminalSerialNumber** | **String** | Terminal serial number assigned by the hardware manufacturer. This value is provided by the client software that is installed on the POS terminal. This value is not forwarded to the processor. Instead, the value is forwarded to the reporting functionality. #### Used by **Authorization and Credit** Optional. This field is supported only by client software that is installed on your POS terminals for the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX | [optional]
-**cardholderVerificationMethodUsed** | **Integer** | Method that was used to verify the cardholder's identity. Possible values: - `0`: No verification - `1`: Signature - `2`: PIN - `3`: Cardholder device CVM | [optional]
+**cardholderVerificationMethodUsed** | **Integer** | Method that was used to verify the cardholder's identity. Possible values: - `0`: No verification - `1`: Signature - `2`: PIN - `3`: Cardholder device CVM - `4`: Biometric - `5`: OTP | [optional]
**laneNumber** | **String** | Identifier for an alternate terminal at your retail location. You define the value for this field. This field is supported only for MasterCard transactions on FDC Nashville Global. Otherwise, this field is not used by all other processors. Use the `terminalId` field to identify the main terminal at your retail location. If your retail location has multiple terminals, use this `laneNumber` field to identify the terminal used for the transaction. This field is a pass-through, which means that the value is not checked or modified in any way before sending it to the processor. Optional field. #### Card present reply messaging Identifier for an alternate terminal at your retail location. You defined the value for this field in the request message. This value must be printed on the receipt. This field is supported only for MasterCard transactions on FDC Nashville Global. | [optional]
**catLevel** | **Integer** | Type of cardholder-activated terminal. Possible values: - 1: Automated dispensing machine - 2: Self-service terminal - 3: Limited amount terminal - 4: In-flight commerce (IFC) terminal - 5: Radio frequency device - 6: Mobile acceptance terminal - 7: Electronic cash register - 8: E-commerce device at your location - 9: Terminal or cash register that uses a dialup connection to connect to the transaction processing network #### Chase Paymentech Solutions Only values 1, 2, and 3 are supported. Required if `pointOfSaleInformation.terminalID` is included in the request; otherwise, optional. #### CyberSource through VisaNet Values 1 through 6 are supported on CyberSource through VisaNet, but some acquirers do not support all six values. Optional field. #### FDC Nashville Global Only values 7, 8, and 9 are supported. Optional field for EMV transactions; otherwise, not used. #### GPN Only values 6, 7, 8, and 9 are supported. Required field. #### JCN Gateway Only values 6, 7, 8, and 9 are supported. Required field. #### TSYS Acquiring Solutions Only value 6 is supported. Required for transactions from mobile devices; otherwise, not used. #### All other processors Not used. Nonnegative integer. | [optional]
**entryMode** | **String** | Method of entering payment card information into the POS terminal. Possible values: - `contact`: Read from direct contact with chip card. - `contactless`: Read from a contactless interface using chip data. - `keyed`: Manually keyed into POS terminal. This value is not supported on OmniPay Direct. - `msd`: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct. - `swiped`: Read from credit card magnetic stripe. The `contact`, `contactless`, and `msd` values are supported only for EMV transactions. #### Used by **Authorization** Required field. #### Card Present Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. #### PIN debit Required for a PIN debit purchase and a PIN debit credit request. | [optional]
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
**trackData** | **String** | Card's track 1 and 2 data. For all processors except FDMS Nashville, this value consists of one of the following: - Track 1 data - Track 2 data - Data for both tracks 1 and 2 For FDMS Nashville, this value consists of one of the following: - Track 1 data - Data for both tracks 1 and 2 Example: %B4111111111111111^SMITH/JOHN ^1612101976110000868000000?;4111111111111111=16121019761186800000? #### Used by **Authorization** Required for Chase Paymentech Solutions, Credit Mutuel-CIC, CyberSource through VisaNet, FDC Nashville Global, JCN Gateway, OmniPay Direct, and SIX if `pointOfSaleInformation.entryMode` is equal to one of these values: - `contact` - `contactless` - `msd` - `swiped` Otherwise, this field not used. Required for all other processors if `pointOfSaleInformation.entryMode=swiped`; otherwise, this field is not used. #### GPX This field only supports transactions from the following card types: - Visa - Mastercard - AMEX - Discover - Diners - JCB - Union Pay International #### PIN debit Track 2 data from the debit card. The sentinels are required. Required field for a PIN debit purchase and a PIN debit credit. | [optional]
**storeAndForwardIndicator** | **String** | When connectivity is unavailable, the client software that is installed on the POS terminal can store a transaction in its memory and send it for authorization when connectivity is restored. This value is provided by the client software that is installed on the POS terminal. This value is not forwarded to the processor. Instead, the value is forwarded to the reporting functionality. Possible values: - `Y`: Transaction was stored and then forwarded. - `N` (default): Transaction was not stored and then forwarded. For authorizations and credits, this field is supported only on these processors: - American Express Direct - FDC Nashville Global - OmniPay Direct - SIX Optional field. | [optional]
**cardholderVerificationMethod** | **List<String>** | Complete list of cardholder verification methods (CVMs) supported by the terminal. Optional field. Possible values: - `PIN`: For terminals with a PIN Pad - `Signature`: For terminals capable of receiving a signature - `pinOnGlass`: For terminals where PIN is entered on a glass-based capture mechanism **EXAMPLE**: [\"PIN\",\"Signature\"]; [\"pinOnGlass\",\"Signature\"] | [optional]
+**terminalCategory** | **String** | Indicates the type of terminal. Possible values: - `AFD`: Automated Fuel Dispenser | [optional]
**terminalInputCapability** | **List<String>** | Complete list of card input methods supported by the terminal. Possible values: - `Keyed`: Terminal can accept card data that is entered manually. - `Swiped`: Terminal can accept card data from a magnetic stripe reader. - `Contact`: Terminal can accept card data in EMV contact mode (\"dipping a card\"). - `Contactless`: Terminal can accept card data in EMV contactless mode (\"tapping a card\"). - `BarCode`: Terminal can read bar codes. - `QRcode`: Terminal can read or scan QR codes. - `OCR`: Terminal can perform optical character recognition (OCT) on the card. **EXAMPLE**: [\"Keyed\",\"Swiped\",\"Contact\",\"Contactless\"] #### Used by **Authorization and Credit** Optional. This field is supported only by client software that is installed on your POS terminals for the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX | [optional]
**terminalCardCaptureCapability** | **String** | Indicates whether the terminal can capture the card. Possible values: - `1`: Terminal can capture card. - `0`: Terminal cannot capture card. For authorizations and credits, this field is supported only by these processors: - American Express Direct - Credit Mutuel-CIC - OmniPay Direct Optional field. | [optional]
**terminalOutputCapability** | **String** | Indicates whether the terminal can print or display messages. Possible values: - 1: Neither - 2: Print only - 3: Display only - 4: Print and display - 5: Merchant terminal supports purchase only approvals This field is supported for authorizations and credits only on the following processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX - VisaNet Optional field. | [optional]
diff --git a/docs/Ptsv2paymentsProcessingInformation.md b/docs/Ptsv2paymentsProcessingInformation.md
index b316984d0..0ebdd6ecc 100644
--- a/docs/Ptsv2paymentsProcessingInformation.md
+++ b/docs/Ptsv2paymentsProcessingInformation.md
@@ -42,6 +42,10 @@ Name | Type | Description | Notes
**paymentType** | **String** | Identifier for the payment type. | [optional]
**enablerId** | **String** | Enablers are payment processing entities that are not acquiring members and are often the primary relationship owner with merchants and originators. Enablers own technical solutions through which the merchant or originator will access acceptance. The Enabler ID is a five-character hexadecimal identifier that will be used by Visa to identify enablers. Enabler ID assignment will be determined by Visa. Visa will communicate Enablers assignments to enablers. | [optional]
**processingInstruction** | **String** | The instruction to process an order. - default value: 'NO_INSTRUCTION' - 'ORDER_SAVED_EXPLICITLY' | [optional]
+**transactionTypeIndicator** | **String** | This field is used identify the type of payment transaction taking place. This field is applicable for MasterCard transactions only. Possible values: - 201- Mastercard Rebate - 202- rePower Load Value - 203- Gaming Re-pay - 204- General Person-to-Person - 205- General Transfer to Own Account - 206- Agent Cash Out - 207- Payment of Own Credit Card Bill - 208- Business Disbursement - 209- Government/Non-Profit Disbursement - 210- Rapid Merchant Settlement - 211- Cash in at ATM (Usage limited to specific countries) - 212- Cash in at Point of Sale (Usage limited to specific countries) - 213- General Business to Business Transfer - 214- Mastercard Merchant Presented QR - 215- Mastercard Merchant Presented QR Refund Payment - 216- Utility Payments (for Brazil domestic use only) - 217- Government Services (for Brazil domestic use only) - 218- Mobile phone top-ups (for Brazil domestic use only) - 219- Coupon booklet payments (for Brazil domestic use only) - 220- General Person-to-Person Transfer - 221- Person-to-Person Transfer to Card Account - 222- General Transfer to Own Account - 223- Agent Cash Out - 224- Payment of Own Credit Card Bill - 225- Business Disbursement - 226- Transfer to Own Staged Digital Wallet Account - 227- Transfer to Own Debit or Prepaid Account - 228- General Business-to-Business Transfer - 229- Installment-based repayment - 230- Mastercard ATM Cash Pick-Up Transaction - 231- Cryptocurrency - 232- High-risk Securities | [optional]
+**purposeOfPayment** | **String** | Possible values: - `16` : High Risk Security Other values can also be accommodated in future for different transactions. Currently this field is only used in OCT, we could not find any existing valid values for the past 30 days in production. Issuer may decline invalid purpose of payment code with response code 93. This field is also applicable for AFT transactions. For list of supported values, please refer to Developer Guide. | [optional]
+**languageCode** | **String** | Contains the ISO 639-2 defined language Code | [optional]
+**originalPaymentId** | **String** | This value is used for linking Authorization extension transaction to the original Authorization transaction and for linking MIT (Merchant initiated transaction) with the respective CIT (Customer initiated transaction). | [optional]
diff --git a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md
index 1bb01b9d1..f5bf6cace 100644
--- a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md
+++ b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptions.md
@@ -10,14 +10,14 @@ Name | Type | Description | Notes
**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). | [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. #### 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 file: - 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. | [optional]
**partialAuthIndicator** | **Boolean** | Flag that indicates whether the transaction is enabled for partial authorization. When the request includes this field, this value overrides the information in your account. Possible values: - `true`: Enable the transaction for partial authorization. - `false`: Do not enable the transaction for partial authorization. #### PIN debit Required field for partial authorizations that use PIN debit purchase; otherwise, not used. #### Used by **Authorization** Optional field. #### 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 | [optional]
-**extendAuthIndicator** | **String** | Flag that indicates whether the transaction is an extended authorization. | [optional]
+**extendAuthIndicator** | **String** | Indicates Authorization extension transaction. Extension transaction is used to prolong the settlement period by one additional settlement cycle period. Possible values: - true: Transaction is an Authorization Extension transaction. - false: Transaction is not an Authorization Extension transaction. | [optional]
**balanceInquiry** | **Boolean** | Flag that indicates whether to return balance information. Possible values: - `true`: Return balance information. - `false`: Do not return balance information. #### Used by **Authorization** Required for a balance inquiry; otherwise, not used. #### PIN debit Required for a balance inquiry request of a PIN debit purchase; otherwise, not used. | [optional]
**ignoreAvsResult** | **Boolean** | Flag for a sale request that indicates whether to allow the capture service to run even when the authorization receives an AVS decline, as indicated by a reply flag value of DAVSNO. 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. When the value of this field is `true`, the list in the `processingInformation.authorizationOptions.declineAvsFlags` field is ignored. #### Used by **Authorization** Optional field. String (3) | [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 for a sale request that indicates whether to allow the capture service to run even when the authorization receives a CVN decline, as indicated by an `processorInformation.cardVerification.resultCode` value of `D` or `N`. 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. #### Used by **Authorization** Optional field. | [optional]
**initiator** | [**Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator**](Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiator.md) | | [optional]
**billPayment** | **Boolean** | Indicates payment for bill or payment towards existing contractual loan. Possible values: - `true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. Optional request field. | [optional]
-**billPaymentType** | **String** | Reason for the payment. Possible values: - 001: Utility payment - 002: Government services - 003: Mobile phone top-up - 004: Coupon payment - 005: Installment based repayment The value for this field corresponds to the following data in the TC 33A capture file (applicable to Brazil): - Record: CP07 TCR0 - Position: 48-50 - Field: Bill Payment Transaction Type Identifier The value for this field corresponds to the following data in the TC 33A capture file (applicable to Installment) based Repayment): - Record: CP01 TCR6 - Position: 154-156 - Field: Bill Payment Transaction Type Identifier This field is supported for 1. Bill payments in Brazil with Mastercard on CyberSource through VisaNet. 2. Installment based repayment transactions on Cybersource through VisaNet. | [optional]
+**billPaymentType** | **String** | Reason for the payment. Possible values: - 001: Public utilities / Utility payment - 002: Government services - 003: Cellular / Mobile phone top-up - 004: Coupon payment - 005: Installment based repayment - 006: Billing payment - 007: Tax payment - 008: Tax payment refunds The value for this field corresponds to the following data in the TC 33A capture file (applicable to Brazil): - Record: CP07 TCR0 - Position: 48-50 - Field: Bill Payment Transaction Type Identifier The value for this field corresponds to the following data in the TC 33A capture file (applicable to Installment) based Repayment): - Record: CP01 TCR6 - Position: 154-156 - Field: Bill Payment Transaction Type Identifier This field is supported for 1. Bill payments in Brazil with Mastercard on CyberSource through VisaNet. 2. Installment based repayment transactions on Cybersource through VisaNet. | [optional]
**redemptionInquiry** | **Boolean** | Flag that indicates the payment request is a redemption inquiry. Possible values: - `true` - `false` | [optional]
**transportationMode** | **String** | Type of transportation mode : Possible Values: - 00 = Unknown - 01 = Urban bus - 02 = Interurban bus - 03=Lighttrainmasstransit(Underground Metro LTR) - 04 = Train - 05 = Commuter train - 06 = Water-borne vehicle - 07 = Toll - 08 = Parking - 09 = Taxi - 10 = High-speed train - 11 = Rural bus - 12 = Express commuter train - 13 = Para transit - 14 = Self drive vehicle - 15 = Coach - 16 = Locomotive - 17 = Powered motor coach - 18 = Trailer - 19 = Regional train - 20 = Inter-city - 21 = Funicular train - 22 = Cable car | [optional]
**aggregatedAuthIndicator** | **String** | Indicates if transaction is an aggregated auth Possible values: - **true** - **false** | [optional]
@@ -26,7 +26,11 @@ Name | Type | Description | Notes
**cashAdvanceIndicator** | **Boolean** | This API field enables the merchant to indicate that a given transaction is Cash Advance. Cash advance or Cash disbursement functionality allows a merchant to dispense cash at a point of sale. It provides the ability of a POS system to act like an ATM. These terminals are typically seen in bank branches where customers can use their card and withdraw cash or at merchant locations where ATMs are sparse. Possible values: - `true` (Cash advance is supported) - `false` (default: cash advance is not supported) | [optional]
**splitPaymentTransaction** | **Boolean** | #### Visa Platform Connect Indicates split payment transaction. A split payment allows the use of two payment methods for a single transaction. Possible values: - `true` (split payment transaction is supported) - `false` (default: split payment transaction is not supported) | [optional]
**cardVerificationIndicator** | **Boolean** | This API field will indicate whether a card verification check is being performed during the transaction Possible values: - `true` - `false` (default value) | [optional]
+**transactionMode** | **String** | Transaction mode identifier. Identifies the specific channel from which the transaction originates. Possible values: - M – Mobile Order - T – Telephone Order | [optional]
**aftIndicator** | **Boolean** | Indicates whether the transaction is an Account Funding Transaction (AFT). This field is mandatory for Account Funding Transactions (AFT). Possible values: - `true` (This is an AFT transaction) - `false` (default value) (This is not an AFT transaction) | [optional]
+**serviceType** | **String** | Field is used for back-to-back funding transaction and can be defined as a payment flow that automatically transfers funds through a real-time funding or a live-load. This type of transaction can also be connected to a purchase. In back-to-back funding of general purpose card that is used to make a purchase, two separate accounts are involved: - account one is used to make the purchase - account two is used to automatically fund or reimburse account one Possible values: - 0B = back to back funding transaction - 00 = normal transaction - 01 = originator hold - 02 = Visa deferred OCT hold, default interval - 03 = Visa deferred OCT hold, user-defined interval - 09 = Cancel pending deferred OCT request - 0I = Visa Direct custom program 1 - 0Q = uery the status of the deferred OCT - A0 = Alias Directory 2 | [optional]
+**balanceUpdate** | **Boolean** | Merchant to inform Cybersource whether a transaction is Money load with Balance Update. Possible values: - `true` (This is a Money load with balance update transaction) - `false` (default value) (This is not a Money load with balance update transaction) | [optional]
+**moneyLoad** | **Boolean** | Merchant to inform Cybersource whether a transaction is Money load with Money load only. Possible values: - `true` (This is a money load transaction) - `false` (default value) (This is not a money load transaction) | [optional]
diff --git a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md
index 7878166fc..87d6f766c 100644
--- a/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md
+++ b/docs/Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction.md
@@ -7,6 +7,7 @@ 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. #### 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 | [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. | [optional]
+**agreementId** | **String** | An API to carry the agreement ID generated for recurring and unscheduled Card on file transaction. the merchant generates this per card holder or per payment agreement and shares the generated unique ID in the subsequent transactions. This can contain foreign/arabic character set also. Cybersource forwards this value to the Saudi Payment processor. | [optional]
diff --git a/docs/Ptsv2paymentsProcessingInformationCaptureOptions.md b/docs/Ptsv2paymentsProcessingInformationCaptureOptions.md
index 5a0165e85..b46e62433 100644
--- a/docs/Ptsv2paymentsProcessingInformationCaptureOptions.md
+++ b/docs/Ptsv2paymentsProcessingInformationCaptureOptions.md
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
**dateToCapture** | **String** | Date on which you want the capture to occur. This field is supported only for CyberSource through VisaNet. Format: `MMDD` #### Used by **Authorization** Optional field. | [optional]
**isFinal** | **String** | Indicates whether to release the authorization hold on the remaining funds. Possible Values: - `true` - `false` | [optional]
**notes** | **String** | An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives. | [optional]
+**reconciliationId** | **String** | Used for authbill request when capture field equals true | [optional]
+**reconciliationIdAlternate** | **String** | Used by Nike merchant to send 12 digit order number | [optional]
diff --git a/docs/Ptsv2paymentsProcessingInformationPurchaseOptions.md b/docs/Ptsv2paymentsProcessingInformationPurchaseOptions.md
index c251cf4bb..b6690f0c0 100644
--- a/docs/Ptsv2paymentsProcessingInformationPurchaseOptions.md
+++ b/docs/Ptsv2paymentsProcessingInformationPurchaseOptions.md
@@ -6,6 +6,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**isElectronicBenefitsTransfer** | **Boolean** | Flag that indicates whether this transaction is an EBT transaction. Possible values: - `true` - `false` #### PIN debit Required field for EBT and EBT voucher transactions that use PIN debit credit or PIN debit purchase; otherwise, not used. | [optional]
**type** | **String** | Flag that indicates an EBT voucher transaction. Possible value: - `EBT_VOUCHER`: Indicates the PIN debit transaction is an EBT voucher. - `BUY` - `RENT` - `BOOK` - `SUBSCRIBE` - `DOWNLOAD` - `ORDER` - `CONTINUE` #### PIN debit Required field for EBT voucher transactions that use PIN debit purchase; otherwise, not used. | [optional]
+**eligibilityIndicator** | **String** | This field contains installment data defined by MasterCard. Possible values: - Y = eligible - N = not eligile | [optional]
+**benefitAmount** | **String** | Workplace benefit amount. | [optional]
+**benefitType** | **String** | Workplace benefit type. Possible values: - 70 = employee benefit - 4T = transportation / transit - 52 = general benefit - 53 = meal voucher - 54 = fuel - 55 = ecological / sustainability - 58 = philanthropy / patronage / consumption - 59 = gift - 5S = sport / culture - 5T = book / education | [optional]
diff --git a/docs/Ptsv2paymentsRecipientInformation.md b/docs/Ptsv2paymentsRecipientInformation.md
index 5aaf1562c..22b2fde98 100644
--- a/docs/Ptsv2paymentsRecipientInformation.md
+++ b/docs/Ptsv2paymentsRecipientInformation.md
@@ -10,12 +10,19 @@ Name | Type | Description | Notes
**middleName** | **String** | Middle name of the recipient. This field is applicable for AFT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. | [optional]
**lastName** | **String** | Last name of the recipient. This field is applicable for AFT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set, are not supported and will be stripped before being sent to sent to the processor. | [optional]
**address1** | **String** | The street address of the recipient This field is applicable for AFT and OCT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor. | [optional]
+**administrativeArea** | **String** | The state or province of the recipient. This field is applicable for AFT transactions when the recipient country is US or CA. Else it is optional. Must be a two character value | [optional]
**postalCode** | **String** | Partial postal code for the recipient's address. For example, if the postal code is **NN5 7SG**, the value for this field should be the first part of the postal code: **NN5**. This field is a _pass-through_, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional]
**country** | **String** | The country associated with the address of the recipient. This field is applicable for AFT and OCT transactions. Must be a two character ISO country code. For example, see [ISO Country Code](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html) | [optional]
**dateOfBirth** | **String** | Recipient's date of birth. **Format**: `YYYYMMDD`. This field is a `pass-through`, which means that CyberSource ensures that the value is eight numeric characters but otherwise does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor. | [optional]
**beneficiaryId** | **String** | Only for e-wallets: ID, username, hash or anything uniquely identifying the ultimate beneficiary. | [optional]
**beneficiaryName** | **String** | Only for e-wallets: The ultimate beneficiary's full name. | [optional]
**beneficiaryAddress** | **String** | Only for e-wallets: The ultimate beneficiary's street address (street, zip code, city), excluding the country. Example: \"Main street 1, 12345, Barcelona | [optional]
+**aliasName** | **String** | Account owner alias name. | [optional]
+**nationality** | **String** | Account Owner Nationality | [optional]
+**countryOfBirth** | **String** | Account Owner Country of Birth | [optional]
+**occupation** | **String** | Account Owner Occupation | [optional]
+**email** | **String** | Account Owner email address | [optional]
+**locality** | **String** | The city of the recipient. This field is applicable for AFT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor. | [optional]
diff --git a/docs/Ptsv2paymentsSenderInformation.md b/docs/Ptsv2paymentsSenderInformation.md
index 9d81d44f6..6b7c4a90f 100644
--- a/docs/Ptsv2paymentsSenderInformation.md
+++ b/docs/Ptsv2paymentsSenderInformation.md
@@ -11,6 +11,10 @@ Name | Type | Description | Notes
**locality** | **String** | The city or locality of the sender. This field is applicable for AFT transactions. Only alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor. | [optional]
**administrativeArea** | **String** | The state or province of the sender. This field is applicable for AFT transactions when the sender country is US or CA. Else it is optional. Must be a two character value | [optional]
**countryCode** | **String** | The country associated with the address of the sender. This field is applicable for AFT transactions. Must be a two character ISO country code. For example, see [ISO Country Code](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html) | [optional]
+**aliasName** | **String** | Sender's alias name. | [optional]
+**referenceNumber** | **String** | This field is applicable for AFT transactions. Contains a transaction reference number provided by the Merchant. Only alpha numeric values are supported. | [optional]
+**account** | [**Ptsv2paymentsSenderInformationAccount**](Ptsv2paymentsSenderInformationAccount.md) | | [optional]
+**postalCode** | **String** | Postal code of sender. | [optional]
diff --git a/docs/Ptsv2paymentsSenderInformationAccount.md b/docs/Ptsv2paymentsSenderInformationAccount.md
new file mode 100644
index 000000000..accd9f2e6
--- /dev/null
+++ b/docs/Ptsv2paymentsSenderInformationAccount.md
@@ -0,0 +1,12 @@
+
+# Ptsv2paymentsSenderInformationAccount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number** | **String** | The account number of the entity funding the transaction. The value for this field can be a payment card account number or bank account number. | [optional]
+**type** | **String** | Identifies the sender's account type. This field is applicable for AFT transactions. Valid values are: - `00` for Other - `01` for Routing Transit Number (RTN) + Bank Account Number (BAN) - `02` for International Bank Account Number (IBAN) - `03` for Card Account - `04` for Email - `05` for Phone Number - `06` for Bank Account Number (BAN) + Bank Identification Code (BIC), also known as a SWIFT code - `07` for Wallet ID - `08` for Social Network ID | [optional]
+**fundsSource** | **String** | Source of funds. Possible Values: - `01`: Credit. - `02`: Debit. - `03`: Prepaid. - `04`: Deposit Account. - `05`: Mobile Money Account. - `06`: Cash. - `07`: Other. - `V5`: Debits / deposit access other than those linked to the cardholders' scheme. - `V6`: Credit accounts other than those linked to the cardholder's scheme. | [optional]
+
+
+
diff --git a/docs/TssV2TransactionsGet200ResponseUnscheduledPaymentInformation.md b/docs/Ptsv2paymentsUnscheduledPaymentInformation.md
similarity index 84%
rename from docs/TssV2TransactionsGet200ResponseUnscheduledPaymentInformation.md
rename to docs/Ptsv2paymentsUnscheduledPaymentInformation.md
index 68ba1464a..7b4c20f0f 100644
--- a/docs/TssV2TransactionsGet200ResponseUnscheduledPaymentInformation.md
+++ b/docs/Ptsv2paymentsUnscheduledPaymentInformation.md
@@ -1,5 +1,5 @@
-# TssV2TransactionsGet200ResponseUnscheduledPaymentInformation
+# Ptsv2paymentsUnscheduledPaymentInformation
## Properties
Name | Type | Description | Notes
diff --git a/docs/Ptsv2paymentsidcapturesInstallmentInformation.md b/docs/Ptsv2paymentsidcapturesInstallmentInformation.md
index 2cf729611..91c408084 100644
--- a/docs/Ptsv2paymentsidcapturesInstallmentInformation.md
+++ b/docs/Ptsv2paymentsidcapturesInstallmentInformation.md
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
**firstInstallmentDate** | **String** | Date of the first installment payment. Format: YYMMDD. When you do not include this field, CyberSource sends a string of six zeros (000000) to the processor. This field is supported only for Crediario installment payments in Brazil on CyberSource through VisaNet. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR9 - Position: 42-47 - Field: Date of First Installment | [optional]
**firstInstallmentAmount** | **String** | Amount of the first installment payment. The issuer provides this value when the first installment payment is successful. This field is supported for Mastercard installment payments on CyberSource through VisaNet in all countries except Brazil,Croatia, Georgia, and Greece. The value for this field corresponds to the following data in the TC 33 capture file: - Record: CP01 TCR5 - Position: 23-34 - Field: Amount of Each Installment | [optional]
**invoiceData** | **String** | Invoice information that you want to provide to the issuer. This value is similar to a tracking number and is the same for all installment payments for one purchase. This field is supported only for installment payments with Mastercard on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR4 - Position: 51-70 - Field: Purchase Identification | [optional]
-**paymentType** | **String** | Payment plan for the installments. Possible values: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. This field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil. The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP07 TCR1 - Position: 9 - Field: Merchant Installment Supporting Information | [optional]
+**paymentType** | **String** | Payment plan for the installments. This field is supported only for installment payments on Visa Platform Connect, RuPay and SPG-KSA seamless flow. Possible values for a standing-instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card: - 1: SI with a fixed amount. - 2: SI with a maximum amount. - 3: Other kind of SI. Possible values for a type of Installment transaction for on-soil transaction in Kingdom of Saudi Arabia - 1: Registration or first transaction. - 2: Subsequent transaction. Possible values for other kinds of installment payments: - 0 (default): Regular installment. This value is not allowed for airline transactions. - 1: Installment payment with down payment. - 2: Installment payment without down payment. This value is supported only for airline transactions. - 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions. - 4: Down payment only; regular installment payment will follow. - 5: Boarding fee only. This value is supported only for airline transactions. - 6: SI de-registration on RuPay for the payer authentication seamless flow. | [optional]
**additionalCosts** | **String** | Additional costs charged by the issuer to fund the installment payments. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 128-139 - Field: Total Other Costs | [optional]
**additionalCostsPercentage** | **String** | Additional costs divided by the amount funded. For example: - A value of 1.0 specifies 1%. - A value of 4.0 specifies 4%. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 140-143 - Field: Percent of Total Other Costs | [optional]
**amountFunded** | **String** | Amount funded. This field is included in the authorization reply for the Crediario eligibility request when the issuer approves the cardholder's request for Crediario installment payments in Brazil. This field is supported only for Crediario installment payments in Brazil on **CyberSource through VisaNet**. The value for this field corresponds to the following data in the TC 33 capture file1: - Record: CP01 TCR9 - Position: 48-59 - Field: Total Amount Funded | [optional]
diff --git a/docs/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.md b/docs/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.md
index 0940bf503..ae3add2b2 100644
--- a/docs/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.md
+++ b/docs/Ptsv2paymentsidcapturesProcessingInformationCaptureOptions.md
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
**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]
**isFinal** | **String** | Indicates whether to release the authorization hold on the remaining funds. Possible Values: - `true` - `false` | [optional]
**notes** | **String** | An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives. | [optional]
+**reconciliationIdAlternate** | **String** | Used by Nike merchant to send 12 digit order number | [optional]
diff --git a/docs/Ptsv2paymentsidrefundsPointOfSaleInformation.md b/docs/Ptsv2paymentsidrefundsPointOfSaleInformation.md
index 33edc5f16..9f75eac87 100644
--- a/docs/Ptsv2paymentsidrefundsPointOfSaleInformation.md
+++ b/docs/Ptsv2paymentsidrefundsPointOfSaleInformation.md
@@ -5,6 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**emv** | [**Ptsv2paymentsidcapturesPointOfSaleInformationEmv**](Ptsv2paymentsidcapturesPointOfSaleInformationEmv.md) | | [optional]
+**terminalCategory** | **String** | Indicates the type of terminal. Possible values: - `AFD`: Automated Fuel Dispenser | [optional]
diff --git a/docs/Ptsv2paymentsidrefundsProcessingInformation.md b/docs/Ptsv2paymentsidrefundsProcessingInformation.md
index 0f69f14d6..da0312d41 100644
--- a/docs/Ptsv2paymentsidrefundsProcessingInformation.md
+++ b/docs/Ptsv2paymentsidrefundsProcessingInformation.md
@@ -15,6 +15,7 @@ Name | Type | Description | Notes
**industryDataType** | **String** | Indicates that the transaction includes industry-specific data. Possible Values: - `airline` - `restaurant` - `lodging` - `auto_rental` - `transit` - `healthcare_medical` - `healthcare_transit` - `transit` #### Card Present, Airlines and Auto Rental You must set this field 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, no airline data is sent 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, no restaurant data is sent to the processor. You must set this field to `auto_rental` in order for auto rental data to be sent to the processor. For example, if this field is not set to `auto_rental` or is not included in the request, no auto rental data is sent to the processor. Restaurant data is supported only on CyberSource through VisaNet. | [optional]
**paymentType** | **String** | Identifier for the payment type | [optional]
**refundOptions** | [**Ptsv2paymentsidrefundsProcessingInformationRefundOptions**](Ptsv2paymentsidrefundsProcessingInformationRefundOptions.md) | | [optional]
+**transactionTypeIndicator** | **String** | This field is used identify the type of payment transaction taking place. This field is applicable for MasterCard transactions only. Possible values: - 201- Mastercard Rebate - 202- rePower Load Value - 203- Gaming Re-pay - 204- General Person-to-Person - 205- General Transfer to Own Account - 206- Agent Cash Out - 207- Payment of Own Credit Card Bill - 208- Business Disbursement - 209- Government/Non-Profit Disbursement - 210- Rapid Merchant Settlement - 211- Cash in at ATM (Usage limited to specific countries) - 212- Cash in at Point of Sale (Usage limited to specific countries) - 213- General Business to Business Transfer - 214- Mastercard Merchant Presented QR - 215- Mastercard Merchant Presented QR Refund Payment - 216- Utility Payments (for Brazil domestic use only) - 217- Government Services (for Brazil domestic use only) - 218- Mobile phone top-ups (for Brazil domestic use only) - 219- Coupon booklet payments (for Brazil domestic use only) - 220- General Person-to-Person Transfer - 221- Person-to-Person Transfer to Card Account - 222- General Transfer to Own Account - 223- Agent Cash Out - 224- Payment of Own Credit Card Bill - 225- Business Disbursement - 226- Transfer to Own Staged Digital Wallet Account - 227- Transfer to Own Debit or Prepaid Account - 228- General Business-to-Business Transfer - 229- Installment-based repayment - 230- Mastercard ATM Cash Pick-Up Transaction - 231- Cryptocurrency - 232- High-risk Securities | [optional]
diff --git a/docs/Ptsv2paymentsidreversalsProcessingInformation.md b/docs/Ptsv2paymentsidreversalsProcessingInformation.md
index 67400f79b..b1bd19150 100644
--- a/docs/Ptsv2paymentsidreversalsProcessingInformation.md
+++ b/docs/Ptsv2paymentsidreversalsProcessingInformation.md
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
**visaCheckoutId** | **String** | Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. | [optional]
**issuer** | [**Ptsv2paymentsIssuerInformation**](Ptsv2paymentsIssuerInformation.md) | | [optional]
**actionList** | **List<String>** | Array of actions (one or more) to be included in the reversal Possible value: - `AP_AUTH_REVERSAL`: Use this when you want to reverse an Alternative Payment Authorization. | [optional]
+**transactionTypeIndicator** | **String** | This field is used identify the type of payment transaction taking place. This field is applicable for MasterCard transactions only. Possible values: - 201- Mastercard Rebate - 202- rePower Load Value - 203- Gaming Re-pay - 204- General Person-to-Person - 205- General Transfer to Own Account - 206- Agent Cash Out - 207- Payment of Own Credit Card Bill - 208- Business Disbursement - 209- Government/Non-Profit Disbursement - 210- Rapid Merchant Settlement - 211- Cash in at ATM (Usage limited to specific countries) - 212- Cash in at Point of Sale (Usage limited to specific countries) - 213- General Business to Business Transfer - 214- Mastercard Merchant Presented QR - 215- Mastercard Merchant Presented QR Refund Payment - 216- Utility Payments (for Brazil domestic use only) - 217- Government Services (for Brazil domestic use only) - 218- Mobile phone top-ups (for Brazil domestic use only) - 219- Coupon booklet payments (for Brazil domestic use only) - 220- General Person-to-Person Transfer - 221- Person-to-Person Transfer to Card Account - 222- General Transfer to Own Account - 223- Agent Cash Out - 224- Payment of Own Credit Card Bill - 225- Business Disbursement - 226- Transfer to Own Staged Digital Wallet Account - 227- Transfer to Own Debit or Prepaid Account - 228- General Business-to-Business Transfer - 229- Installment-based repayment - 230- Mastercard ATM Cash Pick-Up Transaction - 231- Cryptocurrency - 232- High-risk Securities | [optional]
diff --git a/docs/Ptsv1pushfundstransferAggregatorInformation.md b/docs/Ptsv2payoutsAggregatorInformation.md
similarity index 54%
rename from docs/Ptsv1pushfundstransferAggregatorInformation.md
rename to docs/Ptsv2payoutsAggregatorInformation.md
index 5267be5b0..5a2973df7 100644
--- a/docs/Ptsv1pushfundstransferAggregatorInformation.md
+++ b/docs/Ptsv2payoutsAggregatorInformation.md
@@ -1,5 +1,5 @@
-# Ptsv1pushfundstransferAggregatorInformation
+# Ptsv2payoutsAggregatorInformation
## Properties
Name | Type | Description | Notes
@@ -7,7 +7,12 @@ Name | Type | Description | Notes
**aggregatorId** | **String** | Value that identifies you as a payment aggregator. Get this value from the processor. | [optional]
**name** | **String** | Your payment aggregator business name. This field is conditionally required when aggregator id is present. | [optional]
**independentSalesOrganizationID** | **String** | Independent sales organization ID. This field is only used for Mastercard transactions submitted through PPGS. | [optional]
-**subMerchant** | [**Ptsv1pushfundstransferAggregatorInformationSubMerchant**](Ptsv1pushfundstransferAggregatorInformationSubMerchant.md) | | [optional]
+**subMerchant** | [**Ptsv2payoutsAggregatorInformationSubMerchant**](Ptsv2payoutsAggregatorInformationSubMerchant.md) | | [optional]
+**streetAddress** | **String** | Acquirer street name. | [optional]
+**city** | **String** | Acquirer city. | [optional]
+**state** | **String** | Acquirer state. | [optional]
+**postalCode** | **String** | Acquirer postal code. | [optional]
+**country** | **String** | Acquirer country. | [optional]
diff --git a/docs/Ptsv1pushfundstransferAggregatorInformationSubMerchant.md b/docs/Ptsv2payoutsAggregatorInformationSubMerchant.md
similarity index 77%
rename from docs/Ptsv1pushfundstransferAggregatorInformationSubMerchant.md
rename to docs/Ptsv2payoutsAggregatorInformationSubMerchant.md
index 49285f2f6..c4f77eab7 100644
--- a/docs/Ptsv1pushfundstransferAggregatorInformationSubMerchant.md
+++ b/docs/Ptsv2payoutsAggregatorInformationSubMerchant.md
@@ -1,5 +1,5 @@
-# Ptsv1pushfundstransferAggregatorInformationSubMerchant
+# Ptsv2payoutsAggregatorInformationSubMerchant
## Properties
Name | Type | Description | Notes
diff --git a/docs/Ptsv2payoutsProcessingInformation.md b/docs/Ptsv2payoutsProcessingInformation.md
index 45be7856b..5c141c7e2 100644
--- a/docs/Ptsv2payoutsProcessingInformation.md
+++ b/docs/Ptsv2payoutsProcessingInformation.md
@@ -12,6 +12,8 @@ Name | Type | Description | Notes
**transactionReason** | **String** | Transaction reason code. | [optional]
**purposeOfPayment** | **String** | This will send purpose of funds code for original credit transactions (OCTs). | [optional]
**fundingOptions** | [**Ptsv2payoutsProcessingInformationFundingOptions**](Ptsv2payoutsProcessingInformationFundingOptions.md) | | [optional]
+**languageCode** | **String** | Contains the ISO 639-2 defined language Code | [optional]
+**purchaseOptions** | [**Ptsv2payoutsProcessingInformationPurchaseOptions**](Ptsv2payoutsProcessingInformationPurchaseOptions.md) | | [optional]
diff --git a/docs/Ptsv2payoutsProcessingInformationPurchaseOptions.md b/docs/Ptsv2payoutsProcessingInformationPurchaseOptions.md
new file mode 100644
index 000000000..c8dcc8e1e
--- /dev/null
+++ b/docs/Ptsv2payoutsProcessingInformationPurchaseOptions.md
@@ -0,0 +1,11 @@
+
+# Ptsv2payoutsProcessingInformationPurchaseOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**benefitAmount** | **String** | Workplace benefit amount. | [optional]
+**benefitType** | **String** | Workplace benefit type. Possible values: - 70 = employee benefit - 4T = transportation / transit - 52 = general benefit - 53 = meal voucher - 54 = fuel - 55 = ecological / sustainability - 58 = philanthropy / patronage / consumption - 59 = gift - 5S = sport / culture - 5T = book / education | [optional]
+
+
+
diff --git a/docs/Ptsv2payoutsRecipientInformation.md b/docs/Ptsv2payoutsRecipientInformation.md
index f93eafe37..c9e826af7 100644
--- a/docs/Ptsv2payoutsRecipientInformation.md
+++ b/docs/Ptsv2payoutsRecipientInformation.md
@@ -13,6 +13,11 @@ Name | Type | Description | Notes
**country** | **String** | Recipient country code. Required only for FDCCompass. | [optional]
**postalCode** | **String** | Recipient postal code. Required only for FDCCompass. | [optional]
**phoneNumber** | **String** | Recipient phone number. Required only for FDCCompass. | [optional]
+**aliasName** | **String** | Account owner alias name. | [optional]
+**nationality** | **String** | Account Owner Nationality | [optional]
+**countryOfBirth** | **String** | Account Owner Country of Birth | [optional]
+**occupation** | **String** | Account Owner Occupation | [optional]
+**email** | **String** | Account Owner email address | [optional]
diff --git a/docs/Ptsv2payoutsSenderInformation.md b/docs/Ptsv2payoutsSenderInformation.md
index e11569ef1..79985ff22 100644
--- a/docs/Ptsv2payoutsSenderInformation.md
+++ b/docs/Ptsv2payoutsSenderInformation.md
@@ -22,6 +22,7 @@ Name | Type | Description | Notes
**personalIdType** | **String** | #### Visa Platform Connect This tag will contain the type of sender identification. The valid values are: • BTHD (Date of birth) • CUID (Customer identification (unspecified)) • NTID (National identification) • PASN (Passport number) • DRLN (Driver license) • TXIN (Tax identification) • CPNY (Company registration number) • PRXY (Proxy identification) • SSNB (Social security number) • ARNB (Alien registration number) • LAWE (Law enforcement identification) • MILI (Military identification) • TRVL (Travel identification (non-passport)) • EMAL (Email) • PHON (Phone number) | [optional]
**type** | **String** | #### Visa Platform Connect This tag will denote whether the tax ID is a business or individual tax ID when personal ID Type contains the value of TXIN (Tax identification). The valid values are: • B (Business) • I (Individual) | [optional]
**identificationNumber** | **String** | #### Visa Platform Connect This tag will contain an acquirer-populated value associated with the API : senderInformation.personalIdType which will identify the personal ID type of the sender. | [optional]
+**aliasName** | **String** | Sender's alias name. | [optional]
diff --git a/docs/Ptsv2voidsProcessingInformation.md b/docs/Ptsv2voidsProcessingInformation.md
index 12d5c5de8..03819eaa9 100644
--- a/docs/Ptsv2voidsProcessingInformation.md
+++ b/docs/Ptsv2voidsProcessingInformation.md
@@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**paymentId** | **Object** | This field is to accept the id of credit/capture in the body of the requests so the type of void can be identified and processed correctly. | [optional]
+**paymentId** | **String** | This field is to accept the id of credit/capture in the body of the requests so the type of void can be identified and processed correctly. | [optional]
diff --git a/docs/PushFundsRequest.md b/docs/PushFundsRequest.md
index cd494f73d..633eca333 100644
--- a/docs/PushFundsRequest.md
+++ b/docs/PushFundsRequest.md
@@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**aggregatorInformation** | [**Ptsv1pushfundstransferAggregatorInformation**](Ptsv1pushfundstransferAggregatorInformation.md) | | [optional]
+**aggregatorInformation** | [**Ptsv2payoutsAggregatorInformation**](Ptsv2payoutsAggregatorInformation.md) | | [optional]
**clientReferenceInformation** | [**Ptsv1pushfundstransferClientReferenceInformation**](Ptsv1pushfundstransferClientReferenceInformation.md) | | [optional]
**orderInformation** | [**Ptsv1pushfundstransferOrderInformation**](Ptsv1pushfundstransferOrderInformation.md) | |
**processingInformation** | [**Ptsv1pushfundstransferProcessingInformation**](Ptsv1pushfundstransferProcessingInformation.md) | | [optional]
diff --git a/docs/TmsBinLookup.md b/docs/TmsBinLookup.md
new file mode 100644
index 000000000..4bcc0add7
--- /dev/null
+++ b/docs/TmsBinLookup.md
@@ -0,0 +1,11 @@
+
+# TmsBinLookup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**paymentAccountInformation** | [**TmsBinLookupPaymentAccountInformation**](TmsBinLookupPaymentAccountInformation.md) | | [optional]
+**issuerInformation** | [**TmsBinLookupIssuerInformation**](TmsBinLookupIssuerInformation.md) | | [optional]
+
+
+
diff --git a/docs/InlineResponse2011IssuerInformation.md b/docs/TmsBinLookupIssuerInformation.md
similarity index 96%
rename from docs/InlineResponse2011IssuerInformation.md
rename to docs/TmsBinLookupIssuerInformation.md
index 74e89e16a..e4d6fff83 100644
--- a/docs/InlineResponse2011IssuerInformation.md
+++ b/docs/TmsBinLookupIssuerInformation.md
@@ -1,5 +1,5 @@
-# InlineResponse2011IssuerInformation
+# TmsBinLookupIssuerInformation
## Properties
Name | Type | Description | Notes
diff --git a/docs/TmsBinLookupPaymentAccountInformation.md b/docs/TmsBinLookupPaymentAccountInformation.md
new file mode 100644
index 000000000..eff25a847
--- /dev/null
+++ b/docs/TmsBinLookupPaymentAccountInformation.md
@@ -0,0 +1,12 @@
+
+# TmsBinLookupPaymentAccountInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**card** | [**TmsBinLookupPaymentAccountInformationCard**](TmsBinLookupPaymentAccountInformationCard.md) | | [optional]
+**features** | [**TmsBinLookupPaymentAccountInformationFeatures**](TmsBinLookupPaymentAccountInformationFeatures.md) | | [optional]
+**network** | [**TmsBinLookupPaymentAccountInformationNetwork**](TmsBinLookupPaymentAccountInformationNetwork.md) | | [optional]
+
+
+
diff --git a/docs/InlineResponse2011PaymentAccountInformationCard.md b/docs/TmsBinLookupPaymentAccountInformationCard.md
similarity index 95%
rename from docs/InlineResponse2011PaymentAccountInformationCard.md
rename to docs/TmsBinLookupPaymentAccountInformationCard.md
index 2f4c325a3..a491dd218 100644
--- a/docs/InlineResponse2011PaymentAccountInformationCard.md
+++ b/docs/TmsBinLookupPaymentAccountInformationCard.md
@@ -1,5 +1,5 @@
-# InlineResponse2011PaymentAccountInformationCard
+# TmsBinLookupPaymentAccountInformationCard
## Properties
Name | Type | Description | Notes
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
**currency** | **String** | This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency. | [optional]
**maxLength** | **String** | This field contains the max length of the card. | [optional]
**credentialType** | **String** | This field contains the type of the payment credential. Possible values: - PAN - TOKEN | [optional]
-**brands** | [**List<InlineResponse2011PaymentAccountInformationCardBrands>**](InlineResponse2011PaymentAccountInformationCardBrands.md) | Array of brands | [optional]
+**brands** | [**List<TmsBinLookupPaymentAccountInformationCardBrands>**](TmsBinLookupPaymentAccountInformationCardBrands.md) | Array of brands | [optional]
diff --git a/docs/InlineResponse2011PaymentAccountInformationCardBrands.md b/docs/TmsBinLookupPaymentAccountInformationCardBrands.md
similarity index 98%
rename from docs/InlineResponse2011PaymentAccountInformationCardBrands.md
rename to docs/TmsBinLookupPaymentAccountInformationCardBrands.md
index 41f222b2d..93373fc75 100644
--- a/docs/InlineResponse2011PaymentAccountInformationCardBrands.md
+++ b/docs/TmsBinLookupPaymentAccountInformationCardBrands.md
@@ -1,5 +1,5 @@
-# InlineResponse2011PaymentAccountInformationCardBrands
+# TmsBinLookupPaymentAccountInformationCardBrands
## Properties
Name | Type | Description | Notes
diff --git a/docs/InlineResponse2011PaymentAccountInformationFeatures.md b/docs/TmsBinLookupPaymentAccountInformationFeatures.md
similarity index 97%
rename from docs/InlineResponse2011PaymentAccountInformationFeatures.md
rename to docs/TmsBinLookupPaymentAccountInformationFeatures.md
index f0318f3d9..591968da8 100644
--- a/docs/InlineResponse2011PaymentAccountInformationFeatures.md
+++ b/docs/TmsBinLookupPaymentAccountInformationFeatures.md
@@ -1,5 +1,5 @@
-# InlineResponse2011PaymentAccountInformationFeatures
+# TmsBinLookupPaymentAccountInformationFeatures
## Properties
Name | Type | Description | Notes
diff --git a/docs/InlineResponse2011PaymentAccountInformationNetwork.md b/docs/TmsBinLookupPaymentAccountInformationNetwork.md
similarity index 86%
rename from docs/InlineResponse2011PaymentAccountInformationNetwork.md
rename to docs/TmsBinLookupPaymentAccountInformationNetwork.md
index 96c52dfcd..2f50e07b2 100644
--- a/docs/InlineResponse2011PaymentAccountInformationNetwork.md
+++ b/docs/TmsBinLookupPaymentAccountInformationNetwork.md
@@ -1,5 +1,5 @@
-# InlineResponse2011PaymentAccountInformationNetwork
+# TmsBinLookupPaymentAccountInformationNetwork
## Properties
Name | Type | Description | Notes
diff --git a/docs/TmsCardArt.md b/docs/TmsCardArt.md
new file mode 100644
index 000000000..1deb85794
--- /dev/null
+++ b/docs/TmsCardArt.md
@@ -0,0 +1,14 @@
+
+# TmsCardArt
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**foregroundColor** | **String** | Card foreground color. | [optional]
+**combinedAsset** | [**TmsCardArtCombinedAsset**](TmsCardArtCombinedAsset.md) | | [optional]
+**brandLogoAsset** | [**TmsCardArtBrandLogoAsset**](TmsCardArtBrandLogoAsset.md) | | [optional]
+**issuerLogoAsset** | [**TmsCardArtIssuerLogoAsset**](TmsCardArtIssuerLogoAsset.md) | | [optional]
+**iconAsset** | [**TmsCardArtIconAsset**](TmsCardArtIconAsset.md) | | [optional]
+
+
+
diff --git a/docs/TmsCardArtBrandLogoAsset.md b/docs/TmsCardArtBrandLogoAsset.md
new file mode 100644
index 000000000..6cd569b8c
--- /dev/null
+++ b/docs/TmsCardArtBrandLogoAsset.md
@@ -0,0 +1,11 @@
+
+# TmsCardArtBrandLogoAsset
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for the asset | [optional]
+**links** | [**TmsCardArtBrandLogoAssetLinks**](TmsCardArtBrandLogoAssetLinks.md) | | [optional]
+
+
+
diff --git a/docs/TmsCardArtBrandLogoAssetLinks.md b/docs/TmsCardArtBrandLogoAssetLinks.md
new file mode 100644
index 000000000..43562e4ec
--- /dev/null
+++ b/docs/TmsCardArtBrandLogoAssetLinks.md
@@ -0,0 +1,10 @@
+
+# TmsCardArtBrandLogoAssetLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**self** | [**TmsCardArtBrandLogoAssetLinksSelf**](TmsCardArtBrandLogoAssetLinksSelf.md) | | [optional]
+
+
+
diff --git a/docs/TmsCardArtBrandLogoAssetLinksSelf.md b/docs/TmsCardArtBrandLogoAssetLinksSelf.md
new file mode 100644
index 000000000..9d3eb1d60
--- /dev/null
+++ b/docs/TmsCardArtBrandLogoAssetLinksSelf.md
@@ -0,0 +1,10 @@
+
+# TmsCardArtBrandLogoAssetLinksSelf
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**href** | **String** | Link to the card art asset. example: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo' | [optional]
+
+
+
diff --git a/docs/TmsCardArtCombinedAsset.md b/docs/TmsCardArtCombinedAsset.md
new file mode 100644
index 000000000..9bb97c4a5
--- /dev/null
+++ b/docs/TmsCardArtCombinedAsset.md
@@ -0,0 +1,11 @@
+
+# TmsCardArtCombinedAsset
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for the asset | [optional]
+**links** | [**TmsCardArtCombinedAssetLinks**](TmsCardArtCombinedAssetLinks.md) | | [optional]
+
+
+
diff --git a/docs/TmsCardArtCombinedAssetLinks.md b/docs/TmsCardArtCombinedAssetLinks.md
new file mode 100644
index 000000000..c827d2574
--- /dev/null
+++ b/docs/TmsCardArtCombinedAssetLinks.md
@@ -0,0 +1,10 @@
+
+# TmsCardArtCombinedAssetLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**self** | [**TmsCardArtCombinedAssetLinksSelf**](TmsCardArtCombinedAssetLinksSelf.md) | | [optional]
+
+
+
diff --git a/docs/TmsCardArtCombinedAssetLinksSelf.md b/docs/TmsCardArtCombinedAssetLinksSelf.md
new file mode 100644
index 000000000..179c7fa7a
--- /dev/null
+++ b/docs/TmsCardArtCombinedAssetLinksSelf.md
@@ -0,0 +1,10 @@
+
+# TmsCardArtCombinedAssetLinksSelf
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**href** | **String** | Link to the card art asset. example: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined' | [optional]
+
+
+
diff --git a/docs/TmsCardArtIconAsset.md b/docs/TmsCardArtIconAsset.md
new file mode 100644
index 000000000..437cdd748
--- /dev/null
+++ b/docs/TmsCardArtIconAsset.md
@@ -0,0 +1,11 @@
+
+# TmsCardArtIconAsset
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for the asset | [optional]
+**links** | [**TmsCardArtIconAssetLinks**](TmsCardArtIconAssetLinks.md) | | [optional]
+
+
+
diff --git a/docs/TmsCardArtIconAssetLinks.md b/docs/TmsCardArtIconAssetLinks.md
new file mode 100644
index 000000000..cab6c5922
--- /dev/null
+++ b/docs/TmsCardArtIconAssetLinks.md
@@ -0,0 +1,10 @@
+
+# TmsCardArtIconAssetLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**self** | [**TmsCardArtIconAssetLinksSelf**](TmsCardArtIconAssetLinksSelf.md) | | [optional]
+
+
+
diff --git a/docs/TmsCardArtIconAssetLinksSelf.md b/docs/TmsCardArtIconAssetLinksSelf.md
new file mode 100644
index 000000000..2ed3092fc
--- /dev/null
+++ b/docs/TmsCardArtIconAssetLinksSelf.md
@@ -0,0 +1,10 @@
+
+# TmsCardArtIconAssetLinksSelf
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**href** | **String** | Link to the card art asset. example: 'tms/v2/tokens/7020000000010603216/visa/assets/icon' | [optional]
+
+
+
diff --git a/docs/TmsCardArtIssuerLogoAsset.md b/docs/TmsCardArtIssuerLogoAsset.md
new file mode 100644
index 000000000..93336d43f
--- /dev/null
+++ b/docs/TmsCardArtIssuerLogoAsset.md
@@ -0,0 +1,11 @@
+
+# TmsCardArtIssuerLogoAsset
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for the asset | [optional]
+**links** | [**TmsCardArtIssuerLogoAssetLinks**](TmsCardArtIssuerLogoAssetLinks.md) | | [optional]
+
+
+
diff --git a/docs/TmsCardArtIssuerLogoAssetLinks.md b/docs/TmsCardArtIssuerLogoAssetLinks.md
new file mode 100644
index 000000000..3a582640b
--- /dev/null
+++ b/docs/TmsCardArtIssuerLogoAssetLinks.md
@@ -0,0 +1,10 @@
+
+# TmsCardArtIssuerLogoAssetLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**self** | [**TmsCardArtIssuerLogoAssetLinksSelf**](TmsCardArtIssuerLogoAssetLinksSelf.md) | | [optional]
+
+
+
diff --git a/docs/TmsCardArtIssuerLogoAssetLinksSelf.md b/docs/TmsCardArtIssuerLogoAssetLinksSelf.md
new file mode 100644
index 000000000..d6b65ac74
--- /dev/null
+++ b/docs/TmsCardArtIssuerLogoAssetLinksSelf.md
@@ -0,0 +1,10 @@
+
+# TmsCardArtIssuerLogoAssetLinksSelf
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**href** | **String** | Link to the card art asset. example: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo' | [optional]
+
+
+
diff --git a/docs/TmsEmbeddedInstrumentIdentifier.md b/docs/TmsEmbeddedInstrumentIdentifier.md
index 484ec2b9e..4500179bf 100644
--- a/docs/TmsEmbeddedInstrumentIdentifier.md
+++ b/docs/TmsEmbeddedInstrumentIdentifier.md
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
**processingInformation** | [**TmsEmbeddedInstrumentIdentifierProcessingInformation**](TmsEmbeddedInstrumentIdentifierProcessingInformation.md) | | [optional]
**billTo** | [**TmsEmbeddedInstrumentIdentifierBillTo**](TmsEmbeddedInstrumentIdentifierBillTo.md) | | [optional]
**metadata** | [**TmsEmbeddedInstrumentIdentifierMetadata**](TmsEmbeddedInstrumentIdentifierMetadata.md) | | [optional]
+**embedded** | [**TmsEmbeddedInstrumentIdentifierEmbedded**](TmsEmbeddedInstrumentIdentifierEmbedded.md) | | [optional]
diff --git a/docs/TmsEmbeddedInstrumentIdentifierBankAccount.md b/docs/TmsEmbeddedInstrumentIdentifierBankAccount.md
index 90d9ff6d6..2b1316cc8 100644
--- a/docs/TmsEmbeddedInstrumentIdentifierBankAccount.md
+++ b/docs/TmsEmbeddedInstrumentIdentifierBankAccount.md
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**number** | **String** | Account number. When processing encoded account numbers, use this field for the encoded account number. | [optional]
-**routingNumber** | **String** | Bank routing number. This is also called the transit number. | [optional]
+**routingNumber** | **String** | Bank routing number. This is also called the transit number. # For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/) | [optional]
diff --git a/docs/TmsEmbeddedInstrumentIdentifierEmbedded.md b/docs/TmsEmbeddedInstrumentIdentifierEmbedded.md
new file mode 100644
index 000000000..38a3e2501
--- /dev/null
+++ b/docs/TmsEmbeddedInstrumentIdentifierEmbedded.md
@@ -0,0 +1,10 @@
+
+# TmsEmbeddedInstrumentIdentifierEmbedded
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**binLookup** | [**TmsBinLookup**](TmsBinLookup.md) | | [optional]
+
+
+
diff --git a/docs/TmsPaymentInstrumentProcessingInfo.md b/docs/TmsPaymentInstrumentProcessingInfo.md
index ab4018f8c..5dbdfcecd 100644
--- a/docs/TmsPaymentInstrumentProcessingInfo.md
+++ b/docs/TmsPaymentInstrumentProcessingInfo.md
@@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**billPaymentProgramEnabled** | **Boolean** | Flag that indicates that this is a payment for a bill or for an existing contractual loan. Possible Values: - `true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. | [optional]
+**billPaymentProgramEnabled** | **Boolean** | Flag that indicates that this is a payment for a bill or for an existing contractual loan. Possible Values: - `true`: Bill payment or loan payment. - `false` (default): Not a bill payment or loan payment. # 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/) | [optional]
**bankTransferOptions** | [**TmsPaymentInstrumentProcessingInfoBankTransferOptions**](TmsPaymentInstrumentProcessingInfoBankTransferOptions.md) | | [optional]
diff --git a/docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md b/docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md
index 8e92db530..f7ccb443b 100644
--- a/docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md
+++ b/docs/TmsPaymentInstrumentProcessingInfoBankTransferOptions.md
@@ -4,7 +4,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**seCCode** | **String** | Specifies the authorization method for the transaction. #### TeleCheck Possible 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 | [optional]
+**seCCode** | **String** | Specifies the authorization method for the transaction. #### TeleCheck Possible 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/) | [optional]
diff --git a/docs/Tmsv2TokenizedCard.md b/docs/Tmsv2TokenizedCard.md
index bc8517382..8188f158e 100644
--- a/docs/Tmsv2TokenizedCard.md
+++ b/docs/Tmsv2TokenizedCard.md
@@ -4,17 +4,25 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**type** | **String** | The network token card association brand Possible Values: - visa - mastercard - americanexpress | [optional]
-**source** | **String** | This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data. Possible Values: - TOKEN - ISSUER - ONFILE | [optional]
-**state** | **String** | State of the network token or network token provision Possible Values: - ACTIVE : Network token is active. - SUSPENDED : Network token is suspended. This state can change back to ACTIVE. - DELETED : This is a final state for a network token instance. - UNPROVISIONED : A previous network token provision was unsuccessful. | [optional]
-**enrollmentId** | **String** | Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully. | [optional]
-**tokenReferenceId** | **String** | Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully. | [optional]
+**links** | [**Tmsv2TokenizedCardLinks**](Tmsv2TokenizedCardLinks.md) | | [optional]
+**id** | **String** | The Id of the Tokenized Card. | [optional]
+**object** | **String** | The type. Possible Values: - tokenizedCard | [optional]
+**accountReferenceId** | **String** | An identifier provided by the issuer for the account. | [optional]
+**consumerId** | **String** | Identifier of the consumer within the wallet. Maximum 24 characters for VTS. | [optional]
+**createInstrumentIdentifier** | **Boolean** | Specifies whether the InstrumentId should be created (true) or not (false). Possible Values: - `true`: The InstrumentId should be created. - `false`: The InstrumentId should be created. | [optional]
+**source** | **String** | Source of the payment instrument. Possible Values: - ONFILE - TOKEN - ISSUER | [optional]
+**state** | **String** | State of the network token or network token provision. Possible Values: ACTIVE : Network token is active. SUSPENDED : Network token is suspended. This state can change back to ACTIVE. DELETED : This is a final state for a network token instance. UNPROVISIONED : A previous network token. | [optional]
**reason** | **String** | Issuers state for the network token Possible Values: - INVALID_REQUEST : The network token provision request contained invalid data. - CARD_VERIFICATION_FAILED : The network token provision request contained data that could not be verified. - CARD_NOT_ELIGIBLE : Card can currently not be used with issuer for tokenization. - CARD_NOT_ALLOWED : Card can currently not be used with card association for tokenization. - DECLINED : Card can currently not be used with issuer for tokenization. - SERVICE_UNAVAILABLE : The network token service was unavailable or timed out. - SYSTEM_ERROR : An unexpected error occurred with network token service, check configuration. | [optional]
-**number** | **String** | The token requestors network token | [optional]
-**expirationMonth** | **String** | Two-digit month in which the network token expires. Format: `MM`. Possible Values: `01` through `12`. | [optional]
-**expirationYear** | **String** | Four-digit year in which the network token expires. Format: `YYYY`. | [optional]
-**cryptogram** | **String** | Generated value used in conjunction with the network token for making a payment. | [optional]
+**number** | **String** | The token requestor's network token for the provided PAN and consumer Id, if available. | [optional]
+**cryptogram** | **String** | Value generated by the card association to be used alongside the network token for processing a payment. | [optional]
+**securityCode** | **String** | 4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF. | [optional]
+**eci** | **String** | Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication. | [optional]
+**requestorId** | **String** | 11-digit identifier that uniquely identifies the Token Requestor. | [optional]
+**enrollmentId** | **String** | Unique id to identify this PAN/ enrollment. | [optional]
+**tokenReferenceId** | **String** | Unique ID for netwrok token. | [optional]
+**paymentAccountReference** | **String** | Payment account reference. | [optional]
**card** | [**Tmsv2TokenizedCardCard**](Tmsv2TokenizedCardCard.md) | | [optional]
+**passcode** | [**Tmsv2TokenizedCardPasscode**](Tmsv2TokenizedCardPasscode.md) | | [optional]
**metadata** | [**Tmsv2TokenizedCardMetadata**](Tmsv2TokenizedCardMetadata.md) | | [optional]
diff --git a/docs/Tmsv2TokenizedCardCard.md b/docs/Tmsv2TokenizedCardCard.md
index aa1ea19bb..68c371127 100644
--- a/docs/Tmsv2TokenizedCardCard.md
+++ b/docs/Tmsv2TokenizedCardCard.md
@@ -4,9 +4,11 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**suffix** | **String** | The customer's latest payment card number suffix | [optional]
-**expirationMonth** | **String** | Two-digit month in which the customer's latest payment card expires. Format: `MM`. Possible Values: `01` through `12`. | [optional]
-**expirationYear** | **String** | Four-digit year in which the customer's latest payment card expires. Format: `YYYY`. | [optional]
+**number** | **String** | The customer's payment card number, also known as the Primary Account Number (PAN). | [optional]
+**expirationMonth** | **String** | Two-digit month in which the payment card expires. Format: `MM`. Possible Values: `01` through `12`. | [optional]
+**expirationYear** | **String** | Four-digit year in which the credit card expires. Format: `YYYY`. | [optional]
+**type** | **String** | The type of card(Card network). Possible Values: 001: visa | [optional]
+**suffix** | **String** | The customer's latest payment card number suffix. | [optional]
diff --git a/docs/Tmsv2TokenizedCardLinks.md b/docs/Tmsv2TokenizedCardLinks.md
new file mode 100644
index 000000000..6fe428bda
--- /dev/null
+++ b/docs/Tmsv2TokenizedCardLinks.md
@@ -0,0 +1,10 @@
+
+# Tmsv2TokenizedCardLinks
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**self** | [**Tmsv2TokenizedCardLinksSelf**](Tmsv2TokenizedCardLinksSelf.md) | | [optional]
+
+
+
diff --git a/docs/Tmsv2TokenizedCardLinksSelf.md b/docs/Tmsv2TokenizedCardLinksSelf.md
new file mode 100644
index 000000000..a2a16c467
--- /dev/null
+++ b/docs/Tmsv2TokenizedCardLinksSelf.md
@@ -0,0 +1,10 @@
+
+# Tmsv2TokenizedCardLinksSelf
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**href** | **String** | Link to the Tokenized Card. example: 'tms/v2/tokenized-cards/7010000000016241111' | [optional]
+
+
+
diff --git a/docs/Tmsv2TokenizedCardMetadata.md b/docs/Tmsv2TokenizedCardMetadata.md
index d745ea6f9..ca9e864b7 100644
--- a/docs/Tmsv2TokenizedCardMetadata.md
+++ b/docs/Tmsv2TokenizedCardMetadata.md
@@ -4,7 +4,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**cardArt** | [**Tmsv2TokenizedCardMetadataCardArt**](Tmsv2TokenizedCardMetadataCardArt.md) | | [optional]
+**cardArt** | [**TmsCardArt**](TmsCardArt.md) | | [optional]
+**issuer** | [**Tmsv2TokenizedCardMetadataIssuer**](Tmsv2TokenizedCardMetadataIssuer.md) | | [optional]
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArt.md b/docs/Tmsv2TokenizedCardMetadataCardArt.md
deleted file mode 100644
index 9a00a69ad..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArt.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArt
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**combinedAsset** | [**Tmsv2TokenizedCardMetadataCardArtCombinedAsset**](Tmsv2TokenizedCardMetadataCardArtCombinedAsset.md) | | [optional]
-**brandLogoAsset** | [**Tmsv2TokenizedCardMetadataCardArtBrandLogoAsset**](Tmsv2TokenizedCardMetadataCardArtBrandLogoAsset.md) | | [optional]
-**coBrandLogoAsset** | [**Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAsset**](Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAsset.md) | | [optional]
-**issuerLogoAsset** | [**Tmsv2TokenizedCardMetadataCardArtIssuerLogoAsset**](Tmsv2TokenizedCardMetadataCardArtIssuerLogoAsset.md) | | [optional]
-**iconAsset** | [**Tmsv2TokenizedCardMetadataCardArtIconAsset**](Tmsv2TokenizedCardMetadataCardArtIconAsset.md) | | [optional]
-**foregroundColor** | **String** | The foreground color of the brand logo asset. | [optional]
-**backgroundAsset** | [**Tmsv2TokenizedCardMetadataCardArtBackgroundAsset**](Tmsv2TokenizedCardMetadataCardArtBackgroundAsset.md) | | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtBackgroundAsset.md b/docs/Tmsv2TokenizedCardMetadataCardArtBackgroundAsset.md
deleted file mode 100644
index da04dc892..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtBackgroundAsset.md
+++ /dev/null
@@ -1,11 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtBackgroundAsset
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Id of the icon asset. | [optional]
-**links** | [**Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinks**](Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinks.md) | | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinks.md b/docs/Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinks.md
deleted file mode 100644
index bc9cc1c24..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinks.md
+++ /dev/null
@@ -1,10 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinks
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**self** | [**Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinksSelf**](Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinksSelf.md) | | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinksSelf.md b/docs/Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinksSelf.md
deleted file mode 100644
index b1d4fd7d4..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinksSelf.md
+++ /dev/null
@@ -1,10 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtBackgroundAssetLinksSelf
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**href** | **String** | Link to the background asset. | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtBrandLogoAsset.md b/docs/Tmsv2TokenizedCardMetadataCardArtBrandLogoAsset.md
deleted file mode 100644
index 3b1af0b93..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtBrandLogoAsset.md
+++ /dev/null
@@ -1,11 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtBrandLogoAsset
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Id of the brand logo asset. | [optional]
-**links** | [**Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinks**](Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinks.md) | | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinks.md b/docs/Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinks.md
deleted file mode 100644
index 1d133f0a7..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinks.md
+++ /dev/null
@@ -1,10 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinks
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**self** | [**Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinksSelf**](Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinksSelf.md) | | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinksSelf.md b/docs/Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinksSelf.md
deleted file mode 100644
index 29f7f2dee..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinksSelf.md
+++ /dev/null
@@ -1,10 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtBrandLogoAssetLinksSelf
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**href** | **String** | Link to the brand logo asset. | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAsset.md b/docs/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAsset.md
deleted file mode 100644
index 1444a2ac4..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAsset.md
+++ /dev/null
@@ -1,11 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAsset
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Id of the co-brand logo asset. | [optional]
-**links** | [**Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinks**](Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinks.md) | | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinks.md b/docs/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinks.md
deleted file mode 100644
index 33f6a0052..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinks.md
+++ /dev/null
@@ -1,10 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinks
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**self** | [**Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinksSelf**](Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinksSelf.md) | | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinksSelf.md b/docs/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinksSelf.md
deleted file mode 100644
index 2f3aec9ac..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinksSelf.md
+++ /dev/null
@@ -1,10 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtCoBrandLogoAssetLinksSelf
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**href** | **String** | Link to the co-brand logo asset. | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtCombinedAsset.md b/docs/Tmsv2TokenizedCardMetadataCardArtCombinedAsset.md
deleted file mode 100644
index 6181fef94..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtCombinedAsset.md
+++ /dev/null
@@ -1,11 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtCombinedAsset
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Id of the combined asset. | [optional]
-**links** | [**Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinks**](Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinks.md) | | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinks.md b/docs/Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinks.md
deleted file mode 100644
index cfda17c91..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinks.md
+++ /dev/null
@@ -1,10 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinks
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**self** | [**Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinksSelf**](Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinksSelf.md) | | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinksSelf.md b/docs/Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinksSelf.md
deleted file mode 100644
index 0b5455c2d..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinksSelf.md
+++ /dev/null
@@ -1,10 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtCombinedAssetLinksSelf
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**href** | **String** | Link to the combined asset. | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtIconAsset.md b/docs/Tmsv2TokenizedCardMetadataCardArtIconAsset.md
deleted file mode 100644
index 30c39b740..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtIconAsset.md
+++ /dev/null
@@ -1,11 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtIconAsset
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Id of the icon asset. | [optional]
-**links** | [**Tmsv2TokenizedCardMetadataCardArtIconAssetLinks**](Tmsv2TokenizedCardMetadataCardArtIconAssetLinks.md) | | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtIconAssetLinks.md b/docs/Tmsv2TokenizedCardMetadataCardArtIconAssetLinks.md
deleted file mode 100644
index 19cd26e2b..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtIconAssetLinks.md
+++ /dev/null
@@ -1,10 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtIconAssetLinks
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**self** | [**Tmsv2TokenizedCardMetadataCardArtIconAssetLinksSelf**](Tmsv2TokenizedCardMetadataCardArtIconAssetLinksSelf.md) | | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtIconAssetLinksSelf.md b/docs/Tmsv2TokenizedCardMetadataCardArtIconAssetLinksSelf.md
deleted file mode 100644
index bd86701c6..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtIconAssetLinksSelf.md
+++ /dev/null
@@ -1,10 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtIconAssetLinksSelf
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**href** | **String** | Link to the icon asset. | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAsset.md b/docs/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAsset.md
deleted file mode 100644
index aa0c29e31..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAsset.md
+++ /dev/null
@@ -1,11 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtIssuerLogoAsset
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** | The Id of the issuer logo asset. | [optional]
-**links** | [**Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinks**](Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinks.md) | | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinks.md b/docs/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinks.md
deleted file mode 100644
index 0640d5ad4..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinks.md
+++ /dev/null
@@ -1,10 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinks
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**self** | [**Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinksSelf**](Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinksSelf.md) | | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinksSelf.md b/docs/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinksSelf.md
deleted file mode 100644
index 63e46c0d4..000000000
--- a/docs/Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinksSelf.md
+++ /dev/null
@@ -1,10 +0,0 @@
-
-# Tmsv2TokenizedCardMetadataCardArtIssuerLogoAssetLinksSelf
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**href** | **String** | Link to the issuer logo asset. | [optional]
-
-
-
diff --git a/docs/Tmsv2TokenizedCardMetadataIssuer.md b/docs/Tmsv2TokenizedCardMetadataIssuer.md
new file mode 100644
index 000000000..7a8437847
--- /dev/null
+++ b/docs/Tmsv2TokenizedCardMetadataIssuer.md
@@ -0,0 +1,12 @@
+
+# Tmsv2TokenizedCardMetadataIssuer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | issuer name. | [optional]
+**shortDescription** | **String** | issuer short description. | [optional]
+**longDescription** | **String** | issuer long description. | [optional]
+
+
+
diff --git a/docs/Tmsv2TokenizedCardPasscode.md b/docs/Tmsv2TokenizedCardPasscode.md
new file mode 100644
index 000000000..14415aa97
--- /dev/null
+++ b/docs/Tmsv2TokenizedCardPasscode.md
@@ -0,0 +1,10 @@
+
+# Tmsv2TokenizedCardPasscode
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** | OTP generated at issuer. | [optional]
+
+
+
diff --git a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md
index d7f64227c..909e6cc6a 100644
--- a/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md
+++ b/docs/Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformation.md
@@ -5,7 +5,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**companyTaxID** | **String** | Company's tax identifier. This is only used for eCheck service. | [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 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]
+**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 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). # 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/) | [optional]
**dateOfBirth** | [**LocalDate**](LocalDate.md) | Date of birth of the customer. Format: YYYY-MM-DD | [optional]
**personalIdentification** | [**List<Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification>**](Tmsv2customersEmbeddedDefaultPaymentInstrumentBuyerInformationPersonalIdentification.md) | | [optional]
diff --git a/docs/TssV2TransactionsGet200Response.md b/docs/TssV2TransactionsGet200Response.md
index 669b7bd71..91625f1aa 100644
--- a/docs/TssV2TransactionsGet200Response.md
+++ b/docs/TssV2TransactionsGet200Response.md
@@ -25,7 +25,7 @@ Name | Type | Description | Notes
**paymentInformation** | [**TssV2TransactionsGet200ResponsePaymentInformation**](TssV2TransactionsGet200ResponsePaymentInformation.md) | | [optional]
**paymentInsightsInformation** | [**PtsV2PaymentsPost201ResponsePaymentInsightsInformation**](PtsV2PaymentsPost201ResponsePaymentInsightsInformation.md) | | [optional]
**payoutOptions** | [**TssV2TransactionsGet200ResponsePayoutOptions**](TssV2TransactionsGet200ResponsePayoutOptions.md) | | [optional]
-**unscheduledPaymentInformation** | [**TssV2TransactionsGet200ResponseUnscheduledPaymentInformation**](TssV2TransactionsGet200ResponseUnscheduledPaymentInformation.md) | | [optional]
+**unscheduledPaymentInformation** | [**Ptsv2paymentsUnscheduledPaymentInformation**](Ptsv2paymentsUnscheduledPaymentInformation.md) | | [optional]
**processingInformation** | [**TssV2TransactionsGet200ResponseProcessingInformation**](TssV2TransactionsGet200ResponseProcessingInformation.md) | | [optional]
**processorInformation** | [**TssV2TransactionsGet200ResponseProcessorInformation**](TssV2TransactionsGet200ResponseProcessorInformation.md) | | [optional]
**recurringPaymentInformation** | [**TssV2TransactionsGet200ResponseRecurringPaymentInformation**](TssV2TransactionsGet200ResponseRecurringPaymentInformation.md) | | [optional]
diff --git a/docs/TssV2TransactionsGet200ResponsePointOfSaleInformation.md b/docs/TssV2TransactionsGet200ResponsePointOfSaleInformation.md
index 231a05916..0db7927f0 100644
--- a/docs/TssV2TransactionsGet200ResponsePointOfSaleInformation.md
+++ b/docs/TssV2TransactionsGet200ResponsePointOfSaleInformation.md
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
**terminalId** | **String** | Identifier for the terminal at your retail location. You can define this value yourself, but consult the processor for requirements. #### CyberSource through VisaNet A list of all possible values is stored in your CyberSource account. If terminal ID validation is enabled for your CyberSource account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact CyberSource Customer Support. When you do not include this field in a request, CyberSource uses the default value that is defined in your CyberSource account. #### FDC Nashville Global To have your account configured to support this field, contact CyberSource Customer Support. This value must be a value that FDC Nashville Global issued to you. #### For Payouts This field is applicable for CyberSource through VisaNet. #### GPX Identifier for the terminal at your retail location. A list of all possible values is stored in your account. If terminal ID validation is enabled for your account, the value you send for this field is validated against the list each time you include the field in a request. To enable or disable terminal ID validation, contact customer support. When you do not include this field in a request, the default value that is defined in your account is used. Optional for authorizations. #### Used by **Authorization** Optional for the following processors. When you do not include this field in a request, the default value that is defined in your account is used. - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - SIX - Chase Paymentech Solutions: Optional field. If you include this field in your request, you must also include `pointOfSaleInformation.catLevel`. - FDMS Nashville: The default value that is defined in your account is used. - GPX - OmniPay Direct: Optional field. For the following processors, this field is not used. - GPN - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions - Worldpay VAP #### Card Present reply Terminal identifier assigned by the acquirer. This value must be printed on the receipt. | [optional]
**entryMode** | **String** | Method of entering payment card information into the POS terminal. Possible values: - `contact`: Read from direct contact with chip card. - `contactless`: Read from a contactless interface using chip data. - `keyed`: Manually keyed into POS terminal. This value is not supported on OmniPay Direct. - `msd`: Read from a contactless interface using magnetic stripe data (MSD). This value is not supported on OmniPay Direct. - `swiped`: Read from credit card magnetic stripe. The `contact`, `contactless`, and `msd` values are supported only for EMV transactions. #### Used by **Authorization** Required field. #### Card Present Card present information about EMV applies only to credit card processing and PIN debit processing. All other card present information applies only to credit card processing. #### PIN debit Required for a PIN debit purchase and a PIN debit credit request. | [optional]
**terminalCapability** | **Integer** | POS terminal's capability. Possible values: - `1`: Terminal has a magnetic stripe reader only. - `2`: Terminal has a magnetic stripe reader and manual entry capability. - `3`: Terminal has manual entry capability only. - `4`: Terminal can read chip cards. - `5`: Terminal can read contactless chip cards; cannot use contact to read chip cards. For an EMV transaction, the value of this field must be `4` or `5`. #### PIN debit Required for PIN debit purchase and PIN debit credit request. #### Used by **Authorization** Required for the following processors: - American Express Direct - Chase Paymentech Solutions - Credit Mutuel-CIC - FDC Nashville Global - FDMS Nashville - OmniPay Direct - SIX - Worldpay VAP Optional for the following processors: - CyberSource through VisaNet - GPN - GPX - JCN Gateway - RBS WorldPay Atlanta - TSYS Acquiring Solutions | [optional]
-**cardholderVerificationMethodUsed** | **Integer** | Method that was used to verify the cardholder's identity. Possible values: - `0`: No verification - `1`: Signature - `2`: PIN - `3`: Cardholder device CVM | [optional]
+**cardholderVerificationMethodUsed** | **Integer** | Method that was used to verify the cardholder's identity. Possible values: - `0`: No verification - `1`: Signature - `2`: PIN - `3`: Cardholder device CVM - `4`: Biometric - `5`: OTP | [optional]
**emv** | [**Ptsv2paymentsidreversalsPointOfSaleInformationEmv**](Ptsv2paymentsidreversalsPointOfSaleInformationEmv.md) | | [optional]
diff --git a/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md
index 212b0b351..64f67ea9e 100644
--- a/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md
+++ b/docs/TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptions.md
@@ -6,7 +6,7 @@ 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. #### 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. #### 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 PayPal ptsV2CreateOrderPost400Response Set this field to 'AUTHORIZE' or 'CAPTURE' depending on whether you want to invoke delayed capture or sale respectively. | [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. #### 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 file: - 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. | [optional]
-**extendAuthIndicator** | **String** | Flag that indicates whether the transaction is an extended authorization. | [optional]
+**extendAuthIndicator** | **String** | Indicates Authorization extension transaction. Extension transaction is used to prolong the settlement period by one additional settlement cycle period. Possible values: - true: Transaction is an Authorization Extension transaction. - false: Transaction is not an Authorization Extension transaction. | [optional]
**cardVerificationIndicator** | **Boolean** | This API field will indicate whether a card verification check is being performed during the transaction Possible values: - `true` - `false` (default value) | [optional]
**initiator** | [**TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator**](TssV2TransactionsGet200ResponseProcessingInformationAuthorizationOptionsInitiator.md) | | [optional]
diff --git a/docs/Upv1capturecontextsCheckoutApiInitialization.md b/docs/Upv1capturecontextsCheckoutApiInitialization.md
deleted file mode 100644
index f4806f5f7..000000000
--- a/docs/Upv1capturecontextsCheckoutApiInitialization.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-# Upv1capturecontextsCheckoutApiInitialization
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**profileId** | **String** | | [optional]
-**accessKey** | **String** | | [optional]
-**referenceNumber** | **String** | | [optional]
-**transactionUuid** | **String** | | [optional]
-**transactionType** | **String** | | [optional]
-**currency** | **String** | | [optional]
-**amount** | **String** | | [optional]
-**locale** | **String** | | [optional]
-**overrideCustomReceiptPage** | **String** | | [optional]
-**unsignedFieldNames** | **String** | | [optional]
-
-
-
diff --git a/generator/cybersource-java-template/libraries/okhttp-gson/ApiClient.mustache b/generator/cybersource-java-template/libraries/okhttp-gson/ApiClient.mustache
index 7611d1a68..16548d116 100644
--- a/generator/cybersource-java-template/libraries/okhttp-gson/ApiClient.mustache
+++ b/generator/cybersource-java-template/libraries/okhttp-gson/ApiClient.mustache
@@ -142,10 +142,18 @@ public class ApiClient {
*/
public static final String LENIENT_DATETIME_FORMAT = "yyyy-MM-dd'T'HH:mm:ss.SSSZ";
+ /**
+ * Use this field ONLY IF you have more than one instance of ApiClient.
+ * This field should NOT be used/accessed for a singleton object.
+ */
public String responseCode;
+
+ /**
+ * Use this field ONLY IF you have more than one instance of ApiClient.
+ * This field should NOT be used/accessed for a singleton object.
+ */
public String status;
- public InputStream responseBody;
- public String respBody;
+
public MerchantConfig merchantConfig;
public RequestTransactionMetrics apiRequestMetrics = new RequestTransactionMetrics();
@@ -1036,6 +1044,8 @@ public class ApiClient {
return (T) downloadFileFromResponse(response);
}
+ String respBody = null;
+
try {
if (response.body() != null)
respBody = response.body().string();
@@ -1191,8 +1201,9 @@ public class ApiClient {
try {
this.apiRequestMetrics.setComputeTime((System.nanoTime() - this.getComputationStartTime()) / 1000000);
Response response = call.execute();
- responseCode = String.valueOf(response.code());
- status = response.message();
+ String responseCode = String.valueOf(response.code());
+ this.status = response.message();
+ this.responseCode = responseCode;
logger.debug("Network Response :\n" + json.serialize(response.headers()));
@@ -1208,7 +1219,7 @@ public class ApiClient {
logger.info("HTTP Response Body :\n{}", data);
- return new ApiResponse(response.code(), response.headers().toMultimap(), data);
+ return new ApiResponse(response.code(), response.headers().toMultimap(), response.message(), data);
} catch (IOException e) {
logger.error("ApiException : " + e.getMessage());
throw new ApiException(e);
@@ -1317,16 +1328,19 @@ public class ApiClient {
public Call buildCall(String path, String method, List queryParams, Object body,
Map headerParams, Map formParams, String[] authNames,
ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
-
+
+ //create reqHeader parameter here
+ Map requestHeaderMap = new HashMap();
+
if(merchantConfig.getDefaultHeaders() != null && !merchantConfig.getDefaultHeaders().isEmpty()) {
for (Entry header : merchantConfig.getDefaultHeaders().entrySet()) {
if(!header.getKey().equalsIgnoreCase("Authorization") && !header.getKey().equalsIgnoreCase("Signature")){
- addDefaultHeader(header.getKey(), header.getValue());
+ requestHeaderMap.put(header.getKey(), header.getValue());
}
}
}
- callAuthenticationHeader(method, path, body, queryParams);
+ callAuthenticationHeader(method, path, body, queryParams, requestHeaderMap);
if (merchantConfig.isEnableClientCert()) {
addClientCertToKeyStore();
@@ -1339,7 +1353,7 @@ public class ApiClient {
headerParams.put("Accept", defaultAcceptHeader);
}
- headerParams.putAll(defaultHeaderMap);
+ headerParams.putAll(requestHeaderMap);
logger.info("Request Header Parameters:\n{}", new PrettyPrintingMap(headerParams));
@@ -1353,10 +1367,10 @@ public class ApiClient {
*
*/
- public void callAuthenticationHeader(String method, String path, Object body, List queryParams) {
+ public void callAuthenticationHeader(String method, String path, Object body, List queryParams, Map requestHeaderMap) {
try {
- merchantConfig.setRequestType(method);
+ String requestTarget = null;
if (queryParams != null && !queryParams.isEmpty()) {
StringBuilder url = new StringBuilder();
@@ -1377,10 +1391,10 @@ public class ApiClient {
url.append(escapeString(param.getName())).append("=").append(escapeString(value));
}
}
- merchantConfig.setRequestTarget(url.toString());
+ requestTarget= url.toString();
}
} else {
- merchantConfig.setRequestTarget(path);
+ requestTarget = path;
}
Authorization authorization = new Authorization();
@@ -1395,41 +1409,38 @@ public class ApiClient {
}
logger.debug("HTTP Request Body:\n" + requestBody);
- merchantConfig.setRequestData(requestBody);
- authorization.setJWTRequestBody(requestBody);
- boolean isMerchantDetails = merchantConfig.validateMerchantDetails();
-
- merchantConfig.setRequestHost(merchantConfig.getRequestHost().trim());
+ boolean isMerchantDetails = merchantConfig.validateMerchantDetails(method);
if (isMerchantDetails
&& !merchantConfig.getAuthenticationType().equalsIgnoreCase(GlobalLabelParameters.MUTUALAUTH)) {
- String token = authorization.getToken(merchantConfig);
+ String date = PropertiesUtil.getNewDate();
+ String token = authorization.getToken(merchantConfig, method, requestBody, requestTarget, date);
if (merchantConfig.getAuthenticationType().equalsIgnoreCase(GlobalLabelParameters.HTTP)) {
- addDefaultHeader("Date", PropertiesUtil.date);
- addDefaultHeader("Host", merchantConfig.getRequestHost().trim());
- addDefaultHeader("v-c-merchant-id", merchantConfig.getMerchantID());
- addDefaultHeader("Signature", token);
- addDefaultHeader("User-Agent", "Mozilla/5.0");
+ requestHeaderMap.put("Date", date);
+ requestHeaderMap.put("Host", merchantConfig.getRequestHost().trim());
+ requestHeaderMap.put("v-c-merchant-id", merchantConfig.getMerchantID());
+ requestHeaderMap.put("Signature", token);
+ requestHeaderMap.put("User-Agent", "Mozilla/5.0");
if (method.equalsIgnoreCase("POST") || method.equalsIgnoreCase("PUT")
|| method.equalsIgnoreCase("PATCH")) {
- PayloadDigest payloadDigest = new PayloadDigest(merchantConfig);
+ PayloadDigest payloadDigest = new PayloadDigest(requestBody);
String digest = payloadDigest.getDigest();
- addDefaultHeader("Digest", digest);
+ requestHeaderMap.put("Digest", digest);
}
} else if (merchantConfig.getAuthenticationType().equalsIgnoreCase(GlobalLabelParameters.JWT)) {
token = "Bearer " + token;
- addDefaultHeader("Authorization", token);
+ requestHeaderMap.put("Authorization", token);
} else if (merchantConfig.getAuthenticationType().equalsIgnoreCase(GlobalLabelParameters.OAUTH)) {
token = "Bearer " + token;
- addDefaultHeader("Authorization", token);
+ requestHeaderMap.put("Authorization", token);
}
}
if (versionInfo != null && !versionInfo.isEmpty()) {
- addDefaultHeader("v-c-client-id", "cybs-rest-sdk-java-" + versionInfo);
+ requestHeaderMap.put("v-c-client-id", "cybs-rest-sdk-java-" + versionInfo);
}
} catch (ConfigException e) {
diff --git a/generator/cybersource-java-template/libraries/okhttp-gson/ApiResponse.mustache b/generator/cybersource-java-template/libraries/okhttp-gson/ApiResponse.mustache
index 390939369..ac923a407 100644
--- a/generator/cybersource-java-template/libraries/okhttp-gson/ApiResponse.mustache
+++ b/generator/cybersource-java-template/libraries/okhttp-gson/ApiResponse.mustache
@@ -14,13 +14,14 @@ public class ApiResponse {
final private int statusCode;
final private Map> headers;
final private T data;
+ final private String message;
/**
* @param statusCode The status code of HTTP response
* @param headers The headers of HTTP response
*/
- public ApiResponse(int statusCode, Map> headers) {
- this(statusCode, headers, null);
+ public ApiResponse(int statusCode, Map> headers, String message) {
+ this(statusCode, headers, message, null);
}
/**
@@ -28,9 +29,10 @@ public class ApiResponse {
* @param headers The headers of HTTP response
* @param data The object deserialized from response bod
*/
- public ApiResponse(int statusCode, Map> headers, T data) {
+ public ApiResponse(int statusCode, Map> headers, String message, T data) {
this.statusCode = statusCode;
this.headers = headers;
+ this.message= message;
this.data = data;
}
@@ -45,4 +47,8 @@ public class ApiResponse {
public T getData() {
return data;
}
+
+ public String getMessage() {
+ return message;
+ }
}
diff --git a/generator/cybersource-java-template/libraries/okhttp-gson/api.mustache b/generator/cybersource-java-template/libraries/okhttp-gson/api.mustache
index 6c3808637..3a2645f9c 100644
--- a/generator/cybersource-java-template/libraries/okhttp-gson/api.mustache
+++ b/generator/cybersource-java-template/libraries/okhttp-gson/api.mustache
@@ -200,7 +200,6 @@ public class {{classname}} {
*/
public {{#returnType}}{{{returnType}}} {{/returnType}}{{^returnType}}void {{/returnType}}{{operationId}}({{#allParams}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) throws ApiException {
logger.info("CALL TO METHOD '{{operationId}}' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
{{#returnType}}ApiResponse<{{{returnType}}}> {{localVariablePrefix}}resp = {{/returnType}}{{operationId}}WithHttpInfo({{#allParams}}{{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}});
{{#returnType}}
logger.info("CALL TO METHOD '{{operationId}}' ENDED");
@@ -215,6 +214,7 @@ public class {{classname}} {
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse<{{#vendorExtensions.x-streaming}}InputStream{{/vendorExtensions.x-streaming}}{{^vendorExtensions.x-streaming}}{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Void{{/returnType}}{{/vendorExtensions.x-streaming}}> {{operationId}}WithHttpInfo({{#allParams}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{{dataType}}} {{paramName}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call {{localVariablePrefix}}call = {{operationId}}ValidateBeforeCall({{#allParams}}{{paramName}}, {{/allParams}}null, null);
{{#returnType}}Type {{localVariablePrefix}}localVarReturnType = new TypeToken<{{{returnType}}}>(){}.getType();
return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call, {{localVariablePrefix}}localVarReturnType);{{/returnType}}{{^returnType}}return {{localVariablePrefix}}apiClient.execute({{localVariablePrefix}}call);{{/returnType}}
diff --git a/generator/cybersource-java-template/libraries/okhttp-gson/pojo.mustache b/generator/cybersource-java-template/libraries/okhttp-gson/pojo.mustache
new file mode 100644
index 000000000..775c7e0ac
--- /dev/null
+++ b/generator/cybersource-java-template/libraries/okhttp-gson/pojo.mustache
@@ -0,0 +1,214 @@
+/**
+ * {{#description}}{{.}}{{/description}}{{^description}}{{classname}}{{/description}}
+ */{{#description}}
+@ApiModel(description = "{{{description}}}"){{/description}}
+{{>generatedAnnotation}}{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{>xmlAnnotation}}
+public class {{classname}} {{#parent}}extends {{{parent}}} {{/parent}}{{#parcelableModel}}implements Parcelable {{#serializableModel}}, Serializable {{/serializableModel}}{{/parcelableModel}}{{^parcelableModel}}{{#serializableModel}}implements Serializable {{/serializableModel}}{{/parcelableModel}}{
+{{#serializableModel}}
+ private static final long serialVersionUID = 1L;
+
+{{/serializableModel}}
+ {{#vars}}
+ {{#isEnum}}
+ {{^isContainer}}
+{{>modelInnerEnum}}
+ {{/isContainer}}
+ {{/isEnum}}
+ {{#items.isEnum}}
+ {{#items}}
+ {{^isContainer}}
+{{>modelInnerEnum}}
+ {{/isContainer}}
+ {{/items}}
+ {{/items.isEnum}}
+ {{#jackson}}
+ @JsonProperty("{{baseName}}")
+ {{#withXml}}
+ @JacksonXmlProperty({{#isXmlAttribute}}isAttribute = true, {{/isXmlAttribute}}{{#xmlNamespace}}namespace="{{xmlNamespace}}", {{/xmlNamespace}}localName = "{{#xmlName}}{{xmlName}}{{/xmlName}}{{^xmlName}}{{baseName}}{{/xmlName}}")
+ {{/withXml}}
+ {{/jackson}}
+ {{#withXml}}
+ {{#isXmlAttribute}}
+ @XmlAttribute(name = "{{#xmlName}}{{xmlName}}{{/xmlName}}{{^xmlName}}{{baseName}}{{/xmlName}}")
+ {{/isXmlAttribute}}
+ {{^isXmlAttribute}}
+ @XmlElement({{#xmlNamespace}}namespace="{{xmlNamespace}}", {{/xmlNamespace}}name = "{{#xmlName}}{{xmlName}}{{/xmlName}}{{^xmlName}}{{baseName}}{{/xmlName}}")
+ {{/isXmlAttribute}}
+ {{/withXml}}
+ {{#gson}}
+ @SerializedName("{{baseName}}")
+ {{/gson}}
+ {{#isContainer}}
+ private {{{datatypeWithEnum}}} {{name}}{{#required}} = {{{defaultValue}}}{{/required}}{{^required}} = null{{/required}};
+ {{/isContainer}}
+ {{^isContainer}}
+ private {{{datatypeWithEnum}}} {{name}} = {{{defaultValue}}};
+ {{/isContainer}}
+
+ {{/vars}}
+ {{#vars}}
+ {{^isReadOnly}}
+ public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) {
+ this.{{name}} = {{name}};
+ return this;
+ }
+ {{#isListContainer}}
+
+ public {{classname}} add{{nameInCamelCase}}Item({{{items.datatypeWithEnum}}} {{name}}Item) {
+ {{^required}}
+ if (this.{{name}} == null) {
+ this.{{name}} = {{{defaultValue}}};
+ }
+ {{/required}}
+ this.{{name}}.add({{name}}Item);
+ return this;
+ }
+ {{/isListContainer}}
+ {{#isMapContainer}}
+
+ public {{classname}} put{{nameInCamelCase}}Item(String key, {{{items.datatypeWithEnum}}} {{name}}Item) {
+ {{^required}}
+ if (this.{{name}} == null) {
+ this.{{name}} = {{{defaultValue}}};
+ }
+ {{/required}}
+ this.{{name}}.put(key, {{name}}Item);
+ return this;
+ }
+ {{/isMapContainer}}
+
+ {{/isReadOnly}}
+ /**
+ {{#description}}
+ * {{description}}
+ {{/description}}
+ {{^description}}
+ * Get {{name}}
+ {{/description}}
+ {{#minimum}}
+ * minimum: {{minimum}}
+ {{/minimum}}
+ {{#maximum}}
+ * maximum: {{maximum}}
+ {{/maximum}}
+ * @return {{name}}
+ **/
+{{#useBeanValidation}}{{>beanValidation}}{{/useBeanValidation}} @ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}")
+{{#vendorExtensions.extraAnnotation}}
+ {{{vendorExtensions.extraAnnotation}}}
+{{/vendorExtensions.extraAnnotation}}
+ public {{{datatypeWithEnum}}} {{getter}}() {
+ return {{name}};
+ }
+ {{^isReadOnly}}
+
+ public void {{setter}}({{{datatypeWithEnum}}} {{name}}) {
+ this.{{name}} = {{name}};
+ }
+ {{/isReadOnly}}
+
+ {{/vars}}
+
+{{^supportJava6}}
+ @Override
+ public boolean equals(java.lang.Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }{{#hasVars}}
+ {{classname}} {{classVarName}} = ({{classname}}) o;
+ return {{#vars}}Objects.equals(this.{{name}}, {{classVarName}}.{{name}}){{#hasMore}} &&
+ {{/hasMore}}{{/vars}}{{#parent}} &&
+ super.equals(o){{/parent}};{{/hasVars}}{{^hasVars}}
+ return {{#parent}}super.equals(o){{/parent}}{{^parent}}true{{/parent}};{{/hasVars}}
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hash({{#vars}}{{name}}{{#hasMore}}, {{/hasMore}}{{/vars}}{{#parent}}{{#hasVars}}, {{/hasVars}}super.hashCode(){{/parent}});
+ }
+
+{{/supportJava6}}
+{{#supportJava6}}
+ @Override
+ public boolean equals(java.lang.Object o) {
+ if (this == o) {
+ return true;
+ }
+ if (o == null || getClass() != o.getClass()) {
+ return false;
+ }{{#hasVars}}
+ {{classname}} {{classVarName}} = ({{classname}}) o;
+ return {{#vars}}ObjectUtils.equals(this.{{name}}, {{classVarName}}.{{name}}){{#hasMore}} &&
+ {{/hasMore}}{{/vars}}{{#parent}} &&
+ super.equals(o){{/parent}};{{/hasVars}}{{^hasVars}}
+ return true;{{/hasVars}}
+ }
+
+ @Override
+ public int hashCode() {
+ return ObjectUtils.hashCodeMulti({{#vars}}{{name}}{{#hasMore}}, {{/hasMore}}{{/vars}}{{#parent}}{{#hasVars}}, {{/hasVars}}super.hashCode(){{/parent}});
+ }
+
+{{/supportJava6}}
+
+ @Override
+ public String toString() {
+ StringBuilder sb = new StringBuilder();
+ sb.append("class {{classname}} {\n");
+ {{#parent}}sb.append(" ").append(toIndentedString(super.toString())).append("\n");{{/parent}}
+ {{#vars}}if ({{name}} != null) sb.append(" {{name}}: ").append(toIndentedString({{name}})).append("\n");
+ {{/vars}}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 ");
+ }
+
+ {{#parcelableModel}}
+ public void writeToParcel(Parcel out, int flags) {
+ {{#parent}} super.writeToParcel(out, flags); {{/parent}} {{#vars}}
+ out.writeValue({{name}});
+ {{/vars}}
+ }
+
+ public {{classname}}() {
+ super();
+ }
+
+ {{classname}}(Parcel in) {
+ {{#parent}} super(in); {{/parent}}
+ {{#vars}}
+ {{#isPrimitiveType}}
+ {{name}} = ({{{datatypeWithEnum}}})in.readValue(null);
+ {{/isPrimitiveType}}
+ {{^isPrimitiveType}}
+ {{name}} = ({{{datatypeWithEnum}}})in.readValue({{complexType}}.class.getClassLoader());
+ {{/isPrimitiveType}}
+ {{/vars}}
+ }
+
+ public int describeContents() {
+ return 0;
+ }
+
+ public static final Parcelable.Creator<{{classname}}> CREATOR = new Parcelable.Creator<{{classname}}>() {
+ public {{classname}} createFromParcel(Parcel in) {
+ return new {{classname}}(in);
+ }
+ public {{classname}}[] newArray(int size) {
+ return new {{classname}}[size];
+ }
+ };
+ {{/parcelableModel}}
+}
diff --git a/generator/cybersource-java-template/pojo.mustache b/generator/cybersource-java-template/pojo.mustache
index d0a4c70f3..775c7e0ac 100644
--- a/generator/cybersource-java-template/pojo.mustache
+++ b/generator/cybersource-java-template/pojo.mustache
@@ -159,7 +159,7 @@ public class {{classname}} {{#parent}}extends {{{parent}}} {{/parent}}{{#parcela
StringBuilder sb = new StringBuilder();
sb.append("class {{classname}} {\n");
{{#parent}}sb.append(" ").append(toIndentedString(super.toString())).append("\n");{{/parent}}
- {{#vars}}sb.append(" {{name}}: ").append(toIndentedString({{name}})).append("\n");
+ {{#vars}}if ({{name}} != null) sb.append(" {{name}}: ").append(toIndentedString({{name}})).append("\n");
{{/vars}}sb.append("}");
return sb.toString();
}
@@ -170,7 +170,7 @@ public class {{classname}} {{#parent}}extends {{{parent}}} {{/parent}}{{#parcela
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
- return "null";
+ // return "null";
}
return o.toString().replace("\n", "\n ");
}
diff --git a/generator/cybersource-rest-spec.json b/generator/cybersource-rest-spec.json
index 35f69c590..8671afd97 100644
--- a/generator/cybersource-rest-spec.json
+++ b/generator/cybersource-rest-spec.json
@@ -373,6 +373,12 @@
"payments"
],
"operationId": "createPayment",
+ "produces": [
+ "application/hal+json;charset=utf-8"
+ ],
+ "consumes": [
+ "application/json;charset=utf-8"
+ ],
"x-devcenter-metaData": {
"categoryTag": "Payments",
"testingTriggers": "https://developer.cybersource.com/hello-world/testing-guide.html",
@@ -582,7 +588,8 @@
},
"extendAuthIndicator": {
"type": "string",
- "description": "Flag that indicates whether the transaction is an extended authorization.\n"
+ "maxLength": 5,
+ "description": "Indicates Authorization extension transaction. Extension transaction is used to prolong the settlement period by one additional settlement cycle period.\n\nPossible values:\n- true: Transaction is an Authorization Extension transaction. \n- false: Transaction is not an Authorization Extension transaction.\n"
},
"balanceInquiry": {
"type": "boolean",
@@ -637,6 +644,11 @@
"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"
+ },
+ "agreementId": {
+ "type": "string",
+ "maxLength": 140,
+ "description": "An API to carry the agreement ID generated for recurring and unscheduled Card on file transaction. the merchant generates this per card holder or per payment agreement and shares the generated unique ID in the subsequent transactions. This can contain foreign/arabic character set also. Cybersource forwards this value to the Saudi Payment processor.\n"
}
}
}
@@ -648,7 +660,7 @@
},
"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- 005: Installment based repayment\n\nThe value for this field corresponds to the following data in the TC 33A capture file (applicable to Brazil):\n- Record: CP07 TCR0\n- Position: 48-50\n- Field: Bill Payment Transaction Type Identifier\n\nThe value for this field corresponds to the following data in the TC 33A capture file (applicable to Installment)\nbased Repayment):\n- Record: CP01 TCR6\n- Position: 154-156\n- Field: Bill Payment Transaction Type Identifier\n\n\nThis field is supported for\n1. Bill payments in Brazil with Mastercard on CyberSource through VisaNet.\n2. Installment based repayment transactions on Cybersource through VisaNet.\n"
+ "description": "Reason for the payment.\n\nPossible values:\n- 001: Public utilities / Utility payment\n- 002: Government services\n- 003: Cellular / Mobile phone top-up\n- 004: Coupon payment\n- 005: Installment based repayment\n- 006: Billing payment\n- 007: Tax payment\n- 008: Tax payment refunds\n\nThe value for this field corresponds to the following data in the TC 33A capture file (applicable to Brazil):\n- Record: CP07 TCR0\n- Position: 48-50\n- Field: Bill Payment Transaction Type Identifier\n\nThe value for this field corresponds to the following data in the TC 33A capture file (applicable to Installment)\nbased Repayment):\n- Record: CP01 TCR6\n- Position: 154-156\n- Field: Bill Payment Transaction Type Identifier\n\n\nThis field is supported for\n1. Bill payments in Brazil with Mastercard on CyberSource through VisaNet.\n2. Installment based repayment transactions on Cybersource through VisaNet.\n"
},
"redemptionInquiry": {
"type": "boolean",
@@ -682,9 +694,27 @@
"type": "boolean",
"description": "This API field will indicate whether a card verification check is being performed during the transaction\n\nPossible values:\n - `true`\n - `false` (default value)\n"
},
+ "transactionMode": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "Transaction mode identifier. Identifies the specific channel from which the transaction originates.\n\nPossible values:\n- M \u2013 Mobile Order\n- T \u2013 Telephone Order\n"
+ },
"aftIndicator": {
"type": "boolean",
"description": "Indicates whether the transaction is an Account Funding Transaction (AFT). \nThis field is mandatory for Account Funding Transactions (AFT). \n\nPossible values:\n - `true` (This is an AFT transaction)\n - `false` (default value) (This is not an AFT transaction)\n"
+ },
+ "serviceType": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Field is used for back-to-back funding transaction and can be defined as a payment flow that automatically transfers funds through a real-time \nfunding or a live-load. This type of transaction can also be connected to a purchase. \nIn back-to-back funding of general purpose card that is used to make a purchase, two separate accounts are involved: \n- account one is used to make the purchase\n- account two is used to automatically fund or reimburse account one\n\nPossible values:\n- 0B = back to back funding transaction\n- 00 = normal transaction\n- 01 = originator hold\n- 02 = Visa deferred OCT hold, default interval\n- 03 = Visa deferred OCT hold, user-defined interval\n- 09 = Cancel pending deferred OCT request\n- 0I = Visa Direct custom program 1\n- 0Q = uery the status of the deferred OCT\n- A0 = Alias Directory 2\n"
+ },
+ "balanceUpdate": {
+ "type": "boolean",
+ "description": "Merchant to inform Cybersource whether a transaction is Money load with Balance Update.\n\nPossible values:\n - `true` (This is a Money load with balance update transaction)\n - `false` (default value) (This is not a Money load with balance update transaction)\n"
+ },
+ "moneyLoad": {
+ "type": "boolean",
+ "description": "Merchant to inform Cybersource whether a transaction is Money load with Money load only.\n\nPossible values:\n - `true` (This is a money load transaction)\n - `false` (default value) (This is not a money load transaction)\n"
}
}
},
@@ -717,6 +747,16 @@
"type": "string",
"maxLength": 255,
"description": "An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.\n"
+ },
+ "reconciliationId": {
+ "type": "string",
+ "maxLength": 60,
+ "description": "Used for authbill request when capture field equals true"
+ },
+ "reconciliationIdAlternate": {
+ "type": "string",
+ "maxLength": 12,
+ "description": "Used by Nike merchant to send 12 digit order number"
}
}
},
@@ -806,6 +846,21 @@
"type": "string",
"maxLength": 20,
"description": "Flag that indicates an EBT voucher transaction. Possible value:\n- `EBT_VOUCHER`: Indicates the PIN debit transaction is an EBT voucher.\n- `BUY`\n- `RENT`\n- `BOOK`\n- `SUBSCRIBE`\n- `DOWNLOAD`\n- `ORDER`\n- `CONTINUE`\n\n#### PIN debit\nRequired field for EBT voucher transactions that use PIN debit purchase; otherwise, not used.\n"
+ },
+ "eligibilityIndicator": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains installment data defined by MasterCard.\nPossible values:\n - Y = eligible\n - N = not eligile\n"
+ },
+ "benefitAmount": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "Workplace benefit amount."
+ },
+ "benefitType": {
+ "type": "string",
+ "maxLength": 100,
+ "description": "Workplace benefit type.\nPossible values:\n- 70 = employee benefit\n- 4T = transportation / transit\n- 52 = general benefit\n- 53 = meal voucher\n- 54 = fuel\n- 55 = ecological / sustainability\n- 58 = philanthropy / patronage / consumption\n- 59 = gift\n- 5S = sport / culture\n- 5T = book / education\n"
}
}
},
@@ -964,6 +1019,26 @@
"type": "string",
"maxLength": 36,
"description": "The instruction to process an order.\n- default value: 'NO_INSTRUCTION'\n- 'ORDER_SAVED_EXPLICITLY'\n"
+ },
+ "transactionTypeIndicator": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field is used identify the type of payment transaction taking place. This field is applicable for MasterCard transactions only.\nPossible values:\n- 201- Mastercard Rebate\n- 202- rePower Load Value\n- 203- Gaming Re-pay\n- 204- General Person-to-Person\n- 205- General Transfer to Own Account\n- 206- Agent Cash Out\n- 207- Payment of Own Credit Card Bill\n- 208- Business Disbursement\n- 209- Government/Non-Profit Disbursement\n- 210- Rapid Merchant Settlement\n- 211- Cash in at ATM (Usage limited to specific countries)\n- 212- Cash in at Point of Sale (Usage limited to specific countries)\n- 213- General Business to Business Transfer\n- 214- Mastercard Merchant Presented QR\n- 215- Mastercard Merchant Presented QR Refund Payment\n- 216- Utility Payments (for Brazil domestic use only)\n- 217- Government Services (for Brazil domestic use only)\n- 218- Mobile phone top-ups (for Brazil domestic use only)\n- 219- Coupon booklet payments (for Brazil domestic use only)\n- 220- General Person-to-Person Transfer\n- 221- Person-to-Person Transfer to Card Account\n- 222- General Transfer to Own Account\n- 223- Agent Cash Out\n- 224- Payment of Own Credit Card Bill\n- 225- Business Disbursement\n- 226- Transfer to Own Staged Digital Wallet Account\n- 227- Transfer to Own Debit or Prepaid Account\n- 228- General Business-to-Business Transfer\n- 229- Installment-based repayment\n- 230- Mastercard ATM Cash Pick-Up Transaction\n- 231- Cryptocurrency\n- 232- High-risk Securities\n"
+ },
+ "purposeOfPayment": {
+ "type": "string",
+ "maxLength": 25,
+ "description": "\nPossible values:\n- `16` : High Risk Security\n\nOther values can also be accommodated in future for different transactions.\n\nCurrently this field is only used in OCT, we could not find any existing valid values for the past 30 days in production.\nIssuer may decline invalid purpose of payment code with response code 93.\n\nThis field is also applicable for AFT transactions. For list of supported values, please refer to Developer Guide.\n"
+ },
+ "languageCode": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Contains the ISO 639-2 defined language Code\n"
+ },
+ "originalPaymentId": {
+ "type": "string",
+ "maxLength": 26,
+ "description": "This value is used for linking Authorization extension transaction to the original Authorization transaction \nand for linking MIT (Merchant initiated transaction) with the respective CIT (Customer initiated transaction).\n"
}
}
},
@@ -1719,7 +1794,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 2,
+ "maxLength": 50,
"description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n"
},
"postalCode": {
@@ -1761,7 +1836,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"postalCode": {
@@ -1864,12 +1939,12 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"county": {
@@ -2197,7 +2272,7 @@
},
"purchaseOrderNumber": {
"type": "string",
- "maxLength": 25,
+ "maxLength": 50,
"description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n"
},
"purchaseOrderDate": {
@@ -2287,7 +2362,7 @@
},
"shippingMethod": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Shipping method for the product. Possible values:\n\n - `lowcost`: Lowest-cost service\n - `sameday`: Courier or same-day service\n - `oneday`: Next-day or overnight service\n - `twoday`: Two-day service\n - `threeday`: Three-day service\n - `pickup`: Store pick-up\n - `other`: Other shipping method\n - `none`: No shipping method because product is a service or subscription\n"
},
"shipFromPostalCode": {
@@ -2446,6 +2521,41 @@
"type": "string",
"maxLength": 2,
"description": "The country associated with the address of the sender.\nThis field is applicable for AFT transactions. \n\nMust be a two character ISO country code. \nFor example, see [ISO Country Code](https://developer.cybersource.com/docs/cybs/en-us/country-codes/reference/all/na/country-codes/country-codes.html)\n"
+ },
+ "aliasName": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Sender's alias name."
+ },
+ "referenceNumber": {
+ "type": "string",
+ "maxLength": 19,
+ "description": "This field is applicable for AFT transactions. \n\nContains a transaction reference number provided by the Merchant. Only alpha numeric values are supported.\n"
+ },
+ "account": {
+ "type": "object",
+ "properties": {
+ "number": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "The account number of the entity funding the transaction. The value for this field can be a payment card account number or bank account number.\n"
+ },
+ "type": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Identifies the sender's account type.\nThis field is applicable for AFT transactions.\n\nValid values are:\n - `00` for Other\n - `01` for Routing Transit Number (RTN) + Bank Account Number (BAN)\n - `02` for International Bank Account Number (IBAN)\n - `03` for Card Account\n - `04` for Email\n - `05` for Phone Number\n - `06` for Bank Account Number (BAN) + Bank Identification Code (BIC), also known as a SWIFT code\n - `07` for Wallet ID\n - `08` for Social Network ID\n"
+ },
+ "fundsSource": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "Source of funds.\nPossible Values:\n - `01`: Credit.\n - `02`: Debit.\n - `03`: Prepaid.\n - `04`: Deposit Account.\n - `05`: Mobile Money Account.\n - `06`: Cash.\n - `07`: Other.\n - `V5`: Debits / deposit access other than those linked to the cardholders' scheme.\n - `V6`: Credit accounts other than those linked to the cardholder's scheme.\n"
+ }
+ }
+ },
+ "postalCode": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Postal code of sender.\n"
}
}
},
@@ -2482,6 +2592,11 @@
"maxLength": 50,
"description": "The street address of the recipient\nThis field is applicable for AFT and OCT transactions.\n\nOnly alpha numeric values are supported. Special characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor. \n"
},
+ "administrativeArea": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "The state or province of the recipient.\nThis field is applicable for AFT transactions when the recipient country is US or CA. Else it is optional.\n\nMust be a two character value\n"
+ },
"postalCode": {
"type": "string",
"maxLength": 10,
@@ -2511,6 +2626,36 @@
"type": "string",
"maxLength": 255,
"description": "Only for e-wallets: The ultimate beneficiary's street address (street,\nzip code, city), excluding the country. Example: \"Main street 1, 12345,\nBarcelona\n"
+ },
+ "aliasName": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Account owner alias name.\n"
+ },
+ "nationality": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Account Owner Nationality"
+ },
+ "countryOfBirth": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Account Owner Country of Birth"
+ },
+ "occupation": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Account Owner Occupation"
+ },
+ "email": {
+ "type": "string",
+ "maxLength": 150,
+ "description": "Account Owner email address"
+ },
+ "locality": {
+ "type": "string",
+ "maxLength": 25,
+ "description": "The city of the recipient.\nThis field is applicable for AFT transactions.\n\nOnly alpha numeric values are supported.\nSpecial characters not in the standard ASCII character set are not supported and will be stripped before being sent to sent to the processor.\n"
}
}
},
@@ -2656,7 +2801,7 @@
},
"locality": {
"type": "string",
- "maxLength": 13,
+ "maxLength": 30,
"description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
@@ -2871,7 +3016,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 3,
+ "maxLength": 50,
"description": "Sub-merchant's state or province.\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": {
@@ -2900,6 +3045,31 @@
"description": "Sub-merchant's 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"
}
}
+ },
+ "streetAddress": {
+ "type": "string",
+ "maxLength": 150,
+ "description": "Acquirer street name."
+ },
+ "city": {
+ "type": "string",
+ "maxLength": 100,
+ "description": "Acquirer city."
+ },
+ "state": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Acquirer state."
+ },
+ "postalCode": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "Acquirer postal code."
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Acquirer country."
}
}
},
@@ -3008,7 +3178,7 @@
},
"paSpecificationVersion": {
"type": "string",
- "maxLength": 1,
+ "maxLength": 20,
"description": "This field contains 3DS version that was used for Secured Consumer Authentication (SCA). \nThe value for this field should be in the format major.minor.patch version.\n\nValid Values are:\n\n- `2.1.0` (EMV 3D Secure Version 2.1)\n- `2.2.0` (EMV 3D Secure Version 2.2)\n- `2.3.0` (EMV 3D Secure Version 2.3)\n- `2.4.0` (EMV 3D Secure Version 2.4)\n- `2.5.0` (EMV 3D Secure Version 2.5)\n- `2.6.0` (EMV 3D Secure Version 2.6)\n- `2.7.0` (EMV 3D Secure Version 2.7)\n- `2.8.0` (EMV 3D Secure Version 2.8)\n- `2.9.0` (EMV 3D Secure Version 2.9)\n\nFor Visa Platform Connect: \nThe value for this field corresponds to the following data in the TC 33 capture file3: \nRecord: CP01 TCR7, Position: 113 , Field: MC AVV Verification\u2014Program Protocol\n\nIt will contain one of the following values:\n- `1` (3D Secure Version 1.x (3DS 1.0))\n- `2` (EMV 3-D Secure (3DS 2.x))\n"
},
"authenticationType": {
@@ -3213,6 +3383,11 @@
"maxLength": 1,
"description": "Enables the communication of trusted beneficiary/whitelist status between the ACS, the DS and the 3DS Requestor.\n\nPossible Values:\n\nY - 3DS Requestor is whitelisted by cardholder\n\nN - 3DS Requestor is not whitelisted by cardholder\n"
},
+ "authenticationBrand": {
+ "type": "string",
+ "maxLength": 16,
+ "description": "Indicates which directory server was used while authentication process, this data is useful in case of scenarios \nwhen domestic scheme directory server is not present and authentication fallbacks to global scheme directory server.\nPossible values:\n- VISA - Returned for Mada VISA Co-badged cards, when authentication falls back to VISA Directory Server\n- MASTERCARD - Returned for Mada MasterCard Co-badged cards, when authentication falls back to MasterCard Directory Server\n"
+ },
"effectiveAuthenticationType": {
"type": "string",
"maxLength": 2,
@@ -3226,6 +3401,16 @@
"signedPares": {
"type": "string",
"description": "Payer authentication result (PARes) message returned by the card-issuing bank.\nIf you need to show proof of enrollment checking, you may need to\ndecrypt and parse the string for the information required by the payment card company.\nFor more information, see \"Storing Payer Authentication Data,\" page 160.\nImportant The value is in base64. You must remove all carriage returns and line feeds before\nadding the PARes to the request.\n"
+ },
+ "acsReferenceNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Unique identifier assigned by the EMVCo Secretariat upon Testing and Approval."
+ },
+ "dsReferenceNumber": {
+ "type": "string",
+ "maxLength": 32,
+ "description": "EMVCo-assigned unique identifier. This field is required in Cardholder Initiated 3DS fully authenticated mada transactions.\nWhen you request the payer authentication and authorization services separately, get the value for this field from the payerAuthEnrollReply_dsReferenceNumber or payerAuthValidateReply_dsReferenceNumber response field.\n"
}
}
},
@@ -3244,7 +3429,7 @@
},
"cardholderVerificationMethodUsed": {
"type": "integer",
- "description": "Method that was used to verify the cardholder's identity. Possible values:\n\n - `0`: No verification\n - `1`: Signature\n - `2`: PIN\n - `3`: Cardholder device CVM\n"
+ "description": "Method that was used to verify the cardholder's identity. Possible values:\n\n - `0`: No verification\n - `1`: Signature\n - `2`: PIN\n - `3`: Cardholder device CVM\n - `4`: Biometric\n - `5`: OTP\n"
},
"laneNumber": {
"type": "string",
@@ -3331,6 +3516,11 @@
},
"description": "Complete list of cardholder verification methods (CVMs) supported by the terminal.\nOptional field.\nPossible values:\n- `PIN`: For terminals with a PIN Pad\n- `Signature`: For terminals capable of receiving a signature\n- `pinOnGlass`: For terminals where PIN is entered on a glass-based capture mechanism\n\n**EXAMPLE**: [\"PIN\",\"Signature\"]; [\"pinOnGlass\",\"Signature\"]\n"
},
+ "terminalCategory": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "Indicates the type of terminal. \n\nPossible values:\n- `AFD`: Automated Fuel Dispenser\n"
+ },
"terminalInputCapability": {
"type": "array",
"items": {
@@ -3426,7 +3616,7 @@
},
"value": {
"type": "string",
- "maxLength": 255,
+ "maxLength": 800,
"description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
@@ -3463,7 +3653,7 @@
"properties": {
"amount": {
"type": "string",
- "maxLength": 12,
+ "maxLength": 13,
"description": "Amount for the current installment payment.\n\nThis field is supported only for CyberSource through VisaNet.\n"
},
"frequency": {
@@ -3478,17 +3668,17 @@
},
"sequence": {
"type": "integer",
- "maximum": 99,
+ "maximum": 999,
"description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"totalAmount": {
"type": "string",
- "maxLength": 12,
+ "maxLength": 13,
"description": "Total amount of the loan that is being paid in installments. This field is supported only for CyberSource\nthrough VisaNet.\n"
},
"totalCount": {
"type": "integer",
- "maximum": 99,
+ "maximum": 999,
"description": "Total number of installments when making payments in installments.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### American Express Direct, Cielo, and Comercio Latino\nThis value is the total number of installments you approved.\n\n#### CyberSource Latin American Processing in Brazil\nThis value is the total number of installments that you approved. The default is 1.\n\n#### All Other Processors\nThis value is used along with _sequence_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\n#### CyberSource through VisaNet\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 23-25\n- Field: Number of Installments\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 7-8\n- Field: Number of Installments\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR1\n- Position: 7-8\n- Field: Number of Installments\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR5\n- Position: 20-22\n- Field: Installment Total Count\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"firstInstallmentDate": {
@@ -3504,7 +3694,7 @@
"paymentType": {
"type": "string",
"maxLength": 1,
- "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n"
+ "description": "Payment plan for the installments.\nThis field is supported only for installment payments on Visa Platform Connect, RuPay and SPG-KSA seamless flow.\n\nPossible values for a standing-instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card:\n- 1: SI with a fixed amount.\n- 2: SI with a maximum amount.\n- 3: Other kind of SI.\n\nPossible values for a type of Installment transaction for on-soil transaction in Kingdom of Saudi Arabia\n- 1: Registration or first transaction.\n- 2: Subsequent transaction.\n\nPossible values for other kinds of installment payments:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n- 6: SI de-registration on RuPay for the payer authentication seamless flow.\n"
},
"eligibilityInquiry": {
"type": "string",
@@ -4930,6 +5120,16 @@
}
}
},
+ "unscheduledPaymentInformation": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "Indicates the type of unscheduled payment. This field is required for unscheduled payments CIT/MIT Possible values:\n1: First unscheduled transaction.\n2: Subsequent unscheduled transaction.\n"
+ }
+ }
+ },
"hostedPaymentInformation": {
"type": "object",
"properties": {
@@ -5247,6 +5447,41 @@
"description": "Indicates whether you can make additional captures against the authorized payment.\nSet to true if you do not intend to capture additional payments against the authorization.\nSet to false if you intend to capture additional payments\nPossible Values:\n- `true`\n- `false`\n"
}
}
+ },
+ "authorizationOptions": {
+ "type": "object",
+ "properties": {
+ "serviceType": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Field is used for back-to-back funding transaction and can be defined as a payment flow that automatically transfers funds through a real-time \nfunding or a live-load. This type of transaction can also be connected to a purchase. \nIn back-to-back funding of general purpose card that is used to make a purchase, two separate accounts are involved: \n- account one is used to make the purchase\n- account two is used to automatically fund or reimburse account one\n\nPossible values:\n- 0B = back to back funding transaction\n- 00 = normal transaction\n- 01 = originator hold\n- 02 = Visa deferred OCT hold, default interval\n- 03 = Visa deferred OCT hold, user-defined interval\n- 09 = Cancel pending deferred OCT request\n- 0I = Visa Direct custom program 1\n- 0Q = uery the status of the deferred OCT\n- A0 = Alias Directory 2\n"
+ }
+ }
+ },
+ "purchaseOptions": {
+ "type": "object",
+ "properties": {
+ "eligibilityIndicator": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains installment data defined by MasterCard.\nPossible values:\n - Y = eligible\n - N = not eligile\n"
+ },
+ "type": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "Data mapped received in response from MasterCard.\nPossible values:\n- 01 = Meal Voucher - Employee Nutrition Program\n- 02 = Food Voucher - Employee Nutrition Program\n- 03 = Culture Voucher - Worker's Culture Program\n- 04 = Meal Voucher - Consolidation of Labor Laws\n- 05 = Food Voucher - Consolidation of Labor Laws\n"
+ },
+ "benefitAmount": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "Workplace benefit amount."
+ },
+ "benefitType": {
+ "type": "string",
+ "maxLength": 100,
+ "description": "Workplace benefit type.\nPossible values:\n- 70 = employee benefit\n- 4T = transportation / transit\n- 52 = general benefit\n- 53 = meal voucher\n- 54 = fuel\n- 55 = ecological / sustainability\n- 58 = philanthropy / patronage / consumption\n- 59 = gift\n- 5S = sport / culture\n- 5T = book / education\n"
+ }
+ }
}
}
},
@@ -5648,6 +5883,11 @@
"type": "string",
"maxLength": 255,
"description": "The order status. \nPossible values:\n- `CREATED`\n- `VOIDED`\n- `COMPLETED`\n- `PAYER_ACTION_REQUIRED`\n"
+ },
+ "merchantRiskPrediction": {
+ "type": "string",
+ "maxLength": 150,
+ "description": "Mastercard is introducing the Merchant Risk Predict Service in the middle East/Africa Region.\nA newly launched service comprised of seven independent artificial intelligence (AI)-powered scores intended to augment existing merchant risk management practices.\n"
}
}
},
@@ -5915,6 +6155,11 @@
"type": "string",
"maxLength": 1,
"description": "Indicates whether the card is regulated according to the Durbin Amendment. If the card is regulated, the card\nissuer is subject to price caps and interchange rules. This field is supported for Visa, Mastercard, Discover,\nDiners Club, and JCB on Chase Paymentech Solutions. Possible values:\n\n - `Y`: Yes\n - `N`: No\n - `X`: Not applicable / Unknown\n"
+ },
+ "accountHolderType": {
+ "type": "string",
+ "maxLength": 25,
+ "description": "This is the account owner information, valid values are:\n- `01` : primary account holder\n- `02` : secondary account holder\nThis is returned in the response of an account verification transaction by the Issuer. \n"
}
}
},
@@ -6355,7 +6600,7 @@
},
"amount": {
"type": "string",
- "maxLength": 12,
+ "maxLength": 13,
"description": "Amount for the current installment payment.\n\nThis field is supported only for CyberSource through VisaNet.\n"
},
"amountFunded": {
@@ -6430,7 +6675,7 @@
},
"sequence": {
"type": "integer",
- "maximum": 99,
+ "maximum": 999,
"description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"taxes": {
@@ -6445,12 +6690,12 @@
},
"totalAmount": {
"type": "string",
- "maxLength": 12,
+ "maxLength": 13,
"description": "Total amount of the loan that is being paid in installments. This field is supported only for CyberSource\nthrough VisaNet.\n"
},
"totalCount": {
"type": "integer",
- "maximum": 99,
+ "maximum": 999,
"description": "Total number of installments when making payments in installments.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### American Express Direct, Cielo, and Comercio Latino\nThis value is the total number of installments you approved.\n\n#### CyberSource Latin American Processing in Brazil\nThis value is the total number of installments that you approved. The default is 1.\n\n#### All Other Processors\nThis value is used along with _sequence_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\n#### CyberSource through VisaNet\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 23-25\n- Field: Number of Installments\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 7-8\n- Field: Number of Installments\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR1\n- Position: 7-8\n- Field: Number of Installments\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR5\n- Position: 20-22\n- Field: Installment Total Count\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"minimumTotalCount": {
@@ -7176,6 +7421,11 @@
"maxLength": 36,
"description": "The Directory Server Transaction ID is generated by the Mastercard Directory Server during the authentication transaction and passed back to the merchant with the authentication results.\nFor Cybersource Through Visanet Gateway:\nThe value for this field corresponds to the following data in the TC 33 capture file3: Record: CP01 TCR7, Position: 114-149, Field: MC AVV Verification\u2014Directory Server Transaction ID\n"
},
+ "dataQualityIndicator": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "The field is used to indicate that a transaction does not meet the Visa Secure authentication data quality requirements."
+ },
"authenticationResult": {
"type": "string",
"description": "Raw authentication data that comes from the cardissuing bank. Primary authentication field that\nindicates if authentication was successful and if liability shift occurred. You should examine first the\nresult of this field. This field contains one of these values:\n- `-1`: Invalid PARes.\n- `0`: Successful validation.\n- `1`: Cardholder is not participating, but the attempt to authenticate was recorded.\n- `6`: Issuer unable to perform authentication.\n- `9`: Cardholder did not complete authentication.\n"
@@ -7319,6 +7569,40 @@
"description": "The message describing the reason of the status. Value can be\n - The customer matched the Denied Parties List\n - The Export bill_country/ship_country match\n - Export email_country match\n - Export hostname_country/ip_country match\n"
}
}
+ },
+ "TOKEN_CREATE": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "The status of the token create.\n\nPossible value is:\n - SUCCESS\n - SERVER_ERROR\n - INVALID_REQUEST\n"
+ },
+ "reason": {
+ "type": "string",
+ "description": "The reason of the status.\n\nPossible values:\n - INVALID_DATA\n - SYSTEM_ERROR\n - MISSING_FIELD\n"
+ },
+ "message": {
+ "type": "string",
+ "description": "The detail message related to the status and reason listed above."
+ }
+ }
+ },
+ "TOKEN_UPDATE": {
+ "type": "object",
+ "properties": {
+ "status": {
+ "type": "string",
+ "description": "The status of the token update.\n\nPossible value is:\n - SUCCESS\n - SERVER_ERROR\n - INVALID_REQUEST\n"
+ },
+ "reason": {
+ "type": "string",
+ "description": "The reason of the status.\nPossible values:\n - INVALID_DATA\n - SYSTEM_ERROR\n - MISSING_FIELD\n"
+ },
+ "message": {
+ "type": "string",
+ "description": "The detail message related to the status and reason listed above."
+ }
+ }
}
}
},
@@ -7433,7 +7717,27 @@
"code": "X",
"codeRaw": "I1"
},
- "responseCode": "100"
+ "responseCode": "100",
+ "merchantRiskPrediction": "ATT"
+ },
+ "consumerAuthenticationInformation": {
+ "dataQualityIndicator": "1"
+ },
+ "paymentInformation": {
+ "accountFeatures": {
+ "accountHolderType": "01"
+ }
+ },
+ "processingInformation": {
+ "authorizationOptions": {
+ "serviceType": "02"
+ },
+ "purchaseOptions": {
+ "eligibilityIndicator": "Y",
+ "type": "01",
+ "benefitAmount": "10.00",
+ "benefitType": "4T"
+ }
}
}
}
@@ -8240,7 +8544,8 @@
},
"consumerAuthenticationInformation": {
"referenceId": "CybsCruiseTester-8ac0b02f",
- "requestorId": "123123197675"
+ "requestorId": "123123197675",
+ "authenticationBrand": "VISA"
},
"orderInformation": {
"billTo": {
@@ -8283,7 +8588,8 @@
]
},
"consumerAuthenticationInformation": {
- "authenticationTransactionId": "OiCtXA1j1AxtSNDh5lt1"
+ "authenticationTransactionId": "OiCtXA1j1AxtSNDh5lt1",
+ "authenticationBrand": "VISA"
},
"orderInformation": {
"billTo": {
@@ -8441,7 +8747,8 @@
"code": "TC_123122"
},
"processingInformation": {
- "commerceIndicator": "vbv"
+ "commerceIndicator": "vbv",
+ "originalPaymentId": "1111"
},
"orderInformation": {
"billTo": {
@@ -8470,7 +8777,8 @@
},
"consumerAuthenticationInformation": {
"cavv": "AAABCSIIAAAAAAACcwgAEMCoNh+=",
- "xid": "T1Y0OVcxMVJJdkI0WFlBcXptUzE="
+ "xid": "T1Y0OVcxMVJJdkI0WFlBcXptUzE=",
+ "authenticationBrand": "VISA"
}
}
},
@@ -8482,7 +8790,13 @@
"code": "TC_1231223"
},
"processingInformation": {
- "paymentSolution": "012"
+ "paymentSolution": "012",
+ "purposeOfPayment": "16",
+ "languageCode": "US",
+ "authorizationOptions": {
+ "serviceType": "00"
+ },
+ "originalPaymentId": "1111"
},
"orderInformation": {
"billTo": {
@@ -8520,7 +8834,13 @@
"code": "TC_1231223"
},
"processingInformation": {
- "paymentSolution": "001"
+ "paymentSolution": "001",
+ "purposeOfPayment": "16",
+ "languageCode": "US",
+ "authorizationOptions": {
+ "serviceType": "01"
+ },
+ "originalPaymentId": "1111"
},
"orderInformation": {
"billTo": {
@@ -8764,7 +9084,8 @@
"lastName": "Root",
"address1": "34 Orchard Grove",
"locality": "Southampton",
- "countryCode": "GB"
+ "countryCode": "GB",
+ "aliasName": "Joe My Friend"
},
"recipientInformation": {
"firstName": "Ben",
@@ -8773,7 +9094,12 @@
"accountId": "4929421234600821",
"accountType": "03",
"address1": "1 High Street",
- "country": "GB"
+ "country": "GB",
+ "aliasName": "Ben My Friend",
+ "nationality": "GB",
+ "countryOfBirth": "GB",
+ "occupation": "freelancer",
+ "email": "joe@visa.com"
}
}
},
@@ -8965,8 +9291,11 @@
"authorizationOptions": {
"partialAuthIndicator": true,
"ignoreAvsResult": true,
- "ignoreCvResult": true
- }
+ "ignoreCvResult": true,
+ "serviceType": "02"
+ },
+ "purposeOfPayment": "16",
+ "languageCode": "US"
},
"pointOfSaleInformation": {
"cardPresent": "Y",
@@ -9006,8 +9335,11 @@
"authorizationOptions": {
"partialAuthIndicator": true,
"ignoreAvsResult": true,
- "ignoreCvResult": true
- }
+ "ignoreCvResult": true,
+ "serviceType": "03"
+ },
+ "purposeOfPayment": "16",
+ "languageCode": "US"
},
"pointOfSaleInformation": {
"cardPresent": "Y",
@@ -9606,7 +9938,8 @@
"consumerAuthenticationInformation": {
"challengeCode": 4,
"requestorId": 123123197675,
- "referenceId": "CybsCruiseTester-8ac0b02f"
+ "referenceId": "CybsCruiseTester-8ac0b02f",
+ "authenticationBrand": "VISA"
},
"orderInformation": {
"billTo": {
@@ -9916,7 +10249,10 @@
"commerceIndicator": "retail",
"networkRoutingOrder": "K",
"purchaseOptions": {
- "isElectronicBenefitsTransfer": true
+ "isElectronicBenefitsTransfer": true,
+ "eligibilityIndicator": "Y",
+ "benefitAmount": "10.00",
+ "benefitType": "52"
},
"electronicBenefitsTransfer": {
"category": "FOOD"
@@ -9962,7 +10298,10 @@
"commerceIndicator": "retail",
"networkRoutingOrder": "K",
"purchaseOptions": {
- "isElectronicBenefitsTransfer": true
+ "isElectronicBenefitsTransfer": true,
+ "eligibilityIndicator": "N",
+ "benefitAmount": "10.00",
+ "benefitType": "70"
},
"electronicBenefitsTransfer": {
"category": "FOOD"
@@ -10005,7 +10344,10 @@
"commerceIndicator": "retail",
"networkRoutingOrder": "K",
"purchaseOptions": {
- "isElectronicBenefitsTransfer": true
+ "isElectronicBenefitsTransfer": true,
+ "eligibilityIndicator": "Y",
+ "benefitAmount": "10.00",
+ "benefitType": "53"
},
"electronicBenefitsTransfer": {
"voucherSerialNumber": "123451234512345",
@@ -10057,7 +10399,10 @@
"commerceIndicator": "retail",
"networkRoutingOrder": "K",
"purchaseOptions": {
- "isElectronicBenefitsTransfer": true
+ "isElectronicBenefitsTransfer": true,
+ "eligibilityIndicator": "Y",
+ "benefitAmount": "10.00",
+ "benefitType": "59"
},
"electronicBenefitsTransfer": {
"category": "CASH"
@@ -10096,7 +10441,8 @@
},
"consumerAuthenticationInformation": {
"authenticationTransactionContextId": "100000000000000000000000025253",
- "transactionToken": "AxjzbwSTcz9aHyOIL490/949UafAxfvksgAxHXa2/+xcVZ0CtA+AbkvF"
+ "transactionToken": "AxjzbwSTcz9aHyOIL490/949UafAxfvksgAxHXa2/+xcVZ0CtA+AbkvF",
+ "authenticationBrand": "MASTERCARD"
},
"processingInformation": {
"commerceIndicator": "rpy",
@@ -10158,7 +10504,8 @@
},
"consumerAuthenticationInformation": {
"cavv": "MTAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDI1MjM2",
- "xid": "OTE0OTE2MzI5MzE1MDUyOTU4Mjc="
+ "xid": "OTE0OTE2MzI5MzE1MDUyOTU4Mjc=",
+ "authenticationBrand": "MASTERCARD"
},
"processingInformation": {
"commerceIndicator": "rpy",
@@ -10170,7 +10517,12 @@
"subMerchant": {
"name": "rupay"
},
- "name": "aggregatorname"
+ "name": "aggregatorname",
+ "streetAddress": "202 S. Division St.",
+ "city": "Phoenix",
+ "state": "Arizona",
+ "postalCode": "560048",
+ "country": "USA"
},
"orderInformation": {
"billTo": {
@@ -10293,7 +10645,8 @@
}
},
"consumerAuthenticationInformation": {
- "cavv": "EHuWW9PiBkWvqE5juRwDzAUFBAk="
+ "cavv": "EHuWW9PiBkWvqE5juRwDzAUFBAk=",
+ "authenticationBrand": "MASTERCARD"
}
},
"parentTag": "MIT Framework"
@@ -10388,7 +10741,8 @@
}
},
"consumerAuthenticationInformation": {
- "cavv": "EHuWW9PiBkWvqE5juRwDzAUFBAk="
+ "cavv": "EHuWW9PiBkWvqE5juRwDzAUFBAk=",
+ "authenticationBrand": "MASTERCARD"
}
},
"parentTag": "MIT Framework"
@@ -10480,7 +10834,8 @@
}
},
"consumerAuthenticationInformation": {
- "cavv": "EHuWW9PiBkWvqE5juRwDzAUFBAk="
+ "cavv": "EHuWW9PiBkWvqE5juRwDzAUFBAk=",
+ "authenticationBrand": "MASTERCARD"
}
},
"parentTag": "MIT Framework"
@@ -10627,7 +10982,8 @@
},
"consumerAuthenticationInformation": {
"cavv": "EHuWW9PiBkWvqE5juRwDzAUFBAk=",
- "paresStatus": "Y"
+ "paresStatus": "Y",
+ "authenticationBrand": "VISA"
}
},
"parentTag": "MIT Framework"
@@ -10931,6 +11287,11 @@
}
}
},
+ "merchantRiskPrediction": {
+ "type": "string",
+ "maxLength": 150,
+ "description": "Mastercard is introducing the Merchant Risk Predict Service in the middle East/Africa Region.\nA newly launched service comprised of seven independent artificial intelligence (AI)-powered scores intended to augment existing merchant risk management practices.\n"
+ },
"sellerProtection": {
"type": "object",
"properties": {
@@ -11338,6 +11699,11 @@
"items": {
"type": "string"
}
+ },
+ "transactionTypeIndicator": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field is used identify the type of payment transaction taking place. This field is applicable for MasterCard transactions only.\nPossible values:\n- 201- Mastercard Rebate\n- 202- rePower Load Value\n- 203- Gaming Re-pay\n- 204- General Person-to-Person\n- 205- General Transfer to Own Account\n- 206- Agent Cash Out\n- 207- Payment of Own Credit Card Bill\n- 208- Business Disbursement\n- 209- Government/Non-Profit Disbursement\n- 210- Rapid Merchant Settlement\n- 211- Cash in at ATM (Usage limited to specific countries)\n- 212- Cash in at Point of Sale (Usage limited to specific countries)\n- 213- General Business to Business Transfer\n- 214- Mastercard Merchant Presented QR\n- 215- Mastercard Merchant Presented QR Refund Payment\n- 216- Utility Payments (for Brazil domestic use only)\n- 217- Government Services (for Brazil domestic use only)\n- 218- Mobile phone top-ups (for Brazil domestic use only)\n- 219- Coupon booklet payments (for Brazil domestic use only)\n- 220- General Person-to-Person Transfer\n- 221- Person-to-Person Transfer to Card Account\n- 222- General Transfer to Own Account\n- 223- Agent Cash Out\n- 224- Payment of Own Credit Card Bill\n- 225- Business Disbursement\n- 226- Transfer to Own Staged Digital Wallet Account\n- 227- Transfer to Own Debit or Prepaid Account\n- 228- General Business-to-Business Transfer\n- 229- Installment-based repayment\n- 230- Mastercard ATM Cash Pick-Up Transaction\n- 231- Cryptocurrency\n- 232- High-risk Securities\n"
}
}
},
@@ -11531,6 +11897,10 @@
"maxLength": 10,
"description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\n**Important** Do not use this field to evaluate the result of the authorization.\n\n#### PIN debit\nResponse value that is returned by the processor or bank.\n**Important** Do not use this field to evaluate the results of the transaction request.\n\nReturned by PIN debit credit, PIN debit purchase, and PIN debit reversal.\n\n#### AIBMS\nIf this value is `08`, you can accept the transaction if the customer provides you with identification.\n\n#### Atos\nThis value is the response code sent from Atos and it might also include the response code from the bank.\nFormat: `aa,bb` with the two values separated by a comma and where:\n- `aa` is the two-digit error message from Atos.\n- `bb` is the optional two-digit error message from the bank.\n\n#### Comercio Latino\nThis value is the status code and the error or response code received from the processor separated by a colon.\nFormat: [status code]:E[error code] or [status code]:R[response code]\nExample `2:R06`\n\n#### JCN Gateway\nProcessor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field.\nString (3)\n\n#### paypalgateway\nProcessor generated ID for the itemized detail.\n"
},
+ "networkTransactionId": {
+ "type": "string",
+ "description": "Same value as `processorInformation.transactionId`"
+ },
"responseCategoryCode": {
"type": "string",
"maxLength": 36,
@@ -11924,6 +12294,11 @@
"items": {
"type": "string"
}
+ },
+ "transactionTypeIndicator": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field is used identify the type of payment transaction taking place. This field is applicable for MasterCard transactions only.\nPossible values:\n- 201- Mastercard Rebate\n- 202- rePower Load Value\n- 203- Gaming Re-pay\n- 204- General Person-to-Person\n- 205- General Transfer to Own Account\n- 206- Agent Cash Out\n- 207- Payment of Own Credit Card Bill\n- 208- Business Disbursement\n- 209- Government/Non-Profit Disbursement\n- 210- Rapid Merchant Settlement\n- 211- Cash in at ATM (Usage limited to specific countries)\n- 212- Cash in at Point of Sale (Usage limited to specific countries)\n- 213- General Business to Business Transfer\n- 214- Mastercard Merchant Presented QR\n- 215- Mastercard Merchant Presented QR Refund Payment\n- 216- Utility Payments (for Brazil domestic use only)\n- 217- Government Services (for Brazil domestic use only)\n- 218- Mobile phone top-ups (for Brazil domestic use only)\n- 219- Coupon booklet payments (for Brazil domestic use only)\n- 220- General Person-to-Person Transfer\n- 221- Person-to-Person Transfer to Card Account\n- 222- General Transfer to Own Account\n- 223- Agent Cash Out\n- 224- Payment of Own Credit Card Bill\n- 225- Business Disbursement\n- 226- Transfer to Own Staged Digital Wallet Account\n- 227- Transfer to Own Debit or Prepaid Account\n- 228- General Business-to-Business Transfer\n- 229- Installment-based repayment\n- 230- Mastercard ATM Cash Pick-Up Transaction\n- 231- Cryptocurrency\n- 232- High-risk Securities\n"
}
}
},
@@ -12103,6 +12478,10 @@
"maxLength": 10,
"description": "For most processors, this is the error message sent directly from the bank. Returned only when the processor\nreturns this value.\n\n**Important** Do not use this field to evaluate the result of the authorization.\n\n#### PIN debit\nResponse value that is returned by the processor or bank.\n**Important** Do not use this field to evaluate the results of the transaction request.\n\nReturned by PIN debit credit, PIN debit purchase, and PIN debit reversal.\n\n#### AIBMS\nIf this value is `08`, you can accept the transaction if the customer provides you with identification.\n\n#### Atos\nThis value is the response code sent from Atos and it might also include the response code from the bank.\nFormat: `aa,bb` with the two values separated by a comma and where:\n- `aa` is the two-digit error message from Atos.\n- `bb` is the optional two-digit error message from the bank.\n\n#### Comercio Latino\nThis value is the status code and the error or response code received from the processor separated by a colon.\nFormat: [status code]:E[error code] or [status code]:R[response code]\nExample `2:R06`\n\n#### JCN Gateway\nProcessor-defined detail error code. The associated response category code is in the `processorInformation.responseCategoryCode` field.\nString (3)\n\n#### paypalgateway\nProcessor generated ID for the itemized detail.\n"
},
+ "networkTransactionId": {
+ "type": "string",
+ "description": "Same value as `processorInformation.transactionId`"
+ },
"responseCategoryCode": {
"type": "string",
"maxLength": 36,
@@ -12460,6 +12839,11 @@
"type": "string",
"maxLength": 255,
"description": "An informational note about this settlement. Appears in both the payer's transaction history and the emails that the payer receives.\n"
+ },
+ "reconciliationIdAlternate": {
+ "type": "string",
+ "maxLength": 12,
+ "description": "Used by Nike merchant to send 12 digit order number"
}
}
},
@@ -12745,7 +13129,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 2,
+ "maxLength": 50,
"description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n"
},
"postalCode": {
@@ -12782,7 +13166,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"postalCode": {
@@ -12817,7 +13201,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
@@ -12827,7 +13211,7 @@
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"email": {
@@ -13103,7 +13487,7 @@
"properties": {
"purchaseOrderNumber": {
"type": "string",
- "maxLength": 25,
+ "maxLength": 50,
"description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n"
},
"purchaseOrderDate": {
@@ -13247,7 +13631,7 @@
},
"locality": {
"type": "string",
- "maxLength": 13,
+ "maxLength": 30,
"description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
@@ -13371,7 +13755,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 3,
+ "maxLength": 50,
"description": "Sub-merchant's state or province.\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": {
@@ -13441,7 +13825,7 @@
},
"value": {
"type": "string",
- "maxLength": 255,
+ "maxLength": 800,
"description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
@@ -13478,7 +13862,7 @@
"properties": {
"amount": {
"type": "string",
- "maxLength": 12,
+ "maxLength": 13,
"description": "Amount for the current installment payment.\n\nThis field is supported only for CyberSource through VisaNet.\n"
},
"frequency": {
@@ -13493,17 +13877,17 @@
},
"sequence": {
"type": "integer",
- "maximum": 99,
+ "maximum": 999,
"description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"totalAmount": {
"type": "string",
- "maxLength": 12,
+ "maxLength": 13,
"description": "Total amount of the loan that is being paid in installments. This field is supported only for CyberSource\nthrough VisaNet.\n"
},
"totalCount": {
"type": "integer",
- "maximum": 99,
+ "maximum": 999,
"description": "Total number of installments when making payments in installments.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### American Express Direct, Cielo, and Comercio Latino\nThis value is the total number of installments you approved.\n\n#### CyberSource Latin American Processing in Brazil\nThis value is the total number of installments that you approved. The default is 1.\n\n#### All Other Processors\nThis value is used along with _sequence_ to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as _sequence_ = 2 and _totalCount_ = 5.\n\n#### CyberSource through VisaNet\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 23-25\n- Field: Number of Installments\n\nFor installment payments with American Express in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR3\n- Position: 7-8\n- Field: Number of Installments\n\nFor installment payments with Visa in Brazil, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP07 TCR1\n- Position: 7-8\n- Field: Number of Installments\n\nFor all other kinds of installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR5\n- Position: 20-22\n- Field: Installment Total Count\n\n**Note** The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
},
"firstInstallmentDate": {
@@ -13524,7 +13908,7 @@
"paymentType": {
"type": "string",
"maxLength": 1,
- "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n"
+ "description": "Payment plan for the installments.\nThis field is supported only for installment payments on Visa Platform Connect, RuPay and SPG-KSA seamless flow.\n\nPossible values for a standing-instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card:\n- 1: SI with a fixed amount.\n- 2: SI with a maximum amount.\n- 3: Other kind of SI.\n\nPossible values for a type of Installment transaction for on-soil transaction in Kingdom of Saudi Arabia\n- 1: Registration or first transaction.\n- 2: Subsequent transaction.\n\nPossible values for other kinds of installment payments:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n- 6: SI de-registration on RuPay for the payer authentication seamless flow.\n"
},
"additionalCosts": {
"type": "string",
@@ -15332,6 +15716,11 @@
"description": "The reason for the refund."
}
}
+ },
+ "transactionTypeIndicator": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field is used identify the type of payment transaction taking place. This field is applicable for MasterCard transactions only.\nPossible values:\n- 201- Mastercard Rebate\n- 202- rePower Load Value\n- 203- Gaming Re-pay\n- 204- General Person-to-Person\n- 205- General Transfer to Own Account\n- 206- Agent Cash Out\n- 207- Payment of Own Credit Card Bill\n- 208- Business Disbursement\n- 209- Government/Non-Profit Disbursement\n- 210- Rapid Merchant Settlement\n- 211- Cash in at ATM (Usage limited to specific countries)\n- 212- Cash in at Point of Sale (Usage limited to specific countries)\n- 213- General Business to Business Transfer\n- 214- Mastercard Merchant Presented QR\n- 215- Mastercard Merchant Presented QR Refund Payment\n- 216- Utility Payments (for Brazil domestic use only)\n- 217- Government Services (for Brazil domestic use only)\n- 218- Mobile phone top-ups (for Brazil domestic use only)\n- 219- Coupon booklet payments (for Brazil domestic use only)\n- 220- General Person-to-Person Transfer\n- 221- Person-to-Person Transfer to Card Account\n- 222- General Transfer to Own Account\n- 223- Agent Cash Out\n- 224- Payment of Own Credit Card Bill\n- 225- Business Disbursement\n- 226- Transfer to Own Staged Digital Wallet Account\n- 227- Transfer to Own Debit or Prepaid Account\n- 228- General Business-to-Business Transfer\n- 229- Installment-based repayment\n- 230- Mastercard ATM Cash Pick-Up Transaction\n- 231- Cryptocurrency\n- 232- High-risk Securities\n"
}
}
},
@@ -15847,7 +16236,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 2,
+ "maxLength": 50,
"description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n"
},
"postalCode": {
@@ -15884,7 +16273,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"postalCode": {
@@ -15919,7 +16308,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
@@ -15929,7 +16318,7 @@
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"email": {
@@ -16093,7 +16482,7 @@
"properties": {
"purchaseOrderNumber": {
"type": "string",
- "maxLength": 25,
+ "maxLength": 50,
"description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n"
},
"purchaseOrderDate": {
@@ -16237,7 +16626,7 @@
},
"locality": {
"type": "string",
- "maxLength": 13,
+ "maxLength": 30,
"description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
@@ -16341,7 +16730,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 3,
+ "maxLength": 50,
"description": "Sub-merchant's state or province.\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": {
@@ -16390,6 +16779,11 @@
"description": "Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.\n\n\nPossible values:\n- `true`: Fallback method was used.\n- `false` (default): Fallback method was not used.\n\nThis field is supported only on American Express Direct, Chase Paymentech Solutions, CyberSource through VisaNet,\nFDC Nashville Global, GPN, JCN Gateway, OmniPay Direct, and SIX.\n"
}
}
+ },
+ "terminalCategory": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "Indicates the type of terminal. \n\nPossible values:\n- `AFD`: Automated Fuel Dispenser\n"
}
}
},
@@ -16406,7 +16800,7 @@
},
"value": {
"type": "string",
- "maxLength": 255,
+ "maxLength": 800,
"description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
@@ -18000,6 +18394,11 @@
"description": "The reason for the refund."
}
}
+ },
+ "transactionTypeIndicator": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field is used identify the type of payment transaction taking place. This field is applicable for MasterCard transactions only.\nPossible values:\n- 201- Mastercard Rebate\n- 202- rePower Load Value\n- 203- Gaming Re-pay\n- 204- General Person-to-Person\n- 205- General Transfer to Own Account\n- 206- Agent Cash Out\n- 207- Payment of Own Credit Card Bill\n- 208- Business Disbursement\n- 209- Government/Non-Profit Disbursement\n- 210- Rapid Merchant Settlement\n- 211- Cash in at ATM (Usage limited to specific countries)\n- 212- Cash in at Point of Sale (Usage limited to specific countries)\n- 213- General Business to Business Transfer\n- 214- Mastercard Merchant Presented QR\n- 215- Mastercard Merchant Presented QR Refund Payment\n- 216- Utility Payments (for Brazil domestic use only)\n- 217- Government Services (for Brazil domestic use only)\n- 218- Mobile phone top-ups (for Brazil domestic use only)\n- 219- Coupon booklet payments (for Brazil domestic use only)\n- 220- General Person-to-Person Transfer\n- 221- Person-to-Person Transfer to Card Account\n- 222- General Transfer to Own Account\n- 223- Agent Cash Out\n- 224- Payment of Own Credit Card Bill\n- 225- Business Disbursement\n- 226- Transfer to Own Staged Digital Wallet Account\n- 227- Transfer to Own Debit or Prepaid Account\n- 228- General Business-to-Business Transfer\n- 229- Installment-based repayment\n- 230- Mastercard ATM Cash Pick-Up Transaction\n- 231- Cryptocurrency\n- 232- High-risk Securities\n"
}
}
},
@@ -18515,7 +18914,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 2,
+ "maxLength": 50,
"description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n"
},
"postalCode": {
@@ -18552,7 +18951,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"postalCode": {
@@ -18587,7 +18986,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
@@ -18597,7 +18996,7 @@
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"email": {
@@ -18761,7 +19160,7 @@
"properties": {
"purchaseOrderNumber": {
"type": "string",
- "maxLength": 25,
+ "maxLength": 50,
"description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n"
},
"purchaseOrderDate": {
@@ -18905,7 +19304,7 @@
},
"locality": {
"type": "string",
- "maxLength": 13,
+ "maxLength": 30,
"description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
@@ -19009,7 +19408,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 3,
+ "maxLength": 50,
"description": "Sub-merchant's state or province.\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": {
@@ -19058,6 +19457,11 @@
"description": "Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a\ntechnical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:\n\n 1. Swipe the card or key the credit card information into the POS terminal.\n 2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.\n\n\nPossible values:\n- `true`: Fallback method was used.\n- `false` (default): Fallback method was not used.\n\nThis field is supported only on American Express Direct, Chase Paymentech Solutions, CyberSource through VisaNet,\nFDC Nashville Global, GPN, JCN Gateway, OmniPay Direct, and SIX.\n"
}
}
+ },
+ "terminalCategory": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "Indicates the type of terminal. \n\nPossible values:\n- `AFD`: Automated Fuel Dispenser\n"
}
}
},
@@ -19074,7 +19478,7 @@
},
"value": {
"type": "string",
- "maxLength": 255,
+ "maxLength": 800,
"description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
@@ -21260,7 +21664,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 2,
+ "maxLength": 50,
"description": "State or province in the address of the company purchasing the product. Use the State, Province, and Territory\nCodes for the United States and Canada.\n"
},
"postalCode": {
@@ -21297,7 +21701,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"postalCode": {
@@ -21332,7 +21736,7 @@
"properties": {
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
@@ -21342,7 +21746,7 @@
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"email": {
@@ -21506,7 +21910,7 @@
"properties": {
"purchaseOrderNumber": {
"type": "string",
- "maxLength": 25,
+ "maxLength": 50,
"description": "Value used by your customer to identify the order. This value is typically a purchase order number. CyberSource\nrecommends that you do not populate the field with all zeros or nines.\n"
},
"purchaseOrderDate": {
@@ -21650,7 +22054,7 @@
},
"locality": {
"type": "string",
- "maxLength": 13,
+ "maxLength": 30,
"description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
@@ -21754,7 +22158,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 3,
+ "maxLength": 50,
"description": "Sub-merchant's state or province.\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": {
@@ -21801,7 +22205,7 @@
},
"cardholderVerificationMethodUsed": {
"type": "integer",
- "description": "Method that was used to verify the cardholder's identity. Possible values:\n\n - `0`: No verification\n - `1`: Signature\n - `2`: PIN\n - `3`: Cardholder device CVM\n"
+ "description": "Method that was used to verify the cardholder's identity. Possible values:\n\n - `0`: No verification\n - `1`: Signature\n - `2`: PIN\n - `3`: Cardholder device CVM\n - `4`: Biometric\n - `5`: OTP\n"
},
"laneNumber": {
"type": "string",
@@ -21888,6 +22292,11 @@
},
"description": "Complete list of cardholder verification methods (CVMs) supported by the terminal.\nOptional field.\nPossible values:\n- `PIN`: For terminals with a PIN Pad\n- `Signature`: For terminals capable of receiving a signature\n- `pinOnGlass`: For terminals where PIN is entered on a glass-based capture mechanism\n\n**EXAMPLE**: [\"PIN\",\"Signature\"]; [\"pinOnGlass\",\"Signature\"]\n"
},
+ "terminalCategory": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "Indicates the type of terminal. \n\nPossible values:\n- `AFD`: Automated Fuel Dispenser\n"
+ },
"terminalInputCapability": {
"type": "array",
"items": {
@@ -21983,7 +22392,7 @@
},
"value": {
"type": "string",
- "maxLength": 255,
+ "maxLength": 800,
"description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
@@ -25831,7 +26240,7 @@
"type": "object",
"properties": {
"paymentId": {
- "type": "object",
+ "type": "string",
"maxLength": 28,
"description": "This field is to accept the id of credit/capture in the body of the requests so the type of void can be identified and processed correctly."
}
@@ -27171,7 +27580,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"postalCode": {
@@ -27225,12 +27634,12 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
@@ -27469,7 +27878,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 3,
+ "maxLength": 50,
"description": "Sub-merchant's state or province.\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": {
@@ -27581,7 +27990,7 @@
"paymentType": {
"type": "string",
"maxLength": 1,
- "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n"
+ "description": "Payment plan for the installments.\nThis field is supported only for installment payments on Visa Platform Connect, RuPay and SPG-KSA seamless flow.\n\nPossible values for a standing-instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card:\n- 1: SI with a fixed amount.\n- 2: SI with a maximum amount.\n- 3: Other kind of SI.\n\nPossible values for a type of Installment transaction for on-soil transaction in Kingdom of Saudi Arabia\n- 1: Registration or first transaction.\n- 2: Subsequent transaction.\n\nPossible values for other kinds of installment payments:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n- 6: SI de-registration on RuPay for the payer authentication seamless flow.\n"
},
"preferredDay": {
"type": "string",
@@ -27590,7 +27999,7 @@
},
"sequence": {
"type": "integer",
- "maximum": 99,
+ "maximum": 999,
"description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
}
}
@@ -27613,7 +28022,7 @@
},
"locality": {
"type": "string",
- "maxLength": 13,
+ "maxLength": 30,
"description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"name": {
@@ -28631,7 +29040,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 3,
+ "maxLength": 50,
"description": "Sub-merchant's state or province.\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": {
@@ -28743,7 +29152,7 @@
"paymentType": {
"type": "string",
"maxLength": 1,
- "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n"
+ "description": "Payment plan for the installments.\nThis field is supported only for installment payments on Visa Platform Connect, RuPay and SPG-KSA seamless flow.\n\nPossible values for a standing-instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card:\n- 1: SI with a fixed amount.\n- 2: SI with a maximum amount.\n- 3: Other kind of SI.\n\nPossible values for a type of Installment transaction for on-soil transaction in Kingdom of Saudi Arabia\n- 1: Registration or first transaction.\n- 2: Subsequent transaction.\n\nPossible values for other kinds of installment payments:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n- 6: SI de-registration on RuPay for the payer authentication seamless flow.\n"
},
"preferredDay": {
"type": "string",
@@ -28752,7 +29161,7 @@
},
"sequence": {
"type": "integer",
- "maximum": 99,
+ "maximum": 999,
"description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
}
}
@@ -28775,7 +29184,7 @@
},
"locality": {
"type": "string",
- "maxLength": 13,
+ "maxLength": 30,
"description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"name": {
@@ -29956,7 +30365,7 @@
"paymentType": {
"type": "string",
"maxLength": 1,
- "description": "Payment plan for the installments.\n\nPossible values:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n\nThis field is supported only for installment payments with Visa on CyberSource through VisaNet in Brazil.\n\nThe value for this field corresponds to the following data in the TC 33 capture file5:\n- Record: CP07 TCR1\n- Position: 9\n- Field: Merchant Installment Supporting Information\n"
+ "description": "Payment plan for the installments.\nThis field is supported only for installment payments on Visa Platform Connect, RuPay and SPG-KSA seamless flow.\n\nPossible values for a standing-instruction (SI) merchant-initiated transaction (MIT) with Diners Club or Mastercard in India or with an India-issued card:\n- 1: SI with a fixed amount.\n- 2: SI with a maximum amount.\n- 3: Other kind of SI.\n\nPossible values for a type of Installment transaction for on-soil transaction in Kingdom of Saudi Arabia\n- 1: Registration or first transaction.\n- 2: Subsequent transaction.\n\nPossible values for other kinds of installment payments:\n- 0 (default): Regular installment. This value is not allowed for airline transactions.\n- 1: Installment payment with down payment.\n- 2: Installment payment without down payment. This value is supported only for airline transactions.\n- 3: Installment payment; down payment and boarding fee will follow. This value is supported only for airline transactions.\n- 4: Down payment only; regular installment payment will follow.\n- 5: Boarding fee only. This value is supported only for airline transactions.\n- 6: SI de-registration on RuPay for the payer authentication seamless flow.\n"
},
"preferredDay": {
"type": "string",
@@ -29965,7 +30374,7 @@
},
"sequence": {
"type": "integer",
- "maximum": 99,
+ "maximum": 999,
"description": "Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.\n\nFor example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.\n\n#### Chase Paymentech Solutions and FDC Compass\nThis field is optional because this value is required in the merchant descriptors.\n\n#### CyberSource through VisaNet\nWhen you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.\n\nFor Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*:\n- Record: CP01 TCR9\n- Position: 38-40\n- Field: Installment Payment Number\n\n* The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies.\n"
}
}
@@ -29988,7 +30397,7 @@
},
"locality": {
"type": "string",
- "maxLength": 13,
+ "maxLength": 30,
"description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"name": {
@@ -30838,7 +31247,7 @@
"properties": {
"shippingMethod": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"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"
}
}
@@ -31273,12 +31682,12 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
@@ -31466,7 +31875,7 @@
"properties": {
"shippingMethod": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"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"
}
}
@@ -31563,7 +31972,7 @@
},
"locality": {
"type": "string",
- "maxLength": 13,
+ "maxLength": 30,
"description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
@@ -31712,7 +32121,7 @@
},
"value": {
"type": "string",
- "maxLength": 255,
+ "maxLength": 800,
"description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
@@ -32419,12 +32828,12 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
@@ -32612,7 +33021,7 @@
"properties": {
"shippingMethod": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"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"
}
}
@@ -32709,7 +33118,7 @@
},
"locality": {
"type": "string",
- "maxLength": 13,
+ "maxLength": 30,
"description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
@@ -32858,7 +33267,7 @@
},
"value": {
"type": "string",
- "maxLength": 255,
+ "maxLength": 800,
"description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
@@ -33534,12 +33943,12 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
@@ -33990,12 +34399,12 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
@@ -34603,7 +35012,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -34706,7 +35115,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -34714,7 +35123,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -34867,42 +35276,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -34913,79 +35344,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -34994,52 +35470,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -35048,26 +35498,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -35076,65 +35526,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -35231,6 +35670,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -35683,7 +36277,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -35786,7 +36380,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -35794,7 +36388,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -35947,42 +36541,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -35993,79 +36609,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -36074,52 +36735,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -36128,26 +36763,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -36156,65 +36791,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -36311,6 +36935,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -37081,7 +37860,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -37184,7 +37963,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -37192,7 +37971,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -37345,42 +38124,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -37391,79 +38192,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -37472,52 +38318,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -37526,26 +38346,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -37554,65 +38374,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -37709,6 +38518,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -38476,7 +39440,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -38579,7 +39543,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -38587,7 +39551,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -38740,42 +39704,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -38786,79 +39772,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -38867,52 +39898,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -38921,26 +39926,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -38949,65 +39954,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -39104,6 +40098,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -39565,7 +40714,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -39668,7 +40817,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -39676,7 +40825,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -39829,42 +40978,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -39875,79 +41046,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -39956,52 +41172,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -40010,26 +41200,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -40038,65 +41228,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -40193,6 +41372,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -44184,7 +45518,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -44287,7 +45621,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -44295,7 +45629,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -44448,42 +45782,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -44494,79 +45850,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -44575,52 +45976,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -44629,26 +46004,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -44657,65 +46032,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -44812,6 +46176,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -45012,7 +46531,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -45115,7 +46634,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -45123,7 +46642,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -45276,42 +46795,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -45322,79 +46863,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -45403,52 +46989,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -45457,26 +47017,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -45485,65 +47045,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -45640,6 +47189,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -46373,7 +48077,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -46476,7 +48180,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -46484,7 +48188,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -46637,42 +48341,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -46683,79 +48409,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -46764,52 +48535,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -46818,26 +48563,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -46846,65 +48591,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -47001,6 +48735,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -47549,7 +49438,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -47652,7 +49541,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -47660,7 +49549,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -47813,42 +49702,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -47859,79 +49770,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -47940,52 +49896,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -47994,26 +49924,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -48022,65 +49952,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -48177,6 +50096,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -48688,7 +50762,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -48791,7 +50865,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -48799,7 +50873,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -48952,42 +51026,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -48998,79 +51094,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -49079,52 +51220,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -49133,26 +51248,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -49161,65 +51276,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -49316,6 +51420,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -49512,7 +51771,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -49615,7 +51874,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -49623,7 +51882,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -49776,42 +52035,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -49822,79 +52103,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -49903,52 +52229,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -49957,26 +52257,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -49985,65 +52285,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -50140,6 +52429,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -51041,6 +53485,13 @@
"maxLength": 36,
"x-hide-field": true
},
+ {
+ "name": "retrieveBinDetails",
+ "in": "query",
+ "description": "Retrieve the Bin Details of PAN or network token",
+ "required": false,
+ "type": "boolean"
+ },
{
"name": "postPaymentInstrumentRequest",
"in": "body",
@@ -51187,7 +53638,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -51290,7 +53741,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -51298,7 +53749,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -51451,42 +53902,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -51497,79 +53970,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -51578,52 +54096,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -51632,26 +54124,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -51660,65 +54152,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -51815,6 +54296,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -51997,7 +54633,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -52100,7 +54736,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -52108,7 +54744,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -52261,42 +54897,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -52307,79 +54965,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -52388,52 +55091,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -52442,26 +55119,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -52470,65 +55147,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -52625,6 +55291,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -53014,6 +55835,13 @@
"maxLength": 36,
"x-hide-field": true
},
+ {
+ "name": "retrieveBinDetails",
+ "in": "query",
+ "description": "Retrieve the Bin Details of PAN or network token",
+ "required": false,
+ "type": "boolean"
+ },
{
"name": "paymentInstrumentId",
"in": "path",
@@ -53208,7 +56036,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -53311,7 +56139,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -53319,7 +56147,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -53472,42 +56300,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -53518,79 +56368,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -53599,52 +56494,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -53653,26 +56522,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -53681,65 +56550,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -53836,6 +56694,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -54174,6 +57187,13 @@
"maxLength": 36,
"x-hide-field": true
},
+ {
+ "name": "retrieveBinDetails",
+ "in": "query",
+ "description": "Retrieve the Bin Details of PAN or network token",
+ "required": false,
+ "type": "boolean"
+ },
{
"name": "paymentInstrumentId",
"in": "path",
@@ -54338,7 +57358,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -54441,7 +57461,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -54449,7 +57469,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -54602,42 +57622,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -54648,79 +57690,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -54729,52 +57816,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -54783,26 +57844,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -54811,65 +57872,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -54966,6 +58016,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -55162,7 +58367,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -55265,7 +58470,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -55273,7 +58478,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -55426,42 +58631,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -55472,79 +58699,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -55553,52 +58825,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -55607,26 +58853,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -55635,65 +58881,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -55790,6 +59025,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -56558,6 +59948,13 @@
"maxLength": 36,
"x-hide-field": true
},
+ {
+ "name": "retrieveBinDetails",
+ "in": "query",
+ "description": "Retrieve the Bin Details of PAN or network token",
+ "required": false,
+ "type": "boolean"
+ },
{
"name": "postInstrumentIdentifierRequest",
"in": "body",
@@ -56666,42 +60063,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -56712,79 +60131,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -56793,52 +60257,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -56847,26 +60285,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -56875,65 +60313,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -57030,6 +60457,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -57169,42 +60751,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -57215,79 +60819,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -57296,52 +60945,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -57350,26 +60973,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -57378,65 +61001,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -57533,6 +61145,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -57660,42 +61427,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -57706,79 +61495,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -57787,52 +61621,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -57841,26 +61649,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -57869,65 +61677,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -58024,6 +61821,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -58342,6 +62294,13 @@
"maxLength": 36,
"x-hide-field": true
},
+ {
+ "name": "retrieveBinDetails",
+ "in": "query",
+ "description": "Retrieve the Bin Details of PAN or network token",
+ "required": false,
+ "type": "boolean"
+ },
{
"name": "instrumentIdentifierId",
"in": "path",
@@ -58497,42 +62456,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -58543,79 +62524,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -58624,52 +62650,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -58678,26 +62678,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -58706,65 +62706,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -58861,6 +62850,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -59195,6 +63339,13 @@
"maxLength": 36,
"x-hide-field": true
},
+ {
+ "name": "retrieveBinDetails",
+ "in": "query",
+ "description": "Retrieve the Bin Details of PAN or network token",
+ "required": false,
+ "type": "boolean"
+ },
{
"name": "instrumentIdentifierId",
"in": "path",
@@ -59321,42 +63472,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -59367,79 +63540,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -59448,52 +63666,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -59502,26 +63694,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -59530,65 +63722,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -59685,6 +63866,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -59838,42 +64174,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -59884,79 +64242,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -59965,52 +64368,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -60019,26 +64396,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -60047,65 +64424,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -60202,6 +64568,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -60963,6 +65484,13 @@
"maxLength": 36,
"x-hide-field": true
},
+ {
+ "name": "retrieveBinDetails",
+ "in": "query",
+ "description": "Retrieve the Bin Details of PAN or network token",
+ "required": false,
+ "type": "boolean"
+ },
{
"name": "instrumentIdentifierId",
"in": "path",
@@ -61282,7 +65810,7 @@
"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 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"
+ "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 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# 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/)\n"
},
"dateOfBirth": {
"type": "string",
@@ -61385,7 +65913,7 @@
"properties": {
"billPaymentProgramEnabled": {
"type": "boolean",
- "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n"
+ "description": "Flag that indicates that this is a payment for a bill or for an existing contractual loan.\nPossible Values:\n- `true`: Bill payment or loan payment.\n- `false` (default): Not a bill payment or loan payment.\n# 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/)\n"
},
"bankTransferOptions": {
"type": "object",
@@ -61393,7 +65921,7 @@
"SECCode": {
"type": "string",
"maxLength": 3,
- "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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"
+ "description": "Specifies the authorization method for the transaction.\n\n#### TeleCheck\nPossible 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\n# 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/)\n"
}
}
}
@@ -61546,42 +66074,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -61592,79 +66142,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -61673,52 +66268,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -61727,26 +66296,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -61755,65 +66324,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -61910,6 +66468,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -62372,42 +67085,64 @@
},
"routingNumber": {
"type": "string",
- "description": "Bank routing number. This is also called the transit number.\n"
+ "description": "Bank routing number. This is also called the transit number.\n\n# For details, see `ecp_rdfi` field description in the [Electronic Check Services Using the SCMP API Guide.](https://apps.cybersource.com/library/documentation/dev_guides/EChecks_SCMP_API/html/)\n"
}
}
},
"tokenizedCard": {
"title": "tmsv2TokenizedCard",
"type": "object",
- "readOnly": true,
"properties": {
- "type": {
- "type": "string",
+ "_links": {
+ "type": "object",
"readOnly": true,
- "description": "The network token card association brand\nPossible Values:\n- visa\n- mastercard\n- americanexpress\n",
- "example": "visa"
+ "properties": {
+ "self": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "href": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Link to the Tokenized Card.\nexample: 'tms/v2/tokenized-cards/7010000000016241111'\n"
+ }
+ }
+ }
+ }
},
- "source": {
+ "id": {
"type": "string",
"readOnly": true,
- "description": "This enumeration value indicates the origin of the payment instrument (PAN) and the technique employed to supply the payment instrument data.\nPossible Values:\n- TOKEN\n- ISSUER\n- ONFILE\n",
- "example": "ONFILE"
+ "description": "The Id of the Tokenized Card.\n"
},
- "state": {
+ "object": {
"type": "string",
"readOnly": true,
- "example": "ACTIVE",
- "description": "State of the network token or network token provision\nPossible Values:\n- ACTIVE : Network token is active.\n- SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n- DELETED : This is a final state for a network token instance.\n- UNPROVISIONED : A previous network token provision was unsuccessful.\n"
+ "example": "tokenizedCard",
+ "description": "The type.\nPossible Values:\n- tokenizedCard\n"
},
- "enrollmentId": {
+ "accountReferenceId": {
"type": "string",
- "readOnly": true,
- "description": "Unique Identifier for the enrolled PAN. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "description": "An identifier provided by the issuer for the account.\n"
},
- "tokenReferenceId": {
+ "consumerId": {
+ "type": "string",
+ "maxLength": 36,
+ "description": "Identifier of the consumer within the wallet. Maximum 24 characters for VTS."
+ },
+ "createInstrumentIdentifier": {
+ "type": "boolean",
+ "description": "Specifies whether the InstrumentId should be created (true) or not (false).\nPossible Values:\n- `true`: The InstrumentId should be created.\n- `false`: The InstrumentId should be created.\n"
+ },
+ "source": {
+ "type": "string",
+ "description": "Source of the payment instrument.\nPossible Values:\n- ONFILE\n- TOKEN\n- ISSUER\n"
+ },
+ "state": {
"type": "string",
"readOnly": true,
- "description": "Unique Identifier for the network token. This Id is provided by the card association when a network token is provisioned successfully.\n"
+ "example": "ACTIVE",
+ "description": "State of the network token or network token provision.\nPossible Values:\n ACTIVE : Network token is active.\n SUSPENDED : Network token is suspended. This state can change back to ACTIVE.\n DELETED : This is a final state for a network token instance.\n UNPROVISIONED : A previous network token.\n"
},
"reason": {
"type": "string",
@@ -62418,79 +67153,124 @@
"number": {
"type": "string",
"readOnly": true,
- "description": "The token requestors network token\n"
+ "description": "The token requestor's network token for the provided PAN and consumer Id, if available.\n"
},
- "expirationMonth": {
+ "cryptogram": {
"type": "string",
"readOnly": true,
- "maxLength": 2,
- "description": "Two-digit month in which the network token expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Value generated by the card association to be used alongside the network token for processing a payment.\n",
+ "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
},
- "expirationYear": {
+ "securityCode": {
"type": "string",
"readOnly": true,
- "maxLength": 4,
- "description": "Four-digit year in which the network token expires.\n\nFormat: `YYYY`.\n"
+ "description": "4-digit number generated by the card association to be used alogside the network token for processing a payment. Only supported for Amex and SCOF.\n",
+ "example": "4523"
},
- "cryptogram": {
+ "eci": {
"type": "string",
"readOnly": true,
- "description": "Generated value used in conjunction with the network token for making a payment.\n",
- "example": "CgAFRFYFPTFOfg5rj2ais9wQAAAAAM="
+ "description": "Raw Electronic Commerce Indicator provided by the card association with the result of the cardholder authentication.\n"
+ },
+ "requestorId": {
+ "type": "string",
+ "readOnly": true,
+ "maxLength": 11,
+ "description": "11-digit identifier that uniquely identifies the Token Requestor.\n"
+ },
+ "enrollmentId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique id to identify this PAN/ enrollment.\n"
+ },
+ "tokenReferenceId": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique ID for netwrok token.\n"
+ },
+ "paymentAccountReference": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Payment account reference.\n"
},
"card": {
"type": "object",
- "readOnly": true,
- "description": "The latest card details associated with the network token",
+ "description": "Card object used to create a network token\n",
"properties": {
- "suffix": {
+ "number": {
"type": "string",
- "readOnly": true,
- "description": "The customer's latest payment card number suffix\n",
- "example": "1111"
+ "minLength": 12,
+ "maxLength": 19,
+ "description": "The customer's payment card number, also known as the Primary Account Number (PAN).\n"
},
"expirationMonth": {
"type": "string",
- "readOnly": true,
"maxLength": 2,
- "description": "\nTwo-digit month in which the customer's latest payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
+ "description": "Two-digit month in which the payment card expires.\n\nFormat: `MM`.\n\nPossible Values: `01` through `12`.\n"
},
"expirationYear": {
"type": "string",
- "readOnly": true,
"maxLength": 4,
- "description": "Four-digit year in which the customer's latest payment card expires.\n\nFormat: `YYYY`.\n"
+ "description": "Four-digit year in which the credit card expires.\n\nFormat: `YYYY`.\n"
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of card(Card network).\nPossible Values:\n001: visa\n"
+ },
+ "suffix": {
+ "type": "string",
+ "readOnly": true,
+ "description": "The customer's latest payment card number suffix.\n"
+ }
+ }
+ },
+ "passcode": {
+ "type": "object",
+ "description": "Passcode by issuer for ID&V.\n",
+ "properties": {
+ "value": {
+ "type": "string",
+ "description": "OTP generated at issuer.\n"
}
}
},
"metadata": {
"type": "object",
"readOnly": true,
+ "description": "Metadata associated with the tokenized card.\n",
"properties": {
"cardArt": {
- "readOnly": true,
+ "title": "TmsCardArt",
+ "description": "Card art associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
+ "foregroundColor": {
+ "description": "Card foreground color.\n",
+ "type": "string",
+ "readOnly": true
+ },
"combinedAsset": {
- "readOnly": true,
+ "description": "Combined card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the combined asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the combined asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/card-art-combined'\n"
}
}
}
@@ -62499,52 +67279,26 @@
}
},
"brandLogoAsset": {
- "readOnly": true,
+ "description": "Brand logo card art asset associated with the tokenized card.\n",
"type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the brand logo asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the brand logo asset.\n"
- }
- }
- }
- }
- }
- }
- },
- "coBrandLogoAsset": {
"readOnly": true,
- "type": "object",
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the co-brand logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the co-brand logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/brand-logo'\n"
}
}
}
@@ -62553,26 +67307,26 @@
}
},
"issuerLogoAsset": {
- "readOnly": true,
+ "description": "Issuer logo card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the issuer logo asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the issuer logo asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/issuer-logo'\n"
}
}
}
@@ -62581,65 +67335,54 @@
}
},
"iconAsset": {
- "readOnly": true,
+ "description": "Icon card art asset associated with the tokenized card.\n",
"type": "object",
+ "readOnly": true,
"properties": {
"id": {
- "readOnly": true,
"type": "string",
- "description": "The Id of the icon asset.\n"
+ "description": "Unique identifier for the asset\n"
},
"_links": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"self": {
- "readOnly": true,
"type": "object",
+ "readOnly": true,
"properties": {
"href": {
- "readOnly": true,
"type": "string",
- "description": "Link to the icon asset.\n"
+ "readOnly": true,
+ "description": "Link to the card art asset.\nexample: 'tms/v2/tokens/7020000000010603216/visa/assets/icon'\n"
}
}
}
}
}
}
+ }
+ }
+ },
+ "issuer": {
+ "description": "Issuer associated with the tokenized card.\n",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "name": {
+ "description": "issuer name.\n",
+ "type": "string",
+ "readOnly": true
},
- "foregroundColor": {
- "readOnly": true,
+ "shortDescription": {
+ "description": "issuer short description.\n",
"type": "string",
- "description": "The foreground color of the brand logo asset.\n"
+ "readOnly": true
},
- "backgroundAsset": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "id": {
- "readOnly": true,
- "type": "string",
- "description": "The Id of the icon asset.\n"
- },
- "_links": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "self": {
- "readOnly": true,
- "type": "object",
- "properties": {
- "href": {
- "readOnly": true,
- "type": "string",
- "description": "Link to the background asset.\n"
- }
- }
- }
- }
- }
- }
+ "longDescription": {
+ "description": "issuer long description.\n",
+ "type": "string",
+ "readOnly": true
}
}
}
@@ -62736,6 +67479,161 @@
"description": "The creator of the Instrument Identifier."
}
}
+ },
+ "_embedded": {
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "binLookup": {
+ "title": "TmsBinLookup",
+ "description": "Bin Information of the PAN provided by BinLookUp Service. This is only retrieved when retrieveBinDetails=true is passed as a query parameter.\n",
+ "readOnly": true,
+ "type": "object",
+ "properties": {
+ "paymentAccountInformation": {
+ "type": "object",
+ "properties": {
+ "card": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ },
+ "currency": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field indicates the 3-letter [ISO Standard Currency Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf) for the card currency.\n"
+ },
+ "maxLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the max length of the card.\n"
+ },
+ "credentialType": {
+ "type": "string",
+ "maxLength": 5,
+ "description": "This field contains the type of the payment credential.\nPossible values:\n - PAN\n - TOKEN \n"
+ },
+ "brands": {
+ "description": "Array of brands",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {
+ "type": {
+ "type": "string",
+ "maxLength": 3,
+ "description": "This field contains the 3-digit value that indicates the card type.\n\nPossible values:\n- `001`: Visa. For card-present transactions on all processors except SIX, the Visa Electron card type is processed the same way that the Visa debit card is processed. Use card type value `001` for Visa Electron.\n- `002`: Mastercard, Eurocard[^1], which is a European regional brand of Mastercard.\n- `003`: American Express\n- `004`: Discover\n- `005`: Diners Club\n- `006`: Carte Blanche[^1]\n- `007`: JCB[^1]\n- `008`: Optima\n- `011`: Twinpay Credit Card\n- `012`: Twinpay Debit Card\n- `013`: Walmart\n- `014`: Enroute[^1]\n- `015`: Lowes Consumer\n- `016`: Home Depot Consumer\n- `017`: MBNA\n- `018`: Dick's Sportwear\n- `019`: Casual Corner\n- `020`: Sears\n- `021`: JAL[^1]\n- `023`: Disney Card\n- `024`: Switch/Solo\n- `025`: Sams Club Consumer\n- `026`: Sams Club Business\n- `027`: Nicos\n- `029`: Bebe\n- `030`: Restoration Hardware\n- `031`: Delta[^1]: Use this value only for Ingenico ePayments. For other processors, use `001` for all Visa card types.\n- `032`: Solo\n- `033`: Visa Electron[^1]. Use this value only for Ingenico ePayments and SIX. For other processors, use `001` for all Visa card types.\n- `034`: Dankort[^1]\n- `035`: Laser\n- `036`: Cartes Bancaires[^1]\n- `037`: Carta Si[^1]\n- `039`: Encoded account number[^1]\n- `040`: UATP[^1]\n- `041`: HOUSEHOLD\n- `042`: Maestro (International)[^1]\n- `043`: GE MONEY\n- `044`: Korean Cards\n- `045`: Style\n- `046`: J.Crew\n- `050`: Hipercard[^2,3]\n- `051`: Aura\n- `052`: Redecard\n- `053`: Orico Card\n- `054`: Elo[^3]\n- `055`: Capital One Private Label\n- `058`: Carnet\n- `059`: ValueLink\n- `061`: RuPay\n- `062`: China UnionPay\n- `063`: Falabella Private Label\n- `064`: Prompt Card\n- `065`: Korean Domestic\n- `066`: Banricompras\n\n[^1]: For this card type, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in your request for an authorization or a stand-alone credit.\n\n[^2]: For this card type on Cielo 3.0, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit. This card type is not supported on Cielo 1.5.\n\n[^3]: For this card type on Getnet and Rede, you must include the `paymentInformation.card.type` or `paymentInformation.tokenizedCard.type` field in a request for an authorization or a stand-alone credit.\n"
+ },
+ "brandName": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the card brand name. \n\nSome of the possible values (not an exhaustive list) are -\n\n - VISA\n - MASTERCARD\n - AMERICAN EXPRESS\n - DISCOVER\n - DINERS CLUB\n - CARTE BLANCHE\n - JCB\n - OPTIMA\n - TWINPAY CREDIT CARD\n - TWINPAY DEBIT CARD\n - WALMART\n - ENROUTE\n - LOWES CONSUMER\n - HOME DEPOT CONSUMER\n - MBNA\n - DICKS SPORTWEAR\n - CASUAL CORNER\n - SEARS\n - JAL\n - DISNEY CARD\n - SWITCH/SOLO\n - SAMS CLUB CONSUMER\n - SAMS CLUB BUSINESS\n - NICOS HOUSE CARD\n - BEBE\n - RESTORATION HARDWARE\n - DELTA ONLINE\n - SOLO\n - VISA ELECTRON\n - DANKORT\n - LASER\n - CARTE BANCAIRE\n - CARTA SI\n - ENCODED ACCOUNT\n - UATP\n - HOUSEHOLD\n - MAESTRO\n - GE CAPITAL\n - KOREAN CARDS\n - STYLE CARDS\n - JCREW\n - MEIJER\n - HIPERCARD\n - AURA\n - REDECARD\n - ORICO HOUSE CARD\n - ELO\n - CAPITAL ONE PRIVATE LABEL\n - CARNET\n - RUPAY\n - CHINA UNION PAY\n - FALABELLA PRIVATE LABEL\n - PROMPTCARD\n - KOREAN DOMESTIC\n - BANRICOMPRAS\n"
+ }
+ }
+ }
+ }
+ }
+ },
+ "features": {
+ "type": "object",
+ "properties": {
+ "accountFundingSource": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the account funding source.\nPossible values:\n - `CREDIT`\n - `DEBIT`\n - `PREPAID`\n - `DEFERRED DEBIT`\n - `CHARGE`\n"
+ },
+ "accountFundingSourceSubType": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of prepaid card.\nPossible values:\n - `Reloadable`\n - `Non-reloadable`\n"
+ },
+ "cardProduct": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the type of issuer product.\nExample values:\n - Visa Classic\n - Visa Signature\n - Visa Infinite\n"
+ },
+ "messageType": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field contains the type of BIN based authentication.\nPossible values:\n - `S`: Single Message\n - `D`: Dual Message\n"
+ },
+ "acceptanceLevel": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the acceptance level of the PAN.\nPossible values:\n - `0` : Normal\n - `1` : Monitor\n - `2` : Refuse\n - `3` : Not Allowed\n - `4` : Private\n - `5` : Test\n"
+ },
+ "cardPlatform": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "This field contains the type of card platform.\nPossible values:\n - `BUSINESS`\n - `CONSUMER`\n - `COMMERCIAL`\n - `GOVERNMENT`\n"
+ },
+ "comboCard": {
+ "type": "string",
+ "maxLength": 1,
+ "description": "This field indicates the type of combo card.\nPossible values:\n - 0 (Not a combo card)\n - 1 (Credit and Prepaid Combo card)\n - 2 (Credit and Debit Combo card)\n"
+ },
+ "corporatePurchase": {
+ "type": "boolean",
+ "description": "This field indicates whether the card can be used for corporate purchasing. This field is only applicable for American Express cards.\nPossible values:\n - `true`\n - `false`\n"
+ },
+ "healthCard": {
+ "type": "boolean",
+ "description": "This field indicates if the entered card is a healthcare BIN. Currently, this field is only supported for Visa BINs.\nPossible values:\n - `true`\n - `false` \n"
+ }
+ }
+ },
+ "network": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "description": "This field contains a code that identifies the network.\n[List of Network ID and Sharing Group Code](https://developer.visa.com/request_response_codes#network_id_and_sharing_group_code)\n"
+ }
+ }
+ }
+ }
+ },
+ "issuerInformation": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "maxLength": 200,
+ "description": "This field contains the issuer name.\n"
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains [2-character ISO Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) for the issuer.\n"
+ },
+ "binLength": {
+ "type": "string",
+ "maxLength": 2,
+ "description": "This field contains the length of the BIN.\n"
+ },
+ "accountPrefix": {
+ "type": "string",
+ "maxLength": 8,
+ "description": "This field contains the first 6 to 8 digits of a primary account number (PAN). The length of the field is determined by [PCI-DSS standards for truncation](https://pcissc.secure.force.com/faq/articles/Frequently_Asked_Question/What-are-acceptable-formats-for-truncation-of-primary-account-numbers).\n"
+ },
+ "phoneNumber": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "This field contains the customer service phone number for the issuer.\n"
+ }
+ }
+ }
+ }
+ }
+ }
}
}
}
@@ -63159,7 +68057,7 @@
"properties": {
"paymentCredentialType": {
"type": "string",
- "description": "The type of payment credentials to be returned.\nBy default, payment credentials include network token and cryptogram or dynamic CVV.\nIf \"NETWORK_TOKEN\" is supplied then only network token will be returned and cryptogram or dynamic CVV will be excluded. \n\nPossible Values:\n - NETWORK_TOKEN\n"
+ "description": "The type of payment credentials to be returned.\nBy default, payment credentials include network token and cryptogram or dynamic CVV.\nIf \"NETWORK_TOKEN\" is supplied then only network token card number will be returned and no cryptogram or dynamic CVV will be requested.\nIf \"SECURITY_CODE\" is supplied then dynamic CVV will be requested and returned with the network token card number. Dynamic CVV is only supported for Amex and SCOF.\nIf \"CRYPTOGRAM\" is supplied then cryptogram will be requested and returned with the network token card number. Cryptogram is NOT supported for Amex.\n\nPossible Values:\n - NETWORK_TOKEN\n - SECURITY_CODE\n - CRYPTOGRAM\n"
}
}
}
@@ -63487,7 +68385,7 @@
"required": true,
"schema": {
"type": "object",
- "description": "This is a server-to-server API request to generate the capture context that can be used to initiate instance of microform on a acceptance page. The capture context is a digitally signed JWT that provides authentication, one-time keys, and the target origin to the Microform Integration application. ",
+ "description": "This is a server-to-server API request to generate the capture context that can be used to initiate an instance of Microform on an acceptance page. The capture context is a digitally signed JWT that provides authentication, one-time keys, and the target origin to the Microform Integration application. ",
"properties": {
"clientVersion": {
"type": "string",
@@ -63506,54 +68404,14 @@
"items": {
"type": "string"
},
- "description": "The list of card networks you want to use for this Microform transaction.\n\nMicroform currently supports the following card networks:\n- VISA\n- MASTERCARD\n- AMEX\n- CARNET\n- CARTESBANCAIRES\n- CUP\n- DINERSCLUB\n- DISCOVER\n- EFTPOS\n- ELO\n- JCB\n- JCREW\n- MADA\n- MAESTRO\n- MEEZA\n"
+ "description": "The list of card networks you want to use for this Microform transaction.\n\nMicroform currently supports the following card networks:\n- VISA\n- MASTERCARD\n- AMEX\n- CARNET\n- CARTESBANCAIRES\n- CUP\n- DINERSCLUB\n- DISCOVER\n- EFTPOS\n- ELO\n- JCB\n- JCREW\n- MADA\n- MAESTRO\n- MEEZA\n\n**Important:** \n - When integrating Microform (Accept Card) at least one card network should be specified in the allowedCardNetworks field in the capture context request.\n - When integrating Microform (Accept Check) the allowedCardNetworks field is not required in the capture context request.\n - When integrating both Microform (Accept Card) and Microform (Accept Check) at least one card network should be specified in the allowedCardNetworks field in the capture context request.\n"
},
- "checkoutApiInitialization": {
- "type": "object",
- "description": "Use the [Digital Accept Checkout API](https://developer.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Checkout_API/Secure_Acceptance_Checkout_API.pdf) in conjunction with Microform to provide a cohesive PCI SAQ A embedded payment application within your merchant e-commerce page. \n\nThe Digital Accept Checkout API provides access to payment processing and additional value-added services directly from the browser.\n",
- "properties": {
- "profile_id": {
- "type": "string",
- "example": "12341234-1234-1234-1234-123412341234"
- },
- "access_key": {
- "type": "string",
- "example": "acce55acce55acce55acce55acce5500"
- },
- "reference_number": {
- "type": "string",
- "example": 1611305732
- },
- "transaction_uuid": {
- "type": "string",
- "example": "1611305732-001"
- },
- "transaction_type": {
- "type": "string",
- "example": "authorization"
- },
- "currency": {
- "type": "string",
- "example": "USD"
- },
- "amount": {
- "type": "string",
- "example": 100
- },
- "locale": {
- "type": "string",
- "example": "en-us",
- "description": "Locale where application is being used. This field controls aspects of the application such as the language it will be rendered in.\n"
- },
- "override_custom_receipt_page": {
- "type": "string",
- "example": "https://www.test.com/receipt"
- },
- "unsigned_field_names": {
- "type": "string",
- "example": "transient_token"
- }
- }
+ "allowedPaymentTypes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The payment types that are allowed for the merchant. \n\nPossible values when launching Microform:\n- CARD\n- CHECK
\n"
}
}
}
@@ -63561,7 +68419,7 @@
],
"x-example": {
"example0": {
- "summary": "Generate Capture Context simple",
+ "summary": "Generate Capture Context (Accept Card)",
"value": {
"clientVersion": "v2",
"targetOrigins": [
@@ -63583,45 +68441,22 @@
"MADA",
"MAESTRO",
"MEEZA"
+ ],
+ "allowedPaymentTypes": [
+ "CARD"
]
}
},
"example1": {
- "summary": "Generate Capture Context With Checkout API",
+ "summary": "Generate Capture Context (Accept Check)",
"value": {
"clientVersion": "v2",
"targetOrigins": [
"https://www.test.com"
],
- "allowedCardNetworks": [
- "VISA",
- "MASTERCARD",
- "AMEX",
- "CARNET",
- "CARTESBANCAIRES",
- "CUP",
- "DINERSCLUB",
- "DISCOVER",
- "EFTPOS",
- "ELO",
- "JCB",
- "JCREW",
- "MADA",
- "MAESTRO",
- "MEEZA"
- ],
- "checkoutApiInitialization": {
- "profile_id": "12341234-1234-1234-1234-123412341234",
- "access_key": "acce55acce55acce55acce55acce5500",
- "reference_number": "1611305732",
- "transaction_uuid": "1611305732-001",
- "transaction_type": "authorization",
- "currency": "USD",
- "amount": "100.00",
- "locale": "en-us",
- "override_custom_receipt_page": "https://www.test.com/receipt",
- "unsigned_field_names": "transient_token, address1, address2"
- }
+ "allowedPaymentTypes": [
+ "CHECK"
+ ]
}
}
},
@@ -64624,7 +69459,7 @@
},
"shippingMethod": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"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"
}
}
@@ -64649,7 +69484,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
@@ -64689,7 +69524,7 @@
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"destinationCode": {
@@ -64857,7 +69692,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"country": {
@@ -67834,7 +72669,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
@@ -67874,7 +72709,7 @@
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"destinationCode": {
@@ -68070,7 +72905,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"country": {
@@ -70918,7 +75753,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"country": {
@@ -70979,7 +75814,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
@@ -70994,7 +75829,7 @@
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
}
}
@@ -72457,7 +77292,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"country": {
@@ -72506,7 +77341,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"country": {
@@ -72521,7 +77356,7 @@
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
}
}
@@ -73349,7 +78184,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"country": {
@@ -74216,7 +79051,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"postalCode": {
@@ -74267,7 +79102,7 @@
},
"locality": {
"type": "string",
- "maxLength": 13,
+ "maxLength": 30,
"description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
@@ -74346,6 +79181,31 @@
"type": "string",
"maxLength": 20,
"description": "Recipient phone number. Required only for FDCCompass."
+ },
+ "aliasName": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Account owner alias name.\n"
+ },
+ "nationality": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Account Owner Nationality"
+ },
+ "countryOfBirth": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Account Owner Country of Birth"
+ },
+ "occupation": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Account Owner Occupation"
+ },
+ "email": {
+ "type": "string",
+ "maxLength": 150,
+ "description": "Account Owner email address"
}
}
},
@@ -74453,6 +79313,11 @@
"type": "string",
"maxLength": 255,
"description": "#### Visa Platform Connect\nThis tag will contain an acquirer-populated value associated with the API : senderInformation.personalIdType which will identify the personal ID type of the sender.\n"
+ },
+ "aliasName": {
+ "type": "string",
+ "maxLength": 50,
+ "description": "Sender's alias name."
}
}
},
@@ -74533,6 +79398,26 @@
}
}
}
+ },
+ "languageCode": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Contains the ISO 639-2 defined language Code\n"
+ },
+ "purchaseOptions": {
+ "type": "object",
+ "properties": {
+ "benefitAmount": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "Workplace benefit amount."
+ },
+ "benefitType": {
+ "type": "string",
+ "maxLength": 100,
+ "description": "Workplace benefit type.\nPossible values:\n- 70 = employee benefit\n- 4T = transportation / transit\n- 52 = general benefit\n- 53 = meal voucher\n- 54 = fuel\n- 55 = ecological / sustainability\n- 58 = philanthropy / patronage / consumption\n- 59 = gift\n- 5S = sport / culture\n- 5T = book / education\n"
+ }
+ }
}
}
},
@@ -74674,6 +79559,67 @@
}
}
}
+ },
+ "aggregatorInformation": {
+ "type": "object",
+ "x-nullable": true,
+ "properties": {
+ "aggregatorId": {
+ "type": "string",
+ "x-nullable": true,
+ "maxLength": 20,
+ "description": "Value that identifies you as a payment aggregator. Get this value from the processor.\n"
+ },
+ "name": {
+ "type": "string",
+ "x-nullable": true,
+ "maxLength": 37,
+ "description": "Your payment aggregator business name. This field is conditionally required when aggregator id is present.\n"
+ },
+ "independentSalesOrganizationID": {
+ "type": "string",
+ "x-nullable": true,
+ "maxLength": 11,
+ "description": "Independent sales organization ID.\nThis field is only used for Mastercard transactions submitted through PPGS.\n"
+ },
+ "subMerchant": {
+ "type": "object",
+ "x-nullable": true,
+ "properties": {
+ "id": {
+ "type": "string",
+ "maxLength": 20,
+ "x-nullable": true,
+ "description": "The ID you assigned to your sub-merchant.\n"
+ }
+ }
+ },
+ "streetAddress": {
+ "type": "string",
+ "maxLength": 150,
+ "description": "Acquirer street name."
+ },
+ "city": {
+ "type": "string",
+ "maxLength": 100,
+ "description": "Acquirer city."
+ },
+ "state": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Acquirer state."
+ },
+ "postalCode": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "Acquirer postal code."
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Acquirer country."
+ }
+ }
}
},
"example": {
@@ -74690,12 +79636,18 @@
"account": {
"number": "1234567890123456789012345678901234",
"fundsSource": "01"
- }
+ },
+ "aliasName": "Thomas my friend"
},
"processingInformation": {
"commerceIndicator": "internet",
"businessApplicationId": "FD",
- "networkRoutingOrder": "ECG"
+ "networkRoutingOrder": "ECG",
+ "languageCode": "US",
+ "purchaseOptions": {
+ "benefitAmount": "10.00",
+ "benefitType": "5T"
+ }
},
"payoutsOptions": {
"retrievalReferenceNumber": "123456789012",
@@ -74736,7 +79688,19 @@
"postalCode": "94400",
"phoneNumber": "6504320556",
"dateOfBirth": "19801009",
- "country": "US"
+ "country": "US",
+ "aliasName": "John My Friend",
+ "nationality": "GB",
+ "countryOfBirth": "GB",
+ "occupation": "freelancer",
+ "email": "joe@visa.com"
+ },
+ "aggregatorInformation": {
+ "streetAddress": "202 S. Division St.",
+ "city": "Phoenix",
+ "state": "Arizona",
+ "postalCode": "560048",
+ "country": "USA"
}
}
}
@@ -74872,7 +79836,7 @@
},
"locality": {
"type": "string",
- "maxLength": 13,
+ "maxLength": 30,
"description": "Merchant's City.\n\n#### PIN debit\nCity for your business location. This value might be displayed on the cardholder's statement.\n\nWhen you do not include this value in your PIN debit request, the merchant name from your account is used.\n**Important** This value must consist of English characters.\n\nOptional field for PIN debit credit or PIN debit purchase requests.\n"
},
"country": {
@@ -75030,6 +79994,26 @@
}
}
}
+ },
+ "processingInformation": {
+ "type": "object",
+ "properties": {
+ "purchaseOptions": {
+ "type": "object",
+ "properties": {
+ "benefitAmount": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "Workplace benefit amount."
+ },
+ "benefitType": {
+ "type": "string",
+ "maxLength": 100,
+ "description": "Workplace benefit type.\nPossible values:\n- 70 = employee benefit\n- 4T = transportation / transit\n- 52 = general benefit\n- 53 = meal voucher\n- 54 = fuel\n- 55 = ecological / sustainability\n- 58 = philanthropy / patronage / consumption\n- 59 = gift\n- 5S = sport / culture\n- 5T = book / education\n"
+ }
+ }
+ }
+ }
}
}
}
@@ -75123,7 +80107,11 @@
"processingInformation": {
"commerceIndicator": "internet",
"businessApplicationId": "FD",
- "networkRoutingOrder": "V8"
+ "networkRoutingOrder": "V8",
+ "purchaseOptions": {
+ "benefitAmount": "10.00",
+ "benefitType": "5S"
+ }
},
"orderInformation": {
"amountDetails": {
@@ -75279,6 +80267,31 @@
"description": "The ID you assigned to your sub-merchant.\n"
}
}
+ },
+ "streetAddress": {
+ "type": "string",
+ "maxLength": 150,
+ "description": "Acquirer street name."
+ },
+ "city": {
+ "type": "string",
+ "maxLength": 100,
+ "description": "Acquirer city."
+ },
+ "state": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Acquirer state."
+ },
+ "postalCode": {
+ "type": "string",
+ "maxLength": 20,
+ "description": "Acquirer postal code."
+ },
+ "country": {
+ "type": "string",
+ "maxLength": 10,
+ "description": "Acquirer country."
}
}
},
@@ -81345,7 +86358,7 @@
},
"value": {
"type": "string",
- "maxLength": 255,
+ "maxLength": 800,
"description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
@@ -81408,7 +86421,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"postalCode": {
@@ -81473,12 +86486,12 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the billing address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).\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\naccepts and stores non-ASCII characters correctly and displays them correctly in reports. However, the limitations\nof the credit card networks prevent CyberSource through VisaNet from transmitting non-ASCII characters to the\ncredit card networks. Therefore, CyberSource through VisaNet replaces non-ASCII characters with meaningless\nASCII 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#### Chase Paymentech Solutions\nOptional field.\n\n#### Credit Mutuel-CIC\nOptional field.\n\n#### OmniPay Direct\nOptional field.\n\n#### SIX\nOptional field.\n\n#### TSYS Acquiring Solutions\nRequired when `processingInformation.billPaymentOptions.billPayment=true` and `pointOfSaleInformation.entryMode=keyed`.\n\n#### Worldpay VAP\nOptional field.\n\n#### All other processors\nNot used.\n"
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"company": {
@@ -81597,7 +86610,7 @@
},
"shippingMethod": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"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"
}
}
@@ -82017,6 +87030,7 @@
"properties": {
"type": {
"type": "string",
+ "maxLength": 1,
"description": "Indicates the type of unscheduled payment. This field is required for unscheduled payments CIT/MIT Possible values:\n1: First unscheduled transaction.\n2: Subsequent unscheduled transaction.\n"
}
}
@@ -82067,7 +87081,8 @@
},
"extendAuthIndicator": {
"type": "string",
- "description": "Flag that indicates whether the transaction is an extended authorization.\n"
+ "maxLength": 5,
+ "description": "Indicates Authorization extension transaction. Extension transaction is used to prolong the settlement period by one additional settlement cycle period.\n\nPossible values:\n- true: Transaction is an Authorization Extension transaction. \n- false: Transaction is not an Authorization Extension transaction.\n"
},
"cardVerificationIndicator": {
"type": "boolean",
@@ -82425,7 +87440,7 @@
},
"cardholderVerificationMethodUsed": {
"type": "integer",
- "description": "Method that was used to verify the cardholder's identity. Possible values:\n\n - `0`: No verification\n - `1`: Signature\n - `2`: PIN\n - `3`: Cardholder device CVM\n"
+ "description": "Method that was used to verify the cardholder's identity. Possible values:\n\n - `0`: No verification\n - `1`: Signature\n - `2`: PIN\n - `3`: Cardholder device CVM\n - `4`: Biometric\n - `5`: OTP\n"
},
"emv": {
"type": "object",
@@ -83600,7 +88615,7 @@
},
"value": {
"type": "string",
- "maxLength": 255,
+ "maxLength": 800,
"description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
@@ -84447,7 +89462,7 @@
},
"value": {
"type": "string",
- "maxLength": 255,
+ "maxLength": 800,
"description": "The value you assign for your merchant-defined data field.\n\n**Warning** Merchant-defined data fields are not intended to and must not be used to capture personally identifying information. Accordingly, merchants are prohibited from capturing, obtaining, and/or transmitting any personally identifying information in or via the merchant-defined data fields. Personally identifying information includes, but is not\nlimited to, address, credit card number, social security number, driver's license number, state-issued identification number, passport number, and card verification numbers (CVV,\nCVC2, CVV2, CID, CVN). In the event CyberSource discovers that a merchant is capturing and/or transmitting personally identifying information via the merchant-defined data fields, whether or not intentionally, CyberSource will immediately suspend the merchant's account, which will result in a rejection of any and all transaction requests submitted by the merchant after the point of suspension.\n\n#### CyberSource through VisaNet\nFor installment payments with Mastercard in Brazil, use `merchantDefinedInformation[0].value` and\n`merchantDefinedInformation[1].value` for data that you want to provide to the issuer to identify the\ntransaction. \n\nFor installment payments with Mastercard in Brazil:\n- The value for merchantDefinedInformation[0].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 25-44\n - Field: Reference Field 2\n- The value for merchantDefinedInformation[1].value corresponds to the following data in the TC 33 capture file5:\n - Record: CP07 TCR5\n - Position: 45-64\n - Field: Reference Field 3\n"
}
}
@@ -96931,7 +101946,7 @@
},
"administrativeArea": {
"type": "string",
- "maxLength": 20,
+ "maxLength": 50,
"description": "State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2) \n\nRequired field for authorization if any shipping address information is included in the request and shipping to the U.S.\nor Canada; otherwise, optional.\n\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"locality": {
@@ -96941,7 +101956,7 @@
},
"postalCode": {
"type": "string",
- "maxLength": 10,
+ "maxLength": 32,
"description": "Postal code for the shipping address. The postal code must consist of 5 to 9 digits.\n\nRequired field for authorization if any shipping address information is included in the request and\nshipping to the U.S. or Canada; otherwise, optional.\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, all nonalphanumeric characters are removed and, if the\nremaining value is longer than nine characters, the value is truncated starting from the right side.\n#### Tax Calculation\nOptional field for U.S. and Canadian taxes. Not applicable to international and value added taxes.\nBilling address objects will be used to determine the cardholder's location when shipTo objects are not present.\n"
},
"address1": {
@@ -115344,7 +120359,7 @@
"items": {
"type": "string"
},
- "description": "The payment types that are allowed for the merchant. \n\nPossible values when launching Unified Checkout:\n - PANENTRY \n - GOOGLEPAY\n - SRC\n - CHECK
\n\nPossible values when launching Unified Checkout with Checkout API:\n- PANENTRY \n- SRC
\n\nPossible values when launching Click To Pay Drop-In UI:\n- CLICKTOPAY
\n\n**Important:** \n - SRC and CLICKTOPAY are only available for Visa, Mastercard and AMEX.\n"
+ "description": "The payment types that are allowed for the merchant. \n\nPossible values when launching Unified Checkout:\n - APPLEPAY\n - CHECK\n - CLICKTOPAY\n - GOOGLEPAY\n - PANENTRY \n - PAZE
\n\nPossible values when launching Click To Pay Drop-In UI:\n- CLICKTOPAY
\n\n**Important:** \n - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved cards.\n - Visa and Mastercard will look to tokenize using network tokenization for all Click to Pay requests. Click to Pay uses Click to Pay token requester IDs and not the merchant's existing token requester.\n - Apple Pay, Google Pay, Check, and Paze can be used independently without requiring PAN entry in the allowedPaymentTypes field.\n"
},
"country": {
"type": "string",
@@ -115669,52 +120684,6 @@
}
}
}
- },
- "checkoutApiInitialization": {
- "type": "object",
- "description": "Use the [Digital Accept Checkout API](https://developer.cybersource.com/library/documentation/dev_guides/Secure_Acceptance_Checkout_API/Secure_Acceptance_Checkout_API.pdf) in conjunction with Unified Checkout to provide a cohesive PCI SAQ A embedded payment application within your merchant e-commerce page. \n\nThe Digital Accept Checkout API provides access to payment processing and additional value-added services directly from the browser.\n",
- "properties": {
- "profile_id": {
- "type": "string",
- "example": "12341234-1234-1234-1234-123412341234"
- },
- "access_key": {
- "type": "string",
- "example": "acce55acce55acce55acce55acce5500"
- },
- "reference_number": {
- "type": "string",
- "example": 1611305732
- },
- "transaction_uuid": {
- "type": "string",
- "example": "1611305732-001"
- },
- "transaction_type": {
- "type": "string",
- "example": "authorization"
- },
- "currency": {
- "type": "string",
- "example": "USD"
- },
- "amount": {
- "type": "string",
- "example": 100
- },
- "locale": {
- "type": "string",
- "example": "en-us"
- },
- "override_custom_receipt_page": {
- "type": "string",
- "example": "https://the-up-demo.appspot.com/demos/demo5/receipt"
- },
- "unsigned_field_names": {
- "type": "string",
- "example": "transient_token, address1, address2"
- }
- }
}
}
}
@@ -115724,7 +120693,7 @@
"example0": {
"summary": "Generate Unified Checkout Capture Context",
"value": {
- "clientVersion": "0.22",
+ "clientVersion": "0.23",
"targetOrigins": [
"https://yourCheckoutPage.com"
],
@@ -115746,59 +120715,12 @@
"MEEZA"
],
"allowedPaymentTypes": [
- "PANENTRY",
+ "APPLEPAY",
+ "CHECK",
+ "CLICKTOPAY",
"GOOGLEPAY",
- "SRC",
- "CHECK"
- ],
- "country": "US",
- "locale": "en_US",
- "captureMandate": {
- "billingType": "FULL",
- "requestEmail": true,
- "requestPhone": true,
- "requestShipping": true,
- "shipToCountries": [
- "US",
- "GB"
- ],
- "showAcceptedNetworkIcons": true
- },
- "orderInformation": {
- "amountDetails": {
- "totalAmount": "21.00",
- "currency": "USD"
- }
- }
- }
- },
- "example1": {
- "summary": "Generate Unified Checkout Capture Context with Checkout API",
- "value": {
- "clientVersion": "0.22",
- "targetOrigins": [
- "https://yourCheckoutPage.com"
- ],
- "allowedCardNetworks": [
- "VISA",
- "MASTERCARD",
- "AMEX",
- "CARNET",
- "CARTESBANCAIRES",
- "CUP",
- "DINERSCLUB",
- "DISCOVER",
- "EFTPOS",
- "ELO",
- "JCB",
- "JCREW",
- "MADA",
- "MAESTRO",
- "MEEZA"
- ],
- "allowedPaymentTypes": [
"PANENTRY",
- "SRC"
+ "PAZE"
],
"country": "US",
"locale": "en_US",
@@ -115818,25 +120740,13 @@
"totalAmount": "21.00",
"currency": "USD"
}
- },
- "checkoutApiInitialization": {
- "profile_id": "12341234-1234-1234-1234-123412341234",
- "access_key": "acce55acce55acce55acce55acce5500",
- "reference_number": "1611305732",
- "transaction_uuid": "1611305732-001",
- "transaction_type": "authorization",
- "currency": "USD",
- "amount": "100.00",
- "locale": "en-us",
- "override_custom_receipt_page": "https://the-up-demo.appspot.com/demos/demo5/receipt",
- "unsigned_field_names": "transient_token, address1, address2"
}
}
},
"example3": {
"summary": "Generate Unified Checkout Capture Context passing Billing & Shipping",
"value": {
- "clientVersion": "0.22",
+ "clientVersion": "0.23",
"targetOrigins": [
"https://yourCheckoutPage.com"
],
@@ -115858,9 +120768,12 @@
"MEEZA"
],
"allowedPaymentTypes": [
+ "APPLEPAY",
+ "CHECK",
+ "CLICKTOPAY",
+ "GOOGLEPAY",
"PANENTRY",
- "SRC",
- "GOOGLEPAY"
+ "PAZE"
],
"country": "US",
"locale": "en_US",
@@ -115933,7 +120846,7 @@
"example4": {
"summary": "Generate Capture Context For Click To Pay Drop-In UI",
"value": {
- "clientVersion": "0.22",
+ "clientVersion": "0.23",
"targetOrigins": [
"https://yourCheckoutPage.com"
],
diff --git a/pom.xml b/pom.xml
index dbc8f834e..6ab619a4b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -10,7 +10,7 @@
cybersource-rest-client-java
jar
cybersource-rest-client-java
- 0.0.73-SNAPSHOT
+ 0.0.74-SNAPSHOT
http://developer.cybersource.com
Cybersource Rest Client SDK
@@ -274,7 +274,7 @@
com.cybersource
AuthenticationSdk
- 0.0.33
+ 0.0.34
diff --git a/src/main/java/Api/BatchesApi.java b/src/main/java/Api/BatchesApi.java
index 723a75486..16556a3b3 100644
--- a/src/main/java/Api/BatchesApi.java
+++ b/src/main/java/Api/BatchesApi.java
@@ -159,7 +159,6 @@ private okhttp3.Call getBatchReportValidateBeforeCall(String batchId, final Prog
*/
public InlineResponse2007 getBatchReport(String batchId) throws ApiException {
logger.info("CALL TO METHOD 'getBatchReport' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getBatchReportWithHttpInfo(batchId);
logger.info("CALL TO METHOD 'getBatchReport' ENDED");
return resp.getData();
@@ -173,6 +172,7 @@ public InlineResponse2007 getBatchReport(String batchId) throws ApiException {
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getBatchReportWithHttpInfo(String batchId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getBatchReportValidateBeforeCall(batchId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -304,7 +304,6 @@ private okhttp3.Call getBatchStatusValidateBeforeCall(String batchId, final Prog
*/
public InlineResponse2006 getBatchStatus(String batchId) throws ApiException {
logger.info("CALL TO METHOD 'getBatchStatus' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getBatchStatusWithHttpInfo(batchId);
logger.info("CALL TO METHOD 'getBatchStatus' ENDED");
return resp.getData();
@@ -318,6 +317,7 @@ public InlineResponse2006 getBatchStatus(String batchId) throws ApiException {
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getBatchStatusWithHttpInfo(String batchId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getBatchStatusValidateBeforeCall(batchId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -456,7 +456,6 @@ private okhttp3.Call getBatchesListValidateBeforeCall(Long offset, Long limit, S
*/
public InlineResponse2005 getBatchesList(Long offset, Long limit, String fromDate, String toDate) throws ApiException {
logger.info("CALL TO METHOD 'getBatchesList' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getBatchesListWithHttpInfo(offset, limit, fromDate, toDate);
logger.info("CALL TO METHOD 'getBatchesList' ENDED");
return resp.getData();
@@ -473,6 +472,7 @@ public InlineResponse2005 getBatchesList(Long offset, Long limit, String fromDat
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getBatchesListWithHttpInfo(Long offset, Long limit, String fromDate, String toDate) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getBatchesListValidateBeforeCall(offset, limit, fromDate, toDate, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -603,7 +603,6 @@ private okhttp3.Call postBatchValidateBeforeCall(Body body, final ProgressRespon
*/
public InlineResponse202 postBatch(Body body) throws ApiException {
logger.info("CALL TO METHOD 'postBatch' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = postBatchWithHttpInfo(body);
logger.info("CALL TO METHOD 'postBatch' ENDED");
return resp.getData();
@@ -617,6 +616,7 @@ public InlineResponse202 postBatch(Body body) throws ApiException {
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse postBatchWithHttpInfo(Body body) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = postBatchValidateBeforeCall(body, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/BillingAgreementsApi.java b/src/main/java/Api/BillingAgreementsApi.java
index a26de693f..2daeb0972 100644
--- a/src/main/java/Api/BillingAgreementsApi.java
+++ b/src/main/java/Api/BillingAgreementsApi.java
@@ -166,7 +166,6 @@ private okhttp3.Call billingAgreementsDeRegistrationValidateBeforeCall(ModifyBil
*/
public PtsV2ModifyBillingAgreementPost201Response billingAgreementsDeRegistration(ModifyBillingAgreement modifyBillingAgreement, String id) throws ApiException {
logger.info("CALL TO METHOD 'billingAgreementsDeRegistration' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = billingAgreementsDeRegistrationWithHttpInfo(modifyBillingAgreement, id);
logger.info("CALL TO METHOD 'billingAgreementsDeRegistration' ENDED");
return resp.getData();
@@ -181,6 +180,7 @@ public PtsV2ModifyBillingAgreementPost201Response billingAgreementsDeRegistratio
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse billingAgreementsDeRegistrationWithHttpInfo(ModifyBillingAgreement modifyBillingAgreement, String id) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = billingAgreementsDeRegistrationValidateBeforeCall(modifyBillingAgreement, id, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -318,7 +318,6 @@ private okhttp3.Call billingAgreementsIntimationValidateBeforeCall(IntimateBilli
*/
public PtsV2CreditsPost201Response1 billingAgreementsIntimation(IntimateBillingAgreement intimateBillingAgreement, String id) throws ApiException {
logger.info("CALL TO METHOD 'billingAgreementsIntimation' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = billingAgreementsIntimationWithHttpInfo(intimateBillingAgreement, id);
logger.info("CALL TO METHOD 'billingAgreementsIntimation' ENDED");
return resp.getData();
@@ -333,6 +332,7 @@ public PtsV2CreditsPost201Response1 billingAgreementsIntimation(IntimateBillingA
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse billingAgreementsIntimationWithHttpInfo(IntimateBillingAgreement intimateBillingAgreement, String id) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = billingAgreementsIntimationValidateBeforeCall(intimateBillingAgreement, id, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -461,7 +461,6 @@ private okhttp3.Call billingAgreementsRegistrationValidateBeforeCall(CreateBilli
*/
public PtsV2CreateBillingAgreementPost201Response billingAgreementsRegistration(CreateBillingAgreement createBillingAgreement) throws ApiException {
logger.info("CALL TO METHOD 'billingAgreementsRegistration' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = billingAgreementsRegistrationWithHttpInfo(createBillingAgreement);
logger.info("CALL TO METHOD 'billingAgreementsRegistration' ENDED");
return resp.getData();
@@ -475,6 +474,7 @@ public PtsV2CreateBillingAgreementPost201Response billingAgreementsRegistration(
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse billingAgreementsRegistrationWithHttpInfo(CreateBillingAgreement createBillingAgreement) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = billingAgreementsRegistrationValidateBeforeCall(createBillingAgreement, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/BinLookupApi.java b/src/main/java/Api/BinLookupApi.java
index 9a015aaec..6bf623c44 100644
--- a/src/main/java/Api/BinLookupApi.java
+++ b/src/main/java/Api/BinLookupApi.java
@@ -154,7 +154,6 @@ private okhttp3.Call getAccountInfoValidateBeforeCall(CreateBinLookupRequest cre
*/
public InlineResponse2011 getAccountInfo(CreateBinLookupRequest createBinLookupRequest) throws ApiException {
logger.info("CALL TO METHOD 'getAccountInfo' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getAccountInfoWithHttpInfo(createBinLookupRequest);
logger.info("CALL TO METHOD 'getAccountInfo' ENDED");
return resp.getData();
@@ -168,6 +167,7 @@ public InlineResponse2011 getAccountInfo(CreateBinLookupRequest createBinLookupR
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getAccountInfoWithHttpInfo(CreateBinLookupRequest createBinLookupRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getAccountInfoValidateBeforeCall(createBinLookupRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/CaptureApi.java b/src/main/java/Api/CaptureApi.java
index aa4827dcd..5f7036329 100644
--- a/src/main/java/Api/CaptureApi.java
+++ b/src/main/java/Api/CaptureApi.java
@@ -162,7 +162,6 @@ private okhttp3.Call capturePaymentValidateBeforeCall(CapturePaymentRequest capt
*/
public PtsV2PaymentsCapturesPost201Response capturePayment(CapturePaymentRequest capturePaymentRequest, String id) throws ApiException {
logger.info("CALL TO METHOD 'capturePayment' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = capturePaymentWithHttpInfo(capturePaymentRequest, id);
logger.info("CALL TO METHOD 'capturePayment' ENDED");
return resp.getData();
@@ -177,6 +176,7 @@ public PtsV2PaymentsCapturesPost201Response capturePayment(CapturePaymentRequest
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse capturePaymentWithHttpInfo(CapturePaymentRequest capturePaymentRequest, String id) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = capturePaymentValidateBeforeCall(capturePaymentRequest, id, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/ChargebackDetailsApi.java b/src/main/java/Api/ChargebackDetailsApi.java
index 2f6bbe7f6..974ab8ec8 100644
--- a/src/main/java/Api/ChargebackDetailsApi.java
+++ b/src/main/java/Api/ChargebackDetailsApi.java
@@ -170,7 +170,6 @@ private okhttp3.Call getChargebackDetailsValidateBeforeCall(DateTime startTime,
*/
public ReportingV3ChargebackDetailsGet200Response getChargebackDetails(DateTime startTime, DateTime endTime, String organizationId) throws ApiException {
logger.info("CALL TO METHOD 'getChargebackDetails' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getChargebackDetailsWithHttpInfo(startTime, endTime, organizationId);
logger.info("CALL TO METHOD 'getChargebackDetails' ENDED");
return resp.getData();
@@ -186,6 +185,7 @@ public ReportingV3ChargebackDetailsGet200Response getChargebackDetails(DateTime
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getChargebackDetailsWithHttpInfo(DateTime startTime, DateTime endTime, String organizationId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getChargebackDetailsValidateBeforeCall(startTime, endTime, organizationId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/ChargebackSummariesApi.java b/src/main/java/Api/ChargebackSummariesApi.java
index 1aaf1c573..ada3d0ffc 100644
--- a/src/main/java/Api/ChargebackSummariesApi.java
+++ b/src/main/java/Api/ChargebackSummariesApi.java
@@ -170,7 +170,6 @@ private okhttp3.Call getChargebackSummariesValidateBeforeCall(DateTime startTime
*/
public ReportingV3ChargebackSummariesGet200Response getChargebackSummaries(DateTime startTime, DateTime endTime, String organizationId) throws ApiException {
logger.info("CALL TO METHOD 'getChargebackSummaries' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getChargebackSummariesWithHttpInfo(startTime, endTime, organizationId);
logger.info("CALL TO METHOD 'getChargebackSummaries' ENDED");
return resp.getData();
@@ -186,6 +185,7 @@ public ReportingV3ChargebackSummariesGet200Response getChargebackSummaries(DateT
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getChargebackSummariesWithHttpInfo(DateTime startTime, DateTime endTime, String organizationId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getChargebackSummariesValidateBeforeCall(startTime, endTime, organizationId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/ConversionDetailsApi.java b/src/main/java/Api/ConversionDetailsApi.java
index ee5f4e5aa..b8f1298b8 100644
--- a/src/main/java/Api/ConversionDetailsApi.java
+++ b/src/main/java/Api/ConversionDetailsApi.java
@@ -171,7 +171,6 @@ private okhttp3.Call getConversionDetailValidateBeforeCall(DateTime startTime, D
*/
public ReportingV3ConversionDetailsGet200Response getConversionDetail(DateTime startTime, DateTime endTime, String organizationId) throws ApiException {
logger.info("CALL TO METHOD 'getConversionDetail' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getConversionDetailWithHttpInfo(startTime, endTime, organizationId);
logger.info("CALL TO METHOD 'getConversionDetail' ENDED");
return resp.getData();
@@ -187,6 +186,7 @@ public ReportingV3ConversionDetailsGet200Response getConversionDetail(DateTime s
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getConversionDetailWithHttpInfo(DateTime startTime, DateTime endTime, String organizationId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getConversionDetailValidateBeforeCall(startTime, endTime, organizationId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/CreateNewWebhooksApi.java b/src/main/java/Api/CreateNewWebhooksApi.java
index dcb816c8d..63b7cccf6 100644
--- a/src/main/java/Api/CreateNewWebhooksApi.java
+++ b/src/main/java/Api/CreateNewWebhooksApi.java
@@ -149,7 +149,6 @@ private okhttp3.Call createWebhookSubscriptionValidateBeforeCall(CreateWebhookRe
*/
public InlineResponse2014 createWebhookSubscription(CreateWebhookRequest createWebhookRequest) throws ApiException {
logger.info("CALL TO METHOD 'createWebhookSubscription' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = createWebhookSubscriptionWithHttpInfo(createWebhookRequest);
logger.info("CALL TO METHOD 'createWebhookSubscription' ENDED");
return resp.getData();
@@ -163,6 +162,7 @@ public InlineResponse2014 createWebhookSubscription(CreateWebhookRequest createW
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse createWebhookSubscriptionWithHttpInfo(CreateWebhookRequest createWebhookRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = createWebhookSubscriptionValidateBeforeCall(createWebhookRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -295,7 +295,6 @@ private okhttp3.Call findProductsToSubscribeValidateBeforeCall(String organizati
*/
public List findProductsToSubscribe(String organizationId) throws ApiException {
logger.info("CALL TO METHOD 'findProductsToSubscribe' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse> resp = findProductsToSubscribeWithHttpInfo(organizationId);
logger.info("CALL TO METHOD 'findProductsToSubscribe' ENDED");
return resp.getData();
@@ -309,6 +308,7 @@ public List findProductsToSubscribe(String organizationId) t
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse> findProductsToSubscribeWithHttpInfo(String organizationId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = findProductsToSubscribeValidateBeforeCall(organizationId, null, null);
Type localVarReturnType = new TypeToken>(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -455,7 +455,6 @@ private okhttp3.Call saveSymEgressKeyValidateBeforeCall(String vCSenderOrganizat
*/
public InlineResponse2013 saveSymEgressKey(String vCSenderOrganizationId, String vCPermissions, String vCCorrelationId, SaveSymEgressKey saveSymEgressKey) throws ApiException {
logger.info("CALL TO METHOD 'saveSymEgressKey' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = saveSymEgressKeyWithHttpInfo(vCSenderOrganizationId, vCPermissions, vCCorrelationId, saveSymEgressKey);
logger.info("CALL TO METHOD 'saveSymEgressKey' ENDED");
return resp.getData();
@@ -472,6 +471,7 @@ public InlineResponse2013 saveSymEgressKey(String vCSenderOrganizationId, String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse saveSymEgressKeyWithHttpInfo(String vCSenderOrganizationId, String vCPermissions, String vCCorrelationId, SaveSymEgressKey saveSymEgressKey) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = saveSymEgressKeyValidateBeforeCall(vCSenderOrganizationId, vCPermissions, vCCorrelationId, saveSymEgressKey, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/CreditApi.java b/src/main/java/Api/CreditApi.java
index ebf3dbd7d..ca1bc8f95 100644
--- a/src/main/java/Api/CreditApi.java
+++ b/src/main/java/Api/CreditApi.java
@@ -153,7 +153,6 @@ private okhttp3.Call createCreditValidateBeforeCall(CreateCreditRequest createCr
*/
public PtsV2CreditsPost201Response createCredit(CreateCreditRequest createCreditRequest) throws ApiException {
logger.info("CALL TO METHOD 'createCredit' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = createCreditWithHttpInfo(createCreditRequest);
logger.info("CALL TO METHOD 'createCredit' ENDED");
return resp.getData();
@@ -167,6 +166,7 @@ public PtsV2CreditsPost201Response createCredit(CreateCreditRequest createCredit
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse createCreditWithHttpInfo(CreateCreditRequest createCreditRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = createCreditValidateBeforeCall(createCreditRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/CustomerApi.java b/src/main/java/Api/CustomerApi.java
index de76748d8..3db8e9164 100644
--- a/src/main/java/Api/CustomerApi.java
+++ b/src/main/java/Api/CustomerApi.java
@@ -165,7 +165,6 @@ private okhttp3.Call deleteCustomerValidateBeforeCall(String customerId, String
*/
public void deleteCustomer(String customerId, String profileId) throws ApiException {
logger.info("CALL TO METHOD 'deleteCustomer' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
deleteCustomerWithHttpInfo(customerId, profileId);
}
@@ -179,6 +178,7 @@ public void deleteCustomer(String customerId, String profileId) throws ApiExcept
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse deleteCustomerWithHttpInfo(String customerId, String profileId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = deleteCustomerValidateBeforeCall(customerId, profileId, null, null);
return apiClient.execute(call);
}
@@ -313,7 +313,6 @@ private okhttp3.Call getCustomerValidateBeforeCall(String customerId, String pro
*/
public PostCustomerRequest getCustomer(String customerId, String profileId) throws ApiException {
logger.info("CALL TO METHOD 'getCustomer' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getCustomerWithHttpInfo(customerId, profileId);
logger.info("CALL TO METHOD 'getCustomer' ENDED");
return resp.getData();
@@ -328,6 +327,7 @@ public PostCustomerRequest getCustomer(String customerId, String profileId) thro
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getCustomerWithHttpInfo(String customerId, String profileId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getCustomerValidateBeforeCall(customerId, profileId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -473,7 +473,6 @@ private okhttp3.Call patchCustomerValidateBeforeCall(String customerId, PatchCus
*/
public PatchCustomerRequest patchCustomer(String customerId, PatchCustomerRequest patchCustomerRequest, String profileId, String ifMatch) throws ApiException {
logger.info("CALL TO METHOD 'patchCustomer' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = patchCustomerWithHttpInfo(customerId, patchCustomerRequest, profileId, ifMatch);
logger.info("CALL TO METHOD 'patchCustomer' ENDED");
return resp.getData();
@@ -490,6 +489,7 @@ public PatchCustomerRequest patchCustomer(String customerId, PatchCustomerReques
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse patchCustomerWithHttpInfo(String customerId, PatchCustomerRequest patchCustomerRequest, String profileId, String ifMatch) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = patchCustomerValidateBeforeCall(customerId, patchCustomerRequest, profileId, ifMatch, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -624,7 +624,6 @@ private okhttp3.Call postCustomerValidateBeforeCall(PostCustomerRequest postCust
*/
public PostCustomerRequest postCustomer(PostCustomerRequest postCustomerRequest, String profileId) throws ApiException {
logger.info("CALL TO METHOD 'postCustomer' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = postCustomerWithHttpInfo(postCustomerRequest, profileId);
logger.info("CALL TO METHOD 'postCustomer' ENDED");
return resp.getData();
@@ -639,6 +638,7 @@ public PostCustomerRequest postCustomer(PostCustomerRequest postCustomerRequest,
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse postCustomerWithHttpInfo(PostCustomerRequest postCustomerRequest, String profileId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = postCustomerValidateBeforeCall(postCustomerRequest, profileId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/CustomerPaymentInstrumentApi.java b/src/main/java/Api/CustomerPaymentInstrumentApi.java
index fdbaddde6..e4ea77906 100644
--- a/src/main/java/Api/CustomerPaymentInstrumentApi.java
+++ b/src/main/java/Api/CustomerPaymentInstrumentApi.java
@@ -175,7 +175,6 @@ private okhttp3.Call deleteCustomerPaymentInstrumentValidateBeforeCall(String cu
*/
public void deleteCustomerPaymentInstrument(String customerId, String paymentInstrumentId, String profileId) throws ApiException {
logger.info("CALL TO METHOD 'deleteCustomerPaymentInstrument' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
deleteCustomerPaymentInstrumentWithHttpInfo(customerId, paymentInstrumentId, profileId);
}
@@ -190,6 +189,7 @@ public void deleteCustomerPaymentInstrument(String customerId, String paymentIns
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse deleteCustomerPaymentInstrumentWithHttpInfo(String customerId, String paymentInstrumentId, String profileId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = deleteCustomerPaymentInstrumentValidateBeforeCall(customerId, paymentInstrumentId, profileId, null, null);
return apiClient.execute(call);
}
@@ -334,7 +334,6 @@ private okhttp3.Call getCustomerPaymentInstrumentValidateBeforeCall(String custo
*/
public PostCustomerPaymentInstrumentRequest getCustomerPaymentInstrument(String customerId, String paymentInstrumentId, String profileId) throws ApiException {
logger.info("CALL TO METHOD 'getCustomerPaymentInstrument' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getCustomerPaymentInstrumentWithHttpInfo(customerId, paymentInstrumentId, profileId);
logger.info("CALL TO METHOD 'getCustomerPaymentInstrument' ENDED");
return resp.getData();
@@ -350,6 +349,7 @@ public PostCustomerPaymentInstrumentRequest getCustomerPaymentInstrument(String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getCustomerPaymentInstrumentWithHttpInfo(String customerId, String paymentInstrumentId, String profileId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getCustomerPaymentInstrumentValidateBeforeCall(customerId, paymentInstrumentId, profileId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -495,7 +495,6 @@ private okhttp3.Call getCustomerPaymentInstrumentsListValidateBeforeCall(String
*/
public PaymentInstrumentList getCustomerPaymentInstrumentsList(String customerId, String profileId, Long offset, Long limit) throws ApiException {
logger.info("CALL TO METHOD 'getCustomerPaymentInstrumentsList' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getCustomerPaymentInstrumentsListWithHttpInfo(customerId, profileId, offset, limit);
logger.info("CALL TO METHOD 'getCustomerPaymentInstrumentsList' ENDED");
return resp.getData();
@@ -512,6 +511,7 @@ public PaymentInstrumentList getCustomerPaymentInstrumentsList(String customerId
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getCustomerPaymentInstrumentsListWithHttpInfo(String customerId, String profileId, Long offset, Long limit) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getCustomerPaymentInstrumentsListValidateBeforeCall(customerId, profileId, offset, limit, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -668,7 +668,6 @@ private okhttp3.Call patchCustomersPaymentInstrumentValidateBeforeCall(String cu
*/
public PatchCustomerPaymentInstrumentRequest patchCustomersPaymentInstrument(String customerId, String paymentInstrumentId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch) throws ApiException {
logger.info("CALL TO METHOD 'patchCustomersPaymentInstrument' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = patchCustomersPaymentInstrumentWithHttpInfo(customerId, paymentInstrumentId, patchCustomerPaymentInstrumentRequest, profileId, ifMatch);
logger.info("CALL TO METHOD 'patchCustomersPaymentInstrument' ENDED");
return resp.getData();
@@ -686,6 +685,7 @@ public PatchCustomerPaymentInstrumentRequest patchCustomersPaymentInstrument(Str
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse patchCustomersPaymentInstrumentWithHttpInfo(String customerId, String paymentInstrumentId, PatchCustomerPaymentInstrumentRequest patchCustomerPaymentInstrumentRequest, String profileId, String ifMatch) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = patchCustomersPaymentInstrumentValidateBeforeCall(customerId, paymentInstrumentId, patchCustomerPaymentInstrumentRequest, profileId, ifMatch, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -830,7 +830,6 @@ private okhttp3.Call postCustomerPaymentInstrumentValidateBeforeCall(String cust
*/
public PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrument(String customerId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId) throws ApiException {
logger.info("CALL TO METHOD 'postCustomerPaymentInstrument' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = postCustomerPaymentInstrumentWithHttpInfo(customerId, postCustomerPaymentInstrumentRequest, profileId);
logger.info("CALL TO METHOD 'postCustomerPaymentInstrument' ENDED");
return resp.getData();
@@ -846,6 +845,7 @@ public PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrument(String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse postCustomerPaymentInstrumentWithHttpInfo(String customerId, PostCustomerPaymentInstrumentRequest postCustomerPaymentInstrumentRequest, String profileId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = postCustomerPaymentInstrumentValidateBeforeCall(customerId, postCustomerPaymentInstrumentRequest, profileId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/CustomerShippingAddressApi.java b/src/main/java/Api/CustomerShippingAddressApi.java
index 9c4ed7e49..3a0afe673 100644
--- a/src/main/java/Api/CustomerShippingAddressApi.java
+++ b/src/main/java/Api/CustomerShippingAddressApi.java
@@ -175,7 +175,6 @@ private okhttp3.Call deleteCustomerShippingAddressValidateBeforeCall(String cust
*/
public void deleteCustomerShippingAddress(String customerId, String shippingAddressId, String profileId) throws ApiException {
logger.info("CALL TO METHOD 'deleteCustomerShippingAddress' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
deleteCustomerShippingAddressWithHttpInfo(customerId, shippingAddressId, profileId);
}
@@ -190,6 +189,7 @@ public void deleteCustomerShippingAddress(String customerId, String shippingAddr
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse deleteCustomerShippingAddressWithHttpInfo(String customerId, String shippingAddressId, String profileId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = deleteCustomerShippingAddressValidateBeforeCall(customerId, shippingAddressId, profileId, null, null);
return apiClient.execute(call);
}
@@ -334,7 +334,6 @@ private okhttp3.Call getCustomerShippingAddressValidateBeforeCall(String custome
*/
public PostCustomerShippingAddressRequest getCustomerShippingAddress(String customerId, String shippingAddressId, String profileId) throws ApiException {
logger.info("CALL TO METHOD 'getCustomerShippingAddress' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getCustomerShippingAddressWithHttpInfo(customerId, shippingAddressId, profileId);
logger.info("CALL TO METHOD 'getCustomerShippingAddress' ENDED");
return resp.getData();
@@ -350,6 +349,7 @@ public PostCustomerShippingAddressRequest getCustomerShippingAddress(String cust
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getCustomerShippingAddressWithHttpInfo(String customerId, String shippingAddressId, String profileId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getCustomerShippingAddressValidateBeforeCall(customerId, shippingAddressId, profileId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -495,7 +495,6 @@ private okhttp3.Call getCustomerShippingAddressesListValidateBeforeCall(String c
*/
public ShippingAddressListForCustomer getCustomerShippingAddressesList(String customerId, String profileId, Long offset, Long limit) throws ApiException {
logger.info("CALL TO METHOD 'getCustomerShippingAddressesList' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getCustomerShippingAddressesListWithHttpInfo(customerId, profileId, offset, limit);
logger.info("CALL TO METHOD 'getCustomerShippingAddressesList' ENDED");
return resp.getData();
@@ -512,6 +511,7 @@ public ShippingAddressListForCustomer getCustomerShippingAddressesList(String cu
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getCustomerShippingAddressesListWithHttpInfo(String customerId, String profileId, Long offset, Long limit) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getCustomerShippingAddressesListValidateBeforeCall(customerId, profileId, offset, limit, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -668,7 +668,6 @@ private okhttp3.Call patchCustomersShippingAddressValidateBeforeCall(String cust
*/
public PatchCustomerShippingAddressRequest patchCustomersShippingAddress(String customerId, String shippingAddressId, PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest, String profileId, String ifMatch) throws ApiException {
logger.info("CALL TO METHOD 'patchCustomersShippingAddress' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = patchCustomersShippingAddressWithHttpInfo(customerId, shippingAddressId, patchCustomerShippingAddressRequest, profileId, ifMatch);
logger.info("CALL TO METHOD 'patchCustomersShippingAddress' ENDED");
return resp.getData();
@@ -686,6 +685,7 @@ public PatchCustomerShippingAddressRequest patchCustomersShippingAddress(String
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse patchCustomersShippingAddressWithHttpInfo(String customerId, String shippingAddressId, PatchCustomerShippingAddressRequest patchCustomerShippingAddressRequest, String profileId, String ifMatch) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = patchCustomersShippingAddressValidateBeforeCall(customerId, shippingAddressId, patchCustomerShippingAddressRequest, profileId, ifMatch, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -830,7 +830,6 @@ private okhttp3.Call postCustomerShippingAddressValidateBeforeCall(String custom
*/
public PostCustomerShippingAddressRequest postCustomerShippingAddress(String customerId, PostCustomerShippingAddressRequest postCustomerShippingAddressRequest, String profileId) throws ApiException {
logger.info("CALL TO METHOD 'postCustomerShippingAddress' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = postCustomerShippingAddressWithHttpInfo(customerId, postCustomerShippingAddressRequest, profileId);
logger.info("CALL TO METHOD 'postCustomerShippingAddress' ENDED");
return resp.getData();
@@ -846,6 +845,7 @@ public PostCustomerShippingAddressRequest postCustomerShippingAddress(String cus
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse postCustomerShippingAddressWithHttpInfo(String customerId, PostCustomerShippingAddressRequest postCustomerShippingAddressRequest, String profileId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = postCustomerShippingAddressValidateBeforeCall(customerId, postCustomerShippingAddressRequest, profileId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/DecisionManagerApi.java b/src/main/java/Api/DecisionManagerApi.java
index 239b78b99..449da606a 100644
--- a/src/main/java/Api/DecisionManagerApi.java
+++ b/src/main/java/Api/DecisionManagerApi.java
@@ -176,7 +176,6 @@ private okhttp3.Call actionDecisionManagerCaseValidateBeforeCall(String id, Case
*/
public InlineResponse200 actionDecisionManagerCase(String id, CaseManagementActionsRequest caseManagementActionsRequest) throws ApiException {
logger.info("CALL TO METHOD 'actionDecisionManagerCase' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = actionDecisionManagerCaseWithHttpInfo(id, caseManagementActionsRequest);
logger.info("CALL TO METHOD 'actionDecisionManagerCase' ENDED");
return resp.getData();
@@ -191,6 +190,7 @@ public InlineResponse200 actionDecisionManagerCase(String id, CaseManagementActi
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse actionDecisionManagerCaseWithHttpInfo(String id, CaseManagementActionsRequest caseManagementActionsRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = actionDecisionManagerCaseValidateBeforeCall(id, caseManagementActionsRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -328,7 +328,6 @@ private okhttp3.Call addNegativeValidateBeforeCall(String type, AddNegativeListR
*/
public RiskV1UpdatePost201Response addNegative(String type, AddNegativeListRequest addNegativeListRequest) throws ApiException {
logger.info("CALL TO METHOD 'addNegative' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = addNegativeWithHttpInfo(type, addNegativeListRequest);
logger.info("CALL TO METHOD 'addNegative' ENDED");
return resp.getData();
@@ -343,6 +342,7 @@ public RiskV1UpdatePost201Response addNegative(String type, AddNegativeListReque
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse addNegativeWithHttpInfo(String type, AddNegativeListRequest addNegativeListRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = addNegativeValidateBeforeCall(type, addNegativeListRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -480,7 +480,6 @@ private okhttp3.Call commentDecisionManagerCaseValidateBeforeCall(String id, Cas
*/
public InlineResponse201 commentDecisionManagerCase(String id, CaseManagementCommentsRequest caseManagementCommentsRequest) throws ApiException {
logger.info("CALL TO METHOD 'commentDecisionManagerCase' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = commentDecisionManagerCaseWithHttpInfo(id, caseManagementCommentsRequest);
logger.info("CALL TO METHOD 'commentDecisionManagerCase' ENDED");
return resp.getData();
@@ -495,6 +494,7 @@ public InlineResponse201 commentDecisionManagerCase(String id, CaseManagementCom
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse commentDecisionManagerCaseWithHttpInfo(String id, CaseManagementCommentsRequest caseManagementCommentsRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = commentDecisionManagerCaseValidateBeforeCall(id, caseManagementCommentsRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -623,7 +623,6 @@ private okhttp3.Call createBundledDecisionManagerCaseValidateBeforeCall(CreateBu
*/
public RiskV1DecisionsPost201Response createBundledDecisionManagerCase(CreateBundledDecisionManagerCaseRequest createBundledDecisionManagerCaseRequest) throws ApiException {
logger.info("CALL TO METHOD 'createBundledDecisionManagerCase' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = createBundledDecisionManagerCaseWithHttpInfo(createBundledDecisionManagerCaseRequest);
logger.info("CALL TO METHOD 'createBundledDecisionManagerCase' ENDED");
return resp.getData();
@@ -637,6 +636,7 @@ public RiskV1DecisionsPost201Response createBundledDecisionManagerCase(CreateBun
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse createBundledDecisionManagerCaseWithHttpInfo(CreateBundledDecisionManagerCaseRequest createBundledDecisionManagerCaseRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = createBundledDecisionManagerCaseValidateBeforeCall(createBundledDecisionManagerCaseRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -773,7 +773,6 @@ private okhttp3.Call fraudUpdateValidateBeforeCall(String id, FraudMarkingAction
*/
public RiskV1UpdatePost201Response fraudUpdate(String id, FraudMarkingActionRequest fraudMarkingActionRequest) throws ApiException {
logger.info("CALL TO METHOD 'fraudUpdate' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = fraudUpdateWithHttpInfo(id, fraudMarkingActionRequest);
logger.info("CALL TO METHOD 'fraudUpdate' ENDED");
return resp.getData();
@@ -788,6 +787,7 @@ public RiskV1UpdatePost201Response fraudUpdate(String id, FraudMarkingActionRequ
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse fraudUpdateWithHttpInfo(String id, FraudMarkingActionRequest fraudMarkingActionRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = fraudUpdateValidateBeforeCall(id, fraudMarkingActionRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/DownloadDtdApi.java b/src/main/java/Api/DownloadDtdApi.java
index e98749d49..029b557fd 100644
--- a/src/main/java/Api/DownloadDtdApi.java
+++ b/src/main/java/Api/DownloadDtdApi.java
@@ -152,7 +152,6 @@ private okhttp3.Call getDTDV2ValidateBeforeCall(String reportDefinitionNameVersi
*/
public void getDTDV2(String reportDefinitionNameVersion) throws ApiException {
logger.info("CALL TO METHOD 'getDTDV2' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
getDTDV2WithHttpInfo(reportDefinitionNameVersion);
}
@@ -165,6 +164,7 @@ public void getDTDV2(String reportDefinitionNameVersion) throws ApiException {
* @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 {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getDTDV2ValidateBeforeCall(reportDefinitionNameVersion, null, null);
return apiClient.execute(call);
}
diff --git a/src/main/java/Api/DownloadXsdApi.java b/src/main/java/Api/DownloadXsdApi.java
index 96cd218ad..85103b845 100644
--- a/src/main/java/Api/DownloadXsdApi.java
+++ b/src/main/java/Api/DownloadXsdApi.java
@@ -152,7 +152,6 @@ private okhttp3.Call getXSDV2ValidateBeforeCall(String reportDefinitionNameVersi
*/
public void getXSDV2(String reportDefinitionNameVersion) throws ApiException {
logger.info("CALL TO METHOD 'getXSDV2' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
getXSDV2WithHttpInfo(reportDefinitionNameVersion);
}
@@ -165,6 +164,7 @@ public void getXSDV2(String reportDefinitionNameVersion) throws ApiException {
* @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 {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getXSDV2ValidateBeforeCall(reportDefinitionNameVersion, null, null);
return apiClient.execute(call);
}
diff --git a/src/main/java/Api/EmvTagDetailsApi.java b/src/main/java/Api/EmvTagDetailsApi.java
index a10f74a3b..ef9fba537 100644
--- a/src/main/java/Api/EmvTagDetailsApi.java
+++ b/src/main/java/Api/EmvTagDetailsApi.java
@@ -147,7 +147,6 @@ private okhttp3.Call getEmvTagsValidateBeforeCall(final ProgressResponseBody.Pro
*/
public TssV2GetEmvTags200Response getEmvTags() throws ApiException {
logger.info("CALL TO METHOD 'getEmvTags' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getEmvTagsWithHttpInfo();
logger.info("CALL TO METHOD 'getEmvTags' ENDED");
return resp.getData();
@@ -160,6 +159,7 @@ public TssV2GetEmvTags200Response getEmvTags() throws ApiException {
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getEmvTagsWithHttpInfo() throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getEmvTagsValidateBeforeCall(null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -286,7 +286,6 @@ private okhttp3.Call parseEmvTagsValidateBeforeCall(Body body, final ProgressRes
*/
public TssV2PostEmvTags200Response parseEmvTags(Body body) throws ApiException {
logger.info("CALL TO METHOD 'parseEmvTags' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = parseEmvTagsWithHttpInfo(body);
logger.info("CALL TO METHOD 'parseEmvTags' ENDED");
return resp.getData();
@@ -300,6 +299,7 @@ public TssV2PostEmvTags200Response parseEmvTags(Body body) throws ApiException {
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse parseEmvTagsWithHttpInfo(Body body) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = parseEmvTagsValidateBeforeCall(body, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/FlexApiApi.java b/src/main/java/Api/FlexApiApi.java
index 2af1056a0..245b1d4f0 100644
--- a/src/main/java/Api/FlexApiApi.java
+++ b/src/main/java/Api/FlexApiApi.java
@@ -151,7 +151,6 @@ private okhttp3.Call generateFlexAPICaptureContextValidateBeforeCall(GenerateFle
*/
public String generateFlexAPICaptureContext(GenerateFlexAPICaptureContextRequest generateFlexAPICaptureContextRequest) throws ApiException {
logger.info("CALL TO METHOD 'generateFlexAPICaptureContext' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = generateFlexAPICaptureContextWithHttpInfo(generateFlexAPICaptureContextRequest);
logger.info("CALL TO METHOD 'generateFlexAPICaptureContext' ENDED");
return resp.getData();
@@ -165,6 +164,7 @@ public String generateFlexAPICaptureContext(GenerateFlexAPICaptureContextRequest
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse generateFlexAPICaptureContextWithHttpInfo(GenerateFlexAPICaptureContextRequest generateFlexAPICaptureContextRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = generateFlexAPICaptureContextValidateBeforeCall(generateFlexAPICaptureContextRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/InstrumentIdentifierApi.java b/src/main/java/Api/InstrumentIdentifierApi.java
index 36ba14d3d..4edb3741b 100644
--- a/src/main/java/Api/InstrumentIdentifierApi.java
+++ b/src/main/java/Api/InstrumentIdentifierApi.java
@@ -167,7 +167,6 @@ private okhttp3.Call deleteInstrumentIdentifierValidateBeforeCall(String instrum
*/
public void deleteInstrumentIdentifier(String instrumentIdentifierId, String profileId) throws ApiException {
logger.info("CALL TO METHOD 'deleteInstrumentIdentifier' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
deleteInstrumentIdentifierWithHttpInfo(instrumentIdentifierId, profileId);
}
@@ -181,6 +180,7 @@ public void deleteInstrumentIdentifier(String instrumentIdentifierId, String pro
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse deleteInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId, String profileId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = deleteInstrumentIdentifierValidateBeforeCall(instrumentIdentifierId, profileId, null, null);
return apiClient.execute(call);
}
@@ -224,12 +224,13 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
* Build call for getInstrumentIdentifier
* @param instrumentIdentifierId The Id of an Instrument Identifier. (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (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 okhttp3.Call getInstrumentIdentifierCall(String instrumentIdentifierId, String profileId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ public okhttp3.Call getInstrumentIdentifierCall(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
SdkTracker sdkTracker = new SdkTracker();
Object localVarPostBody = null;
if ("GET".equalsIgnoreCase("POST")) {
@@ -251,6 +252,8 @@ public okhttp3.Call getInstrumentIdentifierCall(String instrumentIdentifierId, S
.replaceAll("\\{" + "instrumentIdentifierId" + "\\}", apiClient.escapeString(instrumentIdentifierId.toString()));
List localVarQueryParams = new ArrayList();
+ if (retrieveBinDetails != null)
+ localVarQueryParams.addAll(apiClient.parameterToPairs("", "retrieveBinDetails", retrieveBinDetails));
Map localVarHeaderParams = new HashMap();
if (profileId != null)
@@ -287,7 +290,7 @@ public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOExce
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call getInstrumentIdentifierValidateBeforeCall(String instrumentIdentifierId, String profileId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ private okhttp3.Call getInstrumentIdentifierValidateBeforeCall(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
// verify the required parameter 'instrumentIdentifierId' is set
if (instrumentIdentifierId == null) {
@@ -296,7 +299,7 @@ private okhttp3.Call getInstrumentIdentifierValidateBeforeCall(String instrument
}
- okhttp3.Call call = getInstrumentIdentifierCall(instrumentIdentifierId, profileId, progressListener, progressRequestListener);
+ okhttp3.Call call = getInstrumentIdentifierCall(instrumentIdentifierId, profileId, retrieveBinDetails, progressListener, progressRequestListener);
return call;
@@ -310,13 +313,13 @@ private okhttp3.Call getInstrumentIdentifierValidateBeforeCall(String instrument
* | | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>**Retrieving an Instrument Identifier**<br>Your system can use this API to retrieve an Instrument Identifier.<br>**Note: the actual card data will be masked.**<br>The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).| |**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Instrument Identifiers**<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
* @param instrumentIdentifierId The Id of an Instrument Identifier. (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (optional)
* @return PostInstrumentIdentifierRequest
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public PostInstrumentIdentifierRequest getInstrumentIdentifier(String instrumentIdentifierId, String profileId) throws ApiException {
+ public PostInstrumentIdentifierRequest getInstrumentIdentifier(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails) throws ApiException {
logger.info("CALL TO METHOD 'getInstrumentIdentifier' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
- ApiResponse resp = getInstrumentIdentifierWithHttpInfo(instrumentIdentifierId, profileId);
+ ApiResponse resp = getInstrumentIdentifierWithHttpInfo(instrumentIdentifierId, profileId, retrieveBinDetails);
logger.info("CALL TO METHOD 'getInstrumentIdentifier' ENDED");
return resp.getData();
}
@@ -326,11 +329,13 @@ public PostInstrumentIdentifierRequest getInstrumentIdentifier(String instrument
* | | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>**Retrieving an Instrument Identifier**<br>Your system can use this API to retrieve an Instrument Identifier.<br>**Note: the actual card data will be masked.**<br>The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).| |**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Instrument Identifiers**<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
* @param instrumentIdentifierId The Id of an Instrument Identifier. (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (optional)
* @return ApiResponse<PostInstrumentIdentifierRequest>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public ApiResponse getInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId, String profileId) throws ApiException {
- okhttp3.Call call = getInstrumentIdentifierValidateBeforeCall(instrumentIdentifierId, profileId, null, null);
+ public ApiResponse getInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
+ okhttp3.Call call = getInstrumentIdentifierValidateBeforeCall(instrumentIdentifierId, profileId, retrieveBinDetails, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
}
@@ -340,11 +345,12 @@ public ApiResponse getInstrumentIdentifierWithH
* | | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>**Retrieving an Instrument Identifier**<br>Your system can use this API to retrieve an Instrument Identifier.<br>**Note: the actual card data will be masked.**<br>The Instrument Identifier will also be returned when retrieving a [Customer](#token-management_customer_retrieve-a-customer), [Customer Payment Instrument](#token-management_customer-payment-instrument_retrieve-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_retrieve-a-payment-instrument).| |**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Instrument Identifiers**<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
* @param instrumentIdentifierId The Id of an Instrument Identifier. (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (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 okhttp3.Call getInstrumentIdentifierAsync(String instrumentIdentifierId, String profileId, final ApiCallback callback) throws ApiException {
+ public okhttp3.Call getInstrumentIdentifierAsync(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, final ApiCallback callback) throws ApiException {
this.apiClient.setComputationStartTime(System.nanoTime());
ProgressResponseBody.ProgressListener progressListener = null;
@@ -366,7 +372,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
};
}
- okhttp3.Call call = getInstrumentIdentifierValidateBeforeCall(instrumentIdentifierId, profileId, progressListener, progressRequestListener);
+ okhttp3.Call call = getInstrumentIdentifierValidateBeforeCall(instrumentIdentifierId, profileId, retrieveBinDetails, progressListener, progressRequestListener);
Type localVarReturnType = new TypeToken(){}.getType();
apiClient.executeAsync(call, localVarReturnType, callback);
return call;
@@ -375,6 +381,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
* Build call for getInstrumentIdentifierPaymentInstrumentsList
* @param instrumentIdentifierId The Id of an Instrument Identifier. (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (optional)
* @param offset Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)
* @param limit The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)
* @param progressListener Progress listener
@@ -382,7 +389,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
*/
- public okhttp3.Call getInstrumentIdentifierPaymentInstrumentsListCall(String instrumentIdentifierId, String profileId, Long offset, Long limit, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ public okhttp3.Call getInstrumentIdentifierPaymentInstrumentsListCall(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, Long offset, Long limit, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
SdkTracker sdkTracker = new SdkTracker();
Object localVarPostBody = null;
if ("GET".equalsIgnoreCase("POST")) {
@@ -404,6 +411,8 @@ public okhttp3.Call getInstrumentIdentifierPaymentInstrumentsListCall(String ins
.replaceAll("\\{" + "instrumentIdentifierId" + "\\}", apiClient.escapeString(instrumentIdentifierId.toString()));
List localVarQueryParams = new ArrayList();
+ if (retrieveBinDetails != null)
+ localVarQueryParams.addAll(apiClient.parameterToPairs("", "retrieveBinDetails", retrieveBinDetails));
if (offset != null)
localVarQueryParams.addAll(apiClient.parameterToPairs("", "offset", offset));
if (limit != null)
@@ -444,7 +453,7 @@ public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOExce
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call getInstrumentIdentifierPaymentInstrumentsListValidateBeforeCall(String instrumentIdentifierId, String profileId, Long offset, Long limit, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ private okhttp3.Call getInstrumentIdentifierPaymentInstrumentsListValidateBeforeCall(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, Long offset, Long limit, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
// verify the required parameter 'instrumentIdentifierId' is set
if (instrumentIdentifierId == null) {
@@ -453,7 +462,7 @@ private okhttp3.Call getInstrumentIdentifierPaymentInstrumentsListValidateBefore
}
- okhttp3.Call call = getInstrumentIdentifierPaymentInstrumentsListCall(instrumentIdentifierId, profileId, offset, limit, progressListener, progressRequestListener);
+ okhttp3.Call call = getInstrumentIdentifierPaymentInstrumentsListCall(instrumentIdentifierId, profileId, retrieveBinDetails, offset, limit, progressListener, progressRequestListener);
return call;
@@ -467,15 +476,15 @@ private okhttp3.Call getInstrumentIdentifierPaymentInstrumentsListValidateBefore
* | | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Retrieving all Payment Instruments associated with an Instrument Identifier**<br>Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.
* @param instrumentIdentifierId The Id of an Instrument Identifier. (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (optional)
* @param offset Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)
* @param limit The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)
* @return PaymentInstrumentList1
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public PaymentInstrumentList1 getInstrumentIdentifierPaymentInstrumentsList(String instrumentIdentifierId, String profileId, Long offset, Long limit) throws ApiException {
+ public PaymentInstrumentList1 getInstrumentIdentifierPaymentInstrumentsList(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, Long offset, Long limit) throws ApiException {
logger.info("CALL TO METHOD 'getInstrumentIdentifierPaymentInstrumentsList' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
- ApiResponse resp = getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo(instrumentIdentifierId, profileId, offset, limit);
+ ApiResponse resp = getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo(instrumentIdentifierId, profileId, retrieveBinDetails, offset, limit);
logger.info("CALL TO METHOD 'getInstrumentIdentifierPaymentInstrumentsList' ENDED");
return resp.getData();
}
@@ -485,13 +494,15 @@ public PaymentInstrumentList1 getInstrumentIdentifierPaymentInstrumentsList(Stri
* | | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Retrieving all Payment Instruments associated with an Instrument Identifier**<br>Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.
* @param instrumentIdentifierId The Id of an Instrument Identifier. (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (optional)
* @param offset Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)
* @param limit The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)
* @return ApiResponse<PaymentInstrumentList1>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public ApiResponse getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo(String instrumentIdentifierId, String profileId, Long offset, Long limit) throws ApiException {
- okhttp3.Call call = getInstrumentIdentifierPaymentInstrumentsListValidateBeforeCall(instrumentIdentifierId, profileId, offset, limit, null, null);
+ public ApiResponse getInstrumentIdentifierPaymentInstrumentsListWithHttpInfo(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, Long offset, Long limit) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
+ okhttp3.Call call = getInstrumentIdentifierPaymentInstrumentsListValidateBeforeCall(instrumentIdentifierId, profileId, retrieveBinDetails, offset, limit, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
}
@@ -501,13 +512,14 @@ public ApiResponse getInstrumentIdentifierPaymentInstrum
* | | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing <br>and account numbers.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the <br>Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) <br>or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).| |**Retrieving all Payment Instruments associated with an Instrument Identifier**<br>Your system can use this API to retrieve all Payment Instruments linked to an Instrument Identifier.
* @param instrumentIdentifierId The Id of an Instrument Identifier. (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (optional)
* @param offset Starting record in zero-based dataset that should be returned as the first object in the array. Default is 0. (optional, default to 0)
* @param limit The maximum number that can be returned in the array starting from the offset record in zero-based dataset. Default is 20, maximum is 100. (optional, default to 20)
* @param callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
*/
- public okhttp3.Call getInstrumentIdentifierPaymentInstrumentsListAsync(String instrumentIdentifierId, String profileId, Long offset, Long limit, final ApiCallback callback) throws ApiException {
+ public okhttp3.Call getInstrumentIdentifierPaymentInstrumentsListAsync(String instrumentIdentifierId, String profileId, Boolean retrieveBinDetails, Long offset, Long limit, final ApiCallback callback) throws ApiException {
this.apiClient.setComputationStartTime(System.nanoTime());
ProgressResponseBody.ProgressListener progressListener = null;
@@ -529,7 +541,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
};
}
- okhttp3.Call call = getInstrumentIdentifierPaymentInstrumentsListValidateBeforeCall(instrumentIdentifierId, profileId, offset, limit, progressListener, progressRequestListener);
+ okhttp3.Call call = getInstrumentIdentifierPaymentInstrumentsListValidateBeforeCall(instrumentIdentifierId, profileId, retrieveBinDetails, offset, limit, progressListener, progressRequestListener);
Type localVarReturnType = new TypeToken(){}.getType();
apiClient.executeAsync(call, localVarReturnType, callback);
return call;
@@ -539,13 +551,14 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
* @param instrumentIdentifierId The Id of an Instrument Identifier. (required)
* @param patchInstrumentIdentifierRequest Specify the previous transaction Id to update. (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (optional)
* @param ifMatch Contains an ETag value from a GET request to make the request conditional. (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 okhttp3.Call patchInstrumentIdentifierCall(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ public okhttp3.Call patchInstrumentIdentifierCall(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
SdkTracker sdkTracker = new SdkTracker();
Object localVarPostBody = sdkTracker.insertDeveloperIdTracker(patchInstrumentIdentifierRequest, PatchInstrumentIdentifierRequest.class.getSimpleName(), apiClient.merchantConfig.getRunEnvironment(), apiClient.merchantConfig.getDefaultDeveloperId());
@@ -564,6 +577,8 @@ public okhttp3.Call patchInstrumentIdentifierCall(String instrumentIdentifierId,
.replaceAll("\\{" + "instrumentIdentifierId" + "\\}", apiClient.escapeString(instrumentIdentifierId.toString()));
List localVarQueryParams = new ArrayList();
+ if (retrieveBinDetails != null)
+ localVarQueryParams.addAll(apiClient.parameterToPairs("", "retrieveBinDetails", retrieveBinDetails));
Map localVarHeaderParams = new HashMap();
if (profileId != null)
@@ -602,7 +617,7 @@ public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOExce
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call patchInstrumentIdentifierValidateBeforeCall(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ private okhttp3.Call patchInstrumentIdentifierValidateBeforeCall(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, String ifMatch, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
// verify the required parameter 'instrumentIdentifierId' is set
if (instrumentIdentifierId == null) {
@@ -617,7 +632,7 @@ private okhttp3.Call patchInstrumentIdentifierValidateBeforeCall(String instrume
}
- okhttp3.Call call = patchInstrumentIdentifierCall(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, ifMatch, progressListener, progressRequestListener);
+ okhttp3.Call call = patchInstrumentIdentifierCall(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, retrieveBinDetails, ifMatch, progressListener, progressRequestListener);
return call;
@@ -632,14 +647,14 @@ private okhttp3.Call patchInstrumentIdentifierValidateBeforeCall(String instrume
* @param instrumentIdentifierId The Id of an Instrument Identifier. (required)
* @param patchInstrumentIdentifierRequest Specify the previous transaction Id to update. (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (optional)
* @param ifMatch Contains an ETag value from a GET request to make the request conditional. (optional)
* @return PatchInstrumentIdentifierRequest
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public PatchInstrumentIdentifierRequest patchInstrumentIdentifier(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, String ifMatch) throws ApiException {
+ public PatchInstrumentIdentifierRequest patchInstrumentIdentifier(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, String ifMatch) throws ApiException {
logger.info("CALL TO METHOD 'patchInstrumentIdentifier' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
- ApiResponse resp = patchInstrumentIdentifierWithHttpInfo(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, ifMatch);
+ ApiResponse resp = patchInstrumentIdentifierWithHttpInfo(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, retrieveBinDetails, ifMatch);
logger.info("CALL TO METHOD 'patchInstrumentIdentifier' ENDED");
return resp.getData();
}
@@ -650,12 +665,14 @@ public PatchInstrumentIdentifierRequest patchInstrumentIdentifier(String instrum
* @param instrumentIdentifierId The Id of an Instrument Identifier. (required)
* @param patchInstrumentIdentifierRequest Specify the previous transaction Id to update. (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (optional)
* @param ifMatch Contains an ETag value from a GET request to make the request conditional. (optional)
* @return ApiResponse<PatchInstrumentIdentifierRequest>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public ApiResponse patchInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, String ifMatch) throws ApiException {
- okhttp3.Call call = patchInstrumentIdentifierValidateBeforeCall(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, ifMatch, null, null);
+ public ApiResponse patchInstrumentIdentifierWithHttpInfo(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, String ifMatch) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
+ okhttp3.Call call = patchInstrumentIdentifierValidateBeforeCall(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, retrieveBinDetails, ifMatch, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
}
@@ -666,12 +683,13 @@ public ApiResponse patchInstrumentIdentifierWi
* @param instrumentIdentifierId The Id of an Instrument Identifier. (required)
* @param patchInstrumentIdentifierRequest Specify the previous transaction Id to update. (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (optional)
* @param ifMatch Contains an ETag value from a GET request to make the request conditional. (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 okhttp3.Call patchInstrumentIdentifierAsync(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, String ifMatch, final ApiCallback callback) throws ApiException {
+ public okhttp3.Call patchInstrumentIdentifierAsync(String instrumentIdentifierId, PatchInstrumentIdentifierRequest patchInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, String ifMatch, final ApiCallback callback) throws ApiException {
this.apiClient.setComputationStartTime(System.nanoTime());
ProgressResponseBody.ProgressListener progressListener = null;
@@ -693,7 +711,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
};
}
- okhttp3.Call call = patchInstrumentIdentifierValidateBeforeCall(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, ifMatch, progressListener, progressRequestListener);
+ okhttp3.Call call = patchInstrumentIdentifierValidateBeforeCall(instrumentIdentifierId, patchInstrumentIdentifierRequest, profileId, retrieveBinDetails, ifMatch, progressListener, progressRequestListener);
Type localVarReturnType = new TypeToken(){}.getType();
apiClient.executeAsync(call, localVarReturnType, callback);
return call;
@@ -702,12 +720,13 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
* Build call for postInstrumentIdentifier
* @param postInstrumentIdentifierRequest Specify either a Card, Bank Account or Enrollable Card (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (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 okhttp3.Call postInstrumentIdentifierCall(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ public okhttp3.Call postInstrumentIdentifierCall(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
SdkTracker sdkTracker = new SdkTracker();
Object localVarPostBody = sdkTracker.insertDeveloperIdTracker(postInstrumentIdentifierRequest, PostInstrumentIdentifierRequest.class.getSimpleName(), apiClient.merchantConfig.getRunEnvironment(), apiClient.merchantConfig.getDefaultDeveloperId());
@@ -725,6 +744,8 @@ public okhttp3.Call postInstrumentIdentifierCall(PostInstrumentIdentifierRequest
String localVarPath = "/tms/v1/instrumentidentifiers";
List localVarQueryParams = new ArrayList();
+ if (retrieveBinDetails != null)
+ localVarQueryParams.addAll(apiClient.parameterToPairs("", "retrieveBinDetails", retrieveBinDetails));
Map localVarHeaderParams = new HashMap();
if (profileId != null)
@@ -761,7 +782,7 @@ public okhttp3.Response intercept(okhttp3.Interceptor.Chain chain) throws IOExce
}
@SuppressWarnings("rawtypes")
- private okhttp3.Call postInstrumentIdentifierValidateBeforeCall(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
+ private okhttp3.Call postInstrumentIdentifierValidateBeforeCall(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, final ProgressResponseBody.ProgressListener progressListener, final ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException {
// verify the required parameter 'postInstrumentIdentifierRequest' is set
if (postInstrumentIdentifierRequest == null) {
@@ -770,7 +791,7 @@ private okhttp3.Call postInstrumentIdentifierValidateBeforeCall(PostInstrumentId
}
- okhttp3.Call call = postInstrumentIdentifierCall(postInstrumentIdentifierRequest, profileId, progressListener, progressRequestListener);
+ okhttp3.Call call = postInstrumentIdentifierCall(postInstrumentIdentifierRequest, profileId, retrieveBinDetails, progressListener, progressRequestListener);
return call;
@@ -784,13 +805,13 @@ private okhttp3.Call postInstrumentIdentifierValidateBeforeCall(PostInstrumentId
* | | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>**Creating an Instrument Identifier**<br>It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body)<br>In Europe: You should perform Payer Authentication alongside the Authorization.| |**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Instrument Identifiers**<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
* @param postInstrumentIdentifierRequest Specify either a Card, Bank Account or Enrollable Card (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (optional)
* @return PostInstrumentIdentifierRequest
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public PostInstrumentIdentifierRequest postInstrumentIdentifier(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId) throws ApiException {
+ public PostInstrumentIdentifierRequest postInstrumentIdentifier(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails) throws ApiException {
logger.info("CALL TO METHOD 'postInstrumentIdentifier' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
- ApiResponse resp = postInstrumentIdentifierWithHttpInfo(postInstrumentIdentifierRequest, profileId);
+ ApiResponse resp = postInstrumentIdentifierWithHttpInfo(postInstrumentIdentifierRequest, profileId, retrieveBinDetails);
logger.info("CALL TO METHOD 'postInstrumentIdentifier' ENDED");
return resp.getData();
}
@@ -800,11 +821,13 @@ public PostInstrumentIdentifierRequest postInstrumentIdentifier(PostInstrumentId
* | | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>**Creating an Instrument Identifier**<br>It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body)<br>In Europe: You should perform Payer Authentication alongside the Authorization.| |**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Instrument Identifiers**<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
* @param postInstrumentIdentifierRequest Specify either a Card, Bank Account or Enrollable Card (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (optional)
* @return ApiResponse<PostInstrumentIdentifierRequest>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
- public ApiResponse postInstrumentIdentifierWithHttpInfo(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId) throws ApiException {
- okhttp3.Call call = postInstrumentIdentifierValidateBeforeCall(postInstrumentIdentifierRequest, profileId, null, null);
+ public ApiResponse postInstrumentIdentifierWithHttpInfo(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
+ okhttp3.Call call = postInstrumentIdentifierValidateBeforeCall(postInstrumentIdentifierRequest, profileId, retrieveBinDetails, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
}
@@ -814,11 +837,12 @@ public ApiResponse postInstrumentIdentifierWith
* | | | | | --- | --- | --- | |**Instrument Identifiers**<br>An Instrument Identifier represents either a card number, or in the case of an ACH bank account, the routing and account number.<br>The same token Id is returned for a specific card number or bank account & routing number allowing the Instrument Identifier Id to be used for cross-channel payment tracking.<br>An Instrument Identifier can exist independently but also be associated with a [Customer Payment Instrument](#token-management_customer-payment-instrument_create-a-customer-payment-instrument) or [Standalone Payment Instrument](#token-management_payment-instrument_create-a-payment-instrument).<br><br>**Creating an Instrument Identifier**<br>It is recommended you [create an Instrument Identifier via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-instrument-identifier-token-creation_liveconsole-tab-request-body), this can be for a zero amount.<br>An Instrument Identifier will also be created if you [create a Customer via a Payment Authorization](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-with-token-create_authorization-with-customer-token-creation_liveconsole-tab-request-body)<br>In Europe: You should perform Payer Authentication alongside the Authorization.| |**Payment Network Tokens**<br>Network tokens perform better than regular card numbers and they are not necessarily invalidated when a cardholder loses their card, or it expires.<br>A Payment Network Token will be automatically created and used in future payments if you are enabled for the service.<br>A Payment Network Token can also be [provisioned for an existing Instrument Identifier](#token-management_instrument-identifier_enroll-an-instrument-identifier-for-payment-network-token).<br>For more information about Payment Network Tokens see the Developer Guide.<br><br>**Payments with Instrument Identifiers**<br>To perform a payment with an Instrument Identifier simply specify the [Instrument Identifier Id in the payments request along with the expiration date, card type, & billing address](#payments_payments_process-a-payment_samplerequests-dropdown_authorization-using-tokens_authorization-with-instrument-identifier-token-id_liveconsole-tab-request-body).<br>When an Instrument Identifier is used in a payment the **_previousTransactionId_** and **_originalAuthorizedAmount_** values are automatically recorded.<br>These values will be added for you to future Merchant Initiated Transaction payments.
* @param postInstrumentIdentifierRequest Specify either a Card, Bank Account or Enrollable Card (required)
* @param profileId The Id of a profile containing user specific TMS configuration. (optional)
+ * @param retrieveBinDetails Retrieve the Bin Details of PAN or network token (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 okhttp3.Call postInstrumentIdentifierAsync(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, final ApiCallback callback) throws ApiException {
+ public okhttp3.Call postInstrumentIdentifierAsync(PostInstrumentIdentifierRequest postInstrumentIdentifierRequest, String profileId, Boolean retrieveBinDetails, final ApiCallback callback) throws ApiException {
this.apiClient.setComputationStartTime(System.nanoTime());
ProgressResponseBody.ProgressListener progressListener = null;
@@ -840,7 +864,7 @@ public void onRequestProgress(long bytesWritten, long contentLength, boolean don
};
}
- okhttp3.Call call = postInstrumentIdentifierValidateBeforeCall(postInstrumentIdentifierRequest, profileId, progressListener, progressRequestListener);
+ okhttp3.Call call = postInstrumentIdentifierValidateBeforeCall(postInstrumentIdentifierRequest, profileId, retrieveBinDetails, progressListener, progressRequestListener);
Type localVarReturnType = new TypeToken(){}.getType();
apiClient.executeAsync(call, localVarReturnType, callback);
return call;
@@ -944,7 +968,6 @@ private okhttp3.Call postInstrumentIdentifierEnrollmentValidateBeforeCall(String
*/
public void postInstrumentIdentifierEnrollment(String instrumentIdentifierId, PostInstrumentIdentifierEnrollmentRequest postInstrumentIdentifierEnrollmentRequest, String profileId) throws ApiException {
logger.info("CALL TO METHOD 'postInstrumentIdentifierEnrollment' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
postInstrumentIdentifierEnrollmentWithHttpInfo(instrumentIdentifierId, postInstrumentIdentifierEnrollmentRequest, profileId);
}
@@ -959,6 +982,7 @@ public void postInstrumentIdentifierEnrollment(String instrumentIdentifierId, Po
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse postInstrumentIdentifierEnrollmentWithHttpInfo(String instrumentIdentifierId, PostInstrumentIdentifierEnrollmentRequest postInstrumentIdentifierEnrollmentRequest, String profileId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = postInstrumentIdentifierEnrollmentValidateBeforeCall(instrumentIdentifierId, postInstrumentIdentifierEnrollmentRequest, profileId, null, null);
return apiClient.execute(call);
}
diff --git a/src/main/java/Api/InterchangeClearingLevelDetailsApi.java b/src/main/java/Api/InterchangeClearingLevelDetailsApi.java
index 7da0b75e9..f81fc5dfb 100644
--- a/src/main/java/Api/InterchangeClearingLevelDetailsApi.java
+++ b/src/main/java/Api/InterchangeClearingLevelDetailsApi.java
@@ -170,7 +170,6 @@ private okhttp3.Call getInterchangeClearingLevelDetailsValidateBeforeCall(DateTi
*/
public ReportingV3InterchangeClearingLevelDetailsGet200Response getInterchangeClearingLevelDetails(DateTime startTime, DateTime endTime, String organizationId) throws ApiException {
logger.info("CALL TO METHOD 'getInterchangeClearingLevelDetails' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getInterchangeClearingLevelDetailsWithHttpInfo(startTime, endTime, organizationId);
logger.info("CALL TO METHOD 'getInterchangeClearingLevelDetails' ENDED");
return resp.getData();
@@ -186,6 +185,7 @@ public ReportingV3InterchangeClearingLevelDetailsGet200Response getInterchangeCl
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getInterchangeClearingLevelDetailsWithHttpInfo(DateTime startTime, DateTime endTime, String organizationId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getInterchangeClearingLevelDetailsValidateBeforeCall(startTime, endTime, organizationId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/InvoiceSettingsApi.java b/src/main/java/Api/InvoiceSettingsApi.java
index 1e869977e..e7618477d 100644
--- a/src/main/java/Api/InvoiceSettingsApi.java
+++ b/src/main/java/Api/InvoiceSettingsApi.java
@@ -148,7 +148,6 @@ private okhttp3.Call getInvoiceSettingsValidateBeforeCall(final ProgressResponse
*/
public InvoicingV2InvoiceSettingsGet200Response getInvoiceSettings() throws ApiException {
logger.info("CALL TO METHOD 'getInvoiceSettings' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getInvoiceSettingsWithHttpInfo();
logger.info("CALL TO METHOD 'getInvoiceSettings' ENDED");
return resp.getData();
@@ -161,6 +160,7 @@ public InvoicingV2InvoiceSettingsGet200Response getInvoiceSettings() throws ApiE
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getInvoiceSettingsWithHttpInfo() throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getInvoiceSettingsValidateBeforeCall(null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -287,7 +287,6 @@ private okhttp3.Call updateInvoiceSettingsValidateBeforeCall(InvoiceSettingsRequ
*/
public InvoicingV2InvoiceSettingsGet200Response updateInvoiceSettings(InvoiceSettingsRequest invoiceSettingsRequest) throws ApiException {
logger.info("CALL TO METHOD 'updateInvoiceSettings' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = updateInvoiceSettingsWithHttpInfo(invoiceSettingsRequest);
logger.info("CALL TO METHOD 'updateInvoiceSettings' ENDED");
return resp.getData();
@@ -301,6 +300,7 @@ public InvoicingV2InvoiceSettingsGet200Response updateInvoiceSettings(InvoiceSet
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse updateInvoiceSettingsWithHttpInfo(InvoiceSettingsRequest invoiceSettingsRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = updateInvoiceSettingsValidateBeforeCall(invoiceSettingsRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/InvoicesApi.java b/src/main/java/Api/InvoicesApi.java
index 9e77d249d..2876fd150 100644
--- a/src/main/java/Api/InvoicesApi.java
+++ b/src/main/java/Api/InvoicesApi.java
@@ -158,7 +158,6 @@ private okhttp3.Call createInvoiceValidateBeforeCall(CreateInvoiceRequest create
*/
public InvoicingV2InvoicesPost201Response createInvoice(CreateInvoiceRequest createInvoiceRequest) throws ApiException {
logger.info("CALL TO METHOD 'createInvoice' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = createInvoiceWithHttpInfo(createInvoiceRequest);
logger.info("CALL TO METHOD 'createInvoice' ENDED");
return resp.getData();
@@ -172,6 +171,7 @@ public InvoicingV2InvoicesPost201Response createInvoice(CreateInvoiceRequest cre
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse createInvoiceWithHttpInfo(CreateInvoiceRequest createInvoiceRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = createInvoiceValidateBeforeCall(createInvoiceRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -318,7 +318,6 @@ private okhttp3.Call getAllInvoicesValidateBeforeCall(Integer offset, Integer li
*/
public InvoicingV2InvoicesAllGet200Response getAllInvoices(Integer offset, Integer limit, String status) throws ApiException {
logger.info("CALL TO METHOD 'getAllInvoices' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getAllInvoicesWithHttpInfo(offset, limit, status);
logger.info("CALL TO METHOD 'getAllInvoices' ENDED");
return resp.getData();
@@ -334,6 +333,7 @@ public InvoicingV2InvoicesAllGet200Response getAllInvoices(Integer offset, Integ
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getAllInvoicesWithHttpInfo(Integer offset, Integer limit, String status) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getAllInvoicesValidateBeforeCall(offset, limit, status, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -467,7 +467,6 @@ private okhttp3.Call getInvoiceValidateBeforeCall(String id, final ProgressRespo
*/
public InvoicingV2InvoicesGet200Response getInvoice(String id) throws ApiException {
logger.info("CALL TO METHOD 'getInvoice' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getInvoiceWithHttpInfo(id);
logger.info("CALL TO METHOD 'getInvoice' ENDED");
return resp.getData();
@@ -481,6 +480,7 @@ public InvoicingV2InvoicesGet200Response getInvoice(String id) throws ApiExcepti
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getInvoiceWithHttpInfo(String id) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getInvoiceValidateBeforeCall(id, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -612,7 +612,6 @@ private okhttp3.Call performCancelActionValidateBeforeCall(String id, final Prog
*/
public InvoicingV2InvoicesPost201Response performCancelAction(String id) throws ApiException {
logger.info("CALL TO METHOD 'performCancelAction' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = performCancelActionWithHttpInfo(id);
logger.info("CALL TO METHOD 'performCancelAction' ENDED");
return resp.getData();
@@ -626,6 +625,7 @@ public InvoicingV2InvoicesPost201Response performCancelAction(String id) throws
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse performCancelActionWithHttpInfo(String id) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = performCancelActionValidateBeforeCall(id, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -757,7 +757,6 @@ private okhttp3.Call performSendActionValidateBeforeCall(String id, final Progre
*/
public InvoicingV2InvoicesPost201Response performSendAction(String id) throws ApiException {
logger.info("CALL TO METHOD 'performSendAction' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = performSendActionWithHttpInfo(id);
logger.info("CALL TO METHOD 'performSendAction' ENDED");
return resp.getData();
@@ -771,6 +770,7 @@ public InvoicingV2InvoicesPost201Response performSendAction(String id) throws Ap
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse performSendActionWithHttpInfo(String id) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = performSendActionValidateBeforeCall(id, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -907,7 +907,6 @@ private okhttp3.Call updateInvoiceValidateBeforeCall(String id, UpdateInvoiceReq
*/
public InvoicingV2InvoicesPost201Response updateInvoice(String id, UpdateInvoiceRequest updateInvoiceRequest) throws ApiException {
logger.info("CALL TO METHOD 'updateInvoice' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = updateInvoiceWithHttpInfo(id, updateInvoiceRequest);
logger.info("CALL TO METHOD 'updateInvoice' ENDED");
return resp.getData();
@@ -922,6 +921,7 @@ public InvoicingV2InvoicesPost201Response updateInvoice(String id, UpdateInvoice
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse updateInvoiceWithHttpInfo(String id, UpdateInvoiceRequest updateInvoiceRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = updateInvoiceValidateBeforeCall(id, updateInvoiceRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/ManageWebhooksApi.java b/src/main/java/Api/ManageWebhooksApi.java
index 2bdf5d50c..3c050e867 100644
--- a/src/main/java/Api/ManageWebhooksApi.java
+++ b/src/main/java/Api/ManageWebhooksApi.java
@@ -159,7 +159,6 @@ private okhttp3.Call deleteWebhookSubscriptionValidateBeforeCall(String webhookI
*/
public void deleteWebhookSubscription(String webhookId) throws ApiException {
logger.info("CALL TO METHOD 'deleteWebhookSubscription' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
deleteWebhookSubscriptionWithHttpInfo(webhookId);
}
@@ -172,6 +171,7 @@ public void deleteWebhookSubscription(String webhookId) throws ApiException {
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse deleteWebhookSubscriptionWithHttpInfo(String webhookId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = deleteWebhookSubscriptionValidateBeforeCall(webhookId, null, null);
return apiClient.execute(call);
}
@@ -302,7 +302,6 @@ private okhttp3.Call getWebhookSubscriptionByIdValidateBeforeCall(String webhook
*/
public InlineResponse2004 getWebhookSubscriptionById(String webhookId) throws ApiException {
logger.info("CALL TO METHOD 'getWebhookSubscriptionById' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getWebhookSubscriptionByIdWithHttpInfo(webhookId);
logger.info("CALL TO METHOD 'getWebhookSubscriptionById' ENDED");
return resp.getData();
@@ -316,6 +315,7 @@ public InlineResponse2004 getWebhookSubscriptionById(String webhookId) throws Ap
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getWebhookSubscriptionByIdWithHttpInfo(String webhookId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getWebhookSubscriptionByIdValidateBeforeCall(webhookId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -469,7 +469,6 @@ private okhttp3.Call getWebhookSubscriptionsByOrgValidateBeforeCall(String organ
*/
public List getWebhookSubscriptionsByOrg(String organizationId, String productId, String eventType) throws ApiException {
logger.info("CALL TO METHOD 'getWebhookSubscriptionsByOrg' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse> resp = getWebhookSubscriptionsByOrgWithHttpInfo(organizationId, productId, eventType);
logger.info("CALL TO METHOD 'getWebhookSubscriptionsByOrg' ENDED");
return resp.getData();
@@ -485,6 +484,7 @@ public List getWebhookSubscriptionsByOrg(String organization
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse> getWebhookSubscriptionsByOrgWithHttpInfo(String organizationId, String productId, String eventType) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getWebhookSubscriptionsByOrgValidateBeforeCall(organizationId, productId, eventType, null, null);
Type localVarReturnType = new TypeToken>(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -639,7 +639,6 @@ private okhttp3.Call saveAsymEgressKeyValidateBeforeCall(String vCSenderOrganiza
*/
public InlineResponse2015 saveAsymEgressKey(String vCSenderOrganizationId, String vCPermissions, SaveAsymEgressKey saveAsymEgressKey, String vCCorrelationId) throws ApiException {
logger.info("CALL TO METHOD 'saveAsymEgressKey' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = saveAsymEgressKeyWithHttpInfo(vCSenderOrganizationId, vCPermissions, saveAsymEgressKey, vCCorrelationId);
logger.info("CALL TO METHOD 'saveAsymEgressKey' ENDED");
return resp.getData();
@@ -656,6 +655,7 @@ public InlineResponse2015 saveAsymEgressKey(String vCSenderOrganizationId, Strin
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse saveAsymEgressKeyWithHttpInfo(String vCSenderOrganizationId, String vCPermissions, SaveAsymEgressKey saveAsymEgressKey, String vCCorrelationId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = saveAsymEgressKeyValidateBeforeCall(vCSenderOrganizationId, vCPermissions, saveAsymEgressKey, vCCorrelationId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -789,7 +789,6 @@ private okhttp3.Call updateWebhookSubscriptionValidateBeforeCall(String webhookI
*/
public void updateWebhookSubscription(String webhookId, UpdateWebhookRequest updateWebhookRequest) throws ApiException {
logger.info("CALL TO METHOD 'updateWebhookSubscription' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
updateWebhookSubscriptionWithHttpInfo(webhookId, updateWebhookRequest);
}
@@ -803,6 +802,7 @@ public void updateWebhookSubscription(String webhookId, UpdateWebhookRequest upd
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse updateWebhookSubscriptionWithHttpInfo(String webhookId, UpdateWebhookRequest updateWebhookRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = updateWebhookSubscriptionValidateBeforeCall(webhookId, updateWebhookRequest, null, null);
return apiClient.execute(call);
}
diff --git a/src/main/java/Api/MerchantBoardingApi.java b/src/main/java/Api/MerchantBoardingApi.java
index e914cc786..7dd891e9b 100644
--- a/src/main/java/Api/MerchantBoardingApi.java
+++ b/src/main/java/Api/MerchantBoardingApi.java
@@ -160,7 +160,6 @@ private okhttp3.Call getRegistrationValidateBeforeCall(String registrationId, fi
*/
public InlineResponse2001 getRegistration(String registrationId) throws ApiException {
logger.info("CALL TO METHOD 'getRegistration' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getRegistrationWithHttpInfo(registrationId);
logger.info("CALL TO METHOD 'getRegistration' ENDED");
return resp.getData();
@@ -174,6 +173,7 @@ public InlineResponse2001 getRegistration(String registrationId) throws ApiExcep
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getRegistrationWithHttpInfo(String registrationId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getRegistrationValidateBeforeCall(registrationId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -305,7 +305,6 @@ private okhttp3.Call postRegistrationValidateBeforeCall(PostRegistrationBody pos
*/
public InlineResponse2012 postRegistration(PostRegistrationBody postRegistrationBody, String vCIdempotencyId) throws ApiException {
logger.info("CALL TO METHOD 'postRegistration' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = postRegistrationWithHttpInfo(postRegistrationBody, vCIdempotencyId);
logger.info("CALL TO METHOD 'postRegistration' ENDED");
return resp.getData();
@@ -320,6 +319,7 @@ public InlineResponse2012 postRegistration(PostRegistrationBody postRegistration
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse postRegistrationWithHttpInfo(PostRegistrationBody postRegistrationBody, String vCIdempotencyId) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = postRegistrationValidateBeforeCall(postRegistrationBody, vCIdempotencyId, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/MicroformIntegrationApi.java b/src/main/java/Api/MicroformIntegrationApi.java
index e1015c588..a2db8a45d 100644
--- a/src/main/java/Api/MicroformIntegrationApi.java
+++ b/src/main/java/Api/MicroformIntegrationApi.java
@@ -151,7 +151,6 @@ private okhttp3.Call generateCaptureContextValidateBeforeCall(GenerateCaptureCon
*/
public String generateCaptureContext(GenerateCaptureContextRequest generateCaptureContextRequest) throws ApiException {
logger.info("CALL TO METHOD 'generateCaptureContext' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = generateCaptureContextWithHttpInfo(generateCaptureContextRequest);
logger.info("CALL TO METHOD 'generateCaptureContext' ENDED");
return resp.getData();
@@ -165,6 +164,7 @@ public String generateCaptureContext(GenerateCaptureContextRequest generateCaptu
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse generateCaptureContextWithHttpInfo(GenerateCaptureContextRequest generateCaptureContextRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = generateCaptureContextValidateBeforeCall(generateCaptureContextRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/NetFundingsApi.java b/src/main/java/Api/NetFundingsApi.java
index 508b29670..3b7d49ce4 100644
--- a/src/main/java/Api/NetFundingsApi.java
+++ b/src/main/java/Api/NetFundingsApi.java
@@ -175,7 +175,6 @@ private okhttp3.Call getNetFundingDetailsValidateBeforeCall(DateTime startTime,
*/
public ReportingV3NetFundingsGet200Response getNetFundingDetails(DateTime startTime, DateTime endTime, String organizationId, String groupName) throws ApiException {
logger.info("CALL TO METHOD 'getNetFundingDetails' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getNetFundingDetailsWithHttpInfo(startTime, endTime, organizationId, groupName);
logger.info("CALL TO METHOD 'getNetFundingDetails' ENDED");
return resp.getData();
@@ -192,6 +191,7 @@ public ReportingV3NetFundingsGet200Response getNetFundingDetails(DateTime startT
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getNetFundingDetailsWithHttpInfo(DateTime startTime, DateTime endTime, String organizationId, String groupName) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getNetFundingDetailsValidateBeforeCall(startTime, endTime, organizationId, groupName, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/NotificationOfChangesApi.java b/src/main/java/Api/NotificationOfChangesApi.java
index b8b07313d..0984811ba 100644
--- a/src/main/java/Api/NotificationOfChangesApi.java
+++ b/src/main/java/Api/NotificationOfChangesApi.java
@@ -167,7 +167,6 @@ private okhttp3.Call getNotificationOfChangeReportValidateBeforeCall(DateTime st
*/
public ReportingV3NotificationofChangesGet200Response getNotificationOfChangeReport(DateTime startTime, DateTime endTime) throws ApiException {
logger.info("CALL TO METHOD 'getNotificationOfChangeReport' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = getNotificationOfChangeReportWithHttpInfo(startTime, endTime);
logger.info("CALL TO METHOD 'getNotificationOfChangeReport' ENDED");
return resp.getData();
@@ -182,6 +181,7 @@ public ReportingV3NotificationofChangesGet200Response getNotificationOfChangeRep
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse getNotificationOfChangeReportWithHttpInfo(DateTime startTime, DateTime endTime) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = getNotificationOfChangeReportValidateBeforeCall(startTime, endTime, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/OrdersApi.java b/src/main/java/Api/OrdersApi.java
index 451cf6d0d..ec64ab899 100644
--- a/src/main/java/Api/OrdersApi.java
+++ b/src/main/java/Api/OrdersApi.java
@@ -155,7 +155,6 @@ private okhttp3.Call createOrderValidateBeforeCall(CreateOrderRequest createOrde
*/
public PtsV2CreateOrderPost201Response createOrder(CreateOrderRequest createOrderRequest) throws ApiException {
logger.info("CALL TO METHOD 'createOrder' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = createOrderWithHttpInfo(createOrderRequest);
logger.info("CALL TO METHOD 'createOrder' ENDED");
return resp.getData();
@@ -169,6 +168,7 @@ public PtsV2CreateOrderPost201Response createOrder(CreateOrderRequest createOrde
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse createOrderWithHttpInfo(CreateOrderRequest createOrderRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = createOrderValidateBeforeCall(createOrderRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -305,7 +305,6 @@ private okhttp3.Call updateOrderValidateBeforeCall(String id, UpdateOrderRequest
*/
public PtsV2UpdateOrderPatch201Response updateOrder(String id, UpdateOrderRequest updateOrderRequest) throws ApiException {
logger.info("CALL TO METHOD 'updateOrder' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = updateOrderWithHttpInfo(id, updateOrderRequest);
logger.info("CALL TO METHOD 'updateOrder' ENDED");
return resp.getData();
@@ -320,6 +319,7 @@ public PtsV2UpdateOrderPatch201Response updateOrder(String id, UpdateOrderReques
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse updateOrderWithHttpInfo(String id, UpdateOrderRequest updateOrderRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = updateOrderValidateBeforeCall(id, updateOrderRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
diff --git a/src/main/java/Api/PayerAuthenticationApi.java b/src/main/java/Api/PayerAuthenticationApi.java
index 9f8f1ffc9..bb11b81ce 100644
--- a/src/main/java/Api/PayerAuthenticationApi.java
+++ b/src/main/java/Api/PayerAuthenticationApi.java
@@ -158,7 +158,6 @@ private okhttp3.Call checkPayerAuthEnrollmentValidateBeforeCall(CheckPayerAuthEn
*/
public RiskV1AuthenticationsPost201Response checkPayerAuthEnrollment(CheckPayerAuthEnrollmentRequest checkPayerAuthEnrollmentRequest) throws ApiException {
logger.info("CALL TO METHOD 'checkPayerAuthEnrollment' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = checkPayerAuthEnrollmentWithHttpInfo(checkPayerAuthEnrollmentRequest);
logger.info("CALL TO METHOD 'checkPayerAuthEnrollment' ENDED");
return resp.getData();
@@ -172,6 +171,7 @@ public RiskV1AuthenticationsPost201Response checkPayerAuthEnrollment(CheckPayerA
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse checkPayerAuthEnrollmentWithHttpInfo(CheckPayerAuthEnrollmentRequest checkPayerAuthEnrollmentRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = checkPayerAuthEnrollmentValidateBeforeCall(checkPayerAuthEnrollmentRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -299,7 +299,6 @@ private okhttp3.Call payerAuthSetupValidateBeforeCall(PayerAuthSetupRequest paye
*/
public RiskV1AuthenticationSetupsPost201Response payerAuthSetup(PayerAuthSetupRequest payerAuthSetupRequest) throws ApiException {
logger.info("CALL TO METHOD 'payerAuthSetup' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = payerAuthSetupWithHttpInfo(payerAuthSetupRequest);
logger.info("CALL TO METHOD 'payerAuthSetup' ENDED");
return resp.getData();
@@ -313,6 +312,7 @@ public RiskV1AuthenticationSetupsPost201Response payerAuthSetup(PayerAuthSetupRe
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse payerAuthSetupWithHttpInfo(PayerAuthSetupRequest payerAuthSetupRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = payerAuthSetupValidateBeforeCall(payerAuthSetupRequest, null, null);
Type localVarReturnType = new TypeToken(){}.getType();
return apiClient.execute(call, localVarReturnType);
@@ -440,7 +440,6 @@ private okhttp3.Call validateAuthenticationResultsValidateBeforeCall(ValidateReq
*/
public RiskV1AuthenticationResultsPost201Response validateAuthenticationResults(ValidateRequest validateRequest) throws ApiException {
logger.info("CALL TO METHOD 'validateAuthenticationResults' STARTED");
- this.apiClient.setComputationStartTime(System.nanoTime());
ApiResponse resp = validateAuthenticationResultsWithHttpInfo(validateRequest);
logger.info("CALL TO METHOD 'validateAuthenticationResults' ENDED");
return resp.getData();
@@ -454,6 +453,7 @@ public RiskV1AuthenticationResultsPost201Response validateAuthenticationResults(
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
*/
public ApiResponse validateAuthenticationResultsWithHttpInfo(ValidateRequest validateRequest) throws ApiException {
+ this.apiClient.setComputationStartTime(System.nanoTime());
okhttp3.Call call = validateAuthenticationResultsValidateBeforeCall(validateRequest, null, null);
Type localVarReturnType = new TypeToken